Querying the Version Status of a Secret
Function
Queries the version information of a specified secret version status flag.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/secrets/{secret_name}/stages/{stage_name}
| 
         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.  | 
      
Request 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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         stage  | 
       
         Stage object  | 
       
         Secret status  | 
      
| 
         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
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 401
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 403
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 404
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 500
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 502
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Status code: 504
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error codes  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error description  | 
      
Example Requests
None
Example Responses
Status code: 200
Request succeeded.
{
  "stage" : {
    "name" : "name",
    "version_id" : "v20",
    "update_time" : 1581507580000,
    "secret_name" : "secret-name-demo"
  }
}
  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.  | 
      
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.