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

GetInstanceDetail

更新日時
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:GetInstanceDetail

get

*All Resource

*

 なし なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例
InstanceId

string

必須

インスタンスの ID。

cas_dv-cn-123

レスポンスフィールド

フィールド

型

説明

例

object

InstanceId

string

インスタンスの ID。

cas_dv-cn-123
InstanceType

string

インスタンスタイプ。有効な値:

  • BUY: 正式な証明書。

  • TEST: テスト証明書。

TEST
RequestId

string

リクエスト ID。Alibaba Cloud は各リクエストに一意の識別子を生成します。リクエスト ID を使用して問題をトラブルシューティングできます。

B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9
KeyAlgorithm

string

証明書のアルゴリズム。有効な値:

  • RSA_2048

  • RSA_3072

  • RSA_4096

  • ECC_256

  • SM2。

RSA_2048
Status

string

インスタンスステータス。有効な値:

  • inactive: 使用待ち。

  • pending: 審査中。最新の証明書が審査されています。

  • willExpire: インスタンスの有効期限切れが近づいています。

  • expired: インスタンスが期限切れです。

  • refund: 返金済み。

  • normal: 正常。

  • closed: クローズされ、利用不可。

inactive
Domain

string

証明書にバインドされたドメイン名。

example.com
CertificateId

integer

証明書の ID。

1234567890
CertificateName

string

インスタンス名。証明書が発行されると、この名前がデフォルトの証明書名として使用されます。

123
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" です。

22783111-cn-hangzhou
Spec

string

購入したインスタンスのスペック。

ss.dv.t
CertificateType

string

証明書のタイプ。有効な値: DV、OV、EV。

DV
CertificateStatus

string

証明書のステータス。有効な値:

  • issued: 発行済み。

  • revoked: 失効済み。

  • willExpire: 有効期限切れが近づいています。

  • expired: 有効期限切れ。

issued
CertificateNotAfter

integer

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

1801324800000
CertificateNotBefore

integer

OrderEndTime

integer

インスタンス購入の終了時間。値は UNIX タイムスタンプです。この値を使用してインスタンスの購入持続時間を判断できます。

1801324800000
InstanceStartTime

integer

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

1801324800000
InstanceEndTime

integer

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

1801324800000
FullDomainCount

integer

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

1
WildcardDomainCount

integer

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

0
CompanyId

integer

会社情報の ID。

47305
ContactIdList

array

連絡先 ID のリスト。

integer

連絡先の ID。

123
ResourceGroupId

string

リソースグループの ID。

rg-aek****wia
DomainValidationList

array<object>

検証するドメイン名のリスト。

object

検証するドメイン名。

Domain

string

検証するドメイン名。

example.com
RootDomain

string

ルートドメイン名。

example.com
ValidationType

string

検証タイプ。有効な値: TXT、HTTP、CNAME。

TXT
ValidationValue

string

検証用のホストレコード値。

123
ValidationKey

string

ホストレコード。

@
Cname

string

検証不要の権限付与用の CNAME レコード値。このフィールドは空の場合があります。

123.com
CnameKey

string

CNAME 検証用のプレフィックス。

abc
City

string

証明書購入者の会社または組織が所在する都市。証明書署名リクエストを生成する際にこのフィールドは必須です。デフォルト値: Beijing。

Beijing
Province

string

会社が所在する省またはリージョン。証明書署名リクエストを生成する際にこのフィールドは必須です。デフォルト値: Beijing。

Beijing
CountryCode

string

証明書の組織が所在する国またはリージョンのコード。例えば、CN は中国、US はアメリカ合衆国を示します。証明書署名リクエストを生成する際にこのフィールドは必須です。デフォルト値: CN。

CN
Csr

string

PEM フォーマットの証明書署名リクエスト (CSR)。

-----BEGIN CERTIFICATE REQUEST----- ...... -----END CERTIFICATE REQUEST-----
ValidationMethod

string

証明書アプリケーションの検証メソッド。有効な値:

  • DNS: DNS 検証。TXT または CNAME を使用します。

  • HTTP: ファイルベースの検証。

DNS
AverageWaitingTime

string

このスペックの証明書を発行するための平均待ち時間。単位: 秒。

