华为云用户手册

  • 响应参数 表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 带宽:BANDW IDT H 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地址。
  • 请求示例 查询ID为8ade64b5-d685-40b8-8582-4ce306ea37a6的资源下策略类型为周期策略的伸缩策略列表信息。 GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/8ade64b5-d685-40b8-8582-4ce306ea37a6/list?scaling_policy_type=RECURRENCE
  • 响应参数 表2 响应参数 参数 参数类型 描述 scaling_policy scaling_policy object 伸缩策略详情。详情请见表 scaling_policy字段数据结构说明。 表3 scaling_policy字段数据结构说明 参数 参数类型 描述 scaling_group_id String 伸缩组ID scaling_policy_name String 伸缩策略名称。 支持模糊匹配。 scaling_policy_id String 伸缩策略ID 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时间。 表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:增加实例 REMOVE:减少实例 SET:设置实例数为 instance_number Integer 操作实例个数。 instance_percentage Integer 操作实例百分比。
  • 响应示例 { "scaling_policy": { "scaling_policy_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3", "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a", "scaling_policy_name": "定时1", "scaling_policy_type": "SCHEDULED", "scheduled_policy": { "launch_time": "2015-07-24T01:21Z" }, "cool_down_time": 300, "scaling_policy_action": { "operation": "REMOVE", "instance_number": 1 }, "policy_status": "INSERVICE", "create_time": "2015-07-24T01:09:30Z" }}
  • 返回值 正常 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 网关超时。
  • 返回值 正常 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 网关超时。
  • 响应示例 { "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" } } ]}
  • 功能介绍 根据输入条件过滤查询弹性伸缩策略,支持查询当前租户下全量伸缩策略。查询结果分页显示。 可根据伸缩资源ID,伸缩资源类型,伸缩策略名称,伸缩策略ID,告警ID,企业项目ID,起始行号,记录数,排序方式等条件进行过滤查询。 若不加过滤添加默认查询该租户下最多20条伸缩策略信息。 已释放EIP对应的伸缩带宽策略仍然会占用配额,且只能使用华为云帐号和有全局权限的 IAM 用户进行查询,授予部分企业项目的IAM用户查询不到该伸缩带宽策略。
  • 请求示例 查询伸缩资源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地址。
  • 请求示例 修改ID为0h327883-324n-4dzd-9c61-68d03ee191dd的伸缩策略,修改其名称为policy_01,修改其生效时间为从2016-01-08T17:31Z到2016-02-08T17:31Z且每天下午四点执行,设置实例数为2的周期性策略。 PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/0h327883-324n-4dzd-9c61-68d03ee191dd{ "scaling_policy_type": "RECURRENCE", "scaling_policy_name": "policy_01", "scheduled_policy": { "launch_time": "16:00", "recurrence_type": "Daily", "end_time": "2016-02-08T17:31Z", "start_time": "2016-01-08T17:31Z" }, "scaling_policy_action": { "operation": "SET", "instance_number": 2 }}
  • 返回值 正常 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 网关超时。
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 scaling_policy_name 否 String 伸缩策略名称(1-64个字符),只能包含中文、字母、数字、下划线或中划线。 scaling_policy_type 否 String 策略类型 告警策略:ALARM(与alarm_id对应) 定时策略:SCHEDULED(与scheduled_policy对应) 周期策略:RECURRENCE(与scheduled_policy对应) alarm_id 否 String 告警ID,即告警规则的ID,当scaling_policy_type为ALARM时该项必选,此时scheduled_policy不生效。 修改成功后,会自动为该告警ID对应的告警规则的alarm_actions字段增加类型为autoscaling的告警触发动作。 告警ID通过查询 云监控 告警规则列表获取,请参考《云监控API参考》的“查询告警规则列表”。 scheduled_policy 否 scheduled_policy object 定时、周期任务策略,当scaling_policy_type为SCHEDULED或RECURRENCE时该项必选,此时alarm_id不生效。请参考表 scheduled_policy字段数据结构说明。 scaling_policy_action 否 scaling_policy_action object 策略执行具体动作。请参考表 scaling_policy_action字段数据结构说明。 cool_down_time 否 Integer 冷却时间,取值范围0-86400,单位是秒。 表3 scheduled_policy字段数据结构说明 参数 是否必选 参数类型 描述 launch_time 是 String 触发时间,遵循UTC时间。 如果scaling_policy_type为SCHEDULED,则格式为:YYYY-MM-DDThh:mmZ。 如果scaling_policy_type为RECURRENCE,则格式为:hh:mm。 recurrence_type 否 String 周期触发类型,scaling_policy_type为RECURRENCE时该项必选。 Daily:每天执行一次 Weekly:每周指定天执行一次。 Monthly:每月指定天执行一次。 recurrence_value 否 String 周期触发任务数值,scaling_policy_type为RECURRENCE时该项必选。 类型为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时间,scaling_policy_type为RECURRENCE时该项必选。 当为周期类型策略时,不得早于当前时间和开始时间 格式为:YYYY-MM-DDThh:mmZ。 表4 scaling_policy_action字段数据结构说明 参数 是否必选 参数类型 描述 operation 否 String 操作选项,默认为ADD。 ADD:增加实例 REMOVE/REDUCE:减少实例 SET:设置实例数为 instance_number 否 Integer 操作实例个数,默认为1。当配额为默认配额时,取值范围如下: operation为SET时,取值范围为:0~300。 operation为ADD或REMOVE/REDUCE时,取值范围为:1~300。 说明: 配置参数时,instance_number和instance_percentage参数只能选其中一个进行配置。 instance_percentage 否 Integer 操作实例百分比,将伸缩组容量增加、减少或设置为伸缩组当前实例个数的百分比。操作为ADD或REMOVE/REDUCE时取值范围为1到20000的整数,操作为SET时取值范围为0到20000的整数。 当instance_number和instance_percentage参数均无配置时,则操作实例个数为1。 配置参数时,instance_number和instance_percentage参数只能选其中一个进行配置。
  • 请求示例 批量启用ID为policy_id1和policy_id2的伸缩策略。 POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action{ "action": "resume", "scaling_policy_id": [ "policy_id1", "policy_id2" ]}
  • 返回值 正常 204 异常 返回值 说明 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 网关超时。
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 scaling_policy_id 是 Array of strings 伸缩策略ID action 是 String 批量操作伸缩策略action标识: 删除:delete 启用:resume 停止:pause force_delete 否 String 是否强制删除伸缩策略,不强制删除伸缩策略时,无法删除执行中状态的伸缩策略。取值如下: no:不强制删除伸缩策略,默认为no。 yes:强制删除伸缩策略。 只有action为delete时,该字段才生效。 delete_alarm 否 String 是否删除告警策略使用的告警规则。可选值为yes或no,默认为no。 只有action为delete时,该字段才生效。
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 scaling_policy_name 是 String 伸缩策略名称(1-64个字符),只能包含中文、字母、数字、下划线或中划线。 scaling_resource_id 是 String 伸缩资源ID,伸缩组唯一标识或带宽唯一标识 如果scaling_resource_type为SCALING_GROUP,对应伸缩组唯一标识即伸缩组ID。 如果scaling_resource_type为BANDWIDTH,对应带宽唯一标识即带宽ID。 说明: 弹性伸缩不支持对包年包月的带宽进行调整。 scaling_resource_type 是 string 伸缩资源类型 伸缩组:SCALING_GROUP 带宽:BANDWIDTH scaling_policy_type 是 String 策略类型 告警策略:ALARM(与alarm_id对应) 定时策略:SCHEDULED(与scheduled_policy对应) 周期策略:RECURRENCE(与scheduled_policy对应) alarm_id 否 String 告警ID,即告警规则的ID,当scaling_policy_type为ALARM时该项必选,此时scheduled_policy不生效。 创建告警策略成功后,会自动为该告警ID对应的告警规则的alarm_actions字段增加类型为autoscaling的告警触发动作。 告警ID通过查询云监控告警规则列表获取,请参考《云监控API参考》的“查询告警规则列表”。 scheduled_policy 否 scheduled_policy object 定时、周期任务策略,当scaling_policy_type为SCHEDULED或RECURRENCE时该项必选,此时alarm_id不生效。详情请见表 scheduled_policy字段数据结构说明。 scaling_policy_action 否 scaling_policy_action object 策略执行具体动作。详情请见表 scaling_policy_action字段数据结构说明。 cool_down_time 否 Integer 冷却时间,取值范围0-86400,默认为300,单位是秒。 description 否 String 伸缩策略描述(1-256个字符)。 表3 scheduled_policy字段数据结构说明 参数 是否必选 参数类型 描述 launch_time 是 String 触发时间,遵循UTC时间。 如果scaling_policy_type为SCHEDULED,则格式为:YYYY-MM-DDThh:mmZ。 如果scaling_policy_type为RECURRENCE,则格式为:hh:mm。 recurrence_type 否 String 周期触发类型,scaling_policy_type为RECURRENCE时该项必选。 Daily:每天执行一次 Weekly:每周指定天执行一次。 Monthly:每月指定天执行一次。 recurrence_value 否 String 周期触发任务数值,scaling_policy_type为RECURRENCE时该项必选。 类型为Daily时,该字段为null,表示每天执行 类型为Weekly时,该字段取值范围为1-7,1表示星期日,以此类推,以“,”分割,例如:1,3,5。 类型为Monthly时,该字段取值范围为1-31,分别表示每月的日期,以“,”分割,例如:1,10,13,28。 说明: 当recurrence_type类型为Daily时,recurrence_value参数不生效。 start_time 否 String 周期策略重复执行开始时间,遵循UTC时间,默认为当前时间。 格式为:YYYY-MM-DDThh:mmZ。 end_time 否 String 周期策略重复执行结束时间,遵循UTC时间,scaling_policy_type为RECURRENCE时该项必选。当为周期类型策略时,不得早于当前时间和开始时间。 格式为:YYYY-MM-DDThh:mmZ。 表4 scaling_policy_action字段数据结构说明 参数 是否必选 参数类型 描述 operation 否 String 操作选项,默认为ADD。 当scaling_resource_type为SCALING_GROUP,支持如下操作: ADD:增加 REMOVE/REDUCE:减少 SET:设置为 当scaling_resource_type为BANDWIDTH,支持如下操作: ADD:增加 REDUCE:减少 SET:设置为 size 否 Integer 操作大小,取值范围为0到300的整数,默认为1。只有操作为SET时取值可以为0,其余操作取值均不能为0。 当scaling_resource_type为SCALING_GROUP时,size为实例个数,取值范围为0到300的整数,默认为1。 当scaling_resource_type为BANDWIDTH时,size表示带宽大小,单位为Mbit/s,取值范围为1到300的整数,默认为1。 当scaling_resource_type为SCALING_GROUP时,size和percentage参数只能选其中一个进行配置。 percentage 否 Integer 操作百分比,操作为ADD或REMOVE/REDUCE时取值范围为1到20000的整数,操作为SET时取值范围为0到20000的整数。 当scaling_resource_type为SCALING_GROUP时,size和percentage参数只能选其中一个进行配置,如果size和percentage参数均无配置,则size默认为1。 当scaling_resource_type为BANDWIDTH时,不支持配置percentage参数。 limits 否 Integer 操作限制 当scaling_resource_type为BANDWIDTH,且operation不为SET时,limits参数生效,单位为Mbit/s。 当operation为ADD时,limits表示带宽可调整的上限; 当operation为REDUCE时,limits表示带宽可调整的下限。
  • 返回值 正常 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 网关超时。
  • 请求示例 创建一个名称为hth_aspolicy_1的告警策略,使用的告警规则ID为al1513822380493GvlJKZwA8,每当告警规则达到告警阈值后,该策略会使ID为8ade64b5-d685-40b8-8582-4ce306ea37a6的带宽增加1Mbit/s,直到带宽值达到限制10Mbit/s。 POST https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy{ "alarm_id": "al1513822380493GvlJKZwA8", "cool_down_time": 900, "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "BANDWIDTH", "scaling_policy_action": { "size": 1, "operation": "ADD", "limits": 10 }, "scaling_policy_name": "hth_aspolicy_1", "scaling_policy_type": "ALARM"}
  • 返回值 正常 204 异常 返回值 说明 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 网关超时。
  • 返回值 正常 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 网关超时。
  • 响应示例 { "limit": 20, "scaling_activity_log": [ { "id": "66e0f775-c4ac-4b52-9d5c-f93ba217aa5f", "instance_value": 1, "desire_value": 0, "scaling_value": 1, "start_time": "2019-03-18T16:00:11Z", "end_time": "2019-03-18T16:00:32Z", "instance_added_list": null, "instance_deleted_list": "as-config-bblh-ONQE551S", "instance_removed_list": null, "status": "SUC CES S", "description": "{\"reason\":[{\"change_reason\":\"RECURRENCE\",\"old_value\":1,\"scaling_policy_name\":\"as-policy-bvfk\",\"change_time\":\"2019-03-18T16:00:00Z\",\"new_value\":0,\"scaling_policy_id\":\"05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6\"}]}" }, { "id": "c3a1fff6-84a3-4cbc-8ac0-e3b0f645ecd8", "instance_value": 0, "desire_value": 1, "scaling_value": 1, "start_time": "2019-03-16T10:21:11Z", "end_time": "2019-03-16T10:25:12Z", "instance_added_list": "as-config-bblh-ONQE551S", "instance_deleted_list": null, "instance_removed_list": null, "status": "SUCCESS", "description": "{\"reason\":[{\"change_reason\":\"DIFF\",\"old_value\":0,\"change_time\":\"2019-03-16T10:21:11Z\",\"new_value\":1}]}" }], "total_number": 2, "start_number": 0}
  • URI GET /autoscaling-api/v1/{project_id}/scaling_activity_log/{scaling_group_id} 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_group_id 是 String 伸缩组ID start_time 否 String 查询的起始时间,遵循UTC时间,格式是“yyyy-MM-ddThh:mm:ssZ”。 end_time 否 String 查询的截止时间,遵循UTC时间,格式是“yyyy-MM-ddThh:mm:ssZ”。 start_number 否 Integer 查询的起始行号,默认为0。最小值为0。 limit 否 Integer 查询的记录条数,默认为20。取值范围为:0~100。
  • 响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数 start_number Integer 查询的起始行号 limit Integer 查询记录数 scaling_activity_log Array of scaling_activity_log objects 伸缩活动日志列表。详情请见表 scaling_activity_log字段数据结构说明。 表3 scaling_activity_log字段数据结构说明 参数 参数类型 描述 status String 伸缩活动状态: SUCCESS:成功 FAIL:失败 DOING:伸缩过程中 start_time String 伸缩活动触发时间,遵循UTC时间。 end_time String 伸缩活动结束时间,遵循UTC时间。 id String 伸缩活动日志ID instance_removed_list String 完成伸缩活动且只被移出弹性伸缩组的云服务器名称列表,云服务器名之间以逗号分割。 instance_deleted_list String 完成伸缩活动且被移出弹性伸缩组并删除的云服务器名称列表,云服务器名之间以逗号分割。 instance_added_list String 完成伸缩活动且被加入弹性伸缩组的云服务器名称列表,云服务器名之间以逗号分割。 scaling_value String 伸缩活动中变化(增加或减少)的云服务器数量。 description String 伸缩活动的描述信息。 instance_value Integer 伸缩组当前实例数值。 desire_value Integer 伸缩活动最终期望实例数值。
  • 响应示例 { "limit": 20, "scaling_policy_execute_log": [ { "id": "b86e4175-30cb-4b1e-a332-83f9ee472c58", "status": "SUCCESS", "type": "REMOVE", "tenant_id": "0428982a1b8039f42f01c005edde7c0d", "scaling_resource_type": "SCALING_GROUP", "scaling_resource_id": "1f2d3e73-7ef6-40b3-a8fa-514b68eccaa7", "scaling_policy_id": "05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6", "old_value": "1", "desire_value": "0", "limit_value": "0", "execute_time": "2019-03-18T16:00:00Z", "execute_type": "RECURRENCE", "job_records": [ { "message": "modify desire number of scaling group", "job_name": "ADJUST_VM_NUMBERS", "record_type": "MEG", "record_time": "2019-03-18T16:00:00Z", "job_status": "SUCCESS" } ] } ], "total_number": 1, "start_number": 0}
  • 返回值 正常 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 网关超时。
  • 响应参数 表2 响应参数 参数 参数类型 描述 total_number Integer 总记录数 start_number Integer 查询的起始行号 limit Integer 查询记录数 scaling_policy_execute_log Array of scaling_policy_execute_log objects 伸缩策略执行日志列表。详情请见表 scaling_policy_execute_log字段数据结构说明。 表3 scaling_policy_execute_log字段数据结构说明 参数 参数类型 描述 status String 策略执行状态: SUCCESS:成功 FAIL:失败 EXECUTING:执行中 failed_reason String 策略执行失败原因 execute_type String 策略执行类型: SCHEDULE:自动触发(定时) RECURRENCE:自动触发(周期) ALARM:自动触发(告警) MANUAL:手动触发 execute_time String 策略执行时间,遵循UTC时间。 id String 策略执行日志ID tenant_id String 项目ID scaling_policy_id String 伸缩策略ID scaling_resource_type String 伸缩资源类型 伸缩组:SCALING_GROUP 带宽:BANDWIDTH scaling_resource_id String 伸缩资源ID old_value String 伸缩原始值 desire_value String 伸缩目标值 limit_value String 操作限制 当scaling_resource_type为BANDWIDTH时,且operation不为SET时,limit_value生效,单位为Mbit/s。 此时, 当operation为ADD时,limit_value表示最高带宽限制; 当operation为REDUCE时,limit_value表示最低带宽限制。 type String 策略执行任务类型 ADD:增加 REMOVE:减少 SET:设置为 job_records Array of job_records objects 策略执行动作包含的具体任务。详情请见表 job_records字段数据结构说明。 meta_data meta_data object 附加信息。详情请见表 meta_data字段数据结构说明。 表4 job_records字段数据结构说明 参数 参数类型 描述 job_name String 任务名称 record_type String 记录类型 API:接口调用类型 MEG:消息类型 record_time String 记录时间 request String 请求体,仅当record_type为API时有效 response String 返回体,仅当record_type为API时有效 code String 返回码,仅当record_type为API时有效 message String 消息,仅当record_type为MEG时有效 job_status String job执行状态: SUCCESS:成功 FAIL:失败 表5 meta_data字段数据结构说明 参数 参数类型 描述 metadata_bandwidth_share_type String 伸缩带宽策略中带宽对应的共享类型。 metadata_eip_id String 伸缩带宽策略中带宽对应的EIP的ID。 metadataeip_address String 伸缩带宽策略中带宽对应的EIP地址。
  • URI GET /autoscaling-api/v1/{project_id}/scaling_policy_execute_log/{scaling_policy_id} 可以在URI后面用‘?’和‘&’添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求示例。 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID scaling_policy_id 是 String 伸缩策略ID log_id 否 String 策略执行日志ID scaling_resource_type 否 String 伸缩资源类型 伸缩组:SCALING_GROUP 带宽:BANDWIDTH scaling_resource_id 否 String 伸缩资源ID execute_type 否 String 策略执行类型: SCHEDULED:自动触发(定时) RECURRENCE:自动触发(周期) ALARM:自动触发(告警) MANUAL:手动触发 start_time 否 String 查询的起始时间,遵循UTC时间,格式是“yyyy-MM-ddThh:mm:ssZ”。 end_time 否 String 查询的截止时间,遵循UTC时间,格式是“yyyy-MM-ddThh:mm:ssZ”。 start_number 否 Integer 查询的起始行号,默认为0。最小值为0。 limit 否 Integer 查询的记录条数,默认为20。取值范围为:0~100。
  • 响应示例 { "quotas": { "resources": [ { "type": "scaling_Group", "used": 2, "quota": 25, "max": 50, "min": 0 }, { "type": "scaling_Config", "used": 3, "quota": 100, "max": 200, "min": 0 }, { "type": "scaling_Policy", "used": -1, "quota": 50, "max": 50, "min": 0 }, { "type": "scaling_Instance", "used": -1, "quota": 200, "max": 1000, "min": 0 }, { "type": "bandwidth_scaling_policy", "used": 1, "quota": 10, "max": 100, "min": 0 } ] }}
  • 返回值 正常 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 网关超时。
共100000条