文档首页> 弹性伸缩 AS> API参考> API> 弹性伸缩策略> 查询弹性伸缩策略全量列表(V2版本)
更新时间:2022-02-22 GMT+08:00
分享

查询弹性伸缩策略全量列表(V2版本)

功能介绍

根据输入条件过滤查询弹性伸缩策略,支持查询当前租户下全量伸缩策略。查询结果分页显示。

  • 可根据伸缩资源ID,伸缩资源类型,伸缩策略名称,伸缩策略ID,告警ID,企业项目ID,起始行号,记录数,排序方式等条件进行过滤查询。
  • 若不加过滤添加默认查询该租户下最多20条伸缩策略信息。

已释放EIP对应的伸缩带宽策略仍然会占用配额,且只能使用华为云帐号和有全局权限的IAM用户进行查询,授予部分企业项目的IAM用户查询不到该伸缩带宽策略。

调试

您可以在API Explorer中调试该接口。

URI

GET /autoscaling-api/v2/{project_id}/scaling_policy

可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求样例。

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

scaling_resource_id

String

伸缩资源ID

scaling_resource_type

String

伸缩资源类型

  • 伸缩组:SCALING_GROUP
  • 带宽:BANDWIDTH

scaling_policy_name

String

伸缩策略名称。

支持模糊匹配。

scaling_policy_id

String

伸缩策略ID

scaling_policy_type

String

策略类型

  • 告警策略:ALARM
  • 定时策略:SCHEDULED
  • 周期策略:RECURRENCE

start_number

Integer

查询的起始行号,默认为0。最小值为0。

limit

Integer

查询的记录条数,默认为20。取值范围为:0~100。

sort_by

String

排序方法

  • POLICY_NAME:根据策略名称排序。
  • TRIGGER_CONDITION:根据触发条件排序,如升序排列时,告警策略最先,其余根据最近一次触发时间升序排列。
  • CREATE_TIME:根据策略的创建时间排序。

order

String

排序顺序

  • ASC:升序
  • DESC:降序

enterprise_project_id

String

企业项目ID。

  • 当scaling_resource_type指定为:SCALING_GROUP

    传入all_granted_eps时:

    • 华为云帐号和拥有全局权限的IAM用户可以查询该用户所有的伸缩组对应的伸缩策略。
    • 授予部分企业项目的IAM用户,可以查询该用户所有授权企业项目下的伸缩组对应的伸缩策略。
      说明:

      如果授予部分企业项目的IAM用户拥有超过100个企业项目,则只能返回有权限的前100个企业项目对应伸缩组的伸缩策略列表。

  • 当scaling_resource_type指定为:BANDWIDTH

    传入all_granted_eps时:

    • 华为云帐号和拥有全局权限的IAM用户可以查询该用户所有带宽对应的伸缩策略。
    • 授予部分企业项目的IAM用户,可以查询该用户所有授权企业项目下的带宽对应的伸缩策略,带宽在all_granted_eps场景下返回策略请参见《EIP接口参口》查询带宽列表
  • 不指定scaling_resource_type

    当传入all_granted_eps时:

    • 华为云帐号和拥有全局权限的IAM用户可以查询该用户所有的伸缩组和带宽对应的伸缩策略。
    • 授予部分企业项目的IAM用户,可以查询该用户所有授权企业项目下的伸缩组和带宽对应的伸缩策略。
      说明:

      如果授予部分企业项目的IAM用户拥有超过100个企业项目,则只能返回有权限的前100个企业项目对应伸缩组的伸缩策略列表;带宽在all_granted_eps场景下返回策略请参见《EIP接口参口》查询带宽列表

alarm_id

String

告警ID,即告警规则的ID。

请求消息

  • 请求参数

  • 请求样例
    本示例展示了查询伸缩资源ID为8ade64b5-d685-40b8-8582-4ce306ea37a6且策略类型为周期策略的所有伸缩策略。
    GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy?scaling_resource_id=8ade64b5-d685-40b8-8582-4ce306ea37a6&scaling_policy_type=RECURRENCE

