最近更新时间:2024.03.11 10:25:13
首次发布时间:2023.08.21 14:31:38
API 名称:ListRules
。
API 域名:open.volcengineapi.com
。
API 描述:获取指定 GTM 实例的路由规则列表。
POST
除了以下参数,您还需要 对请求进行鉴权。
参数名称 | 数据类型 | 参数类型 | 是否必选 | 参数说明 |
---|---|---|---|---|
Action | String | 查询参数 | 是 | API 的名称。该参数的取值是 ListRules 。 |
Version | String | 查询参数 | 是 | API 的版本。该参数的取值是 2023-01-01 。 |
GtmId | String | 查询参数 | 是 | 表示 GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。 |
PolicyType | String | 查询参数 | 否 | 路由规则对应的策略类型。
|
Name | String | 查询参数 | 否 | 表示路由规则的名称。 默认为空值,即该参数不作为查询条件。 |
Line | String | 查询参数 | 否 | 表示路由规则所适用的线路,例如 cn_mobile_anhui 。您可以通过调用 ListLines API 获取可用的线路名称。您必须填入 API 返回的 value 字段的值。默认为空值,即该参数不作为查询条件。 |
Address | String | 查询参数 | 否 | 表示路由规则的目标地址,例如 1.1.1.1 。默认为空值,即该参数不作为查询条件。 |
SearchMode | String | 查询参数 | 否 | 表示查询模式。包括以下模式:
|
PoolName | String | 查询参数 | 否 | 表示路由规则中地址池的名称。 默认为空值,即该参数不作为查询条件。 |
PageSize | Integer | 查询参数 | 否 | 每页包含的路由规则的数量。 |
PageNumber | Integer | 查询参数 | 否 | 页码。页数由获取的路由规则总数和 PageSize 确定。 |
SortBy | String | 查询参数 | 否 | 表示对返回结果排序的键值。
默认为空值。返回结果会根据路由规则的更新时间按时间降序排列。 |
SortOrder | String | 查询参数 | 否 | 表示返回结果的排序方向。 默认为空值。默认的排序方向为:
如果你不设置 SortBy ,则该参数无效。 |
参数名称 | 数据类型 | 参数说明 |
---|---|---|
TotalCount | Integer | 地址池的总数量。 |
PageNumber | Integer | 分页的页码。 |
PageSize | Integer | 每个分页的地址池数量。 |
Data | Array of Objects | 路由规则的信息。 |
POST https://open.volcengineapi.com?Action=ListRules&Version=2023-01-01&GtmId=b46cf3dc-10e5-4847-8e32-e5c7696eebd0
{ "ResponseMetadata": { "RequestId": "202307272058195ED12C4A656AD2DDB106", "Action": "ListRules", "Version": "2023-01-01", "Service": "GTM", "Region": "cn-north-1" }, "Result": { "TotalCount": 1, "PageNumber": 1, "PageSize": 100, "Data": [ { "CreateTime": "2023-07-27T10:23:05.935Z", "UpdateTime": "2023-07-27T10:23:05.935Z", "RuleId": "c3f65de3-7b01-4ad5-8225-d0e42ced2e05", "Name": "TestRule", "Remark": "", "Disable": false, "Line": "default", "Weight": 1, "EffectivePoolSetIndex": 0, "PoolSetMode": "auto", "PoolSets": [ { "PoolSetId": "c70aba3f-561b-44a4-8fd3-798fae597245", "Name": "PoolSet1", "Weight": 1, "ActiveCount": 1, "AddrType": "ip4", "Pools": [ { "PoolId": "cf65f46e-6a19-4d15-99b5-684a6ce4e7ff", "Weight": 1, "PoolName": "example-pool", "Addresses": [ { "Type": "ipv4", "Value": "1.1.1.1", "Weight": 3, "RectifiedGeos": [ "mobile" ], "Mode": "auto", "Active": false, "Latency": 0, "PlatId": 0, "Area": "CN" } ], "InactiveAddrNumber": 2 } ], "Active": false, "Disable": false } ], "AddrType": "ipv4", "Probe": { "Nodes": [ "福建 厦门市 中国移动", "山东 济南市 中国移动", "浙江 杭州市 中国移动", "江西 南昌市 中国联通", "山东 济南市 中国联通", "广东 广州市 中国电信", "山东 济南市 中国电信", "山东 青岛市 中国电信" ], "IsManualNodes": false, "AdvisedNodeCount": 0, "Protocol": "", "Interval": 0, "Timeout": 0, "PingLossRate": 0, "PingCount": 0, "Host": "", "Port": 0, "Url": "", "Disable": false }, "ProbeMode": "default" } ] } }