Querying the Secret Version List

Function

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

Constraints

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

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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	The paging parameter, the last value is the version number of a record of the previous page of data.
limit	No	Integer	Number of records on each 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 that is used for obtaining a user token. The value of X-Subject-Token in the response header is the user 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 past the start of the epoch date (January 1, 1970).
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. Every version status is unique under a secret. If you add a status tag in use to a new version, the tag will be automatically removed from the old 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 (secret name at the end of the current page and the start of the next page)
previous_marker	String	secret name at the start of the current page and the end of the last page
current_count	Integer	Number of records returned on the current page.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 403

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 502

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 504

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "version_metadatas" : [ {
    "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
    "create_time" : 1581507580000,
    "secret_name" : "secret-name-demo",
    "version_stages" : [ "pending", "used" ]
  } ],
  "page_info" : {
    "next_marker" : "v10",
    "previous_marker" : "v1",
    "current_count" : 10
  }
}

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request parameters.
401	You must enter a username and password to access the requested page.
403	Authentication failed.
404	The requested resource does not exist or is not found.
500	Internal service error.
502	Failed to complete the request. The server received an invalid response.
504	Gateway timeout.