简介

自有高防调度，是指用自有高防实例为遭受攻击的IP进行DNS调度。首先，用户在百度智能云管理控制台购买高防实例，并配置好转发规则；在IP遭受攻击时，用户手动调用触发调度接口，将流量调度到高防机房，经高防机房清洗攻击流量后，根据已有高防实例配置好的转发规则，将正常流量回源到指定目标；攻击结束时，用户手动调用解除调度动作接口，流量正常到达IP。该场景配置时，需要指定调度IP、private区域、高防实例。

如果您是初次调用百度智能云产品的API，可以观看API入门视频指南，快速掌握调用API的能力。

服务域名

产品是全局产品，服务域名为adas.baidubce.com。

通用说明

API调用遵循HTTP协议，数据交换格式为JSON，所有request/response body内容均采用UTF-8编码。URL参数中所使用的IP均使用点分十进制表示。

API认证机制

所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成，均为字符串。 对于每个HTTP请求，使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}。

• version是正整数。
• timestamp是生成签名时的UTC时间。
• expirationPeriodInSeconds表示签名有效期限。
• signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号（;）分隔，如host;x-bce-date。列表按照字典序排列。（本API签名仅使用host和x-bce-date两个header）
• signature是256位签名的十六进制表示，由64个小写字母组成。

当百度智能云接收到用户的请求后，系统将使用相同的SK和同样的认证机制生成认证字符串，并与用户请求中包含的认证字符串进行比对。如果认证字符串相同，系统认为用户拥有指定的操作权限，并执行相关操作；如果认证字符串不同，系统将忽略该操作并返回错误码。

鉴权认证机制的详细内容请参见鉴权认证。

幂等性

当调用某些接口时如果遇到了请求超时或服务器内部错误，用户可能会尝试重发请求，这时用户通过clientToken参数避免创建出比预期要多的资源，即保证请求的幂等性。

幂等性基于clientToken，clientToken是一个长度不超过64位的ASCII字符串，通常放在query string里，如http://bcc.bj.baidubce.com/v1/instance?clientToken=be31b98c-5e41-4838-9830-9be700de5a20。

如果用户使用同一个clientToken值调用创建接口，则服务端会返回相同的请求结果。因此用户在遇到错误进行重试的时候，可以通过提供相同的clientToken值，来确保只创建一个资源；如果用户提供了一个已经使用过的clientToken，但其他请求参数（包括queryString和requestBody）不同甚至url Path不同，则会返回IdempotentParameterMismatch的错误代码。

clientToken的有效期为24小时，以服务端最后一次收到该clientToken为准。也就是说，如果客户端不断发送同一个clientToken，那么该clientToken将长期有效。

日期与时间规范

日期与时间的表示有多种方式。为统一起见，除非是约定俗成或者有相应规范的，凡需要日期时间表示的地方一律采用UTC时间，遵循ISO 8601，并做以下约束：

1. 表示日期一律采用YYYY-MM-DD方式，例如2014-06-01表示2014年6月1日
2. 表示时间一律采用hh:mm:ss方式，并在最后加一个大写字母Z表示UTC时间。例如23:00:10Z表示UTC时间23点0分10秒。
3. 凡涉及日期和时间合并表示时，在两者中间加大写字母T，例如2014-06-01T23:00:10Z表示UTC时间2014年6月1日23点0分10秒。

请求参数

请求参数包括如下4种：

返回值说明

返回值分为两种形式：

公共请求头

下表列出了所有AdasSchedule API所携带的公共头域。HTTP协议的标准头域不在此处列出

公共响应头

下表列出了所有AdasSchedule API的公共响应头域。HTTP协议的标准响应头域不在此处列出

错误码

请求发生错误时通过respone body返回详细错误信息，遵循如下格式：

示例：

{
	"requestId" : "ae2225f7-1c2e-427a-a1ad-5413b762957d",
	"code" : "NoSuchKey",
	"message" : "The resource you requested does not exist"
}

公共错误码

AdasSchedule业务错误码

名词解释

下表列出了所有AdasSchedule API的涉及到的关键名词及解释。