Querying the Target Server Password in a Template

Function

This API is used to query the target server password configured in a template.

Calling Method

For details, see Calling APIs.

URI

GET /v3/vm/templates/{id}/target-password

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
id	Yes	String	The template ID. Minimum length: 0 characters Maximum length: 255 characters

Request

**Table 2** Request header parameter
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	The user token. The token 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 the user token. Minimum length: 1 character Maximum length: 16,384 characters

Response

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
template_id	String	The template ID. Minimum length: 0 characters Maximum length: 255 characters
target_password	String	The password for logging in to the target server. Minimum length: 0 characters Maximum length: 255 characters

Status code: 403

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum length: 0 characters Maximum length: 255 characters
error_msg	String	The error message. Minimum length: 0 characters Maximum length: 255 characters
encoded_authorization_message	String	Encrypted authorization information. Minimum length: 0 characters Maximum length: 65,535 characters
error_param	Array of strings	Invalid parameter. Minimum length: 0 characters Maximum length: 65,535 characters Array length: 1 to 20
details	Array of details objects	The error message. Array length: 1 to 20

**Table 5** **details** field description
Parameter	Type	Description
error_code	String	The SMS error code. Minimum length: 0 characters Maximum length: 65,535 characters
error_msg	String	The SMS error message. Minimum length: 0 characters Maximum length: 65,535 characters

Example Request

This example queries the target server password configured in the specified template.

GET https://{endpoint}/v3/vm/templates/ef3b9722-07a0-40ae-89b0-889ee96dfc56/target-password

Example Response

Status code: 200

The target server password was obtained.

{
  "template_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx0001",
  "target_password" : "********"
}

Status code: 403

Authentication failed.

{
  "error_code" : "SMS.9004",
  "error_msg" : "The current account does not have the permission to execute policy You do not have permission to perform action XXX on resource XXX.",
  "encoded_authorization_message" : "XXXXXX",
  "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ],
  "details" : [ {
    "error_code" : "SMS.9004",
    "error_msg" : "You do not have permission to perform action XXX on resource XXX."
  } ]
}