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

文档中心

立即注册

导航

TrafficRoute DNS 套件

GetPolicy - 获取策略

最近更新时间：2025.07.21 11:55:22首次发布时间：2023.08.21 14:31:37

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

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetPolicy	要执行的操作，取值：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：智能路由。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
RoutingMode	String	lb	路由模式。该参数取值为： lb：基于负载均衡，把用户流量按比例路由到不同 IDC 机房。 geo：基于用户的地理位置和运营商，把用户流量路由到相同运营商线路下距离用户最近的 IDC 机房。 geo-lb（默认）：先基于用户的地理位置和运营商，把用户流量路由到相同运营商下的最近的 IDC 机房的接入线路。再基于负载均衡把用户流量按比例路由到多个 IDC 机房。
AlarmOnly	Boolean	true	如果当前地址池集合不可用，云调度 GTM 是否仅触发告警通知而不自动切换到可用的地址池。 true：云调度 GTM 仅触发告警通知。 false：云调度 GTM 会自动切换到可用的地址池。
Targets	Object	无	智能路由策略的流量目标。
PerfMode	String	perf	智能路由策略的路由模式。 perf：性能优先 capacity：容量优先 feedback：负载反馈
Statistics	Object	无	地址状态的统计信息。
SourceFlow	Object	无	该参数无实际意义。您可以忽略该参数。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202505271038359108E08EA1368E1084A1",
        "Action": "GetPolicy",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-boe-1"
    },
    "Result": {
        "RoutingMode": "geo-lb",
        "AlarmOnly": false,
        "Targets": null,
        "PerfMode": "perf",
        "Statistics": {
            "InactiveAddr": 0,
            "ActiveAddr": 10
        },
        "SourceFlow": [],
        "LoadImbalanceFactor": 0,
        "IgnoreAddrWeightPercent": 0,
        "IgnoreWaterPercent": 0,
        "NoticeWaterPercent": 0,
        "RatioThreshold": 0,
        "FluctuationThreshold": 0,
        "AddrPriority": "",
        "CapacitySharing": false,
        "CrossIspPenalty": 0,
        "RttFactor": 0,
        "ProxyMode": "",
        "Listeners": null,
        "DefaultLineAddrNum": 0,
        "RelayHandleTime": 0
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
504	internal error	内部错误	内部错误