All Products
Search

This Product

    :ConnectKmsInstance

    Document Center

    :ConnectKmsInstance

    Last Updated:May 07, 2025

    Enables a purchased software key management instance by associating it with a virtual private cloud (VPC) and vSwitch. This network configuration provides secure access for managing cryptographic resources within the instance, including key and secrets management, encryption, and decryption.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

    Request parameters

    Parameter

    Type

    Required

    Example

    Description

    Action

    String

    Yes

    ConnectKmsInstance

    The operation that you want to perform. Set the value to ConnectKmsInstance.

    KmsInstanceId

    String

    Yes

    kst-phzz64f722a1buamw0****

    The instance ID that you want to enable.

    VpcId

    String

    Yes

    vpc-bp19z7cwmltad5dff****

    The VPC ID associated with the KMS instance.

    This ID cannot be modified after enabling the instance.

    ZoneIds

    String

    Yes

    ap-southeast-1a,ap-southeast-1b

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

    VSwitchIds

    String

    Yes

    vsw-bp1i512amda6d10a0****

    The vSwitch ID for both zones. Specify a single ID with at least one available IP address.

    KMProvider

    String

    Yes

    Aliyun

    The provider of the KMS instance. Valid value: Aliyun.

    Response parameters

    Parameter

    Type

    Example

    Description

    RequestId

    String

    d3eca5c8-a856-4347-8eb6-e1898c3fda2e

    The ID of the request, which is used to locate and troubleshoot issues.

    Examples

    Sample requests

    http(s)://[Endpoint]/?Action=ConnectKmsInstance
&KmsInstanceId=kst-phzz64f722a1buamw0****
&VpcId=vpc-bp19z7cwmltad5dff****
&ZoneIds=ap-southeast-1a,ap-southeast-1b
&VSwitchIds=vsw-bp1i512amda6d10a0****
&KMProvider=Aliyun
&Common request parameters

    Sample success responses

    XML format

    HTTP/1.1 200 OK
Content-Type:application/xml

<ConnectKmsInstanceResponse>
    <RequestId>d3eca5c8-a856-4347-8eb6-e1898c3fda2e</RequestId>
</ConnectKmsInstanceResponse>

    JSON format

    HTTP/1.1 200 OK
Content-Type:application/json

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

    Error codes

    For a list of error codes, see Service error codes.