API 名称：DescribeCACertificates 。
API 域名：open.volcengineapi.com 。
API 描述：查询证书列表，单个账号每次最多查询100个CA证书。
节流限制：每秒最多提交 40 个 API 请求。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。
| 名称 | 类型 | 是否必选 | 格式 | 说明 |
|---|---|---|---|---|
| Action | string | 是 | [a-zA-Z]+ | API 名称，如 DescribeCertificates 。 |
| Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2020-04-01 。 |
| X-Expires | int | 否 | 900 | 表示签名的有效时间，单位是秒，默认值是900。 |
在使用该 API 提交请求时，请求参数中可以包含的参数如下。
| 参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
|---|---|---|---|---|
| CACertificateIds.N | Array | 否 | CA 证书的ID，N代表证书的序号。
| CACertificateIds.1=cert-123*** 765&CertificateIds.2=cert-234****876 |
| CACertificateName | String | 否 | CA 证书的名称。 | test |
| PageSize | Integer | 否 | 分页查询时每页的行数，取值1-100，默认为10。 | 20 |
| PageNumber | Integer | 否 | 列表的页码，默认值为1。 | 1 |
| ProjectName | String | 否 | CA 证书所属项目名称。 | default |
| TagFilters | Array | 否 | CA 证书关联的标签，具体参见下表 TagFilters。 | - |
TagFilters
参数 | 类型 | 是否必选 | 参数说明 | 示例 |
|---|---|---|---|---|
| TagFilters.N.Key | String | 否 | 证书标签的标签键。 指定多个标签键时，表示查询同时包含所有指定标签键的证书。 | TagFilters.1.Key=k1&TagFilters.2.Key=k2 |
TagFilters.N.Values.N | String | 否 | 证书标签的标签值。如果传入该参数，则必须先传入TagFilters.N.Key。具体规则如下：
| TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3 |
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
| RequestId | String | 请求ID。 | 20210816110638****2514606306AF947C |
| PageSize | Integer | 当前分页的行数。 | 20 |
| PageNumber | Integer | 当前页码。 | 1 |
| TotalCount | Integer | 符合条件的CA证书总数。 | 50 |
| CACertificates | Array | 符合条件的CA证书的详细信息，具体请参见 CACertificates 。 | - |
CACertificates
| 参数 | 类型 | 参数说明 | 示例值 |
|---|---|---|---|
| CACertificateId | String | CA 证书ID。 | cert-123***765 |
| CACertificateName | String | CA 证书名称。 | test |
| CertificateType | String | CA 证书类型，1. CA：CA证书。 | CA |
| Description | String | CA 证书描述。 | test |
| CreateTime | String | CA 证书的创建时间。 | 2021-12-14T11:13:40+08:00 |
| ExpiredAt | String | CA 证书的过期时间。 | 2021-12-14T11:13:40+08:00 |
| DomainName | String | CA 证书的域名。 | test.com |
| San | String | 证书扩展域名列表，用英文',' 分隔多个域名， 包含(commonName,DnsName,IP)。 | www.test.com,*.test.com |
| Listeners | List of String | CA 证书关联的监听器列表。 | [lsn-123 *****112,lsn-234 *****567] |
Status | String | CA 证书的状态，取值为：
| Active |
| ProjectName | String | CA 证书所属项目名称。 | default |
| Tags | Array | CA 证书关联的标签，具体参见下表 Tags。 | - |
Tags
参数 | 类型 | 参数说明 | 示例 |
|---|---|---|---|
Key | String | 用户标签的标签键。 | key |
Value | String | 用户标签的标签键。 | value |
GET /?Action=DescribeCACertificates&CACertificateIds.1=cert-2fe5jqh****hs5oxruwk7x9ze&Version=2020-04-01 HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing ServiceName: alb
{
"ResponseMetadata": {
"RequestId": "20210816110638****2514606306AF947C",
"Action": "DescribeCACertificates",
"Version": "2020-04-01",
"Service": "alb",
"Region": "cn-beijing"
},
"Result": {
"RequestId": "20210816110638****2514606306AF947C",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"Certificates": [
{
"CACertificateId": "cert-2fe5k****c16o5oxruvtk3qf5",
"CACertificateName": "test",
"CertificateType": "CA",
"Description": "test",
"CreateTime": "2021-12-14T11:13:40+08:00",
"ExpiredAt": "2021-12-14T11:13:40+08:00",
"DomainName": "*.a.cdn-build.net",
"Listeners": [
"lsn-1g0e0p14****88ibuxxpnwden",
"lsn-1g0e0p90e****8ibuxwy36kc1"
]
}
]
}
}
如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。
| HTTP Code | 错误码 | 错误信息 | 错误描述 |
|---|---|---|---|
| 400 | LimitExceed.CACertificate | You've reached the limit on the number of CA certificates that you can operate at a time. | 已达到单次可操作的 CA 证书的数量上限。 |
| 400 | InvalidPaging.Malformed | The specified PageNumber or PageSize is malformed. | 指定的分页参数格式不合法。 |
| 400 | InvalidCACertificateName.Malformed | The specified CACertificateName is malformed. | 指定的 CACertificateName 参数格式不合法。 |
400 | LimitExceed.TagFilters.Values | You've reached the limit on the number of tag filter values that you can operate at a time. | 已达到单次可操作的标签值的数量上限。 |
400 | InvalidTagFilters.Key.Malformed | The specified TagFilters.Key is malformed. | 指定的 TagFilters.Key 参数格式不合法。 |
400 | InvalidTagFilters.Value.Malformed | The specified TagFilters.Value is malformed. | 指定的 TagFilters.Value 参数格式不合法。 |
400 | InvalidTagFilters.Key.Duplicated | The specified TagFilters.Key is duplicated. | 指定的 TagFilters.Key 重复。 |