Auto Scaling. API Reference. Issue 08 Date HUAWEI TECHNOLOGIES CO., LTD.

Transcription

1 Issue 08 Date HUAWEI TECHNOLOGIES CO., LTD.

2 Copyright Huawei Technologies Co., Ltd All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd. Trademarks and Permissions and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd. All other trademarks and trade names mentioned in this document are the property of their respective holders. Notice The purchased products, services and features are stipulated by the contract made between Huawei and the customer. All or part of the products, services and features described in this document may not be within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information, and recommendations in this document are provided "AS IS" without warranties, guarantees or representations of any kind, either express or implied. The information in this document is subject to change without notice. Every effort has been made in the preparation of this document to ensure accuracy of the contents, but all statements, information, and recommendations in this document do not constitute a warranty of any kind, express or implied. Huawei Technologies Co., Ltd. Address: Website: Huawei Industrial Base Bantian, Longgang Shenzhen People's Republic of China support@huawei.com Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. i

3 Contents Contents 1 API Calling Service Usage Request Methods Request Authentication Methods Token Authentication AK/SK Authentication AK and SK Generation Request Signing Procedure Sample Code Obtaining the Project ID or Tenant ID Common Message Headers Common Request Headers Common Response Headers AS Groups Creating an AS Group Querying AS Groups Querying AS Group Details Modifying an AS Group Deleting an AS Group Enabling or Disabling an AS Group AS Configurations Creating an AS Configuration Querying AS Configurations Querying AS Configuration Details Deleting an AS Configuration Batch Deleting AS Configurations Instances in an AS Group Querying Instances in an AS Group Removing Instances from an AS Group Performing Operations on Instances in Batches AS Policies Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. ii

4 Contents 6.1 Creating an AS Policy Creating an AS Policy (V2) Modifying an AS Policy Modifying an AS Policy (V2) Querying AS Policies Querying AS Policies (V2) Querying AS Policy Details Querying Details of an AS Policy (V2) Executing, Enabling, or Disabling an AS Policy Deleting an AS Policy Performing Operations on AS Policies in Batches AS Policy Execution Logs Querying AS Policy Execution Logs Scaling Action Logs Querying Scaling Action Logs Quotas Querying AS Quotas Querying Quotas for AS Policies and AS Instances Notifications Enabling Notification for an AS Group Querying an AS Group Notification List Deleting a Notification for an AS Group Lifecycle Hook Creating a Lifecycle Hook Querying Lifecycle Hooks Querying Lifecycle Hook Details Modifying a Lifecycle Hook Calling Back an Instance Lifecycle Hook Querying Instance Suspension Deleting a Lifecycle Hook A Appendix A.1 Error Codes A.2 AS Metrics B Change History Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. iii

5 1 API Calling 1 API Calling 1.1 Service Usage API requests sent by third-party applications to the public cloud service must be authenticated using signatures. This chapter describes the overall method of using signatures and provides sample codes to detail how to use the default signer to sign requests and how to use an HTTP client to send requests. Public cloud services provide RESTful APIs. Representational State Transfer (REST) allocates Uniform Resource Identifiers (URIs) to dispersed resources so that resources can be located. Applications on clients use Uniform Resource Locators (URLs) to obtain resources. The URL is in the following format: Table 1-1 describes the parameters in a URL. Table 1-1 Parameter description Parameter Endpoint URI Specifies the URL that is the entry point for a web service. Obtain the value from Regions and Endpoints. Specifies the API access path for performing a specified operation. Obtain the value from the URI of the API, for example, v3/auth/ tokens. 1.2 Request Methods The HTTP protocol defines request methods, such as GET, PUT, POST, DELETE, and PATCH, to indicate the desired action to be performed on the identified resource. The following table describes the HTTP methods supported by the RESTful APIs. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 1

