Enable user master key
The table below lists only the unique request parameters for this interface and some common parameters. For more information, see common parameters.
Parameter | Type | Is required | Example value | Description |
|---|---|---|---|---|
Action | String | yes | EnableKey | The operation to perform, possible value: EnableKey. |
Version | String | yes | 2021-02-18 | API version, value: 2021-02-18. |
KeyID | String | No | 39a0e7c6-b7dd-4c83-b400-3449bb95403a | Primary key ID, choose one of the two: |
KeyringName | String | No | keyring-test | Keyring name, length 2 - 31 characters. Allowed characters: [a-zA-Z0-9-_] |
KeyName | String | No | key-test | Primary key name, length 2 - 31 characters. Allowed characters: [a-zA-Z0-9-_] |
This interface has no unique return parameters. For more information, see response structure.
GET /?Action=EnableKey&Version=2021-02-18&KeyringName=demo&KeyName=demo HTTP/1.1 Host: kms.cn-beijing.volcengineapi.com X-Date: 20240708T075217Z Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240708/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
{ "ResponseMetadata": { "RequestId": "2024070815523407603206803272C4E4", "Action": "EnableKey", "Version": "2021-02-18", "Service": "kms", "Region": "cn-beijing" } }
The following table lists error codes related to this interface and business logic. For common error codes, refer to the Common Error Codes document.
const columns = [ { title: 'Status Code', dataIndex: 'HttpCode', width: '12%', className: 'openapi-doc-errorcode-table-httpcode' }, { title: 'Error Code', dataIndex: 'ErrorCode', width: '22%', className: 'openapi-doc-errorcode-table-errorcode' }, { title: 'Error message', dataIndex: 'ErrorMessage', width: '33%', className: 'openapi-doc-errorcode-table-errormessage' }, { title: 'Description' dataIndex: 'Description', width: '33%', className: 'openapi-doc-errorcode-table-description' }, ]; const data = [ { HttpCode: 400, ErrorCode: 'InvalidParameter', ErrorMessage: <RenderMd content={"The request parameter %s is invalid."} />, Description: <RenderMd content={""} />, }, { HttpCode: 400, ErrorCode: 'InvalidKeyStatus', ErrorMessage: <RenderMd content={"Current key status: %s does not allow to perform this action"} />, Description: <RenderMd content={""} />, }, { HttpCode: 403, ErrorCode: 'Reject.Throttling.Action', ErrorMessage: <RenderMd content={"The request of Action: %s upper limit is exceeded."} />, Description: <RenderMd content={""} />, }, { HttpCode: 403, ErrorCode: 'AccessDenied', ErrorMessage: <RenderMd content={"User is not authorized to do this action"} />, Description: <RenderMd content={""} />, }, { HttpCode: 404, ErrorCode: 'Not Found', ErrorMessage: <RenderMd content={"Not found %s [%s]."} />, Description: <RenderMd content={""} />, }, { HttpCode: 500, ErrorCode: 'UndefinedError', ErrorMessage: <RenderMd content={"Undefined Internal Error. Pls Contact With Admin."} />, Description: <RenderMd content={""} />, }, ]; return (<Table columns={columns} data={data} border={ { cell: true, wrapper: true } } scroll={ { x: "auto" } } pagination={false} />);