伸缩组相关接口

弹性伸缩 Auto Scaling

所有文档

          弹性伸缩 Auto Scaling

          • AS
          • >
          • API参考
          • >
          • 伸缩组相关接口

          伸缩组相关接口

          更新时间：2020-07-15

          查询伸缩组列表

          • 查询所有伸缩组的详细信息。

          请求结构

          GET /v{version}/asGroup?marker={marker}&maxKeys={maxKeys}&groupName={groupName} HTTP/1.1
Host: as.bj.baidubce.com
Authorization: authorization string

          请求头域

          除公共头域外，无其它特殊头域。

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String 是 URL参数 API版本号
          marker String 否 Query参数 批量获取列表的查询的起始位置，是一个由系统生成的字符串
          maxKeys int 否 Query参数 每页包含的最大数量，最大数量通常不超过1000。缺省值为1000
          groupName String 否 Query参数 伸缩组名称

          返回头域

          除公共头域，无其它特殊头域。

          返回参数

          参数名称 类型 描述
          marker String 标记查询的起始位置
          isTruncated boolean true表示后面还有数据，false表示已经是最后一页
          nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现
          maxKeys int 每页包含的最大数量
          asGroupInfo List<AsGroup> 伸缩组信息，由 AsGroup 组成的集合

          错误码

          无特殊返回错误码

          请求示例

          GET /v2/asGroup?marker=asg-IyWRtII7&maxKeys=1 HTTP/1.1
Host: as.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

          返回示例

          HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "nextMarker": "asg-xktdeMSf",
    "marker": "asg-IyWRtII7",
    "maxKeys": 1,
    "isTruncated": true,
    "asGroupInfo": [
        {
            "groupId": "asg-LNwOIX6G",
            "groupName": "asg-01",
            "region": "bj",
            "status": "RUNNING",
            "vpcId": "vpc-09480k1ihuzn",
            "nodeNum": 0,
            "createTime": "2019-10-25T06:06:43Z",
            "zoneInfo": [{
                "zone": "zoneA",
                "subnetId": "sbn-5jtva2b0e7gf"
            }],
            "groupConfig": {
                "minNodeNum": 0,
                "maxNodeNum": 20,
                "cooldownInSec": 300
            },
            "blbId": "lb-e8dcbae4"
        }
    ]
}

          查询伸缩组详情

          • 查询单个伸缩组的详细信息。

          请求结构

          GET /v{version}/asGroup/{groupId} HTTP/1.1
Host: as.bj.baidubce.com
Authorization: authorization string

          请求头域

          除公共头域外，无其它特殊头域。

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String 是 URL参数 API版本号
          groupId String 是 URL参数 待查询的伸缩组ID

          返回头域

          除公共头域，无其它特殊头域。

          返回参数

          参数名称 类型 描述
          groupId String 伸缩组ID，符合BCE规范，是一个定长字符串，且只允许包含大小写字母、数字、连字号（-）和下划线（_)。
          groupName String 伸缩组名称,支持大小写字母、数字、中文以及-_ /.特殊字符，必须以字母开头，长度1-65。
          region String 伸缩组所在地域
          status AsGroupStatus 伸缩组状态
          vpcInfo VpcInfo 私有网络VPC信息
          rdsIds String 云数据库RdsId
          scsIds String 云数据库ScsId
          createTime String 创建时间
          zoneInfo ZoneInfo 可用区及子网信息
          groupConfig GroupConfig 伸缩组规格
          blb String 负载均衡Id
          nodeNum int 伸缩组下节点数量

          请求示例

          GET /v2/asGroup/asg-7a8LXBQ8 HTTP/1.1
Host: as.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

          返回示例

          HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "groupId": "asg-LNwOIX6G",
    "groupName": "asg-01",
    "region": "bj",
    "status": "RUNNING",
    "vpcInfo": {
        "vpcId": "vpc-whrt3k5fq0h2",
        "vpcName": "network1"
    },
    "nodeNum": 0,
    "createTime": "2019-10-25T06:06:43Z",
    "zoneInfo": [{
        "zone": "cn-bj-a",
        "subnetId": "sbn-5jtva2b0e7gf"
    }],
    "groupConfig": {
        "minNodeNum": 0,
        "maxNodeNum": 20,
        "cooldownInSec": 300
    },
    "blbId": "lb-e8dcbae4"
}

          查询伸缩组下节点列表

          • 查询指定伸缩组下节点的详细信息。

          请求结构

          GET /v{version}/asNode/{groupId}?marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: as.bj.baidubce.com
Authorization: authorization string

          请求头域

          除公共头域外，无其它特殊头域。

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String 是 URL参数 API版本号
          marker String 否 Query参数 批量获取列表的查询的起始位置，是一个由系统生成的字符串
          maxKeys int 否 Query参数 每页包含的最大数量，最大数量通常不超过1000。缺省值为1000
          groupId String 是 URL参数 伸缩组ID

          返回头域

          除公共头域，无其它特殊头域。

          返回参数

          参数名称 类型 描述
          marker String 标记查询的起始位置
          isTruncated boolean true表示后面还有数据，false表示已经是最后一页
          nextMarker String 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现
          maxKeys int 每页包含的最大数量
          result List<NodeModel> 节点信息，由 NodeModel 组成的集合

          错误码

          无特殊返回错误码

          请求示例

          GET /v2/asNode/asg-BKzF1aDX?marker=asg-IyWRtII7&maxKeys=1 HTTP/1.1
