All Products
Search
Document Center

Key Management Service:ConnectKmsInstance

Last Updated:Aug 28, 2026

Enables a KMS instance so that it can be used for key management and cryptographic operations.

Operation description

Limits

You can enable only instances of the software key management type. You cannot enable instances of the hardware key management type.

For more information about the access policy required by a RAM user or RAM role to call this API, 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 that you want to enable.

kst-phzz64f722a1buamw0****

VpcId

string

Yes

The ID of the virtual private cloud (VPC) that is associated with the KMS instance.

vpc-bp19z7cwmltad5dff****

ZoneIds

string

Yes

The two zones for the KMS instance. Dual-zone deployment improves service availability and disaster recovery capabilities.

cn-hangzhou-k,cn-hangzhou-j

VSwitchIds

string

Yes

The vSwitch in the two zones. The vSwitch must have at least one available IP address.

vsw-bp1i512amda6d10a0****

KMProvider

string

Yes

The provider of the KMS instance. Set the value to Aliyun.

Aliyun

Response elements

Element

Type

Description

Example

object

The response message.

RequestId

string

The request ID.

d3eca5c8-a856-4347-8eb6-e1898c3fda2e

Examples

Success response

JSON format

{
  "RequestId": "d3eca5c8-a856-4347-8eb6-e1898c3fda2e"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.