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 Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	The template ID. Minimum: 1 Maximum: 36

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. The token can be obtained by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Minimum: 1 Maximum: 16384

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
template_id	String	The template ID. Minimum: 0 Maximum: 255
target_password	String	The target server password. Minimum: 0 Maximum: 255

Status code: 403

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	The error code. Minimum: 0 Maximum: 255
error_msg	String	The error message. Minimum: 0 Maximum: 255
encoded_authorization_message	String	The encrypted authorization information. Minimum: 0 Maximum: 65535
error_param	Array of strings	Error parameters. Minimum: 0 Maximum: 65535 Array Length: 1 - 20
details	Array of details objects	The error details. Array Length: 1 - 20

**Table 5** details
Parameter	Type	Description
error_code	String	The SMS error code. Minimum: 0 Maximum: 65535
error_msg	String	The SMS error message. Minimum: 0 Maximum: 65535

Example Requests

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 Responses

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."
  } ]
}