All Products
Search
Document Center

Key Management Service:UpdateKmsInstanceBindVpc

Last Updated:Oct 16, 2025

Updates the virtual private clouds (VPCs) that are configured for a Key Management Service (KMS) instance.

Operation description

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

  • If your self-managed application is deployed in multiple VPCs in the same region, you can bind the KMS instance to additional VPCs. These VPCs are in addition to the one that you specified when you enabled the instance.

    These VPCs can belong to the same Alibaba Cloud account or different Alibaba Cloud accounts. After the configuration is complete, self-managed applications in these VPCs can access the specified KMS instance.

    Note

    If the VPCs belong to different Alibaba Cloud accounts, you must first configure resource sharing to share the vSwitch resources from those accounts with the Alibaba Cloud account that owns the KMS instance. For more information, see Access a KMS instance from multiple VPCs in the same region.

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.

kst-phzz64f722a1buamw0****

BindVpcs

string

Yes

The VPC configuration. Each VPC configuration contains the following parameters:

  • VpcId: The ID of the VPC.

  • VSwitchId: The vSwitch in the VPC.

  • RegionID: The region where the VPC resides.

  • VpcOwnerId: The Alibaba Cloud account that owns the VPC.

The value is a JSON string in the following format: [{"VpcId":"${VpcId}","VSwitchId":"${VSwitchId}","RegionId":"${RegionId}","VpcOwnerId":${VpcOwnerId}},...].

[{"VpcId":"vpc-bp1go9qvmj78j4f4c****","VSwitchId":"vsw-bp16c5pvvcf0fp5b9****","RegionId":"cn-hangzhou","VpcOwnerId":120708975881****},{"VpcId":"vpc-bp14c07ucxg6h1xjm****","VSwitchId":"vsw-bp1wujtnspi1l3gvu****","RegionId":"cn-hangzhou","VpcOwnerId":119285303511****}]

Response elements

Element

Type

Description

Example

object

The response schema.

RequestId

string

The ID of the request. This ID is generated by Alibaba Cloud and is unique to the request. You can use this ID to troubleshoot issues.

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.