All Products
Search

This Product

    Key Management Service:ConnectKmsInstance

    Document Center

    Key Management Service:ConnectKmsInstance

    Last Updated:Oct 11, 2023

    Enables a Key Management Service (KMS) instance.

    Limits

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

    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 ID of the KMS instance that you want to enable.

    VpcId String Yes vpc-bp19z7cwmltad5dff****

    The virtual private cloud (VPC) ID for the KMS instance.

    ZoneIds String Yes cn-hangzhou-k,cn-hangzhou-j

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

    VSwitchIds String Yes vsw-bp1i512amda6d10a0****

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

    KMProvider String Yes Aliyun

    The provider of the KMS instance. Set the value to 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=cn-hangzhou-k,cn-hangzhou-j
&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.