GetCAInstanceStatus API 呼び出しによる非公開 CA インスタンスのステータス確認 - Certificate Management Service

Certificate Management Service コンソールで購入したプライベートルート CA または中間 CA インスタンスのステータスを照会します。

操作説明

この操作を呼び出して、ID に基づいてプライベート CA インスタンスのステータスを照会します。ステータス情報には、インスタンスのステータス、発行可能な証明書の総数、およびすでに発行された証明書の数が含まれます。

この操作を呼び出す前に、Certificate Management Service コンソールでプライベート CA を購入する必要があります。詳細については、「プライベート CA の購入」をご参照ください。

QPS 制限

この操作は、ユーザーごとに 1 秒あたり 10 クエリ (QPS) の制限があります。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。この操作は、適切な頻度で呼び出してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

yundun-cert:GetCAInstanceStatus

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	任意	照会するプライベート CA インスタンスの ID です。説明 Certificate Management Service コンソールでプライベート 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 がルート CA (Type が ROOT) の場合、このパラメーターは発行できる中間 CA 証明書の数を示します。プライベート CA が中間 CA (Type が SUB_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 証明書の発行日です。この値は UNIX タイムスタンプです。単位：ミリ秒。説明このパラメーターは、Status が USED (プライベート CA インスタンスが有効) または REVOKE (プライベート CA インスタンスが失効) の場合にのみ返されます。	1635177600000
Identifier	string	プライベート CA 証明書の一意の識別子です。説明このパラメーターは、Status が USED (プライベート CA インスタンスが有効) または REVOKE (プライベート CA インスタンスが失効) の場合にのみ返されます。	a7bb2dd212a2112128cd5cc9b753****
AfterTime	integer	プライベート CA 証明書の有効期限日です。この値は UNIX タイムスタンプです。単位：ミリ秒。説明このパラメーターは、Status が USED (プライベート CA インスタンスが有効) または REVOKE (プライベート CA インスタンスが失効) の場合にのみ返されます。	1792944000000
InstanceId	string	プライベート CA インスタンスの ID です。	cas-member-0hmi****
UseExpireTime	integer	プライベート CA インスタンスの有効期限日です。この値は UNIX タイムスタンプです。単位：ミリ秒。説明このパラメーターは、インスタンスの購入時に選択したプライベート認証局 (PCA) サービスのサブスクリプション期間に対応します。	1637251200000

例

成功レスポンス

JSONJSON

{
  "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
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。