You need to enable JavaScript to run this app.
导航

创建路由规则

最近更新时间2023.08.24 19:21:41

首次发布时间2023.08.21 14:31:38

API 说明

API 名称:CreateRule
API 域名:open.volcengineapi.com
API 描述:为 GTM 实例创建路由规则。

请求方法

POST

请求参数

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

参数名称
数据类型
参数类型
是否必选
参数说明
Action
String
查询参数
API 的名称。该参数的取值为 CreateRule
Version
String
查询参数
API 的版本。该参数的取值是 2021-07-05
GtmId
String
请求正文参数
GTM 实例的 UUID。您可以通过 ListGtms API 获取 UUID。
PolicyType
String
请求正文参数
路由规则对应的调度策略类型。默认为 geo
  • geo:地理位置策略。
  • perf:性能最优策略。
Rule
Object
请求正文参数
路由规则。

响应正文

ResponseMetadata 对象

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

Result 对象

参数名称
数据类型
参数说明
RuleId
String
路由规则的 ID。

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateRule&Version=2023-01-01

{
	"GtmId": "2a8f91c4-aa07-4ae4-9ebc-68750d611822",
	"Rule": {
		"Name": "TestRule",
		"Remark": "",
		"Disable": false,
		"Line": "default",
		"Weight": 1,
		"PoolSets": [
			{
				"Name": "PoolSet1",
				"Pools": [
					{
						"PoolId": "cf65f46e-6a19-4d15-99b5-684a6ce4e7ff",
						"Weight": 1
					}
				]
			}
		],
		"Probe": {
			"Disable": false
		},
		"ProbeMode": "default"
	}
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023072718230548623722C3A60BA95BBE",
        "Action": "CreateRule",
        "Version": "2023-01-01",
        "Service": "GTM",
        "Region": "cn-north-1"
    },
    "Result": {
        "RuleId": "c3f65de3-7b01-4ad5-8225-d0e42ced2e05"
    }
}