ListInstances - 实例列表

更新时间:
复制 MD 格式

获取实例列表

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-cert:ListInstances

list

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

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

CertificateDomain

string

最新已签发证书的域名。

abc.com,www.abc.com

Spec

string

购买的实例规格。

ss.dv.t

CertificateId

integer

证书 ID。

18541349

CertificateName

string

证书名称。

cert-13216408

UsingProductList

array

最新证书部署云产品列表。

string

部署云产品。

['DCDN', 'VOD', 'CDN', 'OSS']

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

CertificateNotBefore

integer

最新证书的开始时间,时间戳。精确到秒。未签发证书则为空。

1776988800000

AutoReissue

string

是否开启自动托管。

  • enable:开启

  • disable:未开启

enable

FullDomainCount

integer

精准域名数量。

1

WildcardDomainCount

integer

通配符域名的数量。

0

PendingResult

string

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

pending

ResourceGroupId

string

资源组 id。

123

示例

正常返回示例

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",
      "CertificateDomain": "abc.com,www.abc.com",
      "Spec": "ss.dv.t",
      "CertificateId": 18541349,
      "CertificateName": "cert-13216408",
      "UsingProductList": [
        "['DCDN', 'VOD', 'CDN', 'OSS']"
      ],
      "CertIdentifier": "21795675-cn-hangzhou",
      "Brand": "DigiCert",
      "CertificateType": "DV",
      "CertificateStatus": "issued",
      "InstanceType": "BUY",
      "OrderStartTime": 1801324800000,
      "CertificateRevokeTime": 1801324800000,
      "OrderEndTime": 1801324800000,
      "InstanceStartTime": 1801324800000,
      "InstanceEndTime": 1801324800000,
      "CertificateNotAfter": 1801324800000,
      "CertificateNotBefore": 1776988800000,
      "AutoReissue": "enable",
      "FullDomainCount": 1,
      "WildcardDomainCount": 0,
      "PendingResult": "pending",
      "ResourceGroupId": "123"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情