1. 接口描述
接口请求域名: gaap.tencentcloudapi.com 。
本接口(DescribeCertificates)用来查询可以使用的证书列表。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCertificates。 |
Version | 是 | String | 公共参数,本接口取值:2018-05-29。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
CertificateType | 否 | Integer | 证书类型。其中: 0,表示基础认证配置; 1,表示客户端CA证书; 2,表示服务器SSL证书; 3,表示源站CA证书; 4,表示通道SSL证书。 -1,所有类型。 默认为-1。 |
Offset | 否 | Integer | 偏移量,默认为0。 |
Limit | 否 | Integer | 限制数量,默认为20。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CertificateSet | Array of Certificate | 服务器证书列表,包括证书ID 和证书名称。 |
TotalCount | Integer | 满足查询条件的服务器证书总数量。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询服务器证书信息
输入示例
https://gaap.tencentcloudapi.com/?Action=DescribeCertificates
&CertificateType=2
&Offset=0
&Limit=1
&<公共请求参数>
输出示例
{
"Response": {
"TotalCount": 19,
"RequestId": "35d85baa-eeb8-4eb5-96a9-b6d27f4ff92c",
"CertificateSet": [
{
"CertificateId": "cert-8k1l0pat",
"SubjectCN": "lagameft01.xyz",
"CertificateAlias": "test",
"CertificateName": "test",
"BeginTime": 1554134400,
"CertificateType": 2,
"EndTime": 1585713600,
"CreateTime": 1564557014,
"IssuerCN": "TrustAsia TLS RSA CA"
}
]
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
- Tencent Cloud CLI 3.0
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.NotEnterpriseAuthorization | 非企业认证客户。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |