最近更新时间:2024.03.11 10:25:13
首次发布时间:2023.08.21 14:31:38
API 名称:GetRule
。
API 域名:open.volcengineapi.com
。
API 描述:获取指定的路由规则的信息。
POST
除了以下参数,您还需要 对请求进行鉴权。
参数名称 | 数据类型 | 参数类型 | 是否必选 | 参数说明 |
---|---|---|---|---|
Action | String | 查询参数 | 是 | API 的名称。该参数的取值是 GetRule 。 |
Version | String | 查询参数 | 是 | API 的版本。该参数的取值是 2023-01-01 。 |
GtmId | String | 查询参数 | 是 | 表示 GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。 |
PolicyType | String | 查询参数 | 是 | 路由规则对应的策略类型。默认为 geo 。
|
RuleId | String | 查询参数 | 是 | 路由规则的 ID。您在调用 CreateRule API 时,响应正文中包含路由规则的 ID。 |
参数名称 | 数据类型 | 参数说明 |
---|---|---|
CreateTime | String | 路由规则的创建时间。精确到毫秒。格式符合 ISO 8601 标准。 |
UpdateTime | String | 路由规则最近的更改时间。精确到毫秒。格式符合 ISO 8601 标准。 |
RuleId | String | 路由规则的 ID。 |
Name | String | 路由规则的名称。 |
Remark | String | 路由规则的备注。 |
Disable | Boolean | 该路由规则是否处于禁用状态。
|
Line | String | 该路由规则适用的线路。 |
Weight | Integer | 该路由规则的权重。 |
EffectivePoolSetIndex | Integer | 生效的地址池集合的索引。 |
PoolSetMode | String | 地址池集合的生效模式。
|
PoolSets | Array of Objects | 路由规则关联的地址池集合。 |
AddrType | String | 地址的类型。
|
Probe | Object | 健康检查参数。 |
ProbeMode | String | 健康检查模式。
|
POST https://open.volcengineapi.com?Action=GetRule&Version=2023-01-01&GtmId=b46cf3dc-10e5-4847-8e32-e5c7696eebd0&PolicyType=geo&RuleId=c3f65de3-7b01-4ad5-8225-d0e42ced2e05
{ "ResponseMetadata": { "RequestId": "20230727210915DD7878E9C89A04E2481C", "Action": "GetRule", "Version": "2023-01-01", "Service": "GTM", "Region": "cn-north-1" }, "Result": { "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, ], "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" } }