华为云用户手册

  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表2 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of DomainTags objects 标签列表。 最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 数组长度:1 - 20 limit 否 Integer 每页条目数量,取值如下: 10:每页显示10条资源信息。 20:每页显示20条资源信息。 50:每页显示50条资源信息。 最小值:10 最大值:50 缺省值:10 offset 否 Integer 索引位置,偏移量,从offset指定的下一条数据开始查询。 最小值:0 缺省值:0 matches 否 Array of ResourceTag objects 搜索字段。 key为要匹配的字段,如resource_name等。value为匹配的值。key为固定字典值,不能包含重复的key或不支持的key。 数组长度:0 - 20 表3 DomainTags 参数 是否必选 参数类型 描述 key 是 String 标签键。可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 values 是 Array of strings 标签值列表。每个值可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:0 最大长度:255 数组长度:1 - 20 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 是 String 标签值。可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • 响应示例 状态码: 200 正常返回。 { "failure_list" : [ { "resource" : "982b8a6a6ebc43809d82a46ca99aaeb7", "failure_info" : "ELB.8904:certificate 982b8a6a6ebc43809d82a46ca99aaeb7 does not exist" } ] } 状态码: 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 500 请求未完成,服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 failure_list Array of FaiureResource objects 部署失败的资源列表。 数组长度:1 - 20 表6 FaiureResource 参数 参数类型 描述 resource String 部署失败的资源信息,部署WAF与ELB时,此字段为资源ID,部署CDN时,本字段为加速 域名 。 最小长度:0 最大长度:63 failure_info String 失败原因,一般为目标服务返回的错误码信息。 最小长度:0 最大长度:255 状态码: 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表3 请求Body参数 参数 是否必选 参数类型 描述 project_name 否 String 部署的资源所在的项目名称,若在主项目下,则该值为region id。 最小长度:1 最大长度:255 service_name 是 String 证书推送的目标服务,当前仅支持:CDN、WAF、ELB。 最小长度:1 最大长度:64 resources 是 Array of DeployedResource objects 所要部署的资源列表。 数组长度:1 - 20 表4 DeployedResource 参数 是否必选 参数类型 描述 id 否 String 资源ID,部署WAF与ELB时,必传此字段。 最小长度:0 最大长度:63 type 否 String 资源类型,当前仅部署WAF资源时需传入,即独享模式(premium)与云模式(cloud)。 最小长度:0 最大长度:63 domain_name 否 String 需部署的域名,当前仅部署CDN时需传入,即需加速的域名,域名与证书必须可匹配。 最小长度:0 最大长度:63 enterprise_project_id 否 String 需部署的资源所属的企业项目ID,当前仅部署WAF资源时,需传入。 最小长度:0 最大长度:63
  • 响应示例 状态码: 200 请求已成功 { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] } 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of ResourceTag objects 标签列表,key和value键值对的集合。 数组长度:1 - 20 表4 ResourceTag 参数 参数类型 描述 key String 标签键。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value String 标签值。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 200 请求已成功 { "total_count" : 1, "resources" : [ { "resource_id" : "806064a8-7478-4657-a8b0-2edc90621235" }, { "resource_name" : "test" }, { "resource_detail" : [ { "ca_id" : "806064a8-7478-4657-a8b0-2edc90621235", "create_time" : 1681436805000, "delete_time" : null, "crl_configuration" : { "enabled" : false, "obs_bucket_name" : null, "valid_days" : null, "crl_name" : null, "crl_dis_point" : null }, "distinguished_name" : { "country" : "CN", "state" : "guangdong", "locality" : "shenzhen", "organization" : "TestA", "organizational_unit" : "IT", "common_name" : "TestA IT Root CA" }, "enc_cert_info" : null, "enterprise_project_id" : "57d71362-6a1a-4f51-8fa9-693bc3c07f43", "freeze_flag" : 0, "gen_mode" : "GENERATE", "issuer_id" : null, "issuer_name" : null, "key_algorithm" : "SM2", "not_before" : 1681436805000, "not_after" : 1713059205000, "path_length" : 7, "serial_number" : "202203070322544291829058", "signature_algorithm" : "SM3", "status" : "ACTIVED", "type" : "ROOT" } ] }, { "tags" : [ { "key" : "key1", "value" : "value1" } ] } ] } 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 请求示例 根据标签查询CA列表,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificate-authorities/resource-instances/filter { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 最小值:0 最大值:100 resources Array of TagResource objects 资源实例列表,详情请参见TagResource字段数据结构说明。 数组长度:0 - 100 表6 TagResource 参数 参数类型 描述 resource_id String 资源ID。 最小长度:0 最大长度:63 resource_detail Object 资源详情。 tags Array of ResourceTag objects 标签列表,没有标签默认为空数组。 数组长度:0 - 100 resource_name String 资源名称,默认为空字符串。 最小长度:0 最大长度:63 表7 ResourceTag 参数 参数类型 描述 key String 标签键。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value String 标签值。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表2 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of DomainTags objects 标签列表。 最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 数组长度:1 - 20 limit 否 Integer 每页条目数量,取值如下: 10:每页显示10条资源信息。 20:每页显示20条资源信息。 50:每页显示50条资源信息。 最小值:10 最大值:50 缺省值:10 offset 否 Integer 索引位置,偏移量,从offset指定的下一条数据开始查询。 最小值:0 缺省值:0 matches 否 Array of ResourceTag objects 搜索字段。 key为要匹配的字段,如resource_name等。value为匹配的值。key为固定字典值,不能包含重复的key或不支持的key。 数组长度:0 - 20 表3 DomainTags 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 values 是 Array of strings 标签值列表。 每个值可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:0 最大长度:255 数组长度:1 - 20 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 是 String 标签值。 可用UTF-8格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • URI DELETE /v1/private-certificate-authorities/{ca_id} 表1 路径参数 参数 是否必选 参数类型 描述 ca_id 是 String 所要计划删除的CA证书ID。 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 pending_days 否 String 延迟删除时间,单位为”天“, 若用户不输入该字段,默认为30。 最小长度:1 最大长度:2
  • 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应示例 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 响应示例 状态码: 400 请求参数有误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 401 被请求的页面需要鉴权。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 403 认证失败。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 404 资源不存在或资源未找到。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" } 状态码: 500 服务内部错误。 { "error_code" : "PCA.XXX", "error_msg" : "XXX" }
  • 响应参数 状态码: 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 私有证书相关接口的授权信息 权限 对应API接口 授权项(Action) 企业项目 (Enterprise Project) 查询私有证书详情 GET /v1/private-certificates/{certificate_id} pca:cert:get x 解析私有证书 CS R POST /v1/private-certificates/csr/parse pca:cert:parseCsr x 导出私有证书 POST /v1/private-certificates/{certificate_id}/export pca:cert:export x 查询私有证书配额 GET /v1/private-certificates/quotas pca:cert:quota x 创建私有证书 POST /v1/private-certificates pca:ca:issueCert x 删除私有证书 DELETE /v1/private-certificates/{certificate_id} pca:ca:delete x 吊销私有证书 POST /v1/private-certificates/{certificate_id}/revoke pca:cert:revoke x 使用CSR创建私有证书 POST /v1/private-certificates/csr pca:ca:issueCertThroughCSR x 查询私有证书列表 GET /v1/private-certificates pca:cert:list √
  • 私有CA相关接口的授权信息 权限 对应API接口 授权项(Action) 企业项目 (Enterprise Project) 创建CA POST /v1/private-certificate-authorities pca:ca:create x 取消计划删除CA POST /v1/private-certificate-authorities/{ca_id}/restore pca:ca:restore x 查询私有CA详情 GET /v1/private-certificate-authorities/{ca_id} pca:ca:get x 查询私有CA CSR GET /v1/private-certificate-authorities/{ca_id}/csr pca:ca:getCsr x 查询私有CA配额 GET /v1/private-certificate-authorities/quotas pca:ca:quota x 导出私有CA POST /v1/private-certificate-authorities/{ca_id}/export pca:ca:export x 删除私有CA DELETE /v1/private-certificate-authorities/{ca_id} pca:ca:delete x 禁用私有CA POST /v1/private-certificate-authorities/{ca_id}/disable pca:ca:disable x 启用私有CA POST /v1/private-certificate-authorities/{ca_id}/enable pca:ca:enable x 激活私有CA POST /v1/private-certificate-authorities/{ca_id}/activate pca:ca:active x 导入 CA POST /v1/private-certificate-authorities/{ca_id}/import pca:ca:import x 查询私有CA列表 GET /v1/private-certificate-authorities pca:ca:list √
  • 操作步骤 查询证书列表。 接口相关信息 URI格式:GET /v3/scm/certificates 详情请参见查询证书列表。 请求示例 GET: https://{endpoint}/v3/scm/certificates {endpoint}信息请从地区和终端节点获取。 Body: { "limit": "2", "offset": "0" } 响应示例 { "certificates" : [ { "id" : "scs1554192131150", "name" : "test", "domain" : "www.zx.com", "type" : "OV_SSL_CERT", "brand" : "GEOTRUST", "expire_time" : "2021-05-27 16:46:25.0", "domain_type" : "MULTI_DOMAIN", "validity_period" : 12, "status" : "ISSUED", "domain_count" : 2, "wildcard_count" : 0, "description" : null } ], "total_count" : 1 } 推送SSL证书。 接口相关信息 URI格式:POST /v3/scm/certificates/{certificate_id}/push 详情请参见推送证书。 请求示例 POST: https://{endpoint}/v3/scm/certificates/scs1554192131150/push {endpoint}信息请从地区和终端节点获取。 响应示例 { } 或 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 操作步骤 导入证书。 接口相关信息 URI格式:POST /v3/scm/certificates/import 详情请参见导入证书。 请求示例 POST: https://{endpoint}/v3/scm/certificates/import {endpoint}信息请从地区和终端节点获取。 响应示例 { "certificate_id" : "scs1554192131150" } 查询证书列表。 接口相关信息 URI格式:GET /v3/scm/certificates 详情请参见查询证书列表。 请求示例 GET: https://{endpoint}/v3/scm/certificates {endpoint}信息请从地区和终端节点获取。 Body: { "limit": "2", "offset": "0" } 响应示例 { "certificates" : [ { "id" : "scs1554192131150", "name" : "test", "domain" : "www.zx.com", "type" : "OV_SSL_CERT", "brand" : "GEOTRUST", "expire_time" : "2021-05-27 16:46:25.0", "domain_type" : "MULTI_DOMAIN", "validity_period" : 12, "status" : "ISSUED", "domain_count" : 2, "wildcard_count" : 0, "description" : null } ], "total_count" : 1 } 推送证书。 接口相关信息 URI格式:POST /v3/scm/certificates/{certificate_id}/push 详情请参见推送证书。 请求示例 POST: https://{endpoint}/v3/scm/certificates/scs1554192131150/push {endpoint}信息请从地区和终端节点获取。 响应示例 { } 或 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 操作步骤 查询证书列表。 接口相关信息 URI格式:GET /v3/scm/certificates 详情请参见查询证书列表。 请求示例 GET: https://{endpoint}/v3/scm/certificates {endpoint}信息请从地区和终端节点获取。 Body: { "limit": "2", "offset": "0" } 响应示例 { "certificates" : [ { "id" : "scs1554192131150", "name" : "test", "domain" : "www.zx.com", "type" : "OV_SSL_CERT", "brand" : "GEOTRUST", "expire_time" : "2021-05-27 16:46:25.0", "domain_type" : "MULTI_DOMAIN", "validity_period" : 12, "status" : "ISSUED", "domain_count" : 2, "wildcard_count" : 0, "description" : null } ], "total_count" : 1 } 删除证书。 接口相关信息 URI格式:DELETE /v3/scm/certificates/{certificate_id} 详情请参见删除证书。 请求示例 DELETE: https://{endpoint}/v3/scm/certificates/scs1554192131150 {endpoint}信息请从地区和终端节点获取。 Body: { certificate_id:scs1554192131150 } 响应示例 { } 或 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • v3接口的授权信息 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询证书列表 GET /v3/scm/certificates scm:cert:list - √ x 获取证书详情 GET /v3/scm/certificates/{certificate_id} scm:cert:get - √ x 删除证书 DELETE /v3/scm/certificates/{certificate_id} scm:cert:delete - √ x 推送证书 POST /v3/scm/certificates/{certificate_id}/push scm:cert:push 推送至CDN时,还需要添加如下授权项: cdn:configuration:queryHttpsConf √ x 导入证书 POST /v3/scm/certificates/import scm:cert:upload - √ x 导出证书 POST /v3/scm/certificates/{certificate_id}/export scm:cert:download - √ x
  • v2接口的授权信息 权限 对应API接口 授权项(Action) 依赖的授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询证书列表 GET /v2/{project_id}/scm/certlist scm:cert:list - √ x 查询证书详情 GET /v2/{project_id}/scm/cert/{cert_id} scm:cert:get - √ x 查询证书产品类型 GET /v2/{project_id}/scm/cert/product scm:certType:get - √ x 查询证书产品详情 GET /v2/{project_id}/scm/product/{product_id} scm:certProduct:get - √ x 取消申请 POST /v2/{project_id}/scm/cert/{cert_id}/cancel-cert scm:cert:cancel - √ x 购买证书 POST /v2/{project_id}/scm/cert/purchase scm:cert:purchase - √ x 申请证书 POST /v2/{project_id}/scm/cert/{cert_id}/complete scm:cert:complete - √ x 保存申请证书填写的信息 POST /v2/{project_id}/scm/cert/{cert_id}/save scm:cert:complete - √ x 读取申请证书填写的信息 POST /v2/{project_id}/scm/cert/{cert_id}/read scm:cert:complete - √ x 修改证书 PUT /v2/{project_id}/scm/cert/{cert_id} scm:cert:edit - √ x 删除证书 DELETE /v2/{project_id}/scm/cert/{cert_id} scm:cert:delete - √ x 下载证书 GET /v2/{project_id}/scm/cert/{cert_id}/cert_file scm:cert:download - √ x 上传认证信息 POST /v2/{project_id}/scm/cert/{cert_id}/info/{type}/upload_authentication scm:cert:complete - √ x 吊销证书 POST /v2/{project_id}/scm/cert/{cert_id}/revoke scm:cert:revoke - √ x 推送证书 POST /v2/{project_id}/scm/cert/{cert_id}/push scm:cert:push 推送至CDN时,还需要添加如下授权项: cdn:configuration:queryHttpsConf √ x 查询推送记录 GET /v2/{project_id}/scm/cert/{cert_id}/push-history scm:pushHistory:list - √ x 上传证书 POST /v2/{project_id}/scm/cert/upload scm:cert:upload - √ x 校验CSR POST /v2/{project_id}/scm/check-csr scm:cert:complete - √ x 新增附加域名 POST /v2/{project_id}/scm/cert/{cert_id}/supplement scm:cert:supplement - √ x 取消隐私授权 DELETE /v2/{project_id}/scm/privacy-protection/{cert_id} scm:privacyProtection:delete - √ x
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。 云证书管理服务 (CCM)支持的自定义策略授权项如下所示: SSL证书管理 私有证书管理
  • 私有证书管理状态码 状态码 编码 状态说明 200 OK 请求已成功。 201 Created 创建类的请求完全成功。 204 NO Content 执行成功,无响应消息体。 400 Bad Request 请求参数有误。 401 Unauthorized 服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 服务器已经理解请求,但是拒绝执行它。 404 Not Found 资源不存在,资源未找到。 500 Internal Server Error 服务内部错误。
  • SSL证书管理状态码 状态码 编码 状态说明 200 OK 请求已成功。 202 Accept 任务提交成功,当前系统繁忙,下发的任务会延迟处理。 204 No Content 请求已成功,无内容返回。 300 multiple choices 被请求的资源存在多个可供选择的响应。 400 Bad Request 请求参数有误。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 服务器已经理解请求,但是拒绝执行它。 404 Not Found 资源不存在,资源未找到。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证,这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突,请求无法被完成。 500 Internal Server Error 服务内部错误。 501 Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 请求未完成。系统暂时异常。 504 Gateway Timeout 网关超时。
  • 请求消息 请求参数 参数 是否必选 参数类型 描述 ori_sans 是 String 多域名证书中已经绑定的附加域名。 当显示有 多个域名 时,请以“;”隔开。 示例:example.domain.com;example.domain1.com add_sans 否 String 多域名证书需要增加的附加域名。 当需要输入多个域名时,请以“;”隔开。 示例:example.domain2.com;example.domain3.com email 否 String 联系人邮箱地址。
  • 示例 如下以新增1个附加域名“example.domain.com”为例。 请求样例 { "ori_sans": "abc.com;xyz.com", "add_sans": "example.domain.com", "email": "example@xx.com" } 响应样例 { "request_info":"success" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 示例 请求样例 无。 响应样例 { "push_history_list": [ { "push_time": "1556257820000", "push_remote_project": null, "push_service": "CDN" }, { "push_time": "1556257447000", "push_remote_project": "cn-north-7_test", "push_service": "WAF" } ] } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
  • 响应消息 响应参数 参数 是否必选 参数类型 描述 push_history_list 是 Array of push_history_list objects 推送记录列表,详情请参见表1。 表1 push_history_list 参数 是否必选 参数类型 描述 push_time 是 String 推送时间,毫秒级时间戳。 push_remote_project 是 String 推送项目。 push_service 是 String 推送的服务类型。 WAF:证书推送到了 Web应用防火墙 中。 CDN:证书推送到了内容分发网络中。 ELB:证书推送到了弹性负载均衡(经典型)中。 Enhance_ELB:证书推送到了弹性负载均衡(独享型和共享型)中。
  • 示例 如下以推送证书到“WAF”,推送区域为“cn-north-7”为例。 请求样例 { "service_type":"WAF", "remote_project":"cn-north-7" } 响应样例 { "message":"success" } 或 { "error_code": "SCM.XXXX", "error_msg": "XXXX" }
共100000条