查询弹性伸缩配置列表

功能介绍

根据输入条件过滤查询弹性伸缩配置。查询结果分页显示。

• 可以根据伸缩配置名称，镜像ID，起始行号，记录条数进行条件过滤查询。
• 若不加过滤条件默认最多查询租户下20条伸缩配置信息。

URI

GET /autoscaling-api/v1/{project_id}/scaling_configuration

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

请求消息

• 请求参数

  无

• 请求样例

  本示例展示了查询使用了ID为37ca2b35-6fc7-47ab-93c7-900324809c5c的镜像的伸缩配置。

  GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration?image_id=37ca2b35-6fc7-47ab-93c7-900324809c5c

响应消息

• 响应参数

  表2 响应参数

  参数	参数类型	描述
  total_number	Integer	总记录数。
  start_number	Integer	查询的起始行号。
  limit	Integer	查询记录数。
  scaling_configurations	Array of scaling_configurations objects	伸缩配置列表。

  表3 scaling_configurations字段数据结构说明

  参数	参数类型	描述
  scaling_configuration_id	String	伸缩配置ID，全局唯一。
  tenant	String	租户ID。
  scaling_configuration_name	String	伸缩配置名称。 支持模糊匹配。
  instance_config	instance_config object	实例配置信息。
  create_time	String	创建伸缩配置时间，遵循UTC时间。
  scaling_group_id	String	绑定该伸缩配置的伸缩组ID。

  表4 instance_config字段数据结构说明

  参数	参数类型	描述
  flavorRef	String	云服务器的规格ID。
  imageRef	String	镜像ID，同image_id。
  disk	Array of disk objects	磁盘组信息。
  key_name	String	登录云服务器的SSH密钥名称。
  key_fingerprint	String	登录云服务器的SSH密钥指纹。
  instance_name	String	该参数为预留字段。
  instance_id	String	该参数为预留字段。
  adminPass	String	该参数为预留字段。
  personality	Array of personality objects	注入文件信息。
  public_ip	public_ip object	云服务器的弹性IP信息。
  user_data	String	cloud-init用户数据，base64格式编码。
  metadata	metadata object	创建云服务器元数据，详情见表11。
  security_groups	Array of security_groups objects	安全组信息。
  server_group_id	String	云服务器组ID。
  tenancy	String	在专属主机上创建弹性云服务器。
  dedicated_host_id	String	专属主机的ID。
  market_type	String	云服务器的计费模式，可以选择竞价计费或按需计费。
  multi_flavor_priority_policy	String	使用伸缩配置创建云主机的时候，多规格使用的优先级策略。 。

  表5 disk字段数据结构说明

  参数	参数类型	描述
  size	Integer	磁盘大小，容量单位为GB。
  volume_type	String	磁盘类型。
  disk_type	String	系统盘还是数据盘，DATA表示为数据盘，SYS表示为系统盘。
  dedicated_storage_id	String	磁盘所属的专属存储ID。
  data_disk_image_id	String	导入数据盘的数据盘镜像ID。
  snapshot_id	String	磁盘备份的快照ID。
  metadata	metadata object	创建磁盘的元数据，详情见表6。

  表6 创建磁盘的metadata字段数据结构说明

  参数	参数类型	描述
  __system__encrypted	String	metadata中的表示加密功能的字段，0代表不加密，1代表加密。 该字段不存在时，云硬盘默认为不加密。
  __system__cmkid	String	用户主密钥ID，是metadata中的表示加密功能的字段，与__system__encrypted配合使用。 说明： 参考《密钥管理服务API参考》中的“查询密钥列表”章节通过HTTPS请求获取密钥ID。

  表7 personality字段数据结构说明

  参数	参数类型	描述
  path	String	注入文件路径信息。
  content	String	注入文件内容，base64格式编码。

  表8 public_ip字段数据结构说明

  参数	参数类型	描述
  eip	eip object	云服务器自动分配弹性IP时，创建弹性IP的配置参数。

  表9 eip字段数据结构说明

  参数	参数类型	描述
  ip_type	String	IP地址类型。
  bandwidth	bandwidth object	IP地址带宽参数。

  表10 bandwidth字段数据结构说明

  参数	参数类型	描述
  size	Integer	带宽（Mbit/s）。
  share_type	String	带宽的共享类型。 共享类型枚举： PER：独享型。 WHOLE：共享型。
  charging_mode	String	带宽的计费类型。 traffic：按流量计费。
  id	String	带宽ID，创建WHOLE类型带宽的弹性IP时指定的共享带宽。

  表11 metadata字段数据结构说明

  参数	参数类型	描述
  admin_pass	String	Windows弹性云服务器Administrator用户的密码。

  表12 security_groups字段数据结构说明

  参数	参数类型	描述
  id	String	安全组ID

• 响应样例

  {
      "limit": 20,
      "total_number": 2,
      "start_number": 0,
      "scaling_configurations": [
          {
              "tenant": "ce061903a53545dcaddb300093b477d2",
              "scaling_configuration_id": "6afe46f9-7d3d-4046-8748-3b2a1085ad86",
              "scaling_configuration_name": " config_name_1",
              "instance_config": {
                  "disk": [
                      {
                          "size": 40,
                          "volume_type": "SATA",
                          "disk_type": "SYS"
                      },
                      {
                          "size": 100,
                          "volume_type": "SATA",
                          "disk_type": "DATA"
                      }
                  ],
                  "personality": null,
                  "instance_name": null,
                  "instance_id": null,
                  "flavorRef": "103",
                  "imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c",
                  "key_name": "keypair01",
                  "public_ip": null,
                  "user_data": null,
                  "metadate": {},
                  "security_groups": [{
                       "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be"
                  }],
              },
              "create_time": "2015-07-23T01:04:07Z"
          },
          {
              "tenant": "ce061903a53545dcaddb300093b477d2",
              "scaling_configuration_id": "24a8c5f3-c713-4aba-ac29-c17101009e5d",
              "scaling_configuration_name": "config_name_2",
              "instance_config": {
                  "disk": [
                      {
                          "size": 40,
                          "volume_type": "SATA",
                          "disk_type": "SYS"
                      }
                  ],
                  "personality": null,
                  "instance_name": null,
                  "instance_id": null,
                  "flavorRef": "103",
                  "imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c",
                  "key_name": "keypair01",
                  "public_ip": null,
                  "user_data": null,
                  "metadata": {},
                  "security_groups": [{
                       "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be"
                  }],
                  "multi_flavor_priority_policy": "PICK_FIRST"
              },
              "create_time": "2015-07-22T01:08:41Z"
          }
      ]
  }

返回值

• 正常

  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	网关超时。

错误码

请参考错误码。