Querying the Secret Version and Value

Function

This API is used to query information about a specified secret version and plaintext secret values in the version. Only secrets in the ENABLED state can be queried.

You can use /v1/{project_id}/secrets/{secret_name}/versions/latest (that is, set {version_id} in the URL of the current interface to latest) to access the secret value of the latest version.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
secret_name	Yes	String	Secret name
version_id	Yes	String	Version identifier of a secret.

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
version	Version object	Secret version

**Table 4** Version
Parameter	Type	Description
version_metadata	VersionMetadata object	Status of a secret version.
secret_binary	String	Plaintext of a binary secret encoded using Base64. CSMS encrypts the plaintext and stores it in the initial version of the secret. Type: Base64-encoded binary data object
secret_string	String	Plaintext of a text secret. CSMS encrypts the plaintext and stores it in the initial version of the secret.

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

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Status code: 502

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

Status code: 504

**Table 12** 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" : {
    "version_metadata" : {
      "id" : "v6",
      "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b",
      "create_time" : 1581507580000,
      "secret_name" : "secret-name-demo",
      "version_stages" : [ "SYSCURRENT" ]
    },
    "secret_string" : "\\\"demo_key\\\":\\\"demo_value\\\""
  }
}

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.