GetCAInstanceStatus - 查詢CA執行個體的狀態資訊

更新時間:
Copy as MD

查詢您通過SSL認證服務控制台購買的私人根CA執行個體或私人子CA執行個體的狀態資訊。

介面說明

本介面用於通過私人 CA 執行個體的 ID,查詢您通過 SSL 憑證服務控制台購買的私人 CA 執行個體的狀態資訊,例如,CA 執行個體的狀態、包含的認證數量、已簽發的認證數量等。

調用本介面前,您必須已經通過數位憑證管理服務控制台購買了私人 CA。具體操作,請參見購買私人 CA

QPS 限制

本介面的單使用者 QPS 限制為 10 次/秒。超過限制,API 呼叫將會被限流,這可能影響您的業務,請合理調用。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-cert:GetCAInstanceStatus

get

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

InstanceId

string

要查詢的私人 CA 執行個體的 ID。

說明

您在數位憑證管理服務控制台購買私人 CA 執行個體後,可以在私人認證頁面,通過查看私人 CA 執行個體的詳情,擷取私人 CA 執行個體的 ID。

cas-member-0hmi****

Identifier

string

要查詢的用戶端認證或服務端認證的唯一識別碼。

說明

您可以調用 ListClientCertificate 查詢所有用戶端認證和服務端認證的唯一識別碼。

160ae6bb538d538c70c01f81dcf2****

返回參數

名稱

類型

描述

樣本值

object

對象。

RequestId

string

本次請求的 ID。

25589516-2A56-5159-AB88-4A1D9824E183

InstanceStatusList

array<object>

私人 CA 執行個體的狀態詳情。

object

對象。

CertTotalCount

integer

私人 CA 執行個體能夠簽發認證的數量。

對於私人根 CA 執行個體(TypeROOT),該參數表示能夠簽發的子 CA 憑證的數量。 對於私人子 CA 執行個體(TypeSUB_ROOT),該參數表示能夠簽發的用戶端認證和服務端認證的總數量。

10

Status

string

私人 CA 執行個體的狀態。取值:

  • BUY:表示已購買但是未啟用。

  • USED:表示已啟用。

  • REFUND:表示已退款。

  • REVOKE:表示已被吊銷。

USED

Type

string

私人 CA 執行個體的類型。取值:

  • ROOT:表示根 CA 執行個體。

  • SUB_ROOT:表示子 CA 執行個體。

ROOT

CertIssuedCount

integer

私人 CA 執行個體已經簽發認證的數量。

1

BeforeTime

integer

私人 CA 憑證的簽發日期。使用時間戳表示,單位:毫秒。

說明

只有當 StatusUSED(表示私人 CA 執行個體已啟用)或 REVOKE(表示私人 CA 執行個體已被吊銷)時,才會返回該參數。

1635177600000

Identifier

string

私人 CA 憑證的唯一標識碼。

說明

只有當 StatusUSED(表示私人 CA 執行個體已啟用)或 REVOKE(表示私人 CA 執行個體已被吊銷)時,才會返回該參數。

a7bb2dd212a2112128cd5cc9b753****

AfterTime

integer

私人 CA 憑證的到期日。使用時間戳格式表示,單位:毫秒。

說明

只有當 StatusUSED(表示私人 CA 執行個體已啟用)或 REVOKE(表示私人 CA 執行個體已被吊銷)時,才會返回該參數。

1792944000000

InstanceId

string

私人 CA 執行個體的 ID。

cas-member-0hmi****

UseExpireTime

integer

私人 CA 執行個體的到期日。使用時間戳表示,單位:毫秒。

說明

該參數對應您在購買私人 CA 執行個體時選擇的購買時間長度,即 PCA 服務的時間長度。

1637251200000

樣本

正常返回樣本

JSON格式

{
  "RequestId": "25589516-2A56-5159-AB88-4A1D9824E183",
  "InstanceStatusList": [
    {
      "CertTotalCount": 10,
      "Status": "USED",
      "Type": "ROOT",
      "CertIssuedCount": 1,
      "BeforeTime": 1635177600000,
      "Identifier": "a7bb2dd212a2112128cd5cc9b753****",
      "AfterTime": 1792944000000,
      "InstanceId": "cas-member-0hmi****",
      "UseExpireTime": 1637251200000
    }
  ]
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情