查询一个KMS实例的详情。
接口说明
RAM 用户或 RAM 角色调用该 OpenAPI 需要被授予的权限策略详情,请参见访问控制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
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 实例的状态。取值:
|
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 |
string |
KMS 实例绑定的可用区。 |
"cn-hangzhou-k", "cn-hangzhou-j" |
VswitchIds |
string |
KMS 实例绑定的 VPC 中的交换机。 |
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 中,除了 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 |
实例的付费类型,取值:
|
POSTPAY |
ProductVersion |
string |
KMS 实例的版本。 |
3 |
示例
正常返回示例
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": {
"BindVpc": [
{
"RegionId": "cn-hangzhou",
"VpcId": "vpc-bp19z7djuhtad5dff****",
"VpcOwnerId": "190325303126****",
"VSwitchId": "vsw-bp1i512amhdje10f1****"
}
]
},
"ChargeType": "POSTPAY",
"ProductVersion": "3"
}
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | IllegalTimestamp | The input parameter Timestamp that is mandatory for processing this request is not supplied. | 输入参数“时间戳”标明该请求已经不在可处理时间范围内。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。