QueryEcsHostSyncTask - 获取 ECS 主机名同步任务信息--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

QueryEcsHostSyncTask - 获取 ECS 主机名同步任务信息

最近更新时间：2025.05.22 20:14:00首次发布时间：2023.07.19 19:18:22

获取 ECS 主机名同步任务信息。

使用说明

请求频率：每秒最多调用 20 次。

请求说明

请求方式：GET
请求地址：https://private-zone.volcengineapi.com/?Action=QueryEcsHostSyncTask?Version=2022-06-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

除了以下参数，您还需要对请求进行鉴权。

参数	类型	是否必填	示例值	描述
Action	String	是	QueryEcsHostSyncTask	要执行的操作，取值：QueryEcsHostSyncTask。
Version	String	是	2022-06-01	API的版本，取值：2022-06-01。
ZID	Long	是	1234	标识域名的唯一 ID。您可以通过以下 API 获取： CreatePrivateZone API ListPrivateZones API

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ZID	Long	1234	标识域名的唯一 ID。
Status	String	ON	是否开启同步。 ON：开启同步。 OFF：关闭同步。
EcsRegions	Array of Object	无	需要同步的地域和火山引擎账号。

请求示例

GET https://private-zone.volcengineapi.com/?Action=QueryEcsHostSyncTask&Version=2022-06-01&ZID=1013

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230614140553EC822FFD341E9C19EF59",
    "Action": "QueryEcsHostSyncTask",
    "Version": "2022-06-01",
    "Service": "private_zone",
    "Region": "cn"
  },
  "Result": {
    "ZID": 27264,
    "Status": "OFF",
    "EcsRegions": [
      {
        "Region": "cn-beijing",
        "AccountID": "210xxxx01"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ErrZoneNotFound	zone not found	未找到域名
500	ErrInternalServer	server internal error	服务内部错误