Querying the Version Status of a Secret

Queries the version information of a specified secret version status flag.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
csms:secret:getStage	Read	secretName *	csms:Type csms:VersionStage g:EnterpriseProjectId g:ResourceTag/<tag-key>	csms:secretStage:get	-

GET /v1/{project_id}/secrets/{secret_name}/stages/{stage_name}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
secret_name	Yes	String	Secret name
stage_name	Yes	String	Name of a secret version status.

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

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
stage	Stage object	Secret status

**Table 4** Stage
Parameter	Type	Description
name	String	Status of a secret version. Constraint: The value can contain up to 64 characters.
update_time	Long	Time when a secret version status was updated. The value is a timestamp, that is, the total number of seconds on January 1, 1970 to the current time.
secret_name	String	Secret name.
version_id	String	Version identifier of a secret

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 404

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

Status code: 500

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

Status code: 502

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

Status code: 504

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

None

Status code: 200

Request succeeded.

{
  "stage" : {
    "name" : "name",
    "version_id" : "v20",
    "update_time" : 1581507580000,
    "secret_name" : "secret-name-demo"
  }
}

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.