为一个 GTM 实例上报地址池或地址的当前负载和目标负载。云调度 GTM 会根据该 API 上报的负载调整地址池或地址的流量分配比例。
在调用该 API 前,您需要确保 GTM 实例的路由模式是负载反馈。参见 配置 GTM 实例。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateLoad | 要执行的操作,取值:UpdateLoad。 |
Version | String | 是 | 2023-01-01 | API的版本,取值:2023-01-01。 |
GtmId | String | 是 | 8234cb50-f957-4be9-b515-55c5d419ea9e | GTM 实例的 UUID。您可以通过 ListGtms API 获取 GtmId。GTM 实例的路由模式必须是负载反馈。 |
Timestamp | Long | 是 | 1700805259 | 负载的时间。格式是 Unix 时间戳,单位为秒。 |
Statistics | Array of Object | 否 | 无 | 负载信息。 |
本接口无特有的返回参数。更多信息请见返回结构。
POST https://open.volcengineapi.com/?Action=UpdateLoad&Version=2023-01-01 { "GtmId":"8234cb50-f957-4be9-b515-55c5d419ea9e", "Timestamp": 1700805259, "Statistics": [ { "AddrValue": "1.1.1.1", "CurrentLoad": 20, "TargetLoad": 30, "Capacity": 50 } { "AddrValue": "1.1.1.2", "CurrentLoad": 10, "TargetLoad": 20, "Capacity": 30 }, ] }
{ "ResponseMetadata": { "RequestId": "202307261734323E142F8FA3C8461563CC", "Action": "UpdateLoad", "Version": "2023-01-01", "Service": "GTM", "Region": "cn-north-1" }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
504 | internal error | 内部错误 |