You need to enable JavaScript to run this app.
导航
UpdateLoad - 上报负载
最近更新时间:2025.05.28 17:43:55首次发布时间:2024.06.14 16:35:05
我的收藏
有用
有用
无用
无用

为一个 GTM 实例上报地址池或地址的当前负载和目标负载。云调度 GTM 会根据该 API 上报的负载调整地址池或地址的流量分配比例。

注意事项

在调用该 API 前,您需要确保 GTM 实例的路由模式是负载反馈。参见 配置 GTM 实例

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=UpdateLoad&Version=2023-01-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
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

内部错误

内部错误