Host: as.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

          返回示例

          HTTP/1.1 200 OK
x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
Date: Wed, 03 Dec 2014 06:42:19 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS

{
    "nextMarker": "asg-xktdeMSf",
    "marker": "asg-IyWRtII7",
    "maxKeys": 1,
    "isTruncated": true,
    "result": [
        {
            "instanceId": "i-XPWvxNy7",
            "instanceName": "instance-5ncjagda",
            "floatingIp": "10.107.233.231",
            "internalIp": "192.168.64.177",
            "status": "Running",
            "payment": "Postpaid",
            "cpuCount": 0,
            "memoryCapacityInGB": 0,
            "instanceType": "10",
            "sysDiskInGB": 40,
            "subnetType": "BCC",
            "createTime": "2019-10-25T06:06:43Z",
            "isProtected": true,
            "nodeType": "FOREIGN",
            "eip": {
                "bandwidthInMbps": 1,
                "address": "10.107.248.96",
                "eipStatus": "binded",
                "eipAllocationId": "ip-09c65903"
            }
        }
    ]
}

          伸缩组扩容

          • 本接口用于在指定伸缩组下添加节点。
          • 接口参数：伸缩组ID、新增节点数量
          • 返回实例ID和伸缩组ID

          请求结构

          POST /v{version}/asGroup/{groupId}?increase&clientToken={clientToken} HTTP/1.1
Host: as.bj.baidubce.com
Authorization: authorization string
{
  "nodeCount" : nodeCount
}

          请求头域

          除公共头域外，无其它特殊头域。

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String 是 URL参数 API版本号
          clientToken String 是 Query参数 幂等性Token，是一个长度不超过64位的ASCII字符串，详见链接
          groupId String 是 URL参数 待添加节点的伸缩组ID
          nodeCount int 是 RequestBody参数 新增节点数量

          返回头域

          除公共头域，无其它特殊头域。

          返回参数

          参数名称 类型 描述
          groupId String 伸缩组ID
          instanceId List<String> 实例ID

          错误码

          无特殊返回错误码

          请求示例

          POST /v2/asGroup/asg-LNwOIX6G?increase&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: as.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
  "nodeCount" : 1
}

          返回示例

          HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS

{
  "groupId": "asg-LNwOIX6G",
  "instanceId": ["i-ymEOSpX8"]
}

          伸缩组缩容

          • 本接口用于伸缩组下节点的缩容。
          • 接口参数：伸缩组ID、缩容数量
          • 当前伸缩组处于运行中状态，触发成功并返回TaskId
          • 当前伸缩组不处于运行中状态，触发失败并返回失败信息

          请求结构

          POST /v{version}/asGroup/{groupId}?decrease&clientToken={clientToken} HTTP/1.1
Host: as.bj.baidubce.com
Authorization: authorization string
{
  "actionNum" : actionNum
}

          请求头域

          除公共头域外，无其它特殊头域。

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String 是 URL参数 API版本号
          clientToken String 是 Query参数 幂等性Token，是一个长度不超过64位的ASCII字符串，详见链接
          groupId String 是 URL参数 待执行伸缩行为的伸缩组ID
          actionNum int 是 RequestBody参数 缩容数量

          返回头域

          除公共头域，无其它特殊头域。

          返回参数

          参数名称 类型 描述
          taskId String 任务ID

          错误码

          无特殊返回错误码

          请求示例

          POST /v2/asGroup/asg-LNwOIX6G?decrease&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: as.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
  "actionNum" : 1
}

          返回示例

          HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS

{
  "taskId": "task-4IqP00II"
}

          伸缩组节点数量调整

          • 本接口用于伸缩组下节点的缩容。
          • 接口参数：伸缩组ID、节点数量调整为
          • 当前伸缩组处于运行中状态，触发成功并返回TaskId
          • 当前伸缩组不处于运行中状态，触发失败并返回失败信息

          请求结构

          POST /v{version}/asGroup/{groupId}?adjust&clientToken={clientToken} HTTP/1.1
Host: as.bj.baidubce.com
Authorization: authorization string
{
  "actionNum" : actionNum
}

          请求头域

          除公共头域外，无其它特殊头域。

          请求参数

          参数名称 类型 是否必需 参数位置 描述
          version String 是 URL参数 API版本号
          clientToken String 是 Query参数 幂等性Token，是一个长度不超过64位的ASCII字符串，详见链接
          groupId String 是 URL参数 待执行伸缩行为的伸缩组ID
          actionNum int 是 RequestBody参数 节点数量调整为

          返回头域

          除公共头域，无其它特殊头域。

          返回参数

          参数名称 类型 描述
          taskId String 任务ID

          错误码

          无特殊返回错误码

          请求示例

          POST /v2/asGroup/asg-LNwOIX6G?adjust&clientToken=3A8d84403d-a94b-40ce-9d6a-f6225dd26676
Host: as.bj.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de

{
  "actionNum" : 1
}

          返回示例

          HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS

{
  "taskId": "task-4IqP00II"
}
          上一篇
          简介
          下一篇
          附录