Querying an AS Configuration¶
Function¶
This interface is used to query details about an AS configuration by configuration ID.
URI¶
GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Specifies the project ID. |
scaling_configuration_id | Yes | String | Specifies an AS configuration ID, which is unique globally. For details, see Querying an AS Configuration. |
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. This parameter is globally unique.
tenant
String
Specifies the tenant ID.
scaling_configuration_name
String
Specifies the AS configuration name.
Supports fuzzy search.
instance_config
instance_config object
Specifies the information about instance configurations.
create_time
String
Specifies the time when AS configurations are created. The time format complies with UTC.
scaling_group_id
String
Specifies the ID of the AS group to which the AS configuration is bound.
Table 4 instance_config field description¶ Parameter
Type
Description
flavorRef
String
Specifies the ECS flavor ID.
imageRef
String
Specifies the image ID. It is 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 the 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 11.
security_groups
Array of security_groups objects
Specifies the security group information.
server_group_id
String
This parameter is reserved.
tenancy
String
This parameter is reserved.
dedicated_host_id
String
This parameter is reserved.
market_type
String
This parameter is reserved.
multi_flavor_priority_policy
String
This parameter is reserved.
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.
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.
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 6.
Table 6 personality field 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 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.
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.
Enumerated values of the sharing type:
PER: dedicated
charging_mode
String
Specifies the bandwidth billing mode.
traffic: billed by traffic.
Table 10 metadata field description¶ Parameter
Type
Description
admin_pass
String
Specifies the password of the Administrator account for a Windows ECS.
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.