You need to enable JavaScript to run this app.
导航
TrafficRoute DNS 套件
  • 文档首页
    • /TrafficRoute DNS 套件/云调度 GTM/API 参考/负载反馈接口/UpdateLoad-上报负载
UpdateLoad-上报负载
最近更新时间：2024.07.15 14:48:43首次发布时间：2024.06.14 16:35:05
我的收藏

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

注意

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

请求说明

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

请求参数

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

Query

名称
类型
是否必选
示例值
描述
Action
String
是
UpdateLoad
API 的名称。该参数的取值为 UpdateLoad。
Version
String
是
2023-01-01
API 的版本。该参数的取值是 2023-01-01。

Body

名称
类型
是否必选
示例值
描述
GtmId
String
是
8234cb50-f957-4be9-b515-55c5d419ea9e
GTM 实例的 UUID。您可以通过 ListGtms API 获取 GtmId。GTM 实例的路由模式必须是负载反馈。
Timestamp
Integer
否
1700805259
负载的时间。格式是 Unix 时间戳，单位为秒。
Statistics
Object
是
负载信息。

返回参数

ResponseMetadata 对象

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

示例

请求示例

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"
}

错误码

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