全部產品
Search
文件中心

:GetKmsInstance

更新時間:Jan 23, 2025

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

調試

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

請求參數

名稱

類型

是否必選

樣本值

描述

Action String GetKmsInstance

要執行的操作。取值:GetKmsInstance

KmsInstanceId String kst-bjj62f5ba3dnpb6v8****

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

返回資料

名稱

類型

樣本值

描述

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

本次調用請求的ID,是由阿里雲為該請求產生的唯一識別碼,可用於排查和定位問題。

KmsInstance Object

KMS執行個體詳情。

InstanceId String kst-bjj62f5ba3dnpb6v8****

KMS執行個體的ID。

InstanceName String kst-bjj62f5ba3dnpb6v8****

KMS執行個體的名稱。

Status String Connected

KMS執行個體的狀態。取值:

  • Uninitialized:未啟用
  • Connecting:串連中
  • Connected:已啟用
  • Disconnected:已斷開
  • Error:狀態異常
CreateTime String 2023-09-05T12:44:20Z

KMS執行個體建立的時間。

Spec Long 1000

KMS執行個體的計算效能。

KeyNum Long 1000

KMS執行個體支援建立的密鑰數量。

SecretNum String 10

KMS執行個體支援建立的憑據數量。

VpcNum Long 5

KMS執行個體的訪問管理總量。

VpcId String vpc-bp19z7cwmltad5dff****

KMS執行個體綁定的VPC。

ZoneIds String "cn-hangzhou-k", "cn-hangzhou-j"

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

VswitchIds String vsw-bp1i512amda6d10a0****

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

EndDate String 2023-10-05T16:00:00Z

KMS執行個體的到期時間。

StartDate String 2023-09-05T12:44:19Z

KMS執行個體啟用的時間。

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

KMS執行個體的CA認證的內容。

BindVpcs Array of BindVpc

配置的VPC列表。

說明 如果您的自建應用部署在同地區的多個VPC中,除了KMS執行個體所屬的VPC(即啟用KMS執行個體時設定的VPC)外,您還可以將其他VPC配置到KMS執行個體中,這些VPC可以屬於同一個阿里雲帳號,也可以屬於不同阿里雲帳號。配置完成後,在這些VPC中的自建應用即可以訪問指定的KMS執行個體。
BindVpc
RegionId String cn-hangzhou

VPC所屬的地區。

VpcId String vpc-bp19z7djuhtad5dff****

VPC的ID。

VpcOwnerId String 190325303126****

VPC所屬的阿里雲帳號。

VSwitchId String vsw-bp1i512amhdje10f1****

VPC下的交換器。

樣本

請求樣本

http(s)://[Endpoint]/?Action=GetKmsInstance
&KmsInstanceId=kst-bjj62f5ba3dnpb6v8****
&公用請求參數

正常返回樣本

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetKmsInstanceResponse>
    <RequestId>46b4a94a-57d2-44b4-9810-1e87d31abb33</RequestId>
    <KmsInstance>
        <InstanceId>kst-bjj62f5ba3dnpb6v8****</InstanceId>
        <InstanceName>kst-bjj62f5ba3dnpb6v8****</InstanceName>
        <Status>Connected</Status>
        <CreateTime>2023-09-05T12:44:20Z</CreateTime>
        <Spec>1000</Spec>
        <KeyNum>1000</KeyNum>
        <SecretNum>10</SecretNum>
        <VpcNum>5</VpcNum>
        <VpcId>vpc-bp19z7cwmltad5dff****</VpcId>
        <ZoneIds>"cn-hangzhou-k",       "cn-hangzhou-j"</ZoneIds>
        <VswitchIds>vsw-bp1i512amda6d10a0****</VswitchIds>
        <EndDate>2023-10-05T16:00:00Z</EndDate>
        <StartDate>2023-09-05T12:44:19Z</StartDate>
        <CaCertificateChainPem>-----BEGIN CERTIFICATE-----\r\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----</CaCertificateChainPem>
        <BindVpcs>
            <RegionId>cn-hangzhou</RegionId>
            <VpcId>vpc-bp19z7djuhtad5dff****</VpcId>
            <VpcOwnerId>190325303126****</VpcOwnerId>
            <VSwitchId>vsw-bp1i512amhdje10f1****</VSwitchId>
        </BindVpcs>
    </KmsInstance>
</GetKmsInstanceResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "\"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" : [ {
      "RegionId" : "cn-hangzhou",
      "VpcId" : "vpc-bp19z7djuhtad5dff****",
      "VpcOwnerId" : "190325303126****",
      "VSwitchId" : "vsw-bp1i512amhdje10f1****"
    } ]
  }
}

錯誤碼

HttpCode

錯誤碼

錯誤資訊

描述

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

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