ListInstances - 实例列表

更新时间:
复制为 MD 格式

获取实例列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Keyword

string

模糊查询,匹配域名、名称实例或对应的资源 ID。

test

Status

string

实例状态。

  • inactive:待使用

  • pending:审核中,最新证书提交审核中

  • willExpire:实例即将过期

  • expired:实例已经过期

  • refund:已退款

  • normal:正常

  • closed:已关闭,不可使用

inactive

Brand

string

CA 品牌。WoSign、CFCA、DigiCert、GeoTrust、GlobalSign、vTrus、Alibaba。

Digicert

CertificateType

string

证书的类型。取值:DV、OV、EV。

DV

CertificateStatus

string

证书的状态。

  • issued:已签发

  • revoked:已吊销

  • willExpire:即将过期

  • expired:已过期

issued

InstanceType

string

实例类型,BUY:正式证书;TEST:测试证书。

BUY

ResourceGroupId

string

资源组 id。

rg-ae******4wia

ShowSize

integer

分页查询时,设置每页显示实例的数量。默认值为 10,最大为 100

10

CurrentPage

integer

分页查询时,设置当前页面的页码。默认值为 1

1

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次请求的 ID。

12345678-1234-1234-1234-123456789ABC

TotalCount

integer

实例总个数。

12

ShowSize

integer

每页显示多少条记录。

20

CurrentPage

integer

分页查询,当前显示的页数。

1

InstanceList

array<object>

实例列表。

object

实例。

InstanceId

string

实例的 ID。

cas_dv-cn-123

KeyAlgorithm

string

证书算法,默认为 RSA_2048。

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • ECC_256

  • SM2

RSA_2048

Status

string

实例状态。

  • inactive:待使用

  • pending:审核中,最新证书提交审核中

  • willExpire:实例即将过期

  • expired:实例已经过期

  • refund:已退款

  • normal:正常

  • closed:已关闭,不可使用

inactive

Domain

string

证书绑定的域名。

test.com

Spec

string

购买的实例规格。

ss.dv.t

CertificateId

integer

证书 ID。

18541349

CertificateName

string

证书名称。

cert-13216408

CertIdentifier

string

全局证书 ID,格式为证书 Id + "-" + 站点 regionId,常用在阿里云各个云产品中。

  • 国内站为证书 Id + "-cn-hangzhou"

  • 国际站为证书 Id + "-ap-southeast-1"

例如证书 Id = 123,则国内站 CertIdentifier = “123-cn-hangzhou”,国际站 CertIdentifier = "123-ap-southeast-1"。

21795675-cn-hangzhou

Brand

string

CA 品牌。WoSign、CFCA、DigiCert、GeoTrust、GlobalSign、vTrus、Alibaba。

DigiCert

CertificateType

string

证书的类型。取值:DV、OV、EV。

DV

CertificateStatus

string

证书的状态。

  • issued:已签发

  • revoked:已吊销

  • willExpire:即将过期

  • expired:已过期

issued

InstanceType

string

实例类型,BUY:正式证书;TEST:测试证书。

BUY

OrderStartTime

integer

实例购买时的开始时间,时间戳,用来判断退款时间限制。

1801324800000

CertificateRevokeTime

integer

最新一张证书吊销时间,时间戳。

1801324800000

OrderEndTime

integer

实例购买时的结束时间,时间戳,用来判断实例的购买时长。

1801324800000

InstanceStartTime

integer

实例的开始时间,时间戳。如果未签发过证书,则返回空。

1801324800000

InstanceEndTime

integer

实例的到期时间,时间戳。如果未签发过证书,则返回空。

1801324800000

CertificateNotAfter

integer

最新证书的结束时间,时间戳。未签发证书则为空。

1801324800000

AutoReissue

string

是否开启自动托管。

  • enable:开启

  • disable:未开启

enable

FullDomainCount

integer

精准域名数量。

1

WildcardDomainCount

integer

通配符域名的数量。

0

PendingResult

string

最后一次操作证书时,CA 返回的结果。

pending

示例

正常返回示例

JSON格式

{
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "TotalCount": 12,
  "ShowSize": 20,
  "CurrentPage": 1,
  "InstanceList": [
    {
      "InstanceId": "cas_dv-cn-123",
      "KeyAlgorithm": "RSA_2048",
      "Status": "inactive",
      "Domain": "test.com",
      "Spec": "ss.dv.t",
      "CertificateId": 18541349,
      "CertificateName": "cert-13216408",
      "CertIdentifier": "21795675-cn-hangzhou",
      "Brand": "DigiCert",
      "CertificateType": "DV",
      "CertificateStatus": "issued",
      "InstanceType": "BUY",
      "OrderStartTime": 1801324800000,
      "CertificateRevokeTime": 1801324800000,
      "OrderEndTime": 1801324800000,
      "InstanceStartTime": 1801324800000,
      "InstanceEndTime": 1801324800000,
      "CertificateNotAfter": 1801324800000,
      "AutoReissue": "enable",
      "FullDomainCount": 1,
      "WildcardDomainCount": 0,
      "PendingResult": "pending"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情