• Auto Scaling

as
  1. Help Center
  2. Auto Scaling
  3. API Reference
  4. API
  5. AS Configurations
  6. Querying AS Configuration Details

Querying AS Configuration Details

Function

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

URI

GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}
Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

scaling_configuration_id

Yes

String

Specifies the unique ID of an AS configuration.

Request Message

  • Request parameters

    None

  • Example request

    None

Response Message

  • Response parameters
    Table 2 Response parameters

    Parameter

    Type

    Description

    scaling_configuration

    Dictionary data structure

    Provides AS configuration details.

    Table 3 scaling_configurations field data structure description

    Parameter

    Type

    Description

    scaling_configuration_id

    String

    Specifies the AS configuration ID. This parameter is globally unique.

    tenant

    String

    Specifies the tenant ID.

    scaling_configuration_name

    String

    Specifies the AS configuration name.

    instance_config

    Dictionary data structure

    Specifies the information about instance configurations.

    create_time

    String

    Specifies the time when AS configurations are created. The time format complies with UTC.

    Table 4 instance_config field data structure description

    Parameter

    Type

    Description

    flavorRef

    String

    Specifies the ECS flavor ID.

    imageRef

    String

    Specifies the image ID. It is same as image_id.

    disk

    List data structure

    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 field is reserved.

    instance_id

    String

    This field is reserved.

    adminPass

    String

    This field is reserved.

    personality

    List data structure

    Specifies information about the injected file.

    public_ip

    Dictionary data structure

    Specifies the EIP of the ECS.

    user_data

    String

    Specifies the Cloud-Init user data, which is encoded using Base64.

    metadata

    Dictionary data structure

    Specifies the metadata of ECSs to be created.

    security_groups

    List data structure

    Specifies the security group information.

    server_group_id

    String

    This field is reserved.

    tenancy

    String

    This field is reserved.

    dedicated_host_id

    String

    This field is reserved.

    Table 5 disk field data structure description

    Parameter

    Type

    Description

    size

    Integer

    Specifies the disk size. The unit is GB.

    volume_type

    String

    Specifies the disk type.

    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.

    Table 6 personality field data structure description

    Parameter

    Type

    Description

    path

    String

    Specifies the path of the injected file.

    content

    String

    Specifies the content of the file to be injected. The file content is encoded using Base64.

    Table 7 public_ip field data structure description

    Parameter

    Type

    Description

    eip

    Dictionary data structure

    Specifies the configuration parameter for creating an EIP that will be automatically assigned to the ECS.

    Table 8 eip field data structure description

    Parameter

    Type

    Description

    ip_type

    String

    Specifies the IP address type.

    bandwidth

    Dictionary data structure

    Specifies the bandwidth of the IP address.

    Table 9 bandwidth field data structure description

    Parameter

    Type

    Description

    size

    Integer

    Specifies the bandwidth (Mbit/s).

    share_type

    String

    Specifies the bandwidth sharing type.

    Enumerated values of the sharing type:

    PER indicates dedicated bandwidth.

    charging_mode

    String

    Specifies the bandwidth charging mode.

    • If the field value is traffic, the ECS service is charged by traffic.
    Table 10 metadata field data structure description

    Parameter

    Type

    Description

    User-defined field key pair

    String

    Specifies the key and value pair of the metadata.

    Table 11 security_groups field data structure 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",
                "public_ip": null,
                "user_data": null,
                "metadata": {},
                "security_groups": [{
                     "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be"
                }]
            },
            "create_time": "2015-07-23T01:04:07Z"
        }
    }

Returned Value

  • 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 so that the request can be processed.

    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 section Error Codes.