华为云用户手册

  • 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为 IAM 的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "xxxxxxxx", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 响应示例 状态码: 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码: 500 请求未完成,服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表3 请求Body参数 参数 是否必选 参数类型 描述 target_project 是 String 推送到的目标服务所在的区域。 最小长度:1 最大长度:255 target_service 是 String 证书推送的目标服务,当前仅支持:CDN、WAF、ELB。 最小长度:1 最大长度:64
  • 响应参数 状态码: 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 状态码: 500 表6 响应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" }
  • 请求示例 批量删除CA标签,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 DELETE https://{Endpoint}/v1/private-certificate-authorities/4c0e772e-a30c-4029-b929-b7acb04143f7/tags/delete { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表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
  • 请求示例 批量创建证书标签,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificates/4c0e772e-a30c-4029-b929-b7acb04143f7/tags/create { "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" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:32 最大长度:2097152 表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 请求已成功 { "quotas" : { "resources" : [ { "type" : "CERTIFICATE_AUTHORITY", "used" : 25, "quota" : 100 } ] } } 状态码: 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参数 参数 参数类型 描述 quotas Quotas object 证书配额,详情请参见Quotas字段数据结构说明。 表3 Quotas 参数 参数类型 描述 support_hsm_cluster Boolean 是否启用加密机集群加密功能。 true false resources Array of Resources objects 资源配额列表,详情请参见Resources字段数据结构说明。 数组长度:0 - 10 表4 Resources 参数 参数类型 描述 type String 证书类型: CERTIFICATE_AUTHORITY: CA证书; CERTIFICATE: 私有证书。 used Integer 已使用配额数。 quota Integer 配额总数: CERTIFICATE_AUTHORITY: 当前系统指定100; CERTIFICATE: 当前系统指定100000。 状态码: 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
  • 响应示例 状态码: 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 表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
  • 响应示例 状态码: 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
  • 响应参数 状态码: 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
  • 响应示例 状态码: 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 请求已成功 { "signature_algorithm" : "SHA256", "issuer_id" : "ef5d84d1-4f52-47d2-b1c8-a91a672487a0", "issuer_name" : "TestA CA", "not_after" : 1665539214000, "not_before" : 1634295475000, "status" : "ISSUED", "freeze_flag" : 0, "gen_mode" : "GENERATE", "serial_number" : "202110151057541266081861", "distinguished_name" : { "country" : "cn", "state" : "guizhou", "locality" : "guiyang", "organization" : "TestA", "organizational_unit" : "IT", "common_name" : "test.test.com" }, "key_algorithm" : "RSA4096", "create_time" : 1634295475000, "delete_time" : null, "certificate_id" : "6434f74f-2d13-4e6a-89eb-93ee313f1a43", "enc_cert_info" : { "enc_serial_number" : "2ad6c3e393a95bf13f95" } } 状态码: 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参数 参数 参数类型 描述 certificate_id String 私有证书ID。 最小长度:36 最大长度:36 status String 证书状态: ISSUED : 已签发; EXPIRED : 已过期; REVOKED : 已吊销。 issuer_id String 父CA证书ID。 最小长度:36 最大长度:36 issuer_name String 父CA证书名称。 最小长度:1 最大长度:64 key_algorithm String 密钥算法。 signature_algorithm String 签名算法。 freeze_flag Integer 冻结标识: 0 : 非冻结状态; 其它值 : 冻结状态,当前预留。 gen_mode String 证书生成方式: GENERATE : PCA系统生成; IMPORT : 外部导入; CS R : 外部提供CSR,内部CA进行签发,即私钥不在PCA进行托管。 serial_number String 序列号。 最小长度:1 最大长度:64 create_time Long 证书创建时间,格式为时间戳(毫秒级)。 delete_time Long 证书删除时间,格式为时间戳(毫秒级)。 not_before Long 证书创建时间,格式为时间戳(毫秒级)。 not_after Long 证书到期时间,格式为时间戳(毫秒级)。 distinguished_name DistinguishedName object 证书名称配置,详情请参见DistinguishedName字段数据结构说明。 enc_cert_info EncCertInfo object 加密证书信息,详情请参见EncCertInfo字段数据结构说明。 enterprise_project_id String 企业项目ID,默认为“0”。 对于开通企业项目的用户,表示资源处于默认企业项目下。 对于未开通企业项目的用户,表示资源未处于企业项目下。 表4 DistinguishedName 参数 参数类型 描述 common_name String 证书通用名称(CN),名称只能由"-"、"_"、" "、"."、","、"*"、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 country String 国家编码,只能由英文组成,长度为2位字符。 最小长度:2 最大长度:2 state String 省市名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 locality String 地区名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过128位字符。 最小长度:1 最大长度:128 organization String 组织名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 organizational_unit String 组织单元名称,名称只能由"-"、"_"、" "、"."、","、字母、数字、汉字组成,长度不能超过64位字符。 最小长度:1 最大长度:64 表5 EncCertInfo 参数 参数类型 描述 enc_serial_number String 加密证书序列号。 最小长度:1 最大长度:64 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 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 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 quotas Quotas object 证书配额,详情请参见Quotas字段数据结构说明。 表3 Quotas 参数 参数类型 描述 support_hsm_cluster Boolean 是否启用加密机集群加密功能。 true false resources Array of Resources objects 资源配额列表,详情请参见Resources字段数据结构说明。 数组长度:0 - 10 表4 Resources 参数 参数类型 描述 type String 证书类型: CERTIFICATE_AUTHORITY: CA证书; CERTIFICATE: 私有证书。 used Integer 已使用配额数。 quota Integer 配额总数: CERTIFICATE_AUTHORITY: 当前系统指定100; CERTIFICATE: 当前系统指定100000。 状态码: 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 请求已成功 { "quotas" : { "resources" : [ { "type" : "CERTIFICATE", "used" : 25, "quota" : 100000 } ] } } 状态码: 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" }
  • 请求示例 根据标签查询证书数量,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificates/resource-instances/count { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
  • 响应示例 状态码: 200 请求已成功 { "total_count" : 1 } 状态码: 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 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 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 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表10 响应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
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 certificate_id String 当前签发的证书ID。 最小长度:36 最大长度:36 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 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 状态码: 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024 状态码: 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度:3 最大长度:36 error_msg String 错误请求返回的错误信息。 最小长度:0 最大长度:1024
  • 请求示例 通过CSR签发证书,请求头中的X-Auth-Token字段需要填写token,且该token需要具有本API的访问权限。 POST https://{Endpoint}/v1/private-certificates/csr { "csr" : "-----BEGIN CERTIFICATE REQUEST-----\\nMIICyTCCAbECAQAwXjELMAkGA1UEBhMCQ04xEDAOBgNVBAgTB3NpY2hhdW4xEDAO\\nBgNVBAcTB2NoZW5nZHUxCzAJBgNVBAoTAkhXMQswCQYDVQQLEwJJVDERMA8GA1UE\\nAxMIdGVzdC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCZ4q5z\\nxqK/L/FC9x2jESeUW5GB6zS5rVxT0WLTCTv9d1LtWBLsRIinATYTYiP1pNo4/pBq\\nHlM3IiUDkc896CJerYlNzOIjTaV4GjCZvPrxSHU5toJvIDflBsY+gnzbT1ol/y0r\\n3yb9dx7eeF5rPR+U8RTw+Ov/ZNRb+0CY30hrXMdrWjp5dtLGTlr5EFYxlKNOPCkR\\n+6BGyJnC9PWSuqwsykFbgMRkcBaNAxa59dRhMF50pvx2Vs929vFrMi+ofDELUOqz\\n1vyjaEA3pn3AGJGXZgrGNbSfz12ixgGLes4cQD21GCIAWgnBQ7b1ru2V8ImUfyh0\\nyvTEyHJTuFbQ+257AgMBAAGgJjAkBgkqhkiG9w0BCQ4xFzAVMBMGA1UdEQQMMAqC\\nCHRlc3QuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQBKfjZuYsz4s0wb1POIWn41eiAB\\np53qb63QKWILN9z8dLktcdSl3lPfcfPZpXv++QPtn3LR9rJKBawusk6SPXbvOGgS\\n5J+6eM8kVW2O3gHFgoaMcPYVtiO7ekG6o25qx6+Rj84wbFdmpOiCc8AwrLEBwzYV\\np1zaprWQu6PxBulkYPa3FLcntDdi7B67r0YTpxVvo1K7vHYFboDvPz7xG57QIFIM\\nwGd1OegariMT3N8gBOzLZc+jqLpxgo4xoNqBHMo6DEmKLdWdzU4ljpuGK9had99k\\nvQ5vft/Qra3v1uq2lOm/G92b0uA9Y1t2bMHobtAnuXL0HmY9XcLdzpC3f8h8\\n-----END CERTIFICATE REQUEST-----", "validity" : { "type" : "YEAR", "value" : 3 }, "issuer_id" : "2cb2878b-6cd1-460d-bd25-afe655159bdc" }
共100000条