华为云用户手册

  • 请求示例 导出私钥密码为“test”未压缩的PEM格式证书。请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates/6434f74f-2d13-4e6a-89eb-93ee313f1a43/export{ "type" : "other", "is_compressed" : false, "password" : "test"}
  • 响应示例 状态码: 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键值对的集合。 表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" : "Huawei", "organizational_unit" : "IT", "common_name" : "Huawei 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"}
  • 请求示例 查询标签键为"key1",标签值为"value1", "value2"的CA列表。请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/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字段数据结构说明。 表6 TagResource 参数 参数类型 描述 resource_id String 资源ID。 最小长度:0 最大长度:63 resource_detail Object 资源详情。 tags Array of ResourceTag objects 标签列表,没有标签默认为空数组。 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获取方法。 表2 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of DomainTags objects 标签列表。 最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 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。 表3 DomainTags 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 values 是 Array of strings 标签值列表。 每个值可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:0 最大长度:255 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 是 String 标签值。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tags Array of ResourceTag objects 标签列表,key和value键值对的集合。 表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 请求已成功 { "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 表5 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 最小值:0 最大值:100 resources Array of TagResource objects 资源实例列表,详情请参见TagResource字段数据结构说明。 表6 TagResource 参数 参数类型 描述 resource_id String 资源ID。 最小长度:0 最大长度:63 resource_detail Object 资源详情。 tags Array of ResourceTag objects 标签列表,没有标签默认为空数组。 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
  • 响应示例 状态码: 200 请求已成功 { "total_count" : 1, "resources" : [ { "resource_id" : "61e1f947-8794-4574-82bd-14fd0cd3af67" }, { "resource_name" : "test" }, { "resource_detail" : [ { "certificate_id" : "61e1f947-8794-4574-82bd-14fd0cd3af67", "create_time" : 1681436805000, "delete_time" : null, "distinguished_name" : { "country" : "CN", "state" : "guangdong", "locality" : "shenzhen", "organization" : "Huawei", "organizational_unit" : "IT", "common_name" : "Huawei IT Root CA" }, "enc_cert_info" : null, "enterprise_project_id" : "0", "freeze_flag" : 0, "gen_mode" : "GENERATE", "issuer_id" : "93fcdaf2-c094-4f39-9cbc-bcacd0baac48", "issuer_name" : "test", "key_algorithm" : "RSA2048", "not_before" : 1681436805000, "not_after" : 1713059205000, "path_length" : 7, "serial_number" : "202203070322544291829058", "signature_algorithm" : "SHA256", "status" : "ISSUED" } ] }, { "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"}
  • 请求示例 查询标签键为 "key1",标签值为"value1", "value2"的证书列表。请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates/resource-instances/filter{ "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ]}
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表2 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of DomainTags objects 标签列表。 最多包含20个key,每个key下面的value最多20个,每个key对应的value可以为空数组但结构体不能缺失。key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 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。 表3 DomainTags 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 values 是 Array of strings 标签值列表。 每个值可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:0 最大长度:255 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 value 是 String 标签值。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : / = + - @ 最小长度:0 最大长度:255
  • 响应示例 状态码: 200 请求已成功 { "total" : 2, "obs_buckets" : [ { "create_time" : 1554867690718, "bucket_name" : "admin1" }, { "create_time" : 1554949519646, "bucket_name" : "admin3" } ]} 状态码: 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 表2 响应Body参数 参数 参数类型 描述 total Integer OBS桶总数。 obs_buckets Array of ObsBuckets objects OBS桶列表,详情请参见ObsBuckets字段数据结构说明。 表3 ObsBuckets 参数 参数类型 描述 bucket_name String 桶名称。 最小长度:3 最大长度:63 create_time Long 创建时间,格式为时间戳(毫秒级)。 状态码: 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
  • 响应示例 状态码: 200 请求已成功 { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "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 表2 响应Body参数 参数 参数类型 描述 tags Array of DomainTags objects 标签列表。 表3 DomainTags 参数 参数类型 描述 key String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 values Array of strings 标签值列表。 每个值可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:0 最大长度:255 状态码: 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
  • 响应示例 状态码: 200 请求已成功 { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "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 表2 响应Body参数 参数 参数类型 描述 tags Array of DomainTags objects 标签列表。 表3 DomainTags 参数 参数类型 描述 key String 标签键。 可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:1 最大长度:128 values Array of strings 标签值列表。 每个值可用 UTF-8 格式表示的字母(包含中文、西班牙语、葡语等)、数字和空格,以及以下字符: _ . : = + - @ 最小长度:0 最大长度:255 状态码: 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 表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
  • 请求示例 吊销证书,吊销理由为“证书密钥材料泄露”。请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificates/6434f74f-2d13-4e6a-89eb-93ee313f1a43/revoke{ "reason" : "KEY_COMPROMISE"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token,参见:IAM token获取方法。 表3 请求Body参数 参数 是否必选 参数类型 描述 reason 否 String 吊销理由,支持以下选项: UNSPECIFIED : 吊销时未指定吊销原因,为默认值; KEY_COMPROMISE : 证书密钥材料泄露; CERTIFICATE_AUTHORITY_COMPROMISE : 颁发路径上,可能存在CA密钥材料泄露; AFFILIATION_CHANGED : 证书中的主体或其他信息已经被改变; SUPERSEDED : 此证书已被取代; CES SATION_OF_OPERATION : 此证书或颁发路径中的实体已停止运营; CERTIFICATE_HOLD : 该证书当前不应被视为有效,预计将来可能会生效; PRIVILEGE_WITHDRAWN : 此证书不再具备其声明的属性的权限; ATTRIBUTE_AUTHORITY_COMPROMISE : 担保此证书属性的机构可能已受到损害。 说明: 当不想填写吊销理由时,请求body体请置为"{}",否则将会报异常,默认值为UNSPECIFIED。
  • 响应示例 状态码: 200 请求已成功 { "agency_granted" : "true"} 状态码: 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"}
  • 请求示例 查看PCA是否具有用户的OBS委托权限(用于访问OBS桶,更新吊销列表),请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限与安全管理员(secu_admin)权限。 GET https://ccm.cn-north-4.myhuaweicloud.com/v1/private-certificate-authorities/obs/agencies
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 agency_granted String OBS当前的授权结果。 true false 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 终端节点 终端节点(Endpoint)即调用API的请求地址,CCM部署时不区分物理区域,为全局级服务。因此,CCM的终端节点如表1所示。您可以从地区和终端节点中查询服务的终端节点。 表1 云证书管理服务 的终端节点 区域名称 区域 终端节点(Endpoint) 协议类型 包含微服务 所有 ALL scm.cn-north-4.myhuaweicloud.com HTTPS SCM 所有 ALL ccm.cn-north-4.myhuaweicloud.com HTTPS PCA 父主题: 使用前必读
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token可通过调用获取用户Token接口获取,调用本服务API需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } }} 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 Content-Type: application/jsonX-Auth-Token: ABCDEFJ....
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • 示例 { "domain_name": "huawei.com", "domain_email": null, "record_name": "_dnsauth. huawei.com", "record_value": "202305150000002aurxma1tun2fgzz0jbs9h5lsekf8gloq57mbs78m9jist465m", "record_type": "TXT", "domain_method": "DNS", "applicant_email": "huawei@huawei.com", "auto_dns_auth": true}
共100000条