全部產品
Search
文件中心

:GetKmsInstance - 擷取執行個體

更新時間:Apr 10, 2026

查詢一個KMS執行個體的詳情。

介面說明

RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情,請參見存取控制

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

KmsInstanceId

string

要查詢的 KMS 執行個體的 ID。

kst-bjj62f5ba3dnpb6v8****

返回參數

名稱

類型

描述

樣本值

object

KMS 執行個體詳情。

RequestId

string

本次調用請求的 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 執行個體的訪問管理總量。

5

VpcId

string

KMS 執行個體綁定的 VPC。

vpc-bp19z7cwmltad5dff****

ZoneIds

array

KMS 執行個體綁定的可用性區域。

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

string

VswitchIds

array

KMS 執行個體綁定的 VPC 中的交換器。

vsw-bp1i512amda6d10a0****

string

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 中,除了 KMS 執行個體所屬的 VPC(即啟用 KMS 執行個體時設定的 VPC)外,您還可以將其他 VPC 配置到 KMS 執行個體中,這些 VPC 可以屬於同一個阿里雲帳號,也可以屬於不同阿里雲帳號。配置完成後,在這些 VPC 中的自建應用即可以訪問指定的 KMS 執行個體。

object

配置的 VPC 列表。

說明

如果您的自建應用部署在同地區的多個 VPC 中,除了 KMS 執行個體綁定的 VPC,您還可以將其他 VPC 配置到 KMS 執行個體中,這些 VPC 可以屬於同一個阿里雲帳號,也可以屬於不同阿里雲帳號。配置完成後,在這些 VPC 中的自建應用即可以訪問指定的 KMS 執行個體。

RegionId

string

VPC 所屬的地區。

cn-hangzhou

VpcId

string

VPC 的 ID。

vpc-bp19z7djuhtad5dff****

VpcOwnerId

string

VPC 所屬的阿里雲帳號。

190325303126****

VSwitchId

string

VPC 下的交換器。

vsw-bp1i512amhdje10f1****

ChargeType

string

執行個體的付費類型,取值:

  • PREPAY:預付費,訂用帳戶。

  • POSTPAY:後付費,隨用隨付。

POSTPAY

ProductVersion

string

KMS 執行個體的版本。

3

SaleStatus

string

售賣狀態。

Normal

Log

integer

KMS 執行個體是否開啟日誌,取值: 0:不開啟 1:開啟

1

LogStorage

integer

表示日誌的容量。單位為 GB。

100

ProductType

string

產品類型。 預付費: kms_ddi_public_cn:中國站 kms_ddi_public_intl:國際站 後付費: kms_ppi_public_cn:中國站 kms_ppi_public_intl:國際站

kms_ddi_public_cn

樣本

正常返回樣本

JSON格式

{
  "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": [
      ""
    ],
    "VswitchIds": [
      ""
    ],
    "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": "Normal",
    "Log": 1,
    "LogStorage": 100,
    "ProductType": "kms_ddi_public_cn"
  }
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

400 IllegalTimestamp The input parameter Timestamp that is mandatory for processing this request is not supplied. 輸入參數“時間戳記”標明該請求已經不在可處理時間範圍內。

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

變更歷史

更多資訊,參考變更詳情