ListInstances

更新時間:
Copy as MD

取得執行個體列表。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cert:ListInstances

list

*All Resource

*

請求參數

名稱

類型

必填

描述

樣本值

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

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": 0,
      "AutoReissue": "enable",
      "FullDomainCount": 1,
      "WildcardDomainCount": 0,
      "PendingResult": "pending",
      "ResourceGroupId": "123"
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情