ドキュメント
ホームページ Certificate Management Service 開発者リソース APIリファレンス (SSL証明書) フロー制御情報 インスタンスのサブスクリプション ListInstances

ListInstances

更新日時
Copy as MD
製品

インスタンスのリストを取得します。

今すぐお試しください

この 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: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

任意

ページングクエリで 1 ページあたりに表示するインスタンス数。デフォルト値: 10。最大値: 100。

10
CurrentPage

integer

任意

ページングクエリの現在のページ番号。デフォルト値: 1。

1

レスポンスフィールド

フィールド

型

説明

例

object

RequestId

string

リクエスト ID。

12345678-1234-1234-1234-123456789ABC
TotalCount

integer

インスタンスの総数。

12
ShowSize

integer

1 ページあたりのレコード数。

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 + "-" + サイトリージョン ID です。この ID は Alibaba Cloud サービス全体で一般的に使用されます。

  • 中国サイトの場合: 証明書 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

インスタンス購入の開始時刻。UNIX タイムスタンプフォーマットです。この値は返金期限の判定に使用されます。

1801324800000
CertificateRevokeTime

integer

最新の証明書の失効時間。UNIX タイムスタンプフォーマットです。

1801324800000
OrderEndTime

integer

インスタンス購入の終了時刻。UNIX タイムスタンプフォーマットです。この値はインスタンスの購入持続時間の判定に使用されます。

1801324800000
InstanceStartTime

integer

インスタンスの開始時刻。UNIX タイムスタンプフォーマットです。証明書が発行されていない場合、この値は空です。

1801324800000
InstanceEndTime

integer

インスタンスの有効期限時間。UNIX タイムスタンプフォーマットです。証明書が発行されていない場合、この値は空です。

1801324800000
CertificateNotAfter

integer

最新の証明書の終了時間。UNIX タイムスタンプフォーマットです。証明書が発行されていない場合、この値は空です。

1801324800000
CertificateNotBefore

integer

AutoReissue

string

自動マネージド更新が有効かどうかを示します。有効な値:

  • enable: 有効。

  • disable: 無効。

enable
FullDomainCount

integer

完全に一致するドメイン名の数。

1
WildcardDomainCount

integer

ワイルドカードドメイン名の数。

0
PendingResult

string

最後の証明書操作時に CA から返された結果。

pending
ResourceGroupId

string

リソースグループ ID。

123

例

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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

前へ：インスタンスのサブスクリプション次へ：UpdateInstance