Querying the Secret Version List

Function

This API is used to query the version list of a specified secret.

Constraints

The information returned by this API is the metadata of secret versions, which does not contain secret values.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/secrets/{secret_name}/versions

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
secret_name	Yes	String	Secret name

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
marker	No	String	Pagination parameter. The value is the version number of the last record on the previous page.
limit	No	Integer	Specifies the number of items displayed per page. The default value is 50.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
version_metadatas	Array of VersionMetadata objects	version_metadata object.
page_info	PageInfo object	Pagination information.

**Table 5** VersionMetadata
Parameter	Type	Description
id	String	Secret version ID, which is unique under a secret object.
create_time	Long	Time when a secret version was created. The timestamp indicates the total seconds since January 1, 1970.
expire_time	Long	Expiration time of the secret version. The value is a timestamp, that is, the total number of seconds from January 1, 1970 to the time. When the secret subscribes to the version expiration event type, the validity period is determined based on this parameter. This parameter is left blank by default.
kms_key_id	String	ID of the KMS CMK used to encrypt a secret version value.
secret_name	String	Secret name
version_stages	Array of strings	Secret version status list. Each status tag is unique for a secret version. If a status tag in use is added to a new version, the tag will be automatically removed from the original version. If version_stage is not specified, the temporary tag SYSCURRENT will be added to this version.

**Table 6** PageInfo
Parameter	Type	Description
next_marker	String	Query address of the next page (name of the secret at the end of the current page, name of the secret at the start of the next page).
previous_marker	String	Name of the start secret on the current page and name of the end secret on the previous page.
current_count	Integer	Number of records returned on this page.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 502

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Status code: 504

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error codes
error_msg	String	Error description

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "version_metadatas" : [ {
    "id" : "v1",
    "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
    "create_time" : 1581507580000,
    "secret_name" : "secret-name-demo",
    "version_stages" : [ "SYSCURRENT" ]
  } ],
  "page_info" : {
    "next_marker" : "v10",
    "previous_marker" : "v1",
    "current_count" : 10
  }
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameter.
401	A username and password are required.
403	Authentication failed.
404	The requested resource does not exist or is not found.
500	Internal service error.
502	The request failed to be fulfilled because the server received an invalid response from the upstream server.
504	Gateway timed out.