文档首页/ 主机迁移服务 SMS/ API参考（联盟区域）/ API/ Agent运行/ 获取Agent配置信息
更新时间：2025-12-08 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取Agent配置信息

功能介绍

源端Agent启动后，访问此接口获取配置信息。

调用方法

请参见如何调用API。

URI

GET /v3/config

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度：1

最大长度：16384

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

config

Map<String,String>

mainRegion,obs_domain,disktype,process_and_it及以后增加的信息

regions

Array of Map<String,Object> objects

region数组

数组长度：1 - 100

状态码：400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：1024

状态码：403

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误代码

最小长度：0

最大长度：255

error_msg

String

错误信息

最小长度：0

最大长度：255

encoded_authorization_message

String

加密授权信息

最小长度：0

最大长度：65535

error_param

Array of strings

错误参数

最小长度：0

最大长度：65535

数组长度：1 - 20

details

Array of details objects

详细错误信息

数组长度：1 - 20
表5 details

参数

参数类型

描述

error_code

String

SMS错误代码

最小长度：0

最大长度：65535

error_msg

String

SMS错误信息

最小长度：0

最大长度：65535

请求示例

获取endpoint下的配置信息

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

响应示例

状态码：200

获取配置信息成功

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

状态码：403

鉴权失败

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

状态码

状态码

描述

200

获取配置信息成功

400

获取配置信息失败

403

鉴权失败

错误码

请参见错误码。

父主题： Agent运行