Update keyring

Debug #

Request parameters #

The following table lists only the request parameters unique to this interface and some common parameters. For more information, see common parameters.

const columns = [ 
  { 
    width: '20%', 
title: 'Parameter' 
    dataIndex: 'Name', 
    className: 'openapi-doc-parameter-table-name' 
  }, 
  { 
    width: 130, 
title: 'Type', 
    dataIndex: 'DataType', 
    className: 'openapi-doc-parameter-table-type' 
  }, 
  { 
    width: 90, 
title: 'Is required', 
    dataIndex: 'IsRequired', 
    className: 'openapi-doc-parameter-table-required' 
  }, 
  { 
    width: '20%', 
title: 'Example value', 
    dataIndex: 'Example', 
    className: 'openapi-doc-parameter-table-example' 
  }, 
  { 
title: 'Description', 
    dataIndex: 'Description', 
    className: 'openapi-doc-parameter-table-description' 
  }, 
]; 

const data = [ 
  { 
    rowKey: '->Action', 
    Name: 'Action', 
    DataType: 'String', 
IsRequired: 'yes', 
    Example: <RenderMd content={"UpdateKeyring"} />, 
Description: <RenderMd content={"The operation to perform, value: UpdateKeyring."} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Version', 
    Name: 'Version', 
    DataType: 'String', 
IsRequired: 'Yes', 
    Example: <RenderMd content={"2021-02-18"} />, 
Description: <RenderMd content={"API version, value: 2021-02-18."} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->KeyringID', 
    Name: 'KeyringID', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"39a0e7c6-b7dd-4c83-b400-3449bb95403a"} />, 
Description: <RenderMd content={"Keyring ID, choose one of the two:\nKeyringName\nKeyringID"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->KeyringName', 
    Name: 'KeyringName', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"keyring-test"} />, 
Description: <RenderMd content={"Keyring name, length 2 - 31 characters. Allowed characters: [a-zA-Z0-9-_]"} />, 
    children: [ 
    ] 
  }, 
  { 
    rowKey: '->Description', 
    Name: 'Description', 
    DataType: 'String', 
IsRequired: 'No', 
    Example: <RenderMd content={"test"} />, 
Description: <RenderMd content={"Key ring description, length 0 - 8192 characters"} />, 
    children: [ 
    ] 
  }, 

]; 

return (<Table 
  rowKey="rowKey" 
  className="openapi-doc-parameter-table" 
  columns={columns} 
  data={data} 
  border={ { cell: true, wrapper: true } } 
  scroll={ { x: "auto" } } 
  pagination={false} 
/>);

Response parameters #

This interface has no unique return parameters. For more information, see response structure.

request example #

GET /?Action=UpdateKeyring&Version=2021-02-18&KeyringName=demo&Description=demo HTTP/1.1 
Host: kms.cn-beijing.volcengineapi.com 
X-Date: 20240707T073453Z 
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240707/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

response example #

{ 
  "ResponseMetadata": { 
    "RequestId": "20240707153520141247146044854A7C", 
    "Action": "UpdateKeyring", 
    "Version": "2021-02-18", 
    "Service": "kms", 
    "Region": "cn-beijing" 
  } 
}

Error codes #

The table below lists error codes related to the interface and business logic. For common error codes, see the Common Error Codes document.