すべてのプロダクト
Search
ドキュメントセンター

:GetKmsInstance

最終更新日:Nov 28, 2025

KMS インスタンスの詳細を照会します。

操作説明

RAM ユーザーまたは RAM ロールがこの操作を呼び出すために必要なアクセスポリシーについては、「Resource Access Management」をご参照ください。

今すぐお試しください

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

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

必須 / 任意

説明

KmsInstanceId

string

必須

照会する KMS インスタンスの ID。

kst-bjj62f5ba3dnpb6v8****

レスポンスフィールド

フィールド

説明

object

KMS インスタンスの詳細。

RequestId

string

リクエスト ID。Alibaba Cloud はリクエストごとに一意の ID を生成します。この ID は問題のトラブルシューティングに使用されます。

46b4a94a-57d2-44b4-9810-1e87d31abb33

KmsInstance

object

KMS インスタンスの詳細。

3

InstanceId

string

KMS インスタンスの ID。

kst-bjj62f5ba3dnpb6v8****

InstanceName

string

KMS インスタンスの名前。

kst-bjj62f5ba3dnpb6v8****

Status

string

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

  • Uninitialized:インスタンスが有効化されていません。

  • Connecting:インスタンスは接続中です。

  • Connected:インスタンスは有効化されています。

  • Disconnected:インスタンスは切断されています。

  • Error:インスタンスは異常な状態です。

Connected

CreateTime

string

KMS インスタンスが作成された時間。

2023-09-05T12:44:20Z

Spec

integer

KMS インスタンスのコンピューティングパフォーマンス。

1000

KeyNum

integer

KMS インスタンスで作成できるキーの数。

1000

SecretNum

string

KMS インスタンスで作成できる認証情報の数。

10

VpcNum

integer

アクセス管理のために KMS インスタンスにアタッチできる VPC の最大数。

5

VpcId

string

KMS インスタンスがアタッチされている VPC。

vpc-bp19z7cwmltad5dff****

ZoneIds

string

KMS インスタンスがアタッチされているゾーン。

"cn-hangzhou-k", "cn-hangzhou-j"

VswitchIds

string

KMS インスタンスがアタッチされている VPC 内の vSwitch。

vsw-bp1i512amda6d10a0****

EndDate

string

KMS インスタンスの有効期限。

2023-10-05T16:00:00Z

StartDate

string

KMS インスタンスが有効化された時間。

2023-09-05T12:44:19Z

CaCertificateChainPem

string

KMS インスタンスの CA 証明書の内容。

-----BEGIN CERTIFICATE-----\r\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----

BindVpcs

object

BindVpc

array<object>

設定済みの VPC のリスト。

説明

自己管理型アプリケーションが同一リージョン内の複数の VPC にデプロイされている場合、インスタンスを有効化したときに指定した VPC に加えて、他の VPC を KMS インスタンスに関連付けることができます。これらの VPC は、同一または異なる Alibaba Cloud アカウントに属することができます。設定が完了すると、これらの VPC 内のアプリケーションは KMS インスタンスにアクセスできます。

object

設定済みの VPC のリスト。

説明

自己管理型アプリケーションが同一リージョン内の複数の VPC にデプロイされている場合、インスタンスを有効化したときに指定した VPC に加えて、他の VPC を KMS インスタンスに関連付けることができます。これらの VPC は、同一または異なる Alibaba Cloud アカウントに属することができます。設定が完了すると、これらの VPC 内のアプリケーションは KMS インスタンスにアクセスできます。

RegionId

string

VPC が配置されているリージョン。

cn-hangzhou

VpcId

string

VPC の ID。

vpc-bp19z7djuhtad5dff****

VpcOwnerId

string

VPC が属する Alibaba Cloud アカウント。

190325303126****

VSwitchId

string

VPC 内の vSwitch。

vsw-bp1i512amhdje10f1****

ChargeType

string

インスタンスの課金方法。有効な値:

  • PREPAY:サブスクリプション。

  • POSTPAY:従量課金。

POSTPAY

ProductVersion

string

KMS インスタンスのバージョン。

3

SaleStatus

string

Log

integer

LogStorage

integer

ProductType

string

成功レスポンス

JSONJSON

{
  "RequestId": "46b4a94a-57d2-44b4-9810-1e87d31abb33",
  "KmsInstance": {
    "InstanceId": "kst-bjj62f5ba3dnpb6v8****",
    "InstanceName": "kst-bjj62f5ba3dnpb6v8****",
    "Status": "Connected",
    "CreateTime": "2023-09-05T12:44:20Z",
    "Spec": 1000,
    "KeyNum": 1000,
    "SecretNum": "10",
    "VpcNum": 5,
    "VpcId": "vpc-bp19z7cwmltad5dff****",
    "ZoneIds": "\"cn-hangzhou-k\",       \"cn-hangzhou-j\"",
    "VswitchIds": "vsw-bp1i512amda6d10a0****",
    "EndDate": "2023-10-05T16:00:00Z",
    "StartDate": "2023-09-05T12:44:19Z",
    "CaCertificateChainPem": "-----BEGIN CERTIFICATE-----\\r\\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----",
    "BindVpcs": {
      "BindVpc": [
        {
          "RegionId": "cn-hangzhou",
          "VpcId": "vpc-bp19z7djuhtad5dff****",
          "VpcOwnerId": "190325303126****",
          "VSwitchId": "vsw-bp1i512amhdje10f1****"
        }
      ]
    },
    "ChargeType": "POSTPAY",
    "ProductVersion": "3",
    "SaleStatus": "",
    "Log": 0,
    "LogStorage": 0,
    "ProductType": ""
  }
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 IllegalTimestamp The input parameter Timestamp that is mandatory for processing this request is not supplied. リクエストを処理するための必須パラメータ「Timestamp」は提供されていません。

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

変更履歴

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