GetKmsInstance - Key Management Service - Alibaba Cloud Documentation Center

Queries the details of a KMS instance.

Operation description

For information about the access policy required for a RAM user or RAM role to call this operation, see Resource Access Management.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
KmsInstanceId	string	Yes	The ID of the KMS instance to query.	kst-bjj62f5ba3dnpb6v8****

Response elements

Element	Type	Description	Example
	object	The details of the KMS instance.
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. This ID is used to troubleshoot issues.	46b4a94a-57d2-44b4-9810-1e87d31abb33
KmsInstance	object	The details of the KMS instance.	3
InstanceId	string	The ID of the KMS instance.	kst-bjj62f5ba3dnpb6v8****
InstanceName	string	The name of the KMS instance.	kst-bjj62f5ba3dnpb6v8****
Status	string	The status of the KMS instance. Valid values: Uninitialized: The instance is not enabled. Connecting: The instance is being connected. Connected: The instance is enabled. Disconnected: The instance is disconnected. Error: The instance is in an abnormal state.	Connected
CreateTime	string	The time when the KMS instance was created.	2023-09-05T12:44:20Z
Spec	integer	The computing performance of the KMS instance.	1000
KeyNum	integer	The number of keys that can be created in the KMS instance.	1000
SecretNum	string	The number of credentials that can be created in the KMS instance.	10
VpcNum	integer	The maximum number of VPCs that can be attached to the KMS instance for access management.	5
VpcId	string	The VPC to which the KMS instance is attached.	vpc-bp19z7cwmltad5dff****
ZoneIds	string	The zones to which the KMS instance is attached.	"cn-hangzhou-k", "cn-hangzhou-j"
VswitchIds	string	The vSwitches in the VPC to which the KMS instance is attached.	vsw-bp1i512amda6d10a0****
EndDate	string	The expiration time of the KMS instance.	2023-10-05T16:00:00Z
StartDate	string	The time when the KMS instance was enabled.	2023-09-05T12:44:19Z
CaCertificateChainPem	string	The content of the CA certificate for the KMS instance.	-----BEGIN CERTIFICATE-----\r\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----
BindVpcs	object
BindVpc	array<object>	A list of configured VPCs. Note If your self-managed applications are deployed in multiple VPCs in the same region, you can associate other VPCs with the KMS instance in addition to the VPC that was specified when you enabled the instance. These VPCs can belong to the same or different Alibaba Cloud accounts. After the configuration is complete, applications in these VPCs can access the KMS instance.
	object	A list of configured VPCs. Note If your self-managed applications are deployed in multiple VPCs in the same region, you can associate other VPCs with the KMS instance in addition to the VPC that was specified when you enabled the instance. These VPCs can belong to the same or different Alibaba Cloud accounts. After the configuration is complete, applications in these VPCs can access the KMS instance.
RegionId	string	The region where the VPC is located.	cn-hangzhou
VpcId	string	The ID of the VPC.	vpc-bp19z7djuhtad5dff****
VpcOwnerId	string	The Alibaba Cloud account to which the VPC belongs.	190325303126****
VSwitchId	string	The vSwitch in the VPC.	vsw-bp1i512amhdje10f1****
ChargeType	string	The billing method of the instance. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go.	POSTPAY
ProductVersion	string	The version of the KMS instance.	3
SaleStatus	string
Log	integer
LogStorage	integer
ProductType	string

Examples

Success response

JSON format

{
  "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": ""
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalTimestamp	The input parameter Timestamp that is mandatory for processing this request is not supplied.	The input parameter timestamp indicates that the request is outside the processing time range.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.