华为云用户手册

  • 导出原始需求 选择导出部分或全部原始需求。 导出全部:在“原始需求”主页,单击搜索栏最右侧的图标,选择“导出全部”,弹出“选择导出字段”窗口。 导出部分:在原始需求列表中,勾选一个或多个需要导出的原始需求,单击页面下方的“导出”,弹出“选择导出字段”窗口。 选择需要导出的字段,及是否导出子需求。 单击“导出”,弹出导出进度提示框。 导出成功后,单击“下载”,可将原始需求数据下载到本地。 下载的原始需求文件格式为“.xlsx”。
  • 操作步骤 选择导出部分或全部特性。 导出全部:在“工作项”主页,单击搜索栏最右侧的图标,选择“导出全部”,弹出“选择导出字段”窗口。 导出部分:在工作项列表中,勾选一个或多个需要导出的工作项,单击页面下方的“导出”,弹出“选择导出字段”窗口。 选择需要导出的字段,及是否导出子需求。 单击“导出”,弹出导出进度提示框。 导出成功后,单击“下载”,可将工作项数据下载到本地。 下载的工作项文件格式为“.xlsx”。
  • 开通场景 在服务所支持的区域内,各区域独立开通购买、独立计费。 2020年10月16日前,未在某个区域下产生过费用的用户,按照新版计费规则,需在该区域开通/购买套餐后使用服务。 在该区域内产生过费用的用户,延续旧版计费规则,可参考开通按需在该区域开通服务按需计费。 例如: 用户于2020年3月在“华北-北京四”购买了半年期的包月套餐。由于疫情影响业务,套餐到期后关闭了服务;2020年10月20日将重新启用。 若用户仍使用“华北-北京四”,可以开通/购买旧版套餐,或单独开通需求管理服务使用。 若用户使用其它区域,则需开通/购买新版计费。
  • 开通说明 软件开发生产线提供了以下开通方式: 组合开通:包月套餐购买、服务组合开通方式,请参见快速购买/开通套餐。 单独开通:单独开通需求管理服务。 服务的开通需要区分区域,且各区域资源不互通。因此开通前注意选择自己需要开通的区域。 服务开通后,需注意创建的资源也分区域。 例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目A”时,需先切换到“项目A”所在区域“华北-北京四”。 Wiki和文档托管服务:默认随需求管理服务开通。 仅开通了专业版或铂金版才支持使用IPD系统设备类项目模型和IPD独立软件类项目模型。
  • IPD自运营软件/云服务类项目功能介绍 IPD自运营软件/云服务类项目是面向云服务软件类开发场景的IPD需求管理方法,通过端到端客户价值需求管理、灵活轻便的敏捷规划、强大的跨项目协作能力来对云服务软件进行高质高效的管理,主要包含原始需求、战略举措、特性、用户故事等内容。 图1 IPD自运营软件/云服务类项目 原始需求(RR)只支持分解为用户故事(US),跟战略举措(Epic)和特性(FE)属于同层级关系,但是在原始需求(RR)的“关联项”中支持与战略举措(Epic)、特性(FE)进行关联。 战略举措(Epic)支持分解为特性(FE),而特性(FE)又可以分解为用户故事(US)。 相比战略举措(Epic),特性(FE)更具体、更形象,客户可以感知,具有业务价值。用户故事(US)则是从用户角度对产品功能的详细描述,具有用户价值。 IPD自运营软件/云服务类项目的重要操作如表1所示。 表1 IPD自运营软件/云服务类项目操作说明 功能 说明 相关操作 原始需求(RR) 原始需求是以客户视角描述的原始问题或者原始诉求。其中,客户需求是原始需求的一种类别,此类需求需要RMT/RAT分析评审后作出决定。 新建原始需求 处理原始需求 战略举措(Epic) 产品的愿景目标,通过Epic的定义和实现,使产品团队能够把握产品发展方向,并最终获取相应的商业回报。在具体交付中,Epic通常面向产品投资方或决策层,用来组织和呈现特性细节。 新建工作项 处理工作项 特性(FE) 特性是产品包需求或服务支撑“客户问题(PB)”所具备的重大能力。 产品包需求:由产品经理/规划代表规划出来的、完整一致的、成系列的一组正式需求。 原则上特性是产品包的主要卖点(销售亮点)集合,每条特性都是满足客户特定商业价值诉求的端到端解决方案。其中,有一部分特性是可以通过License控制单独销售。 客户问题(PB) :客户面对的挑战与机会(客户战略与痛点),也就是该产品或服务为客户解决的核心问题。通过解决核心问题为客户带来核心价值。 用户故事(US) 对用户或客户有价值的功能点的简单描述,遵循INVEST原则。US间是解耦的,能够独立交付,是敏捷迭代交付基础。 父主题: IPD自运营软件/云服务类项目
  • 返回值 正常 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 网关超时。
  • 响应示例 { "scaling_policy": { "scaling_policy_id": "906f73ff-56e8-41b2-a005-8157d0c60361", "scaling_policy_name": "hth_aspolicy_1", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "BANDW IDT H", "scaling_policy_type": "ALARM", "alarm_id": "al1513822380493GvlJKZwA8", "scheduled_policy": { }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1, "limits": 111 }, "policy_status": "INSERVICE", "create_time": "2018-03-21T08:03:35Z", "meta_data": { "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e", "metadata_eip_address": "255.255.255.255" } }}
  • 响应参数 表2 响应参数 参数 参数类型 描述 scaling_policy scaling_policy object 伸缩策略详情。详情请见表 scaling_policy字段数据结构说明。 表3 scaling_policy字段数据结构说明 参数 参数类型 描述 scaling_resource_id String 伸缩资源ID scaling_resource_type string 伸缩资源类型 伸缩组:SCALING_GROUP 带宽:BANDWIDTH 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时间。 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地址。
  • 操作步骤 确定调用API鉴权时使用的token。 查询token,详情请参见获取用户Token。 获取响应Header参数中X-Subject-Token对应的值。 确定要启用的伸缩组。 查询伸缩组列表。 接口相关信息 URI格式:GET /autoscaling-api/v1/{project_id}/scaling_group 详情请参见查询弹性伸缩组列表。 请求示例 示例为查询满足条件“伸缩配置ID为1d281494-6085-4579-b817-c1f813be835f”的伸缩组列表。 GET https://{Endpoint}/autoscaling-api/v1/0605767c2e80d5762fd0c0146a10aaf2/scaling_group?scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835f {endpoint}信息请从地区和终端节点获取。 响应示例 { "limit": 20, "scaling_groups": [ { "networks": [ { "id": "a8327883-6b07-4497-9c61-68d03ee193a", "ipv6_enable": true, "ipv6_bandwidth": { "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5" } } ], "available_zones": [ "XXXa", "XXXb" ], "detail": null, "scaling_group_name": "as-group-test", "scaling_group_id": "77a7a397-7d2f-4e79-9da9-6a35e2709150", "scaling_group_status": "INSERVICE", "scaling_configuration_id": "1d281494-6085-4579-b817-c1f813be835f", "scaling_configuration_name": "healthCheck", "current_instance_number": 0, "desire_instance_number": 1, "min_instance_number": 0, "max_instance_number": 500, "cool_down_time": 300, "lb_listener_id": "f06c0112570743b51c0e8fbe1f235bab", "security_groups": [ { "id": "8a4b1d5b-0054-419f-84b1-5c8a59ebc829" } ], "create_time": "2015-07-23T02:46:29Z", "vpc_id": "863ccae2-ee85-4d27-bc5b-3ba2a198a9e2", "health_periodic_audit_method": "ELB_AUDIT", "health_periodic_audit_time": 5, "health_periodic_audit_grace_period": 600, "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE", "is_scaling": false, "delete_publicip": false, "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", "multi_az_priority_policy": "PICK_FIRST" } ], "total_number": 1, "start_number": 0} 选择需要启用的伸缩组,并记录伸缩组ID。 启用选定的弹性伸缩组。 接口相关信息 URI格式:POST /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action 详情请参见启用或停止弹性伸缩组。 请求示例 POST: https://{Endpoint}/autoscaling-api/v1/0605767c2e80d5762fd0c0146a10aaf2/scaling_group/77a7a397-7d2f-4e79-9da9-6a35e2709150/action {endpoint}信息请从地区和终端节点获取。 Body: { "action": "resume"} 响应示例 HTTP状态码正常返回204。
  • 返回值 正常 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 网关超时。
  • 响应示例 { "tags": [ { "key": "ENV15", "values": [ "ENV15" ] }, { "key": "111", "values": [ "" ] }, { "key": "environment", "values": [ "DEV" ] }, { "key": "ENV151", "values": [ "ENV151" ] }, { "key": "ENV152", "values": [ "ENV152" ] } ] }
  • 返回值 正常 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 网关超时。
  • URI GET /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 项目ID resource_type 是 String 资源类型,枚举类: scaling_group_tag:资源类型为伸缩组。 resource_id 是 String 资源ID
  • 响应示例 { "tags": [ { "key": "ENV15", "value": "ENV15" }, { "key": "ENV151", "value": "ENV151" }, { "key": "ENV152", "value": "ENV152" } ], "sys_tags": null }
  • 响应参数 表2 响应参数 参数 参数类型 描述 tags Array of ResourceTag objects 资源标签列表。详情请见表 ResourceTag字段数据结构说明。 sys_tags Array of ResourceTag objects 系统资源标签列表。详情请见表 ResourceTag字段数据结构说明。 表3 ResourceTag字段数据结构说明 参数 参数类型 描述 key String 资源标签键 value String 资源标签值
  • 返回值 正常 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 网关超时。
  • 概述 欢迎使用弹性伸缩(Auto Scaling)。弹性伸缩是根据用户的业务需求,通过策略自动调整其业务资源(弹性云服务器和带宽资源)的服务。您可以根据业务需求自行定义伸缩策略,从而降低人为反复调整资源以应对业务变化和负载高峰的工作量,帮您节约资源和人力运维成本。您可以使用本文档提供的API对伸缩组等资源进行相关操作,如创建、删除、修改等。支持的全部操作请参见API概览。 在调用弹性伸缩API之前,请确保已经充分了解弹性伸缩相关概念,详细信息请参见产品介绍。 父主题: 使用前必读
  • 响应示例 { "versions": [ { "id": "v1", "links": [ { "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2016-06-30T00:00:00Z", "version": "" }, { "id": "v2", "links": [ { "href": "https://as.XXX.mycloud.com/autoscaling-api/v2/", "rel": "self" } ], "min_version": "", "status": "SUPPORTED", "updated": "2018-03-30T00:00:00Z", "version": "" } ]}
  • 响应参数 表1 响应参数 参数 参数类型 描述 versions Array of versions objects 描述弹性伸缩API版本信息列表。 表2 versions字段数据结构说明 参数 参数类型 描述 id String API版本ID links Array of links objects API 的url地址,详情请见表3 links字段数据结构说明。 min_version String API支持的最小微版本号。 status String API版本状态: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还在继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String API版本发布时间 version String API支持的最大微版本号 表3 links字段数据结构说明 参数 参数类型 描述 href String API的url地址 rel String API的url地址依赖
  • 返回值 正常 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 网关超时。
  • API概览 通过使用弹性伸缩所提供的接口,您可以完整的使用弹性伸缩的所有功能,例如创建伸缩组。弹性伸缩支持的接口见表1。 表1 弹性伸缩接口说明 子类型 说明 弹性伸缩组 实现伸缩组的创建、查询、修改、删除等操作。 弹性伸缩配置 实现伸缩配置的创建、查询、删除等操作。 弹性伸缩实例 实现伸缩实例的查询、移出伸缩组等操作。 弹性伸缩策略 实现伸缩策略的创建、查询、修改、删除等操作。 伸缩策略执行日志 查询伸缩策略执行的历史记录。 伸缩活动日志 查询伸缩活动日志。 配额 查询指定租户的弹性伸缩组、伸缩配置、伸缩策略和伸缩实例的配额总数及已使用配额数。 通知 提供配置伸缩组通知、查询伸缩组通知列表和删除伸缩组通知功能。 生命周期挂钩 提供创建、查询、修改和删除生命周期挂钩等功能。 标签管理 提供查询租户或资源标签、创建或删除标签和查询资源实例的功能。 弹性伸缩API管理 提供查询弹性伸缩API版本信息的功能。
  • 监控指标 指标 指标名称 含义 取值范围 备注 cpu_util CPU使用率 该指标用于统计测量对象中所有云服务器的CPU使用率的均值。 ≥0% 测量对象为弹性伸缩组。 mem_util 内存使用率 该指标用于统计测量对象中所有云服务器的内存使用率的均值。 ≥0% 测量对象为弹性伸缩组。 说明: 如果用户使用的镜像未安装vmtools,则无法获取该监控指标。 network_incoming_bytes_rate_inband 带内网络流入速率 该指标用于统计测量对象中所有云服务器的网络流入速率的均值。 ≥0 Byte/s 测量对象为弹性伸缩组。 network_outgoing_bytes_rate_inband 带内网络流出速率 该指标用于统计测量对象中所有云服务器的网络流出速率的均值。 ≥0 Byte/s 测量对象为弹性伸缩组。 instance_num 实例数 该指标用于统计测量对象中可用的云服务器数量。 ≥0 测量对象为弹性伸缩组。 可用的云服务器是指伸缩组中生命周期状态为“INSERVICE”的实例。 disk_read_bytes_rate 磁盘读速率 该指标用于统计每秒从测量对象中所有云服务器读出的数据量,以字节/秒为单位。 ≥0 Byte/s 测量对象为弹性伸缩组。 disk_write_bytes_rate 磁盘写速率 该指标用于统计每秒写到测量对象中所有云服务器的数据量,以字节/秒为单位。 ≥0 Byte/s 测量对象为弹性伸缩组。 disk_read_requests_rate 磁盘读操作速率 该指标用于统计每秒从测量对象中所有云服务器读取数据的请求次数,以请求/秒为单位。 ≥0 request/s 测量对象为弹性伸缩组。 disk_write_requests_rate 磁盘写操作速率 该指标用于统计每秒往测量对象中所有云服务器写数据的请求次数,以请求/秒为单位。 ≥0 request/s 测量对象为弹性伸缩组。 对于不同的操作系统,监控指标“内存使用率”、“带内网络流出速率”和“带内网络流入速率”是否支持,详细信息请参见《弹性云服务器用户指南》。
  • 响应示例 { "version": { "id": "v1", "links": [ { "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/", "rel": "self" } ], "min_version": "", "status": "CURRENT", "updated": "2016-06-30T00:00:00Z", "version": "" }}
  • 响应参数 表2 响应参数 参数 参数类型 描述 version version object 描述弹性伸缩API指定版本信息。 表3 version字段数据结构说明 参数 参数类型 描述 id String API版本ID links Array of links objects API 的url地址,详情请见表4 links字段数据结构说明。 min_version String API支持的最小微版本 status String API版本状态: CURRENT:表示该版本为主推版本。 SUPPORTED:表示为老版本,但是现在还在继续支持。 DEPRECATED:表示为废弃版本,存在后续删除的可能。 updated String API版本发布时间 version String API支持的最大微版本号 表4 links字段数据结构说明 参数 参数类型 描述 href String API的url地址 rel String API的url地址依赖
  • 返回值 正常 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 网关超时。
  • 调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为 IAM 的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}
  • 操作步骤 Token认证,具体操作请参考认证鉴权。 获取项目ID(project_id),具体操作请参考获取项目ID。 在Request Header中增加“Content-Type”键,值为“application/json”。 在Request Header中增加“X-Auth-Token”键,值为1获取到的token。 发送“POST https://AS的Endpoint/v1/{project_id}/scaling_group”,project_id为2获取到的项目ID。 在Request Body中传入参数如下: { "scaling_group_name": "GroupNameTest",//伸缩组名称(必填String) "scaling_configuration_id": "47683a91-93ee-462a-a7d7-484c006f4440",//伸缩配置ID(非必填String,但启动伸缩组时组内必有伸缩配置) "desire_instance_number": 0,//期望实例数(非必填Integer) "min_instance_number": 0,//最小实例数(非必填Integer) "max_instance_number": 0,//最大实例数(非必填Integer) "cool_down_time": 200,//冷却时间(非必填Integer) "health_periodic_audit_method": "NOVA_AUDIT",//伸缩组实例健康检查方式(非必填String) "health_periodic_audit_time": 5,//伸缩组实例健康检查周期(非必填Integer) "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",//伸缩组实例移除策略(非必填String) "vpc_id": "a8327883-6b07-4497-9c61-68d03ee193a",//VPC信息(必填String) "networks": [ { "id": "3cd35bca-5a10-416f-8994-f79169559870" } ]//子网信息(必填列表数据结构)} 请求响应成功后,返回scaling_group_id。表示弹性伸缩组创建成功。 若请求失败,则会返回错误码及对应的错误信息说明,详细请参考错误码。 根据获取到的scaling_group_id,可对弹性伸缩组进行查询、修改、删除等操作。
  • 返回值 正常 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 网关超时。
  • 请求示例 修改ID为a8327883-6b07-4497-9c61-68d03ee193a1的伸缩组,修改其名称、伸缩配置、企业项目、期望实例数、最小实例数、最大实例数和冷却时间等参数。 PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1{ "scaling_group_name": "group_1", "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2", "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413", "desire_instance_number": 1, "min_instance_number": 1, "max_instance_number": 3, "cool_down_time": 200, "multi_az_priority_policy": "PICK_FIRST", "iam_agency_name":"test"}
  • 请求参数 表2 请求参数 参数 是否必选 参数类型 描述 scaling_group_name 否 String 伸缩组名称(1-64个字符),只能包含中文、字母、数字、下划线或中划线。 desire_instance_number 否 Integer 期望实例数量。 最小实例数≤期望实例数≤最大实例数。 min_instance_number 否 Integer 最小实例数量。 max_instance_number 否 Integer 最大实例数量,大于等于最小实例数。 cool_down_time 否 Integer 冷却时间,取值范围0-86400,默认为300,单位是秒。 available_zones 否 Array of strings 可用区信息。弹性伸缩活动中自动添加的云服务器会被创建在指定的可用区中。如果没有指定可用区,会由系统自动指定可用区。 详情请参考地区和终端节点。 仅当伸缩组中无伸缩活动时,才可以修改可用区配置。 networks 否 Array of networks objects 网络信息,最多支持选择5个子网,传入的第一个子网默认作为云服务器的主网卡。获取子网信息请参考查询子网列表。数据结构信息请参考表4。 仅当同时满足以下条件时,才可以修改: 伸缩组中无伸缩活动 实例数为0 伸缩组为非启用状态 security_groups 否 Array of security_groups objects 安全组信息,仅支持选择1个安全组。获取安全组信息请参考查询安全组列表。数据结构信息请参考表7。 当伸缩配置和伸缩组同时指定安全组时,将以伸缩配置中的安全组为准;当伸缩配置和伸缩组都没有指定安全组时,增加的弹性云服务器将使用默认安全组。为了使用灵活性更高,推荐在伸缩配置中指定安全组。仅当同时满足以下条件时,才可以修改: 伸缩组中无伸缩活动 实例数为0 伸缩组为非启用状态 lb_listener_id 否 String 弹性负载均衡监听器ID,最多支持绑定6个负载均衡监听器,多个负载均衡监听器ID以逗号分隔。获取监听器ID的方法请参考查询负载均衡器列表。 仅当同时满足以下条件时,才可以修改: 伸缩组中无伸缩活动 lbaas_listeners 否 Array of lbaas_listeners objects 弹性负载均衡器信息,最多支持绑定6个负载均衡。列表数据结构请参考表3。获取负载均衡器的信息请参考查询后端云服务器组。 health_periodic_audit_method 否 String 伸缩组实例健康检查方式:ELB_AUDIT和NOVA_AUDIT。当伸缩组设置负载均衡时,默认为ELB_AUDIT;否则默认为NOVA_AUDIT。 ELB_AUDIT:负载均衡健康检查方式,在有监听器的伸缩组中有效。 NOVA_AUDIT:云服务器健康检查方式,是弹性伸缩自带的健康检查方式。 health_periodic_audit_time 否 Integer 伸缩组实例健康检查周期(分钟):1、5、15、60、180。 若设置为0,可以实现10秒级健康检查。 instance_terminate_policy 否 String 伸缩组实例移除策略: OLD_CONFIG_OLD_INSTANCE(默认):从“较早创建的配置”创建的实例中选择较早创建的实例进行优先移除。 OLD_CONFIG_NEW_INSTANCE:从“较早创建的配置”创建的实例中选择较晚创建的实例进行优先移除。 OLD_INSTANCE:较早创建的实例被优先移除。 NEW_INSTANCE:较晚创建的实例将被优先移除。 health_periodic_audit_grace_period 否 Integer 伸缩组实例健康状况检查宽限期,取值范围0-86400,单位是秒,默认为600。 当实例加入伸缩组并且进入已启用状态后,健康状况检查宽限期才会启动,伸缩组会等健康状况检查宽限期结束后才检查实例的运行状况。 当伸缩组实例健康检查方式为ELB_AUDIT时,该参数生效。 scaling_configuration_id 否 String 伸缩配置ID,通过查询弹性伸缩配置列表接口获取,请参考查询弹性伸缩配置列表。 notifications 否 Array of strings 通知方式: EMAIL为发送邮件通知。 该通知方式已经被废除,建议给弹性伸缩组配置通知功能。请参考通知。 delete_publicip 否 Boolean 配置删除云服务器是否删除云服务器绑定的弹性IP。如果选择不删除,则系统仅做解绑定操作,保留弹性IP资源。 true:删除云服务器时会同时删除绑定在云服务器上的弹性IP。当弹性IP的计费方式为包年包月时,不会被删除。 false:删除云服务器时,仅解绑定在云服务器上的弹性IP,不删除弹性IP。 delete_volume 否 Boolean 配置删除云服务器时是否删除云服务器绑定的数据盘。取值为true或false,默认为false。 true:删除云服务器时,会同时删除绑定在云服务器上的数据盘。当数据盘的计费方式为包年包月时,不会被删除。 false:删除云服务器时,仅解绑定在云服务器上的数据盘,不删除数据盘。 enterprise_project_id 否 String 企业项目ID,用于指定伸缩组归属的企业项目。 取值为0或无该值,表示属于default企业项目。 取值为UUID,表示属于该UUID对应的企业项目,如何获取企业项目ID,请参考查询企业项目列表。 当伸缩组配置企业项目时,由该伸缩组创建的弹性云服务器将归属于该企业项目。否则将使用默认企业项目。 说明: 关于企业项目特性的详细信息,请参见企业项目管理。 multi_az_priority_policy 否 String 伸缩组扩缩容时目标AZ选择的优先级策略: EQUILIBRIUM_DISTRIBUTE(默认):均衡分布,虚拟机扩缩容时优先保证available_zones列表中各AZ下虚拟机数量均衡,当无法在目标AZ下完成虚拟机扩容时,按照PICK_FIRST原则选择其他可用AZ。 PICK_FIRST:选择优先,虚拟机扩缩容时目标AZ的选择按照available_zones列表的顺序进行优先级排序。 description 否 String 伸缩组描述(1-256个字符)。 iam_agency_name 否 String 委托(1-64个字符)。 iam_agency_name为无值则无需修改。 iam_agency_name为空字符串或者其他字符串,则需修改。 表3 lbaas_listeners字段数据结构说明 参数 是否必选 参数类型 描述 pool_id 是 String 后端云服务器组ID。 仅当同时满足以下条件时,才可以修改: 伸缩组中无伸缩活动 protocol_port 是 Integer 后端协议号,指后端云服务器监听的端口,取值范围[1, 65535]。 weight 是 Integer 权重,指后端云服务器经分发得到的请求数量的比例,取值范围[0, 100]。 表4 networks字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 子网的网络ID。 ipv6_enable 否 Boolean 是否启用IPv6。 true:标识此网卡已启用ipv6。 false:标识此网卡未启用ipv6。默认取值为false。 ipv6_bandwidth 否 ipv6_bandwidth object 绑定的IPv6共享带宽。默认为空,表示未绑定IPv6的共享带宽。 allowed_address_pairs 否 Array of allowed_address_pairs objects 是否开启源/目的检查开关。 表5 ipv6_bandwidth字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String IPv6共享带宽的ID 表6 allowed_address_pairs字段数据结构说明 参数 参数类型 描述 ip_address String 是否开启源/目的检查开关。 默认是开启,不允许置空。 关闭:1.1.1.1/0 开启:除“1.1.1.1/0”以外的其余值均按开启处理 表7 security_groups字段数据结构说明 参数 是否必选 参数类型 描述 id 是 String 安全组ID。
共100000条