6 1 API Calling Table 1-2 HTTPS methods Method GET PUT POST DELETE PATCH The GET method requests a representation of the specified resource. The PUT method requests that the enclosed entity be stored under the supplied URI. The POST method requests that the server accept the entity enclosed in the request as a new subordinate of the web resource identified by the URI. The DELETE method deletes the specified resource, for example, an object. The PATCH method applies partial modifications to a resource. If the resource does not exist, the PATCH method creates a resource. 1.3 Request Authentication Methods You can use either of the following two authentication methods to call APIs: Token authentication: Requests are authenticated using Tokens. AK/SK authentication: Requests are encrypted using the access key (AK) and secret key (SK) to provide higher security. 1.4 Token Authentication Scenarios Make an API Call If you use a token for authentication, you must obtain the token and add X-Auth-Token to the request header of the IMS API when making an API call. This section describes how to make an API call for token authentication. 1. Send POST of IAM/v3/auth/tokens to obtain the endpoint of IAM and the region name in the message body. See Regions and Endpoints. An example request message is as follows: NOTE { Replace the items in italic in the following example with actual ones. For details, see the Identity and Access Management. "auth": { "identity": { "methods": [ "password" ], "password": { "user": { Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 2

7 1 API Calling "name": "username", "password": "password", "domain": { "name": "domainname", "scope": { "project": { "id": "0215ef11e49d4743be23dd97a1561e91" //This ID is used as an example. 2. Obtain the token. For details, see section "Obtaining the User Token" in the Identity and Access Management. 3. Make a call to a service API, add X-Auth-Token to the request header, and set the value of X-Auth-Token to the token obtained in AK/SK Authentication When you use API Gateway to send requests to underlying services, the requests are signed using the AK and SK. NOTE AK: indicates the ID of the access key. AK is used together with SK to obtain an encrypted signature for a request. SK: indicates the secret access key together used with the access key ID to sign requests. AK and SK can be used together to identify a request sender to prevent the request from being modified AK and SK Generation 1. Log in to the management console. 2. Hover the mouse over the username and select Basic Information from the drop-down list. 3. On the Account Info page, click Manage after Security Credentials. 4. On the My Credential page, click Access Keys. 5. Click Add Access Key. 6. Enter the current login password. 7. Enter the authentication code received in the or mobile phone. NOTE For users created in Identity and Access Management (IAM), if no address or mobile phone is filled during user creation, you only need to authenticate the login password. 8. Click OK to download the access key. NOTE To prevent the access key from being leaked, keep it secure. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 3

8 1 API Calling Request Signing Procedure Preparations Sign a Request Sample Code 1. Download the API Gateway signature tool from the following link: 2. Extract the package. 3. Create a Java project, and reference the extracted JAR to the dependency path. 1. Create a request com.cloud.sdk.defaultrequest (JAVA) used for signing. 2. Set the target API URL, HTTPS method, and content of request com.cloud.sdk.defaultrequest (JAVA). 3. Sign request com.cloud.sdk.defaultrequest (JAVA). a. Call SignerFactory.getSigner(String servicename, String regionname) to obtain a signing tool. b. Call Signer.sign(Request<?> request, Credentials credentials) to sign the request created in step 1. The following code shows the details: //Select an algorithm for request signing. Signer signer = SignerFactory.getSigner(serviceName, region); //Sign the request. The request will change after the signing. signer.sign(request, new BasicCredentials(this.ak, this.sk)); 4. Convert the request signed in the previous step to a new request that can be used to make an API call and copy the header of the signed request to the new request. For example, if Apache HttpClient is used, convert DefaultRequest to HttpRequestBase and copy the header of the signed DefaultRequest to HttpRequestBase. For details, see descriptions of AccessServiceImpl.java in section Sample Code. The following three types of code show how to sign a request and use an HTTP client to send an HTTPS request: AccessService: indicates the abstract class that converts the GET, POST, PUT, and DELETE methods in to the access method. Demo: indicates the execution entry used to simulate GET, POST, PUT, and DELETE request sending. AccessServiceImpl: indicates the implementation of the access method. Code required for API gateway communication is in the access method. For details about region and servicename in the following code, see Regions and Endpoints. AccessService.java: package com.cloud.apigateway.sdk.demo; import java.io.inputstream; import java.net.url; Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 4

9 1 API Calling import java.util.map; import org.apache.http.httpresponse; import com.cloud.sdk.http.httpmethodname; public abstract class AccessService { protected String servicename = null; protected String region = null; protected String ak = null; protected String sk = null; { public AccessService(String servicename, String region, String ak, String sk) this.region = region; this.servicename = servicename; this.ak = ak; this.sk = sk; public abstract HttpResponse access(url url, Map<String, String> header, InputStream content, Long contentlength, HttpMethodName httpmethod) throws Exception; public HttpResponse access(url url, Map<String, String> header, HttpMethodName httpmethod) throws Exception { return this.access(url, header, null, 0l, httpmethod); public HttpResponse access(url url, InputStream content, Long contentlength, HttpMethodName httpmethod) throws Exception { return this.access(url, null, content, contentlength, httpmethod); public HttpResponse access(url url, HttpMethodName httpmethod) throws Exception { return this.access(url, null, null, 0l, httpmethod); public abstract void close(); public String getservicename() { return servicename; public void setservicename(string servicename) { this.servicename = servicename; public String getregion() { return region; public void setregion(string region) { this.region = region; public String getak() { return ak; public void setak(string ak) { this.ak = ak; Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 5

10 1 API Calling public String getsk() { return sk; public void setsk(string sk) { this.sk = sk; AccessServiceImpl.java: package com.cloud.apigateway.sdk.demo; import java.io.ioexception; import java.io.inputstream; import java.net.urisyntaxexception; import java.net.url; import java.util.hashmap; import java.util.map; import javax.net.ssl.sslcontext; import org.apache.http.header; import org.apache.http.httpheaders; import org.apache.http.httpresponse; import org.apache.http.client.methods.httpdelete; import org.apache.http.client.methods.httpget; import org.apache.http.client.methods.httphead; import org.apache.http.client.methods.httppatch; import org.apache.http.client.methods.httppost; import org.apache.http.client.methods.httpput; import org.apache.http.client.methods.httprequestbase; import org.apache.http.conn.ssl.allowallhostnameverifier; import org.apache.http.conn.ssl.sslconnectionsocketfactory; import org.apache.http.conn.ssl.sslcontexts; import org.apache.http.conn.ssl.trustselfsignedstrategy; import org.apache.http.entity.inputstreamentity; import org.apache.http.impl.client.closeablehttpclient; import org.apache.http.impl.client.httpclients; import com.cloud.sdk.defaultrequest; import com.cloud.sdk.request; import com.cloud.sdk.auth.credentials.basiccredentials; import com.cloud.sdk.auth.signer.signer; import com.cloud.sdk.auth.signer.signerfactory; import com.cloud.sdk.http.httpmethodname; public class AccessServiceImpl extends AccessService { private CloseableHttpClient client = null; public AccessServiceImpl(String servicename, String region, String ak, String sk) { super(servicename, region, ak, sk); /** {@inheritdoc */ public HttpResponse access(url url, Map<String, String> headers, InputStream content, Long contentlength, HttpMethodName httpmethod) throws Exception { // Make a request for signing. Request request = new DefaultRequest(this.serviceName); try { // Set the request address. request.setendpoint(url.touri()); Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 6

11 1 API Calling String urlstring = url.tostring(); String parameters = null; if (urlstring.contains("?")) { parameters = urlstring.substring(urlstring.indexof("?") + 1); Map parametersmap = new HashMap<String, String>(); if (null!= parameters &&!"".equals(parameters)) { String[] parameterarray = parameters.split("&"); for (String p : parameterarray) { String key = p.split("=")[0]; String value = p.split("=")[1]; parametersmap.put(key, value); request.setparameters(parametersmap); catch (URISyntaxException e) { // It is recommended to add logs in this place. e.printstacktrace(); // Set the request method. request.sethttpmethod(httpmethod); if (headers!= null) { // Add request header information if required. request.setheaders(headers); // Configure the request content. request.setcontent(content); // Select an algorithm for request signing. Signer signer = SignerFactory.getSigner(serviceName, region); // Sign the request, and the request will change after the signing. signer.sign(request, new BasicCredentials(this.ak, this.sk)); // Make a request that can be sent by the HTTP client. HttpRequestBase httprequestbase = createrequest(url, null, request.getcontent(), contentlength, httpmethod); Map<String, String> requestheaders = request.getheaders(); // Put the header of the signed request to the new request. for (String key : requestheaders.keyset()) { if (key.equalsignorecase(httpheaders.content_length.tostring())) { continue; httprequestbase.addheader(key, requestheaders.get(key)); HttpResponse response = null; SSLContext sslcontext = SSLContexts.custom().loadTrustMaterial(null, new TrustSelfSignedStrategy()).useTLS().build(); SSLConnectionSocketFactory sslsocketfactory = new SSLConnectionSocketFactory( sslcontext, new AllowAllHostnameVerifier()); client = HttpClients.custom().setSSLSocketFactory(sslSocketFactory).build(); // Send the request, and a response will be returned. response = client.execute(httprequestbase); return response; /** * Make a request that can be sent by the HTTP client. * url Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 7

12 1 API Calling * specifies the API access path. header * specifies the header information to be added. content * specifies the body content to be sent in the API call. contentlength * specifies the length of the content. This parameter is optional. httpmethod * specifies the HTTP method to be used. specifies the request that can be sent by an HTTP client. */ private static HttpRequestBase createrequest(url url, Header header, InputStream content, Long contentlength, HttpMethodName httpmethod) { HttpRequestBase httprequest; if (httpmethod == HttpMethodName.POST) { HttpPost postmethod = new HttpPost(url.toString()); if (content!= null) { InputStreamEntity entity = new InputStreamEntity(content, contentlength); postmethod.setentity(entity); httprequest = postmethod; else if (httpmethod == HttpMethodName.PUT) { HttpPut putmethod = new HttpPut(url.toString()); httprequest = putmethod; if (content!= null) { InputStreamEntity entity = new InputStreamEntity(content, contentlength); putmethod.setentity(entity); else if (httpmethod == HttpMethodName.PATCH) { HttpPatch patchmethod = new HttpPatch(url.toString()); httprequest = patchmethod; if (content!= null) { InputStreamEntity entity = new InputStreamEntity(content, contentlength); patchmethod.setentity(entity); else if (httpmethod == HttpMethodName.GET) { httprequest = new HttpGet(url.toString()); else if (httpmethod == HttpMethodName.DELETE) { httprequest = new HttpDelete(url.toString()); else if (httpmethod == HttpMethodName.HEAD) { httprequest = new HttpHead(url.toString()); else { throw new RuntimeException("Unknown HTTP method name: " + httpmethod); httprequest.addheader(header); return public void close() { try { if (client!= null) { client.close(); catch (IOException e) { // It is recommended to add logs in this place. e.printstacktrace(); Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 8

13 1 API Calling Demo.java: package com.cloud.apigateway.sdk.demo; import java.io.bufferedreader; import java.io.bytearrayinputstream; import java.io.ioexception; import java.io.inputstream; import java.io.inputstreamreader; import java.net.malformedurlexception; import java.net.url; import org.apache.http.httpresponse; import com.cloud.sdk.http.httpmethodname; public class Demo { //replace real region private static final String region = "regionname"; //replace real service name private static final String servicename = "servicename"; public static void main(string[] args) { //replace real AK String ak = "akstring"; //replace real SK String sk = "skstring"; // get method //replace real url String url = "urlstring"; get(ak, sk, url); // post method //replace real url String posturl = "urlstring"; //replace real body String postbody = "bodystring"; post(ak, sk, posturl, postbody); // put method //replace real body String putbody = "bodystring"; //replace real url String puturl = "urlstring"; put(ak, sk, puturl, putbody); // delete method //replace real url String deleteurl = "urlstring"; delete(ak, sk, deleteurl); public static void put(string ak, String sk, String requesturl, String putbody) { AccessService accessservice = null; try { accessservice = new AccessServiceImpl(serviceName, region, ak, sk); URL url = new URL(requestUrl); HttpMethodName httpmethod = HttpMethodName.PUT; Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 9

14 1 API Calling InputStream content = new ByteArrayInputStream(putBody.getBytes()); HttpResponse response = accessservice.access(url, content, (long) putbody.getbytes().length, httpmethod); System.out.println(response.getStatusLine().getStatusCode()); catch (Exception e) { e.printstacktrace(); finally { accessservice.close(); public static void patch(string ak, String sk, String requesturl, String putbody) { AccessService accessservice = null; try { accessservice = new AccessServiceImpl(serviceName, region, ak, sk); URL url = new URL(requestUrl); HttpMethodName httpmethod = HttpMethodName.PATCH; InputStream content = new ByteArrayInputStream(putBody.getBytes()); HttpResponse response = accessservice.access(url, content, (long) putbody.getbytes().length, httpmethod); System.out.println(convertStreamToString(response.getEntity().getContent())); catch (Exception e) { e.printstacktrace(); finally { accessservice.close(); public static void delete(string ak, String sk, String requesturl) { AccessService accessservice = null; try { accessservice = new AccessServiceImpl(serviceName, region, ak, sk); URL url = new URL(requestUrl); HttpMethodName httpmethod = HttpMethodName.DELETE; HttpResponse response = accessservice.access(url, httpmethod); System.out.println(convertStreamToString(response.getEntity().getContent())); catch (Exception e) { e.printstacktrace(); finally { accessservice.close(); public static void get(string ak, String sk, String requesturl) { AccessService accessservice = null; try { accessservice = new AccessServiceImpl(serviceName, region, ak, sk); URL url = new URL(requestUrl); HttpMethodName httpmethod = HttpMethodName.GET; HttpResponse response; response = accessservice.access(url, httpmethod); System.out.println(convertStreamToString(response.getEntity().getContent())); Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 10

15 1 API Calling catch (Exception e) { e.printstacktrace(); finally { accessservice.close(); public static void post(string ak, String sk, String requesturl, String postbody) { AccessService accessservice = new AccessServiceImpl(serviceName, region, ak, sk); URL url = null; try { url = new URL(requestUrl); catch (MalformedURLException e) { e.printstacktrace(); InputStream content = new ByteArrayInputStream(postbody.getBytes()); HttpMethodName httpmethod = HttpMethodName.POST; HttpResponse response; try { response = accessservice.access(url, content, (long) postbody.getbytes().length, httpmethod); System.out.println(convertStreamToString(response.getEntity().getContent())); catch (Exception e) { e.printstacktrace(); finally { accessservice.close(); private static String convertstreamtostring(inputstream is) { BufferedReader reader = new BufferedReader(new InputStreamReader(is)); StringBuilder sb = new StringBuilder(); String line = null; try { while ((line = reader.readline())!= null) { sb.append(line + "\n"); catch (IOException e) { e.printstacktrace(); finally { try { is.close(); catch (IOException e) { e.printstacktrace(); return sb.tostring(); NOTE 1. Parameters URI, AK, SK, and HTTP METHOD are mandatory. 2. You can use the request.addheader() method to add header information. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 11

16 1 API Calling 1.6 Obtaining the Project ID or Tenant ID A project ID is required for some URLs when an API is called. It can be project_id or tenant_id because project_id has the same meaning as tenant_id in this document. Before calling an API, you need to obtain a project ID on the console. The steps are as follows: 1. Log in to the management console. 2. Hover the mouse over the username and select Basic Information from the drop-down list. 3. On the Account Info page, click Manage after Security Credentials. On the My Credential page, view the project ID in the project list. Figure 1-1 Viewing the project ID Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 12

17 2 Common Message Headers 2 Common Message Headers This chapter describes common request and response REST message headers. 2.1 Common Request Headers Table 2-1 Common request headers Parameter Mandatory Example Value x-sdk-date Specifies the time when the request is sent. The time is in YYYYMMDD'T'HHMMS S'Z' format. The value is the current GMT time of the system. No This field is mandatory for AK/SK authentication T101459Z Authorization Specifies the authentication information. The value can be obtained from the request signing result. For details, see section Request Signing Procedure. No This field is mandatory for AK/SK authentication. SDK-HMAC- SHA256 Credential=ZIRRK MTWPTQFQI1WK NKB/ //ec2/ sdk_request, SignedHeaders=cont ent-type;host;x-sdkdate, Signature=55741b61 0f3c9fa3ae40b5a802 1ebf7ebc2a28a603fc 62d25cb3bfe6608e1 994 Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 13

18 2 Common Message Headers Parameter Mandatory Example Value Host Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is hostname[:port]. If the port number is not specified, the default port is used. The default port number for https is 443. No This field is mandatory for AK/SK authentication. code.test.com or code.test.com:443 Content-Type Specifies the request body MIME type. You are advised to use the default value application/json. For interfaces used to upload objects or images, the value can vary depending on the flow type. Yes application/json Content- Length Specifies the length of the request body. The unit is byte. No 3495 X-Project-Id Specifies the project ID. Obtain the project ID by following the instructions in section 1.6 Obtaining the Project ID or Tenant ID. This parameter is mandatory for a request from a DeC or multi-project user. No This field is mandatory for requests that use AK/SK authentication in the Dedicated Cloud (DeC) scenario or multiproject scenario. e9993fc787d94b6c8 86cbaa340f9c0f4 X-Auth-Token Specifies the user token. For details about how to obtain the token, see section "Obtaining the User Token" in the Identity and Access Management. After the request is processed, the value of X- Subject-Token in the header is the token value. No This field is mandatory for token authentication. The following is part of an example token: MIIPAgYJKoZIhvc- NAQcCoIIO8zCCD u8caqexdtalbgl ghkgbzqmeagewg g1qbgkqhkig9w0b BwGggg1BBIINPXs idg9rz. NOTE For details about other parameters in the header, see the HTTP protocol documentation. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 14

19 2 Common Message Headers 2.2 Common Response Headers Table 2-2 Common response headers Name Example Value Content-Length Date Specifies the length of the response body. The unit is byte. Specifies the GMT time when a request response is returned. - Wed, 27 Dec :49:46 GMT Content-Type Specifies the response body MIME type. application/json Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 15

20 3 AS Groups 3 AS Groups 3.1 Creating an AS Group Function This interface is used to create an AS group. An AS group is a set of ECS instances with the same application scenario configurations. An AS group defines the minimum and maximum numbers of ECS instances. URI URI format POST /autoscaling-api/v1/{tenant_id/scaling_group Parameter description Parameter Mandatory Type tenant_id Yes String Specifies the tenant ID. Request Parameter description Parameter Mandatory Type scaling_group_ name scaling_configu ration_id Yes String Specifies the AS group name. The name can contain letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters. No String Specifies the AS configuration ID. You can obtain its value from the API used to query AS configurations. For details, see section 4.2 Querying AS Configurations. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 16

21 3 AS Groups Parameter Mandatory Type desire_instance _number min_instance_n umber max_instance_ number cool_down_tim e No Integer Specifies the expected number of instances. The default value is the minimum number of instances. The value ranges from the minimum number of instances to the maximum number of instances. No Integer Specifies the minimum number of instances. The default value is 0. No Integer Specifies the maximum number of instances. The default value is 0. No Integer Specifies the cooldown period (in seconds). The value ranges from 0 to and is 300 by default. The cooldown period takes effect only for scaling actions triggered by alarms. Scaling actions executed manually as well as those triggered periodically or at a particular time will not be affected. lb_listener_id No String Specifies the ID of a typical ELB listener. The system supports the binding of up to three ELB listeners, the IDs of which are separated using a comma (,). You can use vpc_id to obtain a load balancer ID from the API used to query an ELB list. For details, see section "Querying Load Balancers" in Elastic Load Balance. Then, use the load balancer ID to query the ELB listener list to obtain the ELB listener ID. For details, see section "Querying Listeners" in Elastic Load Balance. available_zones No List<Strin g> Specifies the AZ information. The ECS associated with the scaling action will be created in the specified AZ. If you do not specify an AZ, the system automatically specifies one. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 17

22 3 AS Groups Parameter Mandatory Type networks Yes List data structure security_groups No List data structure Specifies network information. The system supports up to five subnets. The first subnet transferred serves as the primary NIC of the ECS by default. You can use vpc_id to obtain the parameter value from the API used to query VPC subnets. For details, see section Subnet > Querying Subnets in the Virtual Private Cloud. Specifies the security group. A maximum of one security group can be selected. You can use vpc_id to obtain the parameter value from the API used to query VPC security groups. For details, see section "Querying Security Groups" in the Virtual Private Cloud. If the security group is specified both in the AS configuration and AS group, the security group specified in the AS configuration prevails. If the security group is not specified in either of them, the default security group is used. For your convenience, you are advised to specify the security group in the AS configuration. vpc_id Yes String Specifies the VPC information. You can obtain its value from the API used to query VPCs. For details, see section "Querying VPCs" in the Virtual Private Cloud. health_periodic _audit_method No String Specifies the health check method for instances in the AS group. The health check methods include ELB_AUDIT and NOVA_AUDIT. If load balancing is configured, the default value of this parameter is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT. ELB_AUDIT refers to the ELB health check, which takes effect in an AS group that has a listener. NOVA_AUDIT refers to the health check delivered with AS. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 18

23 3 AS Groups Parameter Mandatory Type health_periodic _audit_time health_periodic _audit_grace_p eriod instance_termin ate_policy No Integer Specifies the instance health check period. The value can be 1, 5, 15, 60, or 180 min. If this parameter is not specified, the default value is 5. If the value is set to 0, health check is performed every 10 seconds. No Integer Specifies the grace period for instance health check. The unit is second and value range is The health check grace period starts after an instance is added to an AS group and is enabled. The AS group will start checking status of the instance only after the grace period ends. This parameter is valid when the health check method is ELB_AUDIT. If this parameter is not specified, the default value is 600. No String Specifies the instance removal policy. (Default) OLD_CONFIG_OLD_INSTAN CE: The earlier-created instances that were selected from the instances created based on earliercreated configurations are removed first. OLD_CONFIG_NEW_INSTAN CE: The later-created instances that were selected from the instances created based on earliercreated configurations are removed first. OLD_INSTANCE: The earliercreated instances are removed first. NEW_INSTANCE: The latercreated instances are removed first. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 19

24 3 AS Groups Parameter Mandatory Type notifications No List<Strin g> Specifies the notification mode. refers to notification by . This notification mode is going to be canceled. You are advised to configure the notification function for the AS group. For details, see section 10 Notifications. delete_publicip No Boolean Specifies whether to delete the EIP bound to the ECS when deleting the ECS. The value can be true or false. The default value is false. true: deletes the EIP bound to the ECS when deleting the ECS. When the ECS is charged in Yearly/Monthly mode, the EIP bound to the ECS will not be deleted when the ECS is deleted. false: only unbinds the EIP bound to the ECS when deleting the ECS. networks field data structure description Parameter Mandatory Type id Yes String Specifies the network ID. security_groups field data structure description Parameter Mandatory Type id Yes String Specifies the ID of the security group. Example request { "scaling_group_name": "GroupNameTest", "scaling_configuration_id": "47683a91-93ee-462a-a7d7-484c006f4440", "desire_instance_number": 0, "min_instance_number": 0, "max_instance_number": 0, "cool_down_time": 200, "health_periodic_audit_method": "NOVA_AUDIT", "health_periodic_audit_time": 5, "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE", "vpc_id": "a b c61-68d03ee193a", "networks": [ { "id": "3cd35bca-5a10-416f-8994-f " ], "notifications": [ Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 20

25 3 AS Groups " " ], "security_groups": [ { "id": "23b7b999-0a30-4b48-ae8f-ee201a88a6ab" ] Response Parameter description Parameter Type scaling_group_id String Specifies the AS group ID. Returned Value Example response { "scaling_group_id": "a b c61-68d03ee193a1" Normal 200 Abnormal Returned Value 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. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 21

26 3 AS Groups Returned Value 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. 3.2 Querying AS Groups Function This interface is used to query AS groups based on conditions you input. The results are displayed by page. URI URI format GET /autoscaling-api/v1/{tenant_id/scaling_group{? scaling_group_name,scaling_configuration_id,scaling_group_status,start_number,limit NOTE You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. You can filter all non-mandatory parameters in the parameter description. Parameter description Parameter Mandator y Type tenant_id Yes String Specifies the tenant ID. scaling_group_name No String Specifies the name of the AS group. scaling_configuration_id No String Specifies the AS configuration ID. You can obtain its value from the API used to query AS configurations. For details, see 4.2 Querying AS Configurations. scaling_group_status No String Specifies the AS group status. The value can be INSERVICE, PAUSED, ERROR, or DELETING. start_number No Integer Specifies the start line number. The default value is 0. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 22

27 3 AS Groups Parameter Mandator y Type limit No Integer Specifies the number of query records. The default value is 20. Request Response Example request None Parameter description Parameter Type total_number Integer Specifies the total number of query records. start_number Integer Specifies the start number of query records. limit Integer Specifies the number of query records. scaling_groups List data structure Specifies the scaling group list. scaling_groups field data structure description Parameter Type scaling_group_name String Specifies the name of the AS group. scaling_group_id String Specifies the AS group ID. scaling_group_status String Specifies the status of the AS group. scaling_configuration_id String Specifies the AS configuration ID. scaling_configuration_na me String Specifies the AS configuration name. current_instance_number Integer Specifies the number of current instances in the AS group. desire_instance_number Integer Specifies the expected number of instances in the AS group. min_instance_number Integer Specifies the minimum number of instances in the AS group. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 23

28 3 AS Groups Parameter Type max_instance_number Integer Specifies the maximum number of instances in the AS group. cool_down_time Integer Specifies the cooldown period (s). lb_listener_id String Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,). lbaas_listeners List data structure This field is reserved. available_zones List<String> Specifies the AZ information. networks List data structure Specifies network information. security_groups List data structure Specifies the security group information. create_time String Specifies the time when an AS group was created. The time format complies with UTC. vpc_id String Specifies the ID of the VPC to which the AS group belongs. detail String Specifies details about the AS group. is_scaling Boolean Specifies the scaling flag of the AS group. health_periodic_audit_met hod health_periodic_audit_tim e health_periodic_audit_gra ce_period String Integer Integer Specifies the health check method. Specifies the health check interval. Specifies the grace period for health check. instance_terminate_policy String Specifies the instance removal policy. notifications List<String> Specifies the notification mode. refers to notification by . delete_publicip Boolean Specifies whether to delete the EIP bound to the ECS when deleting the ECS. cloud_location_id String This field is reserved. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 24

29 3 AS Groups networks field data structure description Parameter Type id String Specifies the network ID. security_groups field data structure description Parameter Type id String Specifies the ID of the security group. Example response { "limit": 20, "scaling_groups": [ { "networks": [ { "id": " a b c61-68d03ee193a " ], "detail": null, "scaling_group_name": "healthcheck", "scaling_group_id": "77a7a397-7d2f-4e79-9da9-6a35e ", "scaling_group_status": "INSERVICE", "scaling_configuration_id": "1d b817-c1f813be835f", "scaling_configuration_name": "healthcheck", "current_instance_number": 0, "desire_instance_number": 1, "min_instance_number": 0, "max_instance_number": 500, "cool_down_time": 300, "lb_listener_id": "f06c b51c0e8fbe1f235bab", "security_groups": [ { "id": "8a4b1d5b f-84b1-5c8a59ebc829" ], "create_time": " T02:46:29Z", "vpc_id": "863ccae2-ee85-4d27-bc5b-3ba2a198a9e2", "health_periodic_audit_method": "ELB_AUDIT", "health_periodic_audit_time": 5, "health_periodic_audit_grace_period": 600, "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE", "is_scaling": false, "delete_publicip": false, "notifications": [ " " ] ], "total_number": 1, "start_number": 0 Returned Value Normal 200 Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 25

30 3 AS Groups Abnormal Returned Value 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. 3.3 Querying AS Group Details Function This interface is used to query details about a specified AS group. URI URI format GET /autoscaling-api/v1/{tenant_id/scaling_group/{scaling_group_id Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 26

31 3 AS Groups Parameter description Parameter Mandatory Type tenant_id Yes String Specifies the tenant ID. scaling_group_id Yes String Specifies the AS group ID. Request Response Example request None Parameter description Parameter Type scaling_group Dictionary data structure Specifies details about the AS group. scaling_group field data structure description Parameter Type scaling_group_name String Specifies the name of the AS group. scaling_group_id String Specifies the AS group ID. scaling_group_status String Specifies the status of the AS group. scaling_configuration_id String Specifies the AS configuration ID. scaling_configuration_na me String Specifies the AS configuration name. current_instance_number Integer Specifies the number of current instances in the AS group. desire_instance_number Integer Specifies the expected number of instances in the AS group. min_instance_number Integer Specifies the minimum number of instances in the AS group. max_instance_number Integer Specifies the maximum number of instances in the AS group. cool_down_time Integer Specifies the cooldown period (s). Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 27

32 3 AS Groups Parameter Type lb_listener_id String Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,). lbaas_listeners List data structure This field is reserved. available_zones List<String> Specifies the AZ information. networks List data structure Specifies network information. security_groups List data structure Specifies the security group information. create_time String Specifies the time when an AS group was created. The time format complies with UTC. vpc_id String Specifies the ID of the VPC to which the AS group belongs. detail String Specifies details about the AS group. is_scaling Boolean Specifies the scaling flag of the AS group. health_periodic_audit_met hod health_periodic_audit_tim e health_periodic_audit_gra ce_period String Integer Integer Specifies the health check method. Specifies the health check interval. Specifies the grace period for health check. instance_terminate_policy String Specifies the instance removal policy. notifications List<String> Specifies the notification mode. refers to notification by . delete_publicip Boolean Specifies whether to delete the EIP bound to the ECS when deleting the ECS. cloud_location_id String This field is reserved. networks field data structure description Parameter Type id String Specifies the network ID. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 28

33 3 AS Groups security_groups field data structure description Parameter Type id String Specifies the ID of the security group. Example response { "scaling_group": { "networks": [ { "id": "2daf6ba6-fb24-424a-b5b8-c554fab95f15" ], "detail": null, "scaling_group_name": "api_gateway_modify", "scaling_group_id": "d4e f8-9f5e9714a4b0", "scaling_group_status": "INSERVICE", "scaling_configuration_id": " d-a97b-9cecdb663a90", "scaling_configuration_name": "press", "current_instance_number": 7, "desire_instance_number": 8, "min_instance_number": 0, "max_instance_number": 100, "cool_down_time": 900, "lb_listener_id": null, "security_groups": [ { "id": "23b7b999-0a30-4b48-ae8f-ee201a88a6ab" ], "create_time": " T08:36:10Z", "vpc_id": "3e22f d-4bb4-a588-0b9a ", "health_periodic_audit_method": "NOVA_AUDIT", "health_periodic_audit_time": 60, "health_periodic_audit_grace_period": 600, "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE", "is_scaling": true, "delete_publicip": false, "notifications": [ " " ] Returned Value Normal 200 Abnormal Returned Value 400 Bad Request The server failed to process the request. 401 Unauthorized You must enter the username and password to access the requested page. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 29

34 3 AS Groups Returned Value 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. 3.4 Modifying an AS Group Function This interface is used to modify information about a specified AS group. The ECSs created based on the original AS configuration will not be affected after the AS configuration of an AS group is modified. URI URI format PUT /autoscaling-api/v1/{tenant_id/scaling_group/{scaling_group_id Parameter description Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 30

35 3 AS Groups Parameter Mandatory Type tenant_id Yes String Specifies the tenant ID. scaling_group_id Yes String Specifies the AS group ID. Request Parameter description Parameter Mandatory Type scaling_group_ name desire_instance _number min_instance_n umber max_instance_n umber cool_down_tim e No String Specifies the AS group name. The name can contain letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters. No Integer Specifies the expected number of instances. The value ranges from the minimum number of instances to the maximum number of instances. No Integer Specifies the minimum number of instances. No Integer Specifies the maximum number of instances, which is greater than or equal to the minimum number of instances. No Integer Specifies the cooldown period (in seconds). The value ranges from 0 to availability_zon es No List<String > Specifies the AZ information. The ECS associated with the scaling action will be created in the specified AZ. If you do not specify an AZ, the system automatically specifies one. The value of this parameter can be changed only when all the following conditions are met: No scaling actions are triggered in the AS group. The number of instances in the AS group is 0. The AS group is not in service. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 31

36 3 AS Groups Parameter Mandatory Type networks No List data structure security_groups No List data structure Specifies network information. The system supports up to five subnets. The first subnet transferred serves as the primary NIC of the ECS by default. You can use vpc_id to obtain the parameter value from the API used to query VPC subnets. For details, see section Subnet > Querying Subnets in the Virtual Private Cloud. The value of this parameter can be changed only when all the following conditions are met: No scaling actions are triggered in the AS group. The number of instances in the AS group is 0. The AS group is not in service. Specifies the security group information. You can use vpc_id to obtain the parameter value from the API used to query VPC security groups. For details, see section "Querying Security Groups" in the Virtual Private Cloud. If the security group is specified both in the AS configuration and AS group, the security group specified in the AS configuration prevails. If the security group is not specified in either of them, the default security group is used. For your convenience, you are advised to specify the security group in the AS configuration. The value of this parameter can be changed only when all the following conditions are met: No scaling actions are triggered in the AS group. The number of instances in the AS group is 0. The AS group is not in service. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 32

37 3 AS Groups Parameter Mandatory Type lb_listener_id No String Specifies the ID of a typical ELB listener. The system supports the binding of up to three ELB listeners, the IDs of which are separated using a comma (,). You can use vpc_id to obtain a load balancer ID from the API used to query an ELB list. For details, see section "Querying Load Balancers" in Elastic Load Balance. Then, use the load balancer ID to query the ELB listener list to obtain the ELB listener ID. For details, see section "Querying Listeners" in Elastic Load Balance. The value of this parameter can be changed only when all the following conditions are met: No scaling actions are triggered in the AS group. The number of instances in the AS group is 0. The AS group is not in service. health_periodic _audit_method health_periodic _audit_time No String Specifies the health check method for instances in the AS group. The health check methods include ELB_AUDIT and NOVA_AUDIT. ELB_AUDIT refers to the ELB health check, which takes effect in an AS group that has a listener. NOVA_AUDIT refers to the health check delivered with AS. No Integer Specifies the health check period for the instances in the AS group. The value can be 1, 5, 15, 60, or 180 min. If the value is set to 0, health check is performed every 10 seconds. Issue 08 ( ) Copyright Huawei Technologies Co., Ltd. 33