查询私有证书额度--证书中心-火山引擎

文档中心

立即注册

导航

查询私有证书额度

最近更新时间：2025.08.22 13:41:09首次发布时间：2023.09.21 10:27:10

调用本接口查询您拥有的私有证书额度。

使用说明

私有证书额度可用于抵扣私有证书的配置费用。如需获取私有证书额度，请购买私有证书资源包。

请求说明

接口名称：GetQuotaDetail
请求方式：GET
请求地址：
- IPv4网络接入：pca.volcengineapi.com
- 双栈网络接入（IPv4/IPv6）：pca.volcengine-api.com

调试

暂不支持。

请求参数

下方表格中的参数包含在请求头（header）中。

参数	类型	是否必选	描述	示例值
Region	string	是	服务地区。该参数的取值是`cn-north-1`。	`cn-north-1`
ServiceName	string	是	服务名称。该参数的取值是`pca`。	`pca`

Query

下方表格中的参数包含在查询字符串（query string）中。

参数	类型	是否必选	描述	示例值
Action	String	是	API的名称。该参数的取值是 `GetQuotaDetail`。	`GetQuotaDetail`
Version	String	是	API的版本。该参数的取值是 `2023-05-01`。	`2023-05-01`
quota_type	String	是	额度的类型。该参数的取值是 `leaf`，表示私有证书的额度。	`leaf`

返回参数

参数	类型	描述	示例值
Result	Integer	可用的私有证书额度的数量。	`100`

请求示例

GET https://pca.volcengineapi.com/?Action=GetQuotaDetail&Version=2023-05-01&quota_type=leaf&<其他公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230314200921F7BEBB2D6FFCA5123A1C",
        "Action": "GetQuotaDetail",
        "Version": "2023-05-01",
        "Service": "pca",
        "Region": "cn-north-1"
    },
    "Result": 100
}

错误码

如果响应正文的ResponseMetadata字段中包含Error字段，则表示API请求失败。您可访问公共错误码，获取更多错误码信息。

证书中心