取得執行個體列表。
介面說明
本介面用於透過私有 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
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。