list secret versions

debug #

request parameters #

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

response parameters #

This table lists only the return parameters specific to this interface. For more information, see return structure.

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

const data = [ 
  { 
    rowKey: "->SecretVersions", 
    Name: "SecretVersions", 
    DataType: "Array of Object", 
    Example: <RenderMd content={"[\n    {\n        "VersionID": "54487470-102a-4f35-bfb1-b819e78f7579",\n        "VersionStage": "CURRENT",\n        "CreationDate": 1723104729\n    }\n]"} />, 
Description: <RenderMd content={"Secret version information"} />, 
    children: [ 
        { 
          rowKey: "->SecretVersions->VersionID", 
          Name: "VersionID", 
          DataType: "String", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"Unique identifier for the secret version in UUID format"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->SecretVersions->VersionStage", 
          Name: "VersionStage", 
          DataType: "String", 
          Example: <RenderMd content={"CURRENT"} />, 
Description: <RenderMd content={"secret version label"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->SecretVersions->CreationDate", 
          Name: "CreationDate", 
          DataType: "Long", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"secret version creation time"} />, 
          children: [ 
          ] 
        }, 
    ] 
  }, 
  { 
    rowKey: "->PageInfo", 
    Name: "PageInfo", 
    DataType: "Object", 
    Example: <RenderMd content={"{\n    "TotalCount": 1,\n    "PageSize": 20,\n    "CurrentPage": 1,\n    "Count": 1\n}"} />, 
Description: <RenderMd content={"Paging information"} />, 
    children: [ 
        { 
          rowKey: "->PageInfo->TotalCount", 
          Name: "TotalCount", 
          DataType: "Integer", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"Total count of paged query items"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->PageInfo->PageSize", 
          Name: "PageSize", 
          DataType: "Integer", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"page size for pagination query"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->PageInfo->CurrentPage", 
          Name: "CurrentPage", 
          DataType: "Integer", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"pagination retrieves current page number, starting from 1"} />, 
          children: [ 
          ] 
        }, 
        { 
          rowKey: "->PageInfo->Count", 
          Name: "Count", 
          DataType: "Integer", 
          Example: <RenderMd content={""} />, 
Description: <RenderMd content={"get the number of items on the current page for pagination"} />, 
          children: [ 
          ] 
        }, 
    ] 
  }, 
]; 

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

Request example #

GET /?Action=DescribeSecretVersions&Version=2021-02-18&SecretName=secret-9527&CurrentPage=1&PageSize=20 HTTP/1.1 
Host: kms.cn-beijing.volcengineapi.com 
X-Date: 20240811T024400Z 
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240811/cn-beijing/kms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

Response example #

{ 
  "ResponseMetadata": { 
    "RequestId": "2024081110441815424409905636A85B", 
    "Action": "DescribeSecretVersions", 
    "Version": "2021-02-18", 
    "Service": "kms", 
    "Region": "cn-beijing" 
  }, 
  "Result": { 
    "SecretVersions": [ 
      { 
        "VersionID": "54487470-102a-4f35-bfb1-b819e78f7579", 
        "VersionStage": "CURRENT", 
        "CreationDate": 1723104729 
      } 
    ], 
    "PageInfo": { 
      "TotalCount": 1, 
      "PageSize": 20, 
      "CurrentPage": 1, 
      "Count": 1 
    } 
  } 
}

Error code #

The following table lists error codes related to the interface and business logic. For public error codes, refer to the Public Error Codes document.