更新 ECS 主机名自动同步任务。
请求频率:每秒最多调用 20 次。
除了以下参数,您还需要 对请求进行鉴权。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateEcsHostSyncTask | 要执行的操作,取值:UpdateEcsHostSyncTask。 |
Version | String | 是 | 2022-06-01 | API的版本,取值:2022-06-01。 |
ZID | Long | 是 | 1234 | 标识域名的唯一 ID。您可以通过以下 API 获取: |
Status | String | 否 | ON | 是否开启自动同步。如果您不设置该参数,自动同步开启状态不变。
|
EcsRegions | Array of Object | 是 | 无 | 需要同步的地域和火山引擎账号。 |
本接口无特有的返回参数。更多信息请见返回结构。
POST https://private-zone.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" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | ErrParamInvalid | validation fail: params:[%s] , value:[%v] | 参数校验失败 |
400 | ErrOperationForbidden | operation forbidden for global zone | 全局域名禁止当前操作 |
400 | ErrRegionNotSupport | %s of [%s] not supported by private_zone | private_zone不支持[%s]地域的%s |
400 | ErrNoAuthorization | no authorization on the resource | 未得到跨账号资源授权 |
500 | ErrInternalServer | server internal error | 服务内部错误 |