120
DingGroupList

array<object>

関連付けられたエキスパートサービス DingTalk グループのリスト。

object

関連付けられたエキスパートサービス DingTalk グループ。

DingGroupInstanceId

string

エキスパートサービス DingTalk グループのインスタンス ID。

123
DingGroupName

string

エキスパートサービス DingTalk グループの名前。

123
DingGroupType

string

エキスパートサービス DingTalk グループのタイプ。有効な値:

  • expedite: アプリケーション支援。

  • remote: オフライン Deployment。

remote
DingGroupUrl

string

エキスパートサービス DingTalk グループに参加するためのリンク。

https://123.com
Tags

array<object>

タグのリスト。

object

タグのリスト。

TagKey

string

タグキー。

test
TagValue

string

タグ値。

test
GenerateCsrMethod

string

CSR の生成メソッド。有効な値:

  • online: オンラインでシステム生成。Csr フィールドは無視されます。

  • upload: ユーザーアップロード。Csr フィールドは必須です。

online
AutoReissue

string

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

  • enable: 有効。

  • disable: 無効。

enable
PendingResult

string

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

pending
UpgradeStatus

string

インスタンスのスペックアップステータス。有効な値:

  • none: インスタンスはスペックアップされていません。

  • payed: インスタンスのスペックアップが支払い済みです。

  • issued: インスタンスのスペックアップ後に最新の証明書が発行されました。

none
CertificateRevokeTime

integer

最新の証明書の失効時間。値は UNIX タイムスタンプです。

1801324800000
Brand

string

CA ブランド。有効な値: WoSign、CFCA、DigiCert、GeoTrust、GlobalSign、vTrus、Alibaba。

DigiCert
OrderStartTime

integer

インスタンス購入の開始時刻。値は UNIX タイムスタンプです。この値を使用して返金期限を判断できます。

1801324800000

例

成功レスポンス

JSONJSON

{
  "InstanceId": "cas_dv-cn-123",
  "InstanceType": "TEST",
  "RequestId": "B2CE1D02-6D5E-56E5-A9BD-EE288255C7F9",
  "KeyAlgorithm": "RSA_2048",
  "Status": "inactive",
  "Domain": "example.com",
  "CertificateId": 1234567890,
  "CertificateName": "123",
  "CertIdentifier": "22783111-cn-hangzhou",
  "Spec": "ss.dv.t",
  "CertificateType": "DV",
  "CertificateStatus": "issued",
  "CertificateNotAfter": 1801324800000,
  "CertificateNotBefore": 0,
  "OrderEndTime": 1801324800000,
  "InstanceStartTime": 1801324800000,
  "InstanceEndTime": 1801324800000,
  "FullDomainCount": 1,
  "WildcardDomainCount": 0,
  "CompanyId": 47305,
  "ContactIdList": [
    123
  ],
  "ResourceGroupId": "rg-aek****wia",
  "DomainValidationList": [
    {
      "Domain": "example.com",
      "RootDomain": "example.com",
      "ValidationType": "TXT",
      "ValidationValue": "123",
      "ValidationKey": "@",
      "Cname": "123.com",
      "CnameKey": "abc"
    }
  ],
  "City": "Beijing",
  "Province": "Beijing",
  "CountryCode": "CN",
  "Csr": "-----BEGIN CERTIFICATE REQUEST-----   ...... -----END CERTIFICATE REQUEST-----",
  "ValidationMethod": "DNS",
  "AverageWaitingTime": "120",
  "DingGroupList": [
    {
      "DingGroupInstanceId": "123",
      "DingGroupName": "123",
      "DingGroupType": "remote",
      "DingGroupUrl": "https://123.com"
    }
  ],
  "Tags": [
    {
      "TagKey": "test",
      "TagValue": "test"
    }
  ],
  "GenerateCsrMethod": "online",
  "AutoReissue": "enable",
  "PendingResult": "pending",
  "UpgradeStatus": "none",
  "CertificateRevokeTime": 1801324800000,
  "Brand": "DigiCert",
  "OrderStartTime": 1801324800000
}

エラーコード

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

変更履歴

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

前へ：UpdateInstance次へ：DeleteInstance