All Products
Search

This Product

    Key Management Service:ConnectKmsInstance

    Document Center

    Key Management Service:ConnectKmsInstance

    Last Updated:Jul 29, 2025

    Enables a Key Management Service (KMS) instance.

    Operation description

    Limits

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    KmsInstanceIdstringYes

    The ID of the KMS instance that you want to enable.

    		kst-phzz64f722a1buamw0****
    VpcIdstringYes

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

    		vpc-bp19z7cwmltad5dff****
    ZoneIdsstringYes

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

    		cn-hangzhou-k,cn-hangzhou-j
    VSwitchIdsstringYes

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

    		vsw-bp1i512amda6d10a0****
    KMProviderstringYes

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

    		Aliyun

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response message.

    RequestIdstring

    The request ID.

    		d3eca5c8-a856-4347-8eb6-e1898c3fda2e

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    For a list of error codes, visit the Service error codes.