获取实例列表
接口说明
本接口用于通过私有 CA 实例的 ID,查询您通过 SSL 证书服务控制台购买的私有 CA 实例的状态信息,例如,CA 实例的状态、包含的证书数量、已签发的证书数量等。
调用本接口前,您必须已经通过数字证书管理服务控制台购买了私有 CA。具体操作,请参见购买私有 CA。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
yundun-cert:ListInstances |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Keyword |
string |
否 |
模糊查询,匹配域名、名称实例或对应的资源 ID。 |
test |
| Status |
string |
否 |
实例状态。
|
inactive |
| Brand |
string |
否 |
CA 品牌。WoSign、CFCA、DigiCert、GeoTrust、GlobalSign、vTrus、Alibaba。 |
Digicert |
| CertificateType |
string |
否 |
证书的类型。取值:DV、OV、EV。 |
DV |
| CertificateStatus |
string |
否 |
证书的状态。
|
issued |
| InstanceType |
string |
否 |
实例类型,BUY:正式证书;TEST:测试证书。 |
BUY |
| ResourceGroupId |
string |
否 |
资源组 id。 |
rg-ae******4wia |
| ShowSize |
integer |
否 |
分页查询时,设置每页显示实例的数量。默认值为 10,最大为 100。 |
10 |
| CurrentPage |
integer |
否 |
分页查询时,设置当前页面的页码。默认值为 1。 |
1 |
| ServerDeployFlag |
integer |
否 |
是否返回仅符合服务器部署条件实例。 1:是 0:否。 |
1 |
| AutoReissueFlag |
integer |
否 |
1:已托管 0:未托管。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| CurrentPage |
integer |
分页查询,当前显示的页数。 |
1 |
| DisableReissueCount |
integer |
未开启托管的实例数。 |
80 |
| EnableReissueCount |
integer |
已开启托管的实例数。 |
100 |
| InstanceList |
array<object> |
实例列表。 |
|
|
object |
实例。 |
||
| AutoReissue |
string |
是否开启自动托管。
|
enable |
| Brand |
string |
CA 品牌。WoSign、CFCA、DigiCert、GeoTrust、GlobalSign、vTrus、Alibaba。 |
DigiCert |
| CertIdentifier |
string |
全局证书 ID,格式为证书 Id + "-" + 站点 regionId,常用在阿里云各个云产品中。
例如证书 Id = 123,则国内站 CertIdentifier = “123-cn-hangzhou”,国际站 CertIdentifier = "123-ap-southeast-1"。 |
21795675-cn-hangzhou |
| CertificateDomain |
string |
最新已签发证书的域名。 |
abc.com,www.abc.com |
| CertificateId |
integer |
证书 ID。 |
18541349 |
| CertificateName |
string |
证书名称。 |
cert-13216408 |
| CertificateNotAfter |
integer |
最新证书的结束时间,时间戳。精确到秒。未签发证书则为空。 |
1801324800000 |
| CertificateNotBefore |
integer |
最新证书的开始时间,时间戳。精确到秒。未签发证书则为空。 |
1776988800000 |
| CertificateRevokeTime |
integer |
最新一张证书吊销时间,时间戳。精确到秒。 |
1801324800000 |
| CertificateStatus |
string |
证书的状态。
|
issued |
| CertificateType |
string |
证书的类型。取值:DV、OV、EV。 |
DV |
| Domain |
string |
证书绑定的域名。 |
test.com |
| FullDomainCount |
integer |
精准域名数量。 |
1 |
| InstanceEndTime |
integer |
实例的到期时间,时间戳。精确到秒。如果未签发过证书,则返回空。 |
1801324800000 |
| InstanceId |
string |
实例的 ID。 |
cas_dv-cn-123 |
| InstanceStartTime |
integer |
实例的开始时间,时间戳。精确到秒。如果未签发过证书,则返回空。 |
1801324800000 |
| InstanceType |
string |
实例类型,BUY:正式证书;TEST:测试证书。 |
BUY |
| KeyAlgorithm |
string |
证书算法,默认为 RSA_2048。
|
RSA_2048 |
| OrderEndTime |
integer |
实例购买时的结束时间,时间戳,精确到秒。用来判断实例的购买时长。 |
1801324800000 |
| OrderStartTime |
integer |
实例购买时的开始时间,时间戳,精确到秒。用来判断退款时间限制。 |
1801324800000 |
| PendingResult |
string |
最后一次操作证书时,CA 返回的结果。 |
pending |
| ResourceGroupId |
string |
资源组 id。 |
123 |
| Spec |
string |
购买的实例规格。 |
ss.dv.t |
| Status |
string |
实例状态。
|
inactive |
| UsingProductList |
array |
最新证书部署云产品列表。 |
|
|
string |
部署云产品。 |
['DCDN', 'VOD', 'CDN', 'OSS'] |
|
| VersionType |
string |
版本类型,取值有: 基础版 basic、标准版 standard、专业版 professional、旗舰版 ultimate |
professional |
| WildcardDomainCount |
integer |
通配符域名的数量。 |
0 |
| RequestId |
string |
本次请求的 ID。 |
12345678-1234-1234-1234-123456789ABC |
| ShowSize |
integer |
每页显示多少条记录。 |
20 |
| TotalCount |
integer |
实例总个数。 |
12 |
示例
正常返回示例
JSON格式
{
"CurrentPage": 1,
"DisableReissueCount": 80,
"EnableReissueCount": 100,
"InstanceList": [
{
"AutoReissue": "enable",
"Brand": "DigiCert",
"CertIdentifier": "21795675-cn-hangzhou",
"CertificateDomain": "abc.com,www.abc.com",
"CertificateId": 18541349,
"CertificateName": "cert-13216408",
"CertificateNotAfter": 1801324800000,
"CertificateNotBefore": 1776988800000,
"CertificateRevokeTime": 1801324800000,
"CertificateStatus": "issued",
"CertificateType": "DV",
"Domain": "test.com",
"FullDomainCount": 1,
"InstanceEndTime": 1801324800000,
"InstanceId": "cas_dv-cn-123",
"InstanceStartTime": 1801324800000,
"InstanceType": "BUY",
"KeyAlgorithm": "RSA_2048",
"OrderEndTime": 1801324800000,
"OrderStartTime": 1801324800000,
"PendingResult": "pending",
"ResourceGroupId": "123",
"Spec": "ss.dv.t",
"Status": "inactive",
"UsingProductList": [
"['DCDN', 'VOD', 'CDN', 'OSS']"
],
"VersionType": "professional",
"WildcardDomainCount": 0
}
],
"RequestId": "12345678-1234-1234-1234-123456789ABC",
"ShowSize": 20,
"TotalCount": 12
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。