CreateRule-创建路由规则--TrafficRoute DNS 套件-火山引擎

文档中心

立即注册

导航

TrafficRoute DNS 套件

CreateRule-创建路由规则

最近更新时间：2024.09.04 10:58:23首次发布时间：2023.08.21 14:31:38

为 GTM 实例下的策略创建一条路由规则。

请求说明

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

请求参数

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

Query

名称	类型	是否必选	示例值	描述
Action	String	是	`CreateRule`	API 的名称。该参数的取值为 `CreateRule`。
Version	String	是	`2023-01-01`	API 的版本。该参数的取值是 `2023-01-01`。

Body

名称	类型	是否必选	示例值	描述
GtmId	String	是	`2a8f91c4-aa07-4ae4-9ebc-68750d611822`	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",
	"PolicyType": "geo",
	"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
		},
		"UseRuleProbeConfig": false,
		"UsePolicyProbeNodes": false
	}
}

返回示例

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

错误码

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