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
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
Parameter | Type | Description |
---|---|---|
config | Map<String,String> | mainRegion, obs_domain, disktype, process_and_it, and information to be added later |
regions | Array of RegionInfo objects | The Region array. Array length: 1 - 100 characters |
Status code: 400
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: 1,024 characters |
Example Request
This example obtains the Agent configuration information under the current endpoint.
GET https://{endpoint}/v3/config
Example Response
Status code: 200
The configuration information obtained.
{"config" : {"mainRegion" : "ap-southeast-1","disktype" : "SATA"},"regions" : [ {"region_name" : "cn-north-1","project_name" : "cn-north-1"}, {"region_name" : "cn-north-4","project_name" : "cn-north-4"} ]}
Status Codes
Status Code | Description |
---|---|
200 | The configuration information obtained. |
400 | Obtaining the configuration information failed. |
Error Codes
For details, see Error Codes.
- Function
- Calling Method
- URI
- Request
- Response
- Example Request
- Example Response
- Status Codes
- Error Codes