You need to enable JavaScript to run this app.
文档中心
存储迁移服务

存储迁移服务

请输入
  • 文档首页
    • 存储迁移服务API 参考DMS 2.0 API代理组GetAgentGroupStatus - 获取代理组状态
复制全文
下载 pdf
我的收藏
代理组
GetAgentGroupStatus - 获取代理组状态
复制全文
下载 pdf
我的收藏
GetAgentGroupStatus - 获取代理组状态
调用 GetAgentGroupStatus 接口获取代理组状态。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值：GetAgentGroupStatus​
要执行的操作，取值：GetAgentGroupStatus。​
​
Version string 必选 示例值：2025-01-01​
API的版本，取值：2025-01-01。​
​
Id string 必选 示例值：1*​
代理组 ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Id string 示例值：1*​
代理组 ID。​
​
Status boolean 示例值：true​
代理组是否存在可用 Agent，取值说明如下：​
  • true：代理组存在活跃的 Agent​
  • false：代理组不存在活跃的 Agent​
​
​
​
请求示例​
​
GET /?Action=GetAgentGroupStatus&Version=2025-01-01&Id=1* HTTP/1.1​
Host: dms.cn-beijing.volcengineapi.com​
X-Date: 20251009T091352Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251009/cn-beijing/dms/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202510091713562350492201064BE478",​
"Action": "GetAgentGroupStatus",​
"Version": "2025-01-01",​
"Service": "dms",​
"Region": "cn-beijing"​
},​
"Result": {​
"Id": "1*",​
"Status": true​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
2002-00000012​
InvalidRequestBody​
参数错误。​
404​
2002-00000014​
EntityNotFoundErr​
对应实体不存在。​
500​
2001-00000001​
ServiceInternalErr​
服务端异常，请稍后重试。​
​
​
最近更新时间：2026.01.27 18:52:33
这个页面对您有帮助吗？
有用
有用
无用
无用