调度实例相关接口

创建调度实例

  • 描述

创建一个调度实例,用于绑定调度的IP。

需要开启两个白名单:AdasAutoSchedule(高防自动化调度)和 RouteOpenSourceAddress(自定义路由白名单)。

创建调度实例需要实名认证,若未通过实名认证可以前往百度开放云官网控制台中的安全认证下的实名认证中进行认证。

  • 请求语法
POST /v{version}/schedule?clientToken={clientToken} HTTP/1.1
Host: adas.baidubce.com
Authorization: authorization string
  • 请求头域

除公共头域外,无其他特殊头域

  • 请求参数
参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
clientToken String Query参数 幂等性Token
  • 响应头域

除公共头域外,无其他特殊头域

  • 响应参数
参数名称 类型 描述
scheduleId String 创建的调度实例id

请求示例

POST /v1/schedule?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST adas.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "scheduleId":"sche-12345678"
}

配置调度实例

  • 描述

只有在调度实例正常状态下,才能进行配置,即调度实例的status必须是normal。

需要指定scheduleIp,region, healthCheckPort, 其中,region只能为公有云的区域,healthCheckPort为后端机器开放的TCP端口。

  • 请求语法
PUT /v{version}/schedule/{scheduleId}?action={action}&clientToken={clientToken} HTTP/1.1
Host: adas.baidubce.com
Authorization: authorization string

{
    "scheduleIp": "182.61.1.1",
    "region": "bj",
    "healthCheckPort": 80,    
}
  • 请求头域

除公共头域外,无其他特殊头域

  • 请求参数
参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
scheduleId String Query参数 调度实例ID
action String Query参数 对实例执行的动作,本接口中该参数取值update
clientToken String Query参数 幂等性Token
scheduleIp String RequestBody参数 配置调度实例IP:eip
region String RequestBody参数 调度实例IP所属的区域
healthCheckPort String RequestBody参数 用于健康检查的后端的端口。
  • 响应状态码

成功返回200,失败返回见错误码

  • 响应头域

除公共头域外,无其他特殊头域

  • 响应参数

无特殊返回参数

请求示例

PUT /v1/schedule/sche-1234abcd?action=update&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST adas.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

{
    "scheduleIp": "182.61.1.1",
    "region": "bj",
    "healthCheckPort": 80,    
}

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

查询调度实例列表

  • 描述

可以指定scheduleIp,region,status,查询指定条件的调度实例的列表。

根据region字段,可以查询指定区域的调度实例。region为bj,gz,su,hk02,hkg,fsh可查询指定区域的BGP高防自动化调度实例列表。

根据status字段,可以查询处于不同调度状态下的调度实例。

  • 请求结构
GET /v{version}/schedule?scheduleIp={scheduleIp}&region={region}&clientToken={clientToken} HTTP/1.1
Host: adas.baidubce.com
Authorization: authorization string
  • 请求头域

除公共头域外,无其他特殊头域

  • 请求参数
参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
scheduleIp String Query参数 要查询的调度实例IP,点分十进制
region String Query参数 要查询的调度实例所属区域
status String Query参数 要查询的调度实例状态
marker String Query参数 批量获取列表的查询的起始位置,是一个由系统生成的字符串
maxKeys int Query参数 每页包含的最大数量,最大数量通常不超过1000。缺省值为1000
clientToken String Query参数 幂等性Token
  • 响应状态码

成功返回200,失败返回见错误码

  • 响应头域

除公共头域外,无其他特殊头域

  • 响应参数
参数名称 类型 描述
scheduleList list<ScheduleInstanceModel> 调度实例列表
marker String 标记查询的起始位置,若结果列表为空,此项不存在
isTruncated boolean true表示后面还有数据,false表示已经是最后一页
nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现
maxKeys int 每页包含的最大数量

请求示例

GET /v1/schedule?region=bj&clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST adas.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "nextMarker": "sche-62a7vb3m",
    "marker": "sche-1234abcd",
    "maxKeys": 1000,
    "isTruncated": true,
    "scheduleList": [
        {
            'scheduleId': 'sche-1234abcd',
            'scheduleIp': '180.76.1.1',
            'region': 'bj',
            'scheduleBandwidthInGbps': 5,
            'cname': '1234abcd.baiduads.com',
            'status': "normal",
            'rsIp': '180.76.1.1',                      
            'healthCheckPort': 80,
            'adasBgpIp': '180.76.198.100',
            'adasId': 'adas-0343ebb9',
            'updateTime': "2018-04-23 14:14:16",
            'scheduleStartTime': "2018-04-23 14:14:16",
        },
        ...
    ]   
}

查询调度实例详情

  • 描述

指定调度实例ID, 查询调度实例详情。

  • 请求语法
GET /v{version}/schedule/{scheduleId}?clientToken={clientToken} HTTP/1.1
Host: adas.baidubce.com
Authorization: authorization string
  • 请求头域

除公共头域外,无其他特殊头域

  • 请求参数
参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
scheduleId String Query参数 调度实例ID
clientToken String Query参数 幂等性Token
  • 响应状态码

成功返回200,失败返回见错误码

  • 响应头域

除公共头域外,无其他特殊头域

  • 响应参数
参数名称 类型 描述
schedule ScheduleInstanceModel 调度实例信息

请求示例

GET /v1/schedule/{sche-1234abcd}?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST adas.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "schedule": {
        'scheduleId': 'sche-1234abcd',
        'scheduleIp': '180.76.1.1',
        'region': 'bj',
        'scheduleBandwidthInGbps': "5",
        'cname': '1234abcd.baiduads.com',
        'status': "normal",                         
        'healthCheckPort': "80",
        'adasBgpIp': '180.76.198.100',              
        'adasId': 'adas-0343ebb9',
        'updateTime': "2018-04-23 14:14:16",
        'scheduleStartTime': "2018-04-23 14:14:16",
    } 
}

删除调度实例

  • 描述

删除调度实例。

  • 请求语法
DELETE /v{version}/schedule/{scheduleId}?clientToken={clientToken} HTTP/1.1
Host: adas.baidubce.com
Authorization: authorization string
  • 请求头域

除公共头域外,无其他特殊头域

  • 请求参数
参数名称 类型 是否必需 参数位置 描述
version String URL参数 API版本号,当前取值1
scheduleId String Query参数 调度实例ID
clientToken String Query参数 幂等性Token
  • 响应状态码

成功返回200,失败返回见错误码

  • 响应头域

除公共头域外,无其他特殊头域

  • 响应参数

无特殊返回参数

请求示例

DELETE /v1/schedule/sche-1234abcd?clientToken=be31b98c-5e41-4838-9830-9be700de5a20 HTTP/1.1
HOST adas.baidubce.com
Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

响应示例

HTTP/1.1 200 OK
x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
Date: Wed, 10 Apr 2016 08:26:52 GMT
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8
Server: BWS