响应消息

  • 响应参数
    表2 响应参数

    参数

    参数类型

    描述

    total_number

    Integer

    总记录数。

    start_number

    Integer

    查询的起始行号。

    limit

    Integer

    查询记录。

    scaling_policies

    Array of scaling_policies objects

    伸缩策略列表。详情请见表 scaling_policies字段数据结构说明

    表3 scaling_policies字段数据结构说明

    参数

    参数类型

    描述

    scaling_policy_name

    String

    伸缩策略名称

    scaling_policy_id

    String

    伸缩策略ID

    scaling_resource_id

    String

    伸缩资源ID

    scaling_resource_type

    string

    伸缩资源类型

    • 伸缩组:SCALING_GROUP
    • 带宽:BANDWIDTH

    policy_status

    String

    伸缩策略状态

    • INSERVICE:已启用
    • PAUSED:已停用
    • EXECUTING:执行中

    scaling_policy_type

    String

    伸缩策略类型:

    • ALARM:告警策略,此时alarm_id有返回,scheduled_policy不会返回。
    • SCHEDULED:定时策略,此时alarm_id不会返回,scheduled_policy有返回,并且recurrence_type、recurrence_value、start_time和end_time不会返回。
    • RECURRENCE:周期策略,此时alarm_id不会返回,scheduled_policy有返回,并且recurrence_type、recurrence_value、start_time和end_time有返回。

    alarm_id

    String

    告警ID

    scheduled_policy

    scheduled_policy object

    定时、周期任务策。详情请见表 scheduled_policy字段数据结构说明

    scaling_policy_action

    scaling_policy_action object

    策略执行具体动作。详情请见表 scaling_policy_action字段数据结构说明

    cool_down_time

    Integer

    冷却时间,单位秒。

    create_time

    String

    创建伸缩策略时间,遵循UTC时间。

    meta_data

    meta_data object

    附加信息。详情请见表 meta_data字段数据结构说明

    description

    String

    伸缩策略描述。

    表4 scheduled_policy字段数据结构说明

    参数

    参数类型

    描述

    launch_time

    String

    触发时间,遵循UTC时间。

    • 如果scaling_policy_type为SCHEDULED,则格式为:YYYY-MM-DDThh:mmZ。
    • 如果scaling_policy_type为RECURRENCE,则格式为:hh:mm。

    recurrence_type

    String

    周期触发类型。

    • Daily:每天执行一次
    • Weekly:每周指定天执行一次。
    • Monthly:每月指定天执行一次。

    recurrence_value

    String

    周期触发任务数值:

    • 类型为Daily时,该字段为null,表示每天执行
    • 类型为Weekly时,该字段取值范围为1-7,1表示星期日,以此类推,以“,”分割,例如:1,3,5。
    • 类型为Monthly时,该字段取值范围为1-31,分别表示每月的日期,以“,”分割,例如:1,10,13,28。

    start_time

    String

    周期策略重复执行开始时间,遵循UTC时间。

    格式为:YYYY-MM-DDThh:mmZ。

    end_time

    String

    周期策略重复执行结束时间,遵循UTC时间。

    格式为:YYYY-MM-DDThh:mmZ。

    表5 scaling_policy_action字段数据结构说明

    参数

    参数类型

    描述

    operation

    String

    操作选项。

    • ADD:增加
    • REDUCE:减少
    • SET:设置为

    size

    Integer

    操作实例个数。

    percentage

    Integer

    操作实例百分比。

    limits

    Integer

    操作限制

    表6 meta_data字段数据结构说明

    参数

    参数类型

    描述

    metadata_bandwidth_share_type

    String

    伸缩带宽策略中带宽对应的共享类型。

    metadata_eip_id

    String

    伸缩带宽策略中带宽对应的EIP的ID。

    metadata_eip_address

    String

    伸缩带宽策略中带宽对应的EIP地址。

  • 响应样例
    {
        "limit": 20,
        "total_number": 3,
        "start_number": 0,
        "scaling_policies": [
            {
                "scaling_policy_id": "803a35a5-38fb-4d27-a042-496c14bc1fb8",
                "scaling_policy_name": "as-policy-7a75",
                "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
                "scaling_resource_type": "SCALING_GROUP",
                "scaling_policy_type": "RECURRENCE",
                "scheduled_policy": {
                    "launch_time": "03:30",
                    "recurrence_type": "Daily",
                    "start_time": "2017-08-28T03:08Z",
                    "end_time": "2017-09-01T03:08Z"
                },
                "cool_down_time": 900,
                "scaling_policy_action": {
                    "operation": "ADD",
                    "size": 1
                },
                "policy_status": "INSERVICE",
                "create_time": "2017-08-31T03:02:41Z"
            },
            {
                "scaling_policy_id": "535fd67e-276b-409c-879e-52f4e09e14bb",
                "scaling_policy_name": "as-policy-7a75",
                "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
                "scaling_resource_type": "SCALING_GROUP",
                "scaling_policy_type": "RECURRENCE",
                "scheduled_policy": {
                    "launch_time": "21:30",
                    "recurrence_type": "Daily",
                    "start_time": "2017-08-27T21:08Z",
                    "end_time": "2017-08-31T21:08Z"
                },
                "cool_down_time": 900,
                "scaling_policy_action": {
                    "operation": "ADD",
                    "size": 1
                },
                "policy_status": "INSERVICE",
                "create_time": "2017-08-31T07:35:05Z",
    "meta_data": {
                    "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
                    "metadata_eip_address": "255.255.255.255"
                }
            },
            {
                "scaling_policy_id": "37df92f8-73cb-469e-a420-c15f445d2ee1",
                "scaling_policy_name": "as-policy-7a75",
                "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
                "scaling_resource_type": "SCALING_GROUP",
                "scaling_policy_type": "RECURRENCE",
                "scheduled_policy": {
                    "launch_time": "22:30",
                    "recurrence_type": "Daily",
                    "start_time": "2017-08-27T22:08Z",
                    "end_time": "2017-08-31T22:08Z"
                },
                "cool_down_time": 900,
                "scaling_policy_action": {
                    "operation": "ADD",
                    "size": 1
                },
                "policy_status": "INSERVICE",
                "create_time": "2017-08-31T07:41:06Z",
    "meta_data": {
                    "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
                    "metadata_eip_address": "255.255.255.255"
                }
            }
        ]
    }

返回值

  • 正常

    200

  • 异常

    返回值

    说明

    400 Bad Request

    服务器未能处理请求。

    401 Unauthorized

    被请求的页面需要用户名和密码。

    403 Forbidden

    对被请求的页面访问禁止。

    404 Not Found

    服务器无法找到被请求的页面。

    405 Method Not Allowed

    请求中指定的方法不被允许。

    406 Not Acceptable

    服务器生成的响应无法被客户端所接受。

    407 Proxy Authentication Required

    用户必须首先使用代理服务器进行验证,这样请求才会被处理。

    408 Request Timeout

    请求超出了服务器的等待时间。

    409 Conflict

    由于冲突,请求无法被完成。

    500 Internal Server Error

    请求未完成。服务异常。

    501 Not Implemented

    请求未完成。服务器不支持所请求的功能。

    502 Bad Gateway

    请求未完成。服务器从上游服务器收到一个无效的响应。

    503 Service Unavailable

    请求未完成。系统暂时异常。

    504 Gateway Timeout

    网关超时。

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读