查询一个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实例的状态。取值：
|
| 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. | 输入参数“时间戳”标明该请求已经不在可处理时间范围内。 |
访问错误中心查看更多错误码。