UpdateEcsHostSyncTask-更新 ECS 主机名自动同步任务--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

UpdateEcsHostSyncTask-更新 ECS 主机名自动同步任务

最近更新时间：2024.08.12 10:25:11首次发布时间：2023.07.19 19:18:22

更新 ECS 主机名自动同步任务。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateEcsHostSyncTask?Version=2022-06-01

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`UpdateEcsHostSyncTask`	API 的名称。该参数的取值是 `UpdateEcsHostSyncTask`。
Version	String	是	`2022-06-01`	API 的版本。该参数的取值是 `2022-06-01`。

Body

名称	类型	是否必选	示例值	描述
ZID	Integer	是	`1234`	标识域名的唯一 ID。您可以通过以下 API 获取： CreatePrivateZone API ListPrivateZones API
EcsRegions	Array of Objects	是		需要同步的地域和火山引擎账号。
Status	String	否	`ON`	是否开启自动同步。如果您不设置该参数，自动同步开启状态不变。 ON：开启自动同步。 OFF：关闭自动同步。

返回参数

ResponseMetadata 对象

名称	类型	描述
RequestId	String	标识本次请求的 ID。
Action	String	Action 查询参数的值。
Version	String	API 版本。
Service	String	服务类型。
Region	String	服务所在地域。

示例

请求示例

POST https://open.volcengineapi.com/?Action=UpdateEcsHostSyncTask&Version=2022-06-01

{
  "ZID": 1013,
  "EcsRegions": [
    {
      "Region": "cn-beijing",
      "AccountID": "210xxxx01"
    }
  ],
  "Status": "OFF"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230614140553EC822FFD341E9C19EF59",
        "Action": "UpdateEcsHostSyncTask",
        "Version": "2022-06-01",
        "Service": "private_zone",
        "Region": "cn"
    }
}

错误码

您可访问公共错误码，获取详细信息。