文档首页/ 云证书管理服务 CCM/ API参考/ API说明/ 管理私有证书/ 私有证书管理/ 查询私有证书配额
更新时间：2024-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询私有证书配额

功能介绍

查询私有证书配额。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/private-certificates/quotas

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：32

最大长度：2097152

响应参数

状态码： 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

请求示例

查询私有证书配额，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。

GET https://{Endpoint}/v1/private-certificates/quotas

响应示例

状态码： 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"
}

状态码

状态码

描述

200

请求已成功

400

请求参数有误。

401

被请求的页面需要鉴权。

403

认证失败。

404

资源不存在或资源未找到。

500

服务内部错误。

错误码

请参见错误码。

父主题： 私有证书管理

相关文档