创建静态调度策略--多云CDN-火山引擎

文档中心

立即注册

导航

创建静态调度策略

最近更新时间：2024.12.16 14:13:47首次发布时间：2024.03.13 10:27:00

调用本接口在指定的调度实例下创建一条静态调度策略。

默认静态调度策略（即兜底策略）

每个调度实例下包含至少一条默认静态调度策略。默认静态调度策略是创建调度实例时必须创建的。默认静态调度策略的调度区域包含：

“默认”：对中国内地区域内的流量进行调度。
“全球（不含中国内地）”：对中国内地区域外的流量进行调度。

细分区域的静态调度策略

通过调用本接口创建静态调度策略，您可以针对以下细分的调度区域指定流量分配设置：

“中国内地/省份&运营商”维度：策略优先级高于“默认”区域的策略。
“全球（不含中国内地）/国家或地区”维度：策略优先级高于“全球（不含中国内地）”区域的策略。

更多信息，请参见调度中心概述。

使用说明

每个请求中必须包含鉴权信息。该鉴权信息用以验证请求者的身份。参见签名机制。

使用限制

节流限制：您每秒最多可以提交 10 个 API 请求。

请求说明

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

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `AddDnsScheduleStaticWeight`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
DnsScheduleId	String	是	指定调度实例的 ID。说明调度实例 ID 是多云CDN为调度实例生成的唯一标识符。您可以调用 ListDnsSchedules 接口查询所有调度实例的 ID。	`27557981222815XXXX`
Country	String	是	设置调度区域所属国家或地区的代码。您可以调用 ListViews 接口查询所有国家或地区代码。	`CN`
Province	String	是	设置调度区域所属中国行政区域（省、自治区、直辖市、特别行政区）的代码。您可以调用 ListViews 接口查询所有行政区域代码。说明该参数只适用于 `Country` 为 `CN` 的情形。该参数值允许设置为空。例如，当 `Country` 值为除 `CN` 外的其他值时，您可以将该参数的值设置为空。	`BJ`
Isp	String	是	设置调度区域对应的运营商的代码。您可以调用 ListViews 接口查询所有运营商代码。说明该参数只适用于 `Country` 为 `CN` 的情形。该参数值允许设置为空。例如，当 `Country` 值为除 `CN` 外的其他值时，您可以将该参数的值设置为空。	`MOBILE`
WeightItems	Object[]	是	为当前调度区域设置的流量分配比例。

返回参数

参数名称	数据类型	参数说明	示例
StaticWeight	Object	已创建的静态调度策略的信息。

请求示例

POST https://open.volcengineapi.com/?Action=AddDnsScheduleStaticWeight&Version=2022-03-01&<其他公共请求参数>=
{
    "DnsScheduleId": "27557981222815****",
    "Country": "CN",
    "Province": "BJ",
    "Isp": "MOBILE",
    "WeightItems": [
        {
            "DomainId": "655372e030060dd533f9****",
            "Value": 50
        },
        {
            "DomainId": "65537682167cb75a3dc4****",
            "Value": 50
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "202402222001267F4D525DA698DC7648EE",
        "Action": "AddDnsScheduleStaticWeight",
        "Version": "2022-03-01",
        "Service": "mcdn",
        "Region": "cn-north-1"
    },
    "Result": {
        "StaticWeight": {
            "Id": "28368966611182****",
            "Country": "CN",
            "Province": "BJ",
            "Isp": "MOBILE",
            "WeightItems": [
                {
                    "DomainId": "655372e030060dd533f9****",
                    "Value": 50
                },
                {
                    "DomainId": "65537682167cb75a3dc4****",
                    "Value": 50
                }
            ]
        }
    }
}

错误码

如果响应正文的 ResponseMetadata 字段中包含 Error 字段，则表示 API 请求失败。关于更多错误码的信息，参见错误码。