You need to enable JavaScript to run this app.
导航
获取策略
最近更新时间:2024.03.11 10:25:13首次发布时间:2023.08.21 14:31:37

API 说明

API 名称:GetPolicy
API 域名:open.volcengineapi.com
API 描述:获取指定 GTM 实例的策略的信息。

请求方法

POST

请求参数

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

参数名称
数据类型参数类型是否必选参数说明
ActionString查询参数API 的名称。该参数的取值是 GetPolicy
VersionString查询参数API 的版本。该参数的取值是 2023-01-01
GtmIdString查询参数GTM 实例的 UUID。您可以通过 ListGtms API 获取 GtmId
PolicyTypeString查询参数策略类型。
  • geo:基础路由。
  • perf:智能路由。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称
数据类型
参数说明
RoutingMode
String
路由模式。该参数取值为:
  • lb:基于负载均衡,把用户流量按比例路由到不同 IDC 机房。
  • geo:基于用户的地理位置和运营商,把用户流量路由到相同运营商线路下距离用户最近的 IDC 机房。
  • geo-lb(默认):先基于用户的地理位置和运营商,把用户流量路由到相同运营商下的最近的 IDC 机房的接入线路。再基于负载均衡把用户流量按比例路由到多个 IDC 机房。
AlarmOnly
Boolean
如果当前地址池集合不可用,云调度 GTM 是否仅触发告警通知而不自动切换到可用的地址池。
  • true:云调度 GTM 仅触发告警通知。
  • false:云调度 GTM 会自动切换到可用的地址池。
Targets
Array of Objects
智能路由策略的流量目标。
Statistics
Objects
可用目标地址和不可用目标地址的统计数据。

示例

请求示例

POST https://open.volcengineapi.com?Action=GetPolicy&Version=2023-01-01&GtmId=e93cb374-2b33-4202-842f-c066a4462c03&PolicyType=perf

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023080711584012BFB041BDE2F044610C",
        "Action": "GetPolicy",
        "Version": "2023-01-01",
        "Service": "gtm",
        "Region": "cn-north-1"
    },
    "Result": {
        "RoutingMode": "geo",
        "AlarmOnly": false,
        "Targets": [
            {
                "PoolId": "cf65f46e-6a19-4d15-99b5-684a6ce4e7ff"
            }
        ],
        "Statistics": {
            "InactiveAddr": 0,
            "ActiveAddr": 0
        }
    }
}