Help Center> Server Migration Service> API Reference> APIs V3.0> Template Management> Querying the Target Server Password in a Template
Updated on 2024-07-08 GMT+08:00

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 target server password.

Minimum length: 0 characters

Maximum length: 255 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 is returned.

{
  "template_id" : "d7fa81b9-c174-4c0a-a475-51a54c8af8a4",
  "target_password" : "********"
}

Status Codes

Status Code

Description

200

The target server password is returned.

Error Codes

For details, see Error Codes.