guoyanyan 9f6c9f3524 AS API 20220928 v1

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: guoyanyan <guoyanyan3@huawei.com>
Co-committed-by: guoyanyan <guoyanyan3@huawei.com>

2022-10-04 07:01:40 +00:00

55 KiB

Raw Blame History

Creating an AS Configuration

Function

This API is used to create an AS configuration.

An AS configuration is a template of ECSs in an AS group. It defines the specifications of the instances to be added to the AS group.
The AS configuration is decoupled from the AS group. An AS configuration can be used by multiple AS groups.
Up to 100 AS configurations can be created for each user.

URI

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

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.

Request Message

Request parameters

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
scaling_configuration_name	Yes	String	Specifies the AS configuration name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.
instance_config	Yes	Object	Specifies the ECS configuration. For details, see Table 3.

**Table 3** **instance_config** field description
Parameter	Mandatory	Type	Description
instance_id	No	String	Specifies the ECS ID. When using the existing ECS specifications as the template to create AS configurations, specify this parameter. In this case, the flavorRef, imageRef, disk, and security_groups fields do not take effect. If the instance_id field is not specified, flavorRef, imageRef, and disk fields are mandatory.
flavorRef	No	String	Specifies the ECS flavor ID. A maximum of 10 flavors can be selected. Use a comma (,) to separate multiple flavor IDs. You can obtain its value from the API for querying details about flavors and extended flavor information.
imageRef	No	String	Specifies the image ID. Its value is the same as that of image_id for specifying the image selected during ECS creation. Obtain the value using the API for querying images. .
disk	No	Array of disk objects	Specifies the disk group information. System disks are mandatory and data disks are optional. For details, see Table 4.
key_name	Yes	String	Specifies the name of the SSH key pair used to log in to the ECS.
personality	No	Array of personality objects	Specifies information about the injected file. Only text files can be injected. A maximum of five files can be injected at a time and the maximum size of each file is 1 KB. For details, see Table 6.
public_ip	No	public_ip object	Specifies the EIP of the ECS. The EIP can be configured in two ways. For details, see Table 7. Do not use an EIP. In this case, this parameter is unavailable. Automatically assign an EIP. You need to specify the information about the new EIP.
user_data	No	String	Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected. Constraints: The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB. Examples: Linux #! /bin/bash echo user_test >> /home/user.txt Windows rem cmd echo 111 > c:\aaa.txt
metadata	No	metadata object	Specifies the ECS metadata. For details, see Table 10.
security_groups	Yes	Array of security_groups objects	Specifies security groups. For details, see Table 11. If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration.
market_type	No	String	This parameter is reserved.

**Table 4** **disk** field description
Parameter	Mandatory	Type	Description
size	Yes	Integer	Specifies the disk size. The unit is GB. The system disk size ranges from 1 to 1024 and must be greater than or equal to the minimum size (min_disk value) of the system disk specified in the image. The data disk size ranges from 10 to 32768.
volume_type	Yes	String	Specifies the ECS system disk type. The disk type must match the available disk type. SATA: common I/O disk type SAS: high I/O disk type SSD: ultra-high I/O disk type co-p1: high I/O (performance-optimized I) disk type uh-l1: ultra-high I/O (latency-optimized) disk type If the specified disk type is not available in the AZ, the disk will fail to create. NOTE: For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks.
disk_type	Yes	String	Specifies a disk type. The options are as follows: DATA: indicates a data disk. SYS: indicates a system disk. NOTE: System disk encryption is not supported.
dedicated_storage_id	No	String	Specifies a DSS device ID for creating an ECS disk. NOTE: Specify DSS devices for all disks in an AS configuration or not. If DSS devices are specified, all the data stores must belong to the same AZ, and the disk types supported by a DSS device for a disk must be the same as the volume_type value.
data_disk_image_id	No	String	Specifies the ID of a data disk image used to export data disks of an ECS.
snapshot_id	No	String	Specifies the disk backup snapshot ID for restoring the system disk and data disks using a full-ECS backup when a full-ECS image is used. NOTE: Each disk in an AS configuration must correspond to a disk backup in the full-ECS backup by snapshot_id.
metadata	No	metadata object	Specifies the metadata for creating disks. For details, see Table 5.

