GetPolicy-获取策略--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

GetPolicy-获取策略

最近更新时间：2024.07.15 14:47:53首次发布时间：2023.08.21 14:31:37

获取一个 GTM 实例的策略信息。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`GetPolicy`	API 的名称。该参数的取值是 `GetPolicy`。
Version	String	是	`2023-01-01`	API 的版本。该参数的取值是 `2023-01-01`。
GtmId	String	是	`e93cb374-2b33-4202-842f-c066a4462c03`	GTM 实例的 UUID。您可以通过 ListGtms API 获取 `GtmId`。
PolicyType	String	是	`geo`	策略类型。 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
        }
    }
}

错误码

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