Querying the Secret Version List

Function

Query the version list of a specific secret.

Constraints

The information returned via this API is the metadata of the secret version and does not contain the secret value.

URI

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

**Table 1** URI 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	Version number of the last item in the previous page.
limit	No	Integer	Number of items displayed per page. The default value is 50.

Request Parameter

**Table 3** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

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

**Table 5** VersionMetadata
Parameter	Type	Description
id	String	ID of a secret version. A secret cannot have duplicate version IDs.
create_time	Long	Secret creation time. 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 secret values.
secret_name	String	Secret name
version_stages	Array of strings	Status of a secret version. A status tag can be used for only one version of each secret. For example, if you add the status tag used by version A to version B, the tag will be moved from version A to version B. If the version_stage parameter is not specified, the status of the latest version will be SYSCURRENT by default.

**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 description

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Status code: 502

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

Status code: 504

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

Example Request

None

Example Response

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 Code

Status Code	Description
200	Request succeeded.
400	Invalid request parameters.
401	Username and password are required for the requested page.
403	Authentication failed.
404	The requested resource does not exist.
500	Internal service error.
502	Failed to complete the request. The server receives an invalid response from the upstream server.
504	Gateway timed out.