Querying an AS Configuration

Function

This interface is used to query details about an AS configuration by configuration ID.

Authorization

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

• If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
• If you are using identity policy-based authorization, the permission listed below is required.

  Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
  as:scalingConfig:get	read	scalingConfig*	-	as:configs:get	-

URI

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

Request

None

Example Request

This example queries the details about the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86.

GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/6afe46f9-7d3d-4046-8748-3b2a1085ad86

Response

• Response parameters

  Table 2 Response parameters

  Parameter	Type	Description
  scaling_configuration	scaling_configurations object	Provides AS configuration details.

  Table 3 scaling_configurations field description

  Parameter	Type	Description
  scaling_configuration_id	String	Specifies the AS configuration ID. The value is globally unique.
  tenant	String	Specifies the tenant ID.
  scaling_configuration_name	String	Specifies the AS configuration name. The value supports fuzzy matching.
  instance_config	instance_config object	Specifies the information about instance configurations.
  create_time	String	Specifies the time when the AS configuration was created, in UTC format.
  scaling_group_id	String	Specifies the ID of the AS group that the AS configuration is bound to.

  Table 4 instance_config field description

  Parameter	Type	Description
  flavorRef	String	Specifies the ECS flavor ID.
  imageRef	String	Specifies the image ID. It is the same as image_id.
  disk	Array of disk objects	Specifies the disk group information.
  key_name	String	Specifies the name of the SSH key pair used to log in to the ECS.
  key_fingerprint	String	Specifies the fingerprint of the SSH key pair used to log in to the ECS.
  instance_name	String	This parameter is reserved. NOTE: When you call APIs to query details about an AS configuration created from an ECS or to list such AS configurations, instance_name is empty in the response.
  instance_id	String	This parameter is reserved.
  adminPass	String	This parameter is reserved.
  personality	Array of personality objects	Specifies information about the injected file.
  public_ip	public_ip object	Specifies the EIP of the ECS.
  user_data	String	Specifies the Cloud-Init user data, which is encoded using Base64.
  metadata	metadata object	Specifies the ECS metadata. For details, see Table 10.
  security_groups	Array of security_groups objects	Specifies the security group information.
  server_group_id	String	Specifies the ECS group ID.
  tenancy	String	Specifies that ECSs are created on DeHs.
  dedicated_host_id	String	Specifies the DeH ID.
  market_type	String	Specifies the ECS billing mode. Valid values: Null: pay-per-use spot: spot price
  multi_flavor_priority_policy	String	Specifies the priority policy for selecting a flavor when using an AS configuration to create ECSs.

  Table 5 disk field description

  Parameter	Type	Description
  size	Integer	Specifies the disk size. The unit is GB.
  volume_type	String	Specifies the disk type. The value can be: SATA: common I/O SAS: high I/O GPSSD: general-purpose SSD SSD: ultra-I/O ESSD: extreme SSD GPSSD2: general-purpose SSD V2 ESSD2: extreme SSD V2
  disk_type	String	Specifies whether the disk is a system disk or a data disk. DATA indicates a data disk. SYS indicates a system disk.
  dedicated_storage_id	String	Specifies the ID of the DSS device for the disk.
  data_disk_image_id	String	Specifies the ID of the data disk image for creating a data disk.
  snapshot_id	String	Specifies the disk backup snapshot ID.
  metadata	metadata object	Specifies the metadata for creating disks. For details, see Table 10.
  iops	Integer	Specifies the IOPS of the EVS disk. This parameter is available when volume_type is set to GPSSD2 or ESSD2. NOTE: For details about IOPS of GPSSD2 and ESSD2 EVS disks, see Disk Types and Performance. Only pay-per-use billing is supported currently.
  throughput	Integer	Specifies the throughput of the EVS disk. The unit is MiB/s. This parameter is available when volume_type is set to GPSSD2. NOTE: For details about the throughput range of GPSSD2 EVS disks, see Disk Types and Performance. Only pay-per-use billing is supported currently.

  Table 6 personality field description

  Parameter	Type	Description
  path	String	Specifies the path of the injected file.
  content	String	Specifies the injected file content, which is encoded using Base64.

  Table 7 public_ip field description

  Parameter	Type	Description
  eip	eip object	Specifies the automatically assigned EIP.

  Table 8 eip field description

  Parameter	Type	Description
  ip_type	String	Specifies the IP address type. The value can be: 5_bgp: dynamic BGP 5_sbgp: static BGP For details, see the publicip field in "Assigning an EIP" in Virtual Private Cloud API Reference.
  bandwidth	bandwidth object	Specifies the bandwidth of an IP address.

  Table 9 bandwidth field description

  Parameter	Type	Description
  size	Integer	Specifies the bandwidth (Mbit/s).
  share_type	String	Specifies the bandwidth sharing type. The value can be: PER: dedicated WHOLE: shared
  charging_mode	String	Specifies the bandwidth billing mode. bandwidth: billed by bandwidth. traffic: billed by traffic.
  id	String	Specifies the bandwidth ID. You can specify a shared bandwidth when applying for an EIP with the bandwidth whose type is set to WHOLE.

  Table 10 metadata Field Description for Creating Disks

  Parameter	Type	Description
  __system__encrypted	String	Specifies encryption in metadata. The value can be 0 (encryption disabled) or 1 (encryption enabled). If this parameter does not exist, the disk will not be encrypted by default.
  __system__cmkid	String	Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted. NOTE: For details about how to obtain the CMK ID, see Querying the List of CMKs.

  Table 11 security_groups field description

  Parameter	Type	Description
  id	String	Specifies the security group ID.

Example Response

{
    "scaling_configuration": {
        "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"
                }
            ],
            "adminPass": "***",
            "personality": null,
            "instance_name": null,
            "instance_id": null,
            "flavorRef": "103",
            "imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c",
            "key_name": "keypair01",
            "key_fingerprint" : "SHA256:qlvdUkYgSjKUxcr2uJgJJRMCKMLkJO5BPLooBcgsF8k",
            "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-23T01:04:07Z"
    }
}

Returned Values

• Normal

  200

• Abnormal

  Returned Value	Description
  400 Bad Request	The server failed to process the request.
  401 Unauthorized	You must enter the username and password to access the requested page.
  403 Forbidden	You are forbidden to access the requested page.
  404 Not Found	The server could not find the requested page.
  405 Method Not Allowed	You are not allowed to use the method specified in the request.
  406 Not Acceptable	The response generated by the server could not be accepted by the client.
  407 Proxy Authentication Required	You must use the proxy server for authentication to process the request.
  408 Request Timeout	The request timed out.
  409 Conflict	The request could not be processed due to a conflict.
  500 Internal Server Error	Failed to complete the request because of an internal service error.
  501 Not Implemented	Failed to complete the request because the server does not support the requested function.
  502 Bad Gateway	Failed to complete the request because the request is invalid.
  503 Service Unavailable	Failed to complete the request because the system is unavailable.
  504 Gateway Timeout	A gateway timeout error occurred.

Error Codes

See Error Codes.