Help Center/Server Migration Service/API Reference/API/Agent Running/Obtaining the Agent configuration information
Updated on 2026-01-27 GMT+08:00
View PDF

Obtaining the Agent configuration information

Function

After the Agent installed on a source server is started, it calls this API to obtain configuration information.

Calling Method

For details, see Calling APIs.

URI

GET /v3/config

Request Parameters

Table 1 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 2 Response body parameters

Parameter

Type

Description

config

Map<String,String>

mainRegion, obs_domain, disktype, process_and_it, and information added.

regions

Array of Map<String,Object> objects

The region array.

Array Length: 1 - 100

Status code: 400

Table 3 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: 1024

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 obtains the Agent configuration information for the current endpoint.

GET https://{endpoint}/v3/config

Example Responses

Status code: 200

The configuration information was obtained.

{
  "config" : {
    "mainRegion" : "region_name",
    "disktype" : "SATA"
  },
  "regions" : [ {
    "region_name" : "region_name",
    "project_name" : "project_name"
  }, {
    "region_name" : "region_name",
    "project_name" : "project_name"
  } ]
}

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

Status Codes

Status Code

Description

200

The configuration information was obtained.

400

Obtaining the configuration information failed.

403

Authentication failed.

Error Codes

See Error Codes.

Parent topic:Agent Running