**Table 5** **metadata** Field Description for Creating Disks
Parameter	Mandatory	Type	Description
__system__encrypted	No	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. NOTE: System disk encryption is not supported.
__system__cmkid	No	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" in Key Management Service API Reference. System disk encryption is not supported.

**Table 6** **personality** field description
Parameter	Mandatory	Type	Description
path	Yes	String	Specifies the path of the injected file. For Linux OSs, specify the path, for example, /etc/foo.txt, for storing the injected file. For Windows, the injected file is automatically stored in the root directory of drive C. You only need to specify the file name, for example, foo. The file name contains only letters and digits.
content	Yes	String	Specifies the content of the injected file. The value must be the information after the content of the injected file is encoded using Base64.

**Table 7** **public_ip** field description
Parameter	Mandatory	Type	Description
eip	Yes	eip object	Specifies the EIP automatically assigned to the ECS. For details, see Table 8.

**Table 8** **eip** field description
Parameter	Mandatory	Type	Description
ip_type	Yes	String	Specifies the EIP type. Enumerated value of the IP address type: 5_bgp (indicates dynamic BGP)
bandwidth	Yes	bandwidth object	Specifies the bandwidth of an IP address. For details, see Table 9.

**Table 9** **bandwidth** field description
Parameter	Mandatory	Type	Description
size	Yes	Integer	Specifies the bandwidth (Mbit/s). The value range is 1 to 500. NOTE: The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console. The minimum unit for bandwidth varies depending on the bandwidth range. The minimum unit is 1 Mbit/s if the allowed bandwidth size ranges from 0 to 300 Mbit/s (with 300 Mbit/s included). The minimum unit is 50 Mbit/s if the allowed bandwidth size ranges 300 Mbit/s to 500 Mbit/s (with 500 Mbit/s included).
share_type	Yes	String	Specifies the bandwidth sharing type. Enumerated values of the sharing type: PER: dedicated Only dedicated bandwidth is available.
charging_mode	Yes	String	Specifies the bandwidth billing mode. traffic: billed by traffic. If the parameter value is out of the preceding options, creating the ECS will fail.

**Table 10** **metadata** field description
Parameter	Mandatory	Type	Description
admin_pass	No	String	Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator. Password complexity requirements: Consists of 8 to 26 characters. Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./? The password cannot contain the username or the username in reversed order. The Windows ECS password cannot contain the username, the username in reversed order, or more than two consecutive characters in the username.

**Table 11** **security_groups** field description
Parameter	Mandatory	Type	Description
id	Yes	String	Specifies the ID of the security group.

Example request

This example shows how to create an AS configuration with name as-config-tlzp, image ID 627a1223-2ca3-46a7-8d5f-7aef22c74ee6, flavor ID s3.xlarge.4, 40 GB SATA system disk, and SSH key name 100vm_key.

POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration

{ 
    "scaling_configuration_name": "as-config-tlzq", 
    "instance_config": { 
        "flavorRef": "s3.xlarge.4", 
        "imageRef": "627a1223-2ca3-46a7-8d5f-7aef22c74ee6", 
        "disk": [ 
            { 
                "size": 40, 
                "volume_type": "SATA", 
                "disk_type": "SYS" 
            } 
        ], 
        "key_name": "100vm_key" ,
	"security_groups": [{
		"id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be"
	}], 
        "multi_flavor_priority_policy": "PICK_FIRST"
    } 
}

Response Message

Response parameters
Table 12 Response parameters
Parameter

Type

Description

scaling_configuration_id

String

Specifies the AS configuration ID.

**Table 12** Response parameters
Parameter	Type	Description
scaling_configuration_id	String	Specifies the AS configuration ID.

Example response

{
    "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2"
}

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

Parent topic: AS Configurations

55 KiB Raw Blame History