GetKmsInstance-阿里云帮助中心

Retrieves the details of a KMS instance.

Operation description

Refer to Resource Access Management for the access policy required to call this OpenAPI as a RAM user or RAM role.

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 request ID. Alibaba Cloud generates a unique identifier for each request. You can use this ID to locate and 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 connecting. `Connected`: The instance is enabled. `Disconnected`: The instance is disconnected. `Error`: The instance is in an error state.	Connected
CreateTime	string	The creation time of the KMS instance.	2023-09-05T12:44:20Z
Spec	integer	The computing performance of the KMS instance.	1000
KeyNum	integer	The maximum number of keys that can be created in the KMS instance.	1000
SecretNum	string	The maximum number of credentials that can be created in the KMS instance.	10
VpcNum	integer	The maximum number of VPCs that can be associated with the KMS instance for access control.	5
VpcId	string	The VPC to which the KMS instance is attached.	vpc-bp19z7cwmltad5dff****
ZoneIds	array	The zones to which the KMS instance is attached.	"cn-hangzhou-k", "cn-hangzhou-j"
	string
VswitchIds	array	The vSwitches in the VPC to which the KMS instance is attached.	vsw-bp1i512amda6d10a0****
	string
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 CA certificate chain for the KMS instance in PEM format.	-----BEGIN CERTIFICATE-----\r\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----
BindVpcs	object
BindVpc	array<object>	A list of associated VPCs. Note You can associate the KMS instance with additional VPCs in the same region, allowing self-managed applications in those VPCs to access the instance. These VPCs can belong to the same or different Alibaba Cloud accounts.
	object	Details of an associated VPC. Note You can associate the KMS instance with additional VPCs in the same region, allowing self-managed applications in those VPCs to access the instance. These VPCs can belong to the same or different Alibaba Cloud accounts.
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	The sales status of the instance.	Normal
Log	integer	Indicates whether logging is enabled for the KMS instance. Valid values: `1` (enabled) and `0` (disabled).	1
LogStorage	integer	The log storage capacity. Unit: GB.	100
ProductType	string	The product type. Subscription: `kms_ddi_public_cn`: China site `kms_ddi_public_intl`: international site Pay-as-you-go: `kms_ppi_public_cn`: China site `kms_ppi_public_intl`: international site	kms_ddi_public_cn

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": [
      ""
    ],
    "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"
  }
}

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.