diff --git a/docs/as/dev/ALL_META.TXT.json b/docs/as/dev/ALL_META.TXT.json
new file mode 100644
index 000000000..d2a74e234
--- /dev/null
+++ b/docs/as/dev/ALL_META.TXT.json
@@ -0,0 +1,202 @@
+[
+ {
+ "uri":"en-us_topic_0110252694.html",
+ "product_code":"as",
+ "code":"1",
+ "des":"This document describes how to call the APIs of Auto Scaling (AS) to use basic functions of the service.For details about how to use APIs, see API Usage Guidelines.",
+ "doc_type":"devg",
+ "kw":"Overview,Developer Guide",
+ "title":"Overview",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252697.html",
+ "product_code":"as",
+ "code":"2",
+ "des":"AS GroupAn AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling ac",
+ "doc_type":"devg",
+ "kw":"Basic Concepts,Developer Guide",
+ "title":"Basic Concepts",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252699.html",
+ "product_code":"as",
+ "code":"3",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"devg",
+ "kw":"Common Operations",
+ "title":"Common Operations",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252700.html",
+ "product_code":"as",
+ "code":"4",
+ "des":"An AS configuration specifies the specifications of the ECSs to be added to an AS group, including the ECS specifications, images, and disks. You can create an AS configu",
+ "doc_type":"devg",
+ "kw":"Creating an AS Configuration,Common Operations,Developer Guide",
+ "title":"Creating an AS Configuration",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252701.html",
+ "product_code":"as",
+ "code":"5",
+ "des":"An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions.If",
+ "doc_type":"devg",
+ "kw":"Creating an AS Group,Common Operations,Developer Guide",
+ "title":"Creating an AS Group",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252702.html",
+ "product_code":"as",
+ "code":"6",
+ "des":"An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions.On",
+ "doc_type":"devg",
+ "kw":"Enabling an AS Group,Common Operations,Developer Guide",
+ "title":"Enabling an AS Group",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252703.html",
+ "product_code":"as",
+ "code":"7",
+ "des":"An AS policy specifies a condition for triggering a scaling action. When the trigger condition is met, a scaling action occurs.If you use a token for authentication, you ",
+ "doc_type":"devg",
+ "kw":"Creating an AS Policy,Common Operations,Developer Guide",
+ "title":"Creating an AS Policy",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252684.html",
+ "product_code":"as",
+ "code":"8",
+ "des":"An instance is an ECS in an AS group.Adding Instances to or Removing Instances from an AS GroupIf you use a token for authentication, you must call the IAM API to obtain ",
+ "doc_type":"devg",
+ "kw":"Performing Operations on Instances in Batches,Common Operations,Developer Guide",
+ "title":"Performing Operations on Instances in Batches",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252685.html",
+ "product_code":"as",
+ "code":"9",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"devg",
+ "kw":"Appendix",
+ "title":"Appendix",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252686.html",
+ "product_code":"as",
+ "code":"10",
+ "des":"Response parameters are as follows.Parameter descriptionDescriptions of vpcs fieldsDescription of the route fieldExample response",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying VPCs,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying VPCs",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252687.html",
+ "product_code":"as",
+ "code":"11",
+ "des":"Response parameters are as follows.Parameter descriptionDescriptions of subnets fieldsExample response",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying Subnets,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying Subnets",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252688.html",
+ "product_code":"as",
+ "code":"12",
+ "des":"Response parameters are as follows.Parameter descriptionExample response",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying Security Groups,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying Security Groups",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252689.html",
+ "product_code":"as",
+ "code":"13",
+ "des":"Response parameters are as follows.Parameter descriptionExample response",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying Images,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying Images",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252690.html",
+ "product_code":"as",
+ "code":"14",
+ "des":"Response parameters are as follows.Parameter descriptionExample response",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying SSH Key Pairs,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying SSH Key Pairs",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252691.html",
+ "product_code":"as",
+ "code":"15",
+ "des":"Response parameters are as follows.Parameter descriptionlinks field data structure descriptionExample response",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying ECSs,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying ECSs",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252693.html",
+ "product_code":"as",
+ "code":"16",
+ "des":"Response parameters are as follows.Parameter descriptionscaling_groups field data structure descriptionlbaas_listeners field data structure descriptionnetworks field data",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying AS Groups,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying AS Groups",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252695.html",
+ "product_code":"as",
+ "code":"17",
+ "des":"Response parameters are as follows.Parameter descriptionscaling_configurations field descriptioninstance_config field descriptiondisk field descriptionpersonality field d",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying AS Configurations,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying AS Configurations",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0110252696.html",
+ "product_code":"as",
+ "code":"18",
+ "des":"Response parameters are as follows.Parameter descriptionscaling_group_instances field data structure descriptionExample response",
+ "doc_type":"devg",
+ "kw":"Response Parameters for Querying Instances in an AS Group,Appendix,Developer Guide",
+ "title":"Response Parameters for Querying Instances in an AS Group",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0136596144.html",
+ "product_code":"as",
+ "code":"19",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"devg",
+ "kw":"ICMP-Port Range Relationship Table,Appendix,Developer Guide",
+ "title":"ICMP-Port Range Relationship Table",
+ "githuburl":""
+ },
+ {
+ "uri":"en-us_topic_0139616237.html",
+ "product_code":"as",
+ "code":"20",
+ "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "doc_type":"devg",
+ "kw":"Change History,Developer Guide",
+ "title":"Change History",
+ "githuburl":""
+ }
+]
\ No newline at end of file
diff --git a/docs/as/dev/CLASS.TXT.json b/docs/as/dev/CLASS.TXT.json
new file mode 100644
index 000000000..795420fc1
--- /dev/null
+++ b/docs/as/dev/CLASS.TXT.json
@@ -0,0 +1,182 @@
+[
+ {
+ "desc":"This document describes how to call the APIs of Auto Scaling (AS) to use basic functions of the service.For details about how to use APIs, see API Usage Guidelines.",
+ "product_code":"as",
+ "title":"Overview",
+ "uri":"en-us_topic_0110252694.html",
+ "doc_type":"devg",
+ "p_code":"",
+ "code":"1"
+ },
+ {
+ "desc":"AS GroupAn AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling ac",
+ "product_code":"as",
+ "title":"Basic Concepts",
+ "uri":"en-us_topic_0110252697.html",
+ "doc_type":"devg",
+ "p_code":"",
+ "code":"2"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"as",
+ "title":"Common Operations",
+ "uri":"en-us_topic_0110252699.html",
+ "doc_type":"devg",
+ "p_code":"",
+ "code":"3"
+ },
+ {
+ "desc":"An AS configuration specifies the specifications of the ECSs to be added to an AS group, including the ECS specifications, images, and disks. You can create an AS configu",
+ "product_code":"as",
+ "title":"Creating an AS Configuration",
+ "uri":"en-us_topic_0110252700.html",
+ "doc_type":"devg",
+ "p_code":"3",
+ "code":"4"
+ },
+ {
+ "desc":"An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions.If",
+ "product_code":"as",
+ "title":"Creating an AS Group",
+ "uri":"en-us_topic_0110252701.html",
+ "doc_type":"devg",
+ "p_code":"3",
+ "code":"5"
+ },
+ {
+ "desc":"An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions.On",
+ "product_code":"as",
+ "title":"Enabling an AS Group",
+ "uri":"en-us_topic_0110252702.html",
+ "doc_type":"devg",
+ "p_code":"3",
+ "code":"6"
+ },
+ {
+ "desc":"An AS policy specifies a condition for triggering a scaling action. When the trigger condition is met, a scaling action occurs.If you use a token for authentication, you ",
+ "product_code":"as",
+ "title":"Creating an AS Policy",
+ "uri":"en-us_topic_0110252703.html",
+ "doc_type":"devg",
+ "p_code":"3",
+ "code":"7"
+ },
+ {
+ "desc":"An instance is an ECS in an AS group.Adding Instances to or Removing Instances from an AS GroupIf you use a token for authentication, you must call the IAM API to obtain ",
+ "product_code":"as",
+ "title":"Performing Operations on Instances in Batches",
+ "uri":"en-us_topic_0110252684.html",
+ "doc_type":"devg",
+ "p_code":"3",
+ "code":"8"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"as",
+ "title":"Appendix",
+ "uri":"en-us_topic_0110252685.html",
+ "doc_type":"devg",
+ "p_code":"",
+ "code":"9"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionDescriptions of vpcs fieldsDescription of the route fieldExample response",
+ "product_code":"as",
+ "title":"Response Parameters for Querying VPCs",
+ "uri":"en-us_topic_0110252686.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"10"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionDescriptions of subnets fieldsExample response",
+ "product_code":"as",
+ "title":"Response Parameters for Querying Subnets",
+ "uri":"en-us_topic_0110252687.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"11"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionExample response",
+ "product_code":"as",
+ "title":"Response Parameters for Querying Security Groups",
+ "uri":"en-us_topic_0110252688.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"12"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionExample response",
+ "product_code":"as",
+ "title":"Response Parameters for Querying Images",
+ "uri":"en-us_topic_0110252689.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"13"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionExample response",
+ "product_code":"as",
+ "title":"Response Parameters for Querying SSH Key Pairs",
+ "uri":"en-us_topic_0110252690.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"14"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionlinks field data structure descriptionExample response",
+ "product_code":"as",
+ "title":"Response Parameters for Querying ECSs",
+ "uri":"en-us_topic_0110252691.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"15"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionscaling_groups field data structure descriptionlbaas_listeners field data structure descriptionnetworks field data",
+ "product_code":"as",
+ "title":"Response Parameters for Querying AS Groups",
+ "uri":"en-us_topic_0110252693.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"16"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionscaling_configurations field descriptioninstance_config field descriptiondisk field descriptionpersonality field d",
+ "product_code":"as",
+ "title":"Response Parameters for Querying AS Configurations",
+ "uri":"en-us_topic_0110252695.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"17"
+ },
+ {
+ "desc":"Response parameters are as follows.Parameter descriptionscaling_group_instances field data structure descriptionExample response",
+ "product_code":"as",
+ "title":"Response Parameters for Querying Instances in an AS Group",
+ "uri":"en-us_topic_0110252696.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"18"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"as",
+ "title":"ICMP-Port Range Relationship Table",
+ "uri":"en-us_topic_0136596144.html",
+ "doc_type":"devg",
+ "p_code":"9",
+ "code":"19"
+ },
+ {
+ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
+ "product_code":"as",
+ "title":"Change History",
+ "uri":"en-us_topic_0139616237.html",
+ "doc_type":"devg",
+ "p_code":"",
+ "code":"20"
+ }
+]
\ No newline at end of file
diff --git a/docs/as/dev/PARAMETERS.txt b/docs/as/dev/PARAMETERS.txt
new file mode 100644
index 000000000..6da8d5f07
--- /dev/null
+++ b/docs/as/dev/PARAMETERS.txt
@@ -0,0 +1,3 @@
+version=""
+language="en-us"
+type=""
\ No newline at end of file
diff --git a/docs/as/dev/en-us_topic_0110252684.html b/docs/as/dev/en-us_topic_0110252684.html
new file mode 100644
index 000000000..348977dc1
--- /dev/null
+++ b/docs/as/dev/en-us_topic_0110252684.html
@@ -0,0 +1,27 @@
+
+
+Performing Operations on Instances in Batches
+Scenario
- An instance is an ECS in an AS group.
- Adding Instances to or Removing Instances from an AS Group
+
+
Precautions
- If you use a token for authentication, you must call the IAM API to obtain the user's token and add X-Auth-Token to the request message header of ECS API you call.
- The validity period of the token obtained from the IAM service is 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently calling the IAM API.
- The number of instances after the removal must be greater than or equal to the minimum number of instances allowed.
- The number of instances after the adding must be less than or equal to the maximum number of instances allowed.
- Instances can be added to an AS group only when the AS group is in the INSERVICE state and has no scaling action in progress.
- You can remove instances from an AS group only when no scaling action is in progress.
- The instances are removable only when they are in INSERVICE state.
- To add instances to an AS group, ensure that the AZ of the instances must be within the AZ of the AS group and that the instances are in the same VPC as the AS group.
+
+
Involved APIs
- IAM API used to obtain the token
- API used to query AS groups
- API used to query instances in an AS group
- API used to query ECSs (native OpenStack API)
- API used to perform operations on instances in batches
+
+
Procedure
- For details about token authentication, see Token Authentication.
- Send GET https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_group to obtain AS groups. Use the ID of one of the AS groups as the URI parameter scaling_group_id for querying instances in an AS group. For the response parameters of the API used to query AS groups, see section Response Parameters for Querying AS Groups.
- Send GET https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_group_instance/{scaling_group_id}/list to obtain instances of a specified AS group, such as instance_id_1 and instance_id_2. For the response parameters of the API used to query instances of an AS group, see section Response Parameters for Querying Instances in an AS Group.
- Send POST https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_group_instance/{scaling_group_id}/action to remove instances from an AS group in batches. For detailed parameters, see section "Performing Operations on Instances in Batches" in the Auto Scaling API Reference.
Specify the following parameters in the request body:
{
+ "action": "REMOVE",
+ "instances_id": [
+ "instance_id_1",
+ "instance_id_2"
+ ],
+ "instance_delete": "yes"
+}
+
+
+
Appendix
+
+
+
diff --git a/docs/as/dev/en-us_topic_0110252686.html b/docs/as/dev/en-us_topic_0110252686.html
new file mode 100644
index 000000000..48660d242
--- /dev/null
+++ b/docs/as/dev/en-us_topic_0110252686.html
@@ -0,0 +1,135 @@
+
+
+Response Parameters for Querying VPCs
+Response parameters are as follows.
+
Parameter description
+
+
Table 1 Response parameterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+vpcs
+ |
+Array of vpcs objects
+ |
+Specifies the VPC objects.
+ |
+
+
+
+
+
Descriptions of vpcs fields
+
+
Table 2 vpcs field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Specifies a resource ID in UUID format.
+ |
+
+name
+ |
+String
+ |
+- Specifies the VPC name.
- The value is a string of no more than 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.).
- Each VPC name of a tenant must be unique if the VPC name is not left blank.
+ |
+
+description
+ |
+String
+ |
+- Provides supplementary information about the VPC.
- The value is a string of no more than 255 characters and cannot contain angle brackets (< or >).
+ |
+
+cidr
+ |
+String
+ |
+- Specifies the available IP address ranges for subnets in the VPC.
- Possible values are as follows:
- 10.0.0.0/8~24
- 172.16.0.0/12~24
- 192.168.0.0/16~24
+ - If cidr is not specified, the default value is left blank.
- The value must be in CIDR format, for example, 192.168.0.0/16.
+ |
+
+status
+ |
+String
+ |
+- Specifies the VPC status.
- Possible values are as follows:
- CREATING: The VPC is being created.
- OK: The VPC is created successfully.
+
+ |
+
+routes
+ |
+Array of route objects
+ |
+- Specifies the route information.
- For details about constraints, see Table 3.
+ |
+
+enable_shared_snat
+ |
+Boolean
+ |
+Specifies whether the shared SNAT function is enabled. The value true indicates that the function is enabled, and the value false indicates that the function is not enabled.
+ |
+
+
+
+
+
Description of the route field
+
+
Table 3 route objectsName
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+destination
+ |
+String
+ |
+- Specifies the destination network segment of a route.
- The value must be in the CIDR format. Currently, only the value 0.0.0.0/0 is supported.
+ |
+
+nexthop
+ |
+String
+ |
+- Specifies the next hop of a route.
- The value must be an IP address and must belong to the subnet in the VPC. Otherwise, this value does not take effect.
+ |
+
+
+
+
+
Example response
+
{
+ "vpc":
+ {
+ "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
+ "name": "vpc",
+ "description": "test",
+ "cidr": "192.168.0.0/16",
+ "status": "CREATING",
+ "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
+ "routes": []
+ }
+}
+
Response Parameters for Querying Subnets
+Response parameters are as follows.
+
Parameter description
+
+
Table 1 Response parameterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+subnets
+ |
+Array of subnets objects
+ |
+Specifies the subnets objects.
+ |
+
+
+
+
+
Descriptions of subnets fields
+
+
Table 2 subnets objectsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Specifies a resource ID in UUID format.
+ |
+
+name
+ |
+String
+ |
+- Specifies the subnet name.
- The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).
+ |
+
+description
+ |
+String
+ |
+- Provides supplementary information about the subnet.
- The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
+ |
+
+cidr
+ |
+String
+ |
+Specifies the subnet CIDR block.
+ |
+
+gateway_ip
+ |
+String
+ |
+Specifies the subnet gateway address.
+ |
+
+dhcp_enable
+ |
+Boolean
+ |
+Specifies whether the DHCP function is enabled for the subnet.
+ |
+
+primary_dns
+ |
+String
+ |
+Specifies the IP address of DNS server 1 on the subnet.
+ |
+
+secondary_dns
+ |
+String
+ |
+Specifies the IP address of DNS server 2 on the subnet.
+ |
+
+dnsList
+ |
+Array of strings
+ |
+Specifies the IP address list of DNS servers on the subnet.
+ |
+
+availability_zone
+ |
+String
+ |
+Identifies the AZ to which the subnet belongs.
+ |
+
+vpc_id
+ |
+String
+ |
+Specifies the ID of the VPC to which the subnet belongs.
+ |
+
+status
+ |
+String
+ |
+- Specifies the status of the subnet.
- The value can be ACTIVE, UNKNOWN, or ERROR.
- ACTIVE: indicates that the subnet has been associated with a VPC.
- UNKNOWN: indicates that the subnet has not been associated with a VPC.
- ERROR: indicates that the subnet is abnormal.
+
+ |
+
+neutron_network_id
+ |
+String
+ |
+Specifies the ID of the corresponding network (OpenStack Neutron API).
+ |
+
+neutron_subnet_id
+ |
+String
+ |
+Specifies the ID of the corresponding subnet (OpenStack Neutron API).
+ |
+
+extra_dhcp_opts
+ |
+Array of extra_dhcp_opt objects
+ |
+Specifies the NTP server address configured for the subnet. For details, see Table 3.
+ |
+
+
+
+
+
+
Table 3 extra_dhcp_opt objectName
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+opt_value
+ |
+No
+ |
+String
+ |
+- Specifies the NTP server address configured for the subnet.
- Constraints:
The option ntp for opt_name indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). The option null for opt_name indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string.
+
+ |
+
+opt_name
+ |
+Yes
+ |
+String
+ |
+- Specifies the NTP server address name configured for the subnet.
- Currently, the value can only be set to ntp.
+ |
+
+
+
+
+
Example response
+
{
+ "subnets": [
+ {
+ "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
+ "name": "subnet",
+ "cidr": "192.168.20.0/24",
+ "dnsList": [
+ "114.xx.xx.114",
+ "114.xx.xx.115"
+ ],
+ "status": "ACTIVE",
+ "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
+ "gateway_ip": "192.168.20.1",
+ "dhcp_enable": true,
+ "primary_dns": "114.xx.xx.114",
+ "secondary_dns": "114.xx.xx.115",
+ "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc.
+ "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
+ "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12",
+ "extra_dhcp_opts": [
+ {
+ "opt_value": "10.100.0.33,10.100.0.34",
+ "opt_name": "ntp"
+ }
+ ]
+ },
+ {
+ "id": "531dec0f-3116-411b-a21b-e612e42349fd",
+ "name": "Subnet1",
+ "description": "",
+ "cidr": "192.168.1.0/24",
+ "dnsList": [
+ "114.xx.xx.114",
+ "114.xx.xx.115"
+ ],
+ "status": "ACTIVE",
+ "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
+ "gateway_ip": "192.168.1.1",
+ "dhcp_enable": true,
+ "primary_dns": "114.xx.xx.114",
+ "secondary_dns": "114.xx.xx.115",
+ "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc.
+ "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd",
+ "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78",
+ "extra_dhcp_opts": [
+ {
+ "opt_value": "10.100.0.33,10.100.0.34",
+ "opt_name": "ntp"
+ }
+ ]
+ }
+ ]
+}
+
Response Parameters for Querying Security Groups
+Response parameters are as follows.
+
Parameter description
+
+
Table 1 Response parameterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+security_groups
+ |
+Array of security_group objects
+ |
+Specifies the security group objects. For details, see Table 2.
+ |
+
+
+
+
+
+
Table 2 Description of security_group fieldsName
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+Yes
+ |
+String
+ |
+- Specifies the security group name.
- The value is a string of 1 to 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.).
+ |
+
+vpc_id
+ |
+No
+ |
+String
+ |
+Specifies the resource ID of the VPC to which the security group belongs.
+ NOTE: This parameter has been discarded, it is not recommended to use it.
+
+ |
+
+enterprise_project_id
+ |
+No
+ |
+String
+ |
+- Specifies the enterprise project ID. When creating a security group, associate the enterprise project ID with the security group.
- The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). Value 0 indicates the default enterprise project.
+ NOTE: This parameter is unsupported. Do not use it.
+
+ |
+
+
+
+
+
+
Table 3 security_group_rules objectsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Specifies the security group rule ID, which uniquely identifies the security group rule.
+ |
+
+description
+ |
+String
+ |
+- Provides supplementary information about the security group rule.
- The value is a string of no more than 255 characters that can contain letters and digits.
+ |
+
+security_group_id
+ |
+String
+ |
+Specifies the security group rule ID, which uniquely identifies the security group rule.
+ |
+
+direction
+ |
+String
+ |
+- Specifies the direction of access control.
- The value can be egress or ingress.
+ |
+
+ethertype
+ |
+String
+ |
+- Specifies the IP protocol version.
- The value can be IPv4 or IPv6.
+ |
+
+protocol
+ |
+String
+ |
+- Specifies the protocol type.
- The value can be icmp, tcp, udp, or others.
- If the parameter is left blank, the security group supports all protocols.
+ |
+
+port_range_min
+ |
+int
+ |
+- Specifies the start port number.
- The value ranges from 1 to 65535.
- The value cannot be greater than the port_range_max value. An empty value indicates all ports. If the protocol is icmp, the value range is shown in ICMP-Port Range Relationship Table.
+ |
+
+port_range_max
+ |
+int
+ |
+- Specifies the end port number.
- The value ranges from 1 to 65535.
- If the protocol is not icmp, the value cannot be smaller than the port_range_min value. An empty value indicates all ports. If the protocol is icmp, the value range is shown in ICMP-Port Range Relationship Table.
+ |
+
+remote_ip_prefix
+ |
+String
+ |
+- Specifies the remote IP address. If the access control direction is set to egress, the parameter specifies the source IP address. If the access control direction is set to ingress, the parameter specifies the destination IP address.
- The value can be in the CIDR format or IP addresses.
- The parameter is exclusive with parameter remote_group_id.
+ |
+
+remote_group_id
+ |
+String
+ |
+- Specifies the ID of the peer security group.
- The value is exclusive with parameter remote_ip_prefix.
+ |
+
+
+
+
+
Example response
+
{
+ "security_groups": [
+ {
+ "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6",
+ "name": "qq",
+ "description": "qq",
+ "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
+
+ "security_group_rules": [
+ {
+ "direction": "egress",
+ "ethertype": "IPv4",
+ "id": "369e6499-b2cb-4126-972a-97e589692c62",
+ "description": "",
+ "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6"
+ },
+ {
+ "direction": "ingress",
+ "ethertype": "IPv4",
+ "id": "0222556c-6556-40ad-8aac-9fd5d3c06171",
+ "description": "",
+ "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6",
+ "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6"
+ }
+ ]
+ },
+ {
+ "id": "9c0f56be-a9ac-438c-8c57-fce62de19419",
+ "name": "default",
+ "description": "qq",
+ "vpc_id": "13551d6b-755d-4757-b956-536f674975c0",
+
+ "security_group_rules": [
+ {
+ "direction": "egress",
+ "ethertype": "IPv4",
+ "id": "95479e0a-e312-4844-b53d-a5e4541b783f",
+ "description": "",
+ "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419"
+ },
+ {
+ "direction": "ingress",
+ "ethertype": "IPv4",
+ "id": "0c4a2336-b036-4fa2-bc3c-1a291ed4c431",
+ "description": "",
+ "remote_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419",
+ "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419"
+ }
+ ]
+ }
+ ]
+}
+
Response Parameters for Querying Images
+Response parameters are as follows.
+
Parameter description
+
+
Parameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+file
+ |
+Yes
+ |
+String
+ |
+Specifies the URL for uploading and downloading the image file.
+ |
+
+owner
+ |
+Yes
+ |
+String
+ |
+Specifies the tenant to which the image belongs.
+ |
+
+id
+ |
+Yes
+ |
+String
+ |
+Indicates the image ID.
+ |
+
+size
+ |
+Yes
+ |
+Long
+ |
+This parameter is unavailable currently.
+ |
+
+self
+ |
+Yes
+ |
+String
+ |
+Specifies the image URL.
+ |
+
+schema
+ |
+Yes
+ |
+String
+ |
+Specifies the image schema.
+ |
+
+status
+ |
+Yes
+ |
+String
+ |
+Specifies the image status. Possible values are:
+- queued: indicates that the image metadata has already been created, and it is ready for the image file to upload.
- saving: indicates that the image file is being uploaded to the backend storage.
- deleted: indicates that the image has been deleted.
- killed: indicates that an error occurs on the image uploading.
- active: indicates that the image is available for use.
+ |
+
+tags
+ |
+Yes
+ |
+List<String>
+ |
+Specifies the image tags using which the user can manage private images in a user-defined way. Users can use the image tag interface to add different tags for each image and filter images by tag.
+ |
+
+visibility
+ |
+Yes
+ |
+String
+ |
+Specifies whether the image can be seen by other tenants. The value can be private or public.
+ |
+
+name
+ |
+Yes
+ |
+String
+ |
+Specifies the image name.
+ |
+
+checksum
+ |
+Yes
+ |
+String
+ |
+This parameter is unavailable currently.
+ |
+
+deleted
+ |
+Yes
+ |
+Boolean
+ |
+Specifies whether the image has been deleted. The value can be true or false.
+ |
+
+protected
+ |
+Yes
+ |
+Boolean
+ |
+Specifies whether the image is protected. A protected image cannot be deleted. The value of this parameter can be true or false.
+ |
+
+container_format
+ |
+Yes
+ |
+String
+ |
+Specifies the container type.
+ |
+
+min_ram
+ |
+Yes
+ |
+Int
+ |
+Specifies the minimum memory size (MB) required for running the image. The parameter value depends on the ECS specifications limit. The value is generally set to 0.
+ |
+
+updated_at
+ |
+Yes
+ |
+String
+ |
+Specifies the time when a DR drill was updated. The value is in UTC format.
+ |
+
+__os_bit
+ |
+No
+ |
+String
+ |
+Specifies the number of bits in the operating system: 32 or 64.
+ |
+
+__os_version
+ |
+No
+ |
+String
+ |
+Specifies the OS version.
+ |
+
+__description
+ |
+No
+ |
+String
+ |
+Provides supplementary information about the image.
+ |
+
+disk_format
+ |
+Yes
+ |
+String
+ |
+Specifies the image format. The value can be vhd, raw, or qcow2.
+ |
+
+__isregistered
+ |
+No
+ |
+String
+ |
+Specifies whether the image has been registered. The value can be true or false.
+ |
+
+__platform
+ |
+No
+ |
+String
+ |
+Specifies the image platform type. The value can be Windows, Ubuntu, RedHat, SUSE, CentOS, Debian, OpenSUSE, Oracle Linux, Fedora, Other, CoreOS, or EulerOS.
+ |
+
+__os_type
+ |
+No
+ |
+String
+ |
+Specifies the operating system type. The value can be Linux, Windows, or Other.
+ |
+
+min_disk
+ |
+Yes
+ |
+Int
+ |
+Specifies the minimum disk space (GB) required for running the image. The value ranges from 1 GB to 1024 GB.
+ |
+
+virtual_env_type
+ |
+Yes
+ |
+String
+ |
+Specifies the environment where the image is used. The value can be FusionCompute, Ironic, or DataImage. For an ECS image, the value is FusionCompute. For a data disk image, the value is DataImage. For a BMS image, the value is Ironic.
+ |
+
+__image_source_type
+ |
+No
+ |
+String
+ |
+Specifies the image backend storage type. Only UDS is supported currently.
+ |
+
+__imagetype
+ |
+No
+ |
+String
+ |
+Specifies the image type. The following types are supported:
+- Public image: The value is gold.
- Private image: The value is private.
- Shared image: The value is shared.
+ |
+
+created_at
+ |
+No
+ |
+String
+ |
+Specifies the time when a DR drill was created. The value is in UTC format.
+ |
+
+virtual_size
+ |
+No
+ |
+Int
+ |
+This parameter is unavailable currently.
+ |
+
+deleted_at
+ |
+No
+ |
+String
+ |
+Specifies the time when the image was deleted. The value is in UTC format.
+ |
+
+__originalimagename
+ |
+No
+ |
+String
+ |
+Specifies the parent image ID.
+If the image is a public image or it is created using a file, this value is left empty.
+ |
+
+__backup_id
+ |
+No
+ |
+String
+ |
+Backup ID To create an image using a backup, set the value to the backup ID. Otherwise, this value is left empty.
+ |
+
+__productcode
+ |
+No
+ |
+String
+ |
+Specifies the ID of the market image product.
+ |
+
+__image_size
+ |
+No
+ |
+String
+ |
+Specifies the size (bytes) of the image file.
+ |
+
+__data_origin
+ |
+No
+ |
+String
+ |
+Specifies the image resource.
+If the image is a public image, this parameter is left empty.
+ |
+
+__support_xen
+ |
+No
+ |
+String
+ |
+Specifies whether the image supports Xen. If yes, the value is true. Otherwise, this attribute is not required.
+ |
+
+__support_largememory
+ |
+No
+ |
+String
+ |
+Specifies whether the image supports large-memory ECSs. If the image supports large-memory ECSs, the value is true. Otherwise, this attribute is not required.
+ |
+
+__support_diskintensive
+ |
+No
+ |
+String
+ |
+Specifies whether the image supports disk-intensive ECSs. If the image supports disk-intensive ECSs, the value is true. Otherwise, this attribute is not required.
+ |
+
+__support_highperformance
+
+ |
+No
+ |
+String
+ |
+Specifies whether the image supports high-performance ECSs. If the image supports high-performance ECSs, the value is true. Otherwise, this attribute is not required.
+ |
+
+__support_xen_gpu_type
+ |
+No
+ |
+String
+
+ |
+Specifies whether the image supports GPU-optimized ECSs on the Xen platform. If the GPU-optimized image is not supported on Xen, this attribute is not required. This attribute cannot co-exist with __support_xen.
+ |
+
+__support_xen_hana
+ |
+No
+ |
+String
+ |
+Specifies whether the image supports HANA ECSs on the Xen platform. If yes, the value is true. Otherwise, this attribute is not required.
+This attribute cannot co-exist with __support_xen.
+ |
+
+__support_kvm_infiniband
+ |
+No
+ |
+String
+ |
+Specifies whether the image supports ECSs with the InfiniBand NIC on the KVM platform. If yes, the value is true. Otherwise, this attribute is not required.
+This attribute cannot co-exist with __support_xen.
+ |
+
+
+
+
+
Example response
+
STATUS CODE 200
+
1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70 | {
+ "images": [
+ {
+ "schema": "/v2/schemas/image",
+ "min_disk": 100,
+ "created_at": "2018-09-06T14:03:27Z",
+ "__image_source_type": "uds",
+ "container_format": "bare",
+ "file": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52/file",
+ "updated_at": "2018-09-06T15:17:33Z",
+ "protected": true,
+ "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+ "__support_kvm_fpga_type": "VU9P",
+ "id": "bc6bed6e-ba3a-4447-afcc-449174a3eb52",
+ "__isregistered": "true",
+ "min_ram": 2048,
+ "__lazyloading": "true",
+ "owner": "1bed856811654c1cb661a6ca845ebc77",
+ "__os_type": "Linux",
+ "__imagetype": "gold",
+ "visibility": "public",
+ "virtual_env_type": "FusionCompute",
+ "tags": [],
+ "__platform": "CentOS",
+ "size": 0,
+ "__os_bit": "64",
+ "__os_version": "CentOS 7.3 64bit",
+ "name": "CentOS 7.3 64bit vivado",
+ "self": "/v2/images/bc6bed6e-ba3a-4447-afcc-449174a3eb52",
+ "disk_format": "zvhd2",
+ "virtual_size": null,
+ "hw_firmware_type": "bios",
+ "status": "active",
+ "__support_fc_inject":"true"
+ },
+ {
+ "schema": "/v2/schemas/image",
+ "min_disk": 100,
+ "created_at": "2018-09-06T14:03:05Z",
+ "__image_source_type": "uds",
+ "container_format": "bare",
+ "file": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f/file",
+ "updated_at": "2018-09-25T14:27:40Z",
+ "protected": true,
+ "checksum": "d41d8cd98f00b204e9800998ecf8427e",
+ "__support_kvm_fpga_type": "VU9P_COMMON",
+ "id": "0328c25e-c840-4496-81ac-c4e01b214b1f",
+ "__isregistered": "true",
+ "min_ram": 2048,
+ "__lazyloading": "true",
+ "owner": "1bed856811654c1cb661a6ca845ebc77",
+ "__os_type": "Linux",
+ "__imagetype": "gold",
+ "visibility": "public",
+ "virtual_env_type": "FusionCompute",
+ "tags": [],
+ "__platform": "CentOS",
+ "size": 0,
+ "__os_bit": "64",
+ "__os_version": "CentOS 7.3 64bit",
+ "name": "CentOS 7.3 64bit with sdx",
+ "self": "/v2/images/0328c25e-c840-4496-81ac-c4e01b214b1f",
+ "disk_format": "zvhd2",
+ "virtual_size": null,
+ "hw_firmware_type": "bios",
+ "status": "active",
+ "__support_fc_inject":"true"
+ }
+ ]
+}
+ |
+
Response Parameters for Querying SSH Key Pairs
+Response parameters are as follows.
+
Parameter description
+
+
Parameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+keypairs
+ |
+List data structure
+ |
+Specifies key pairs. For details, see Table 1.
+ |
+
+
+
+
+
+
Table 1 keypairs field data structure descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+keypair
+ |
+Dictionary data structure
+ |
+Specifies details about a key pair. For details, see Table 2.
+ |
+
+
+
+
+
+
Table 2 keypair field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+fingerprint
+ |
+String
+ |
+Specifies fingerprint information about the key pair.
+ |
+
+name
+ |
+String
+ |
+Specifies the key pair name.
+ |
+
+type
+ |
+String
+ |
+Specifies the key type, which is ssh by default.
+This parameter is supported in microversion 2.2 and later.
+ |
+
+public_key
+ |
+String
+ |
+Specifies information about the public key.
+ |
+
+
+
+
+
Example response
+
{
+ "keypairs": [
+ {
+ "keypair": {
+ "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a",
+ "name": "keypair-601a2305-4f25-41ed-89c6-2a966fc8027a",
+ "type": "ssh",
+ "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova\n"
+ }
+ }
+ ]
+}
+
Response Parameters for Querying ECSs
+Response parameters are as follows.
+
Parameter description
+
+
Parameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+servers
+ |
+List data structure
+ |
+Specifies the ECSs to be queried. For details, see Table 1.
+ |
+
+servers_links
+ |
+Array of objects
+ |
+Specifies the link of the next page in pagination query. For details, see Table 2.
+ |
+
+
+
+
+
+
Table 1 servers field data structure descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+name
+ |
+String
+ |
+Specifies the ECS name.
+ |
+
+id
+ |
+String
+ |
+Specifies the unique identifier of the ECS.
+ |
+
+links
+ |
+List data structure
+ |
+Specifies ECS shortcut links. For details, see Table 2.
+ |
+
+
+
+
+
links field data structure description
+
+
Table 2 servers_links and links field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+rel
+ |
+String
+ |
+Specifies the shortcut link marker name.
+ |
+
+href
+ |
+String
+ |
+Specifies the shortcut link.
+ |
+
+
+
+
+
Example response
+
{
+ "servers": [
+ {
+ "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
+ "links": [
+ {
+ "href": "http://openstack.example.com/v2/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19",
+ "rel": "self"
+ },
+ {
+ "href": "http://openstack.example.com/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19",
+ "rel": "bookmark"
+ }
+ ],
+ "name": "new-server-test"
+ }
+ ]
+}
+
Response Parameters for Querying AS Groups
+Response parameters are as follows.
+
Parameter description
+
+
Table 1 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+total_number
+ |
+Integer
+ |
+Specifies the total number of resources.
+ |
+
+start_number
+ |
+Integer
+ |
+Specifies the start number of query records.
+ |
+
+limit
+ |
+Integer
+ |
+Specifies the maximum number of resources to be queried.
+ |
+
+scaling_groups
+ |
+Array of scaling_groups objects
+ |
+Specifies the scaling group list.
+ |
+
+
+
+
+
scaling_groups field data structure description
+
+
Table 2 scaling_groups field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+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_name
+ |
+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, in seconds.
+ |
+
+lb_listener_id
+ |
+String
+ |
+Specifies the ID of a typical ELB listener. ELB listener IDs are separated using commas (,).
+ |
+
+lbaas_listeners
+ |
+List data structure
+ |
+Specifies information about an enhanced load balancer. .
+ |
+
+available_zones
+ |
+List<String>
+ |
+Specifies the AZ information.
+ |
+
+networks
+ |
+List data structure
+ |
+Specifies the network information. For details, see Table 4.
+ |
+
+security_groups
+ |
+List data structure
+ |
+Specifies the security group information. For details, see Table 5.
+ |
+
+create_time
+ |
+String
+ |
+Specifies the time when the 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_method
+ |
+String
+ |
+Specifies the health check method.
+ |
+
+health_periodic_audit_time
+ |
+Integer
+ |
+Specifies the health check interval.
+ |
+
+health_periodic_audit_grace_period
+ |
+Integer
+ |
+Specifies the grace period for health check.
+ |
+
+instance_terminate_policy
+ |
+String
+ |
+Specifies the instance removal policy.
+ |
+
+notifications
+ |
+List<String>
+ |
+Specifies the notification method.
+EMAIL refers to notification by email.
+ |
+
+delete_publicip
+ |
+Boolean
+ |
+Specifies whether to delete the EIP bound to an ECS when deleting the ECS.
+ |
+
+cloud_location_id
+ |
+String
+ |
+This parameter is reserved.
+ |
+
+enterprise_project_id
+ |
+String
+ |
+Specifies the enterprise project ID.
+ |
+
+activity_type
+ |
+String
+ |
+Specifies the type of the scaling action.
+ |
+
+
+
+
+
lbaas_listeners field data structure description
+
+
Table 3 lbaas_listeners field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+listener_id
+ |
+String
+ |
+Specifies the listener ID.
+ |
+
+pool_id
+ |
+String
+ |
+Specifies the backend ECS group ID.
+ |
+
+protocol_port
+ |
+Integer
+ |
+Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic.
+ |
+
+weight
+ |
+Integer
+ |
+Specifies the weight, which determines the portion of requests a backend ECS processes when being compared to other backend ECSs added to the same listener.
+ |
+
+
+
+
+
networks field data structure description
+
+
Table 4 networks field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Specifies the subnet ID.
+ |
+
+
+
+
+
security_groups field data structure description
+
+
Table 5 security_groups field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Specifies the security group ID.
+ |
+
+
+
+
+
Example response
+
{
+ "limit": 20,
+ "scaling_groups": [
+ {
+ "networks": [
+ {
+ "id": "a8327883-6b07-4497-9c61-68d03ee193a",
+ "ipv6_enable": false,
+ "ipv6_bandwidth": null,
+ }
+ ],
+ "available_zones": [
+ "XXXa",
+ "XXXb"
+ ],
+ "detail": null,
+ "scaling_group_name": "as-group-test",
+ "scaling_group_id": "77a7a397-7d2f-4e79-9da9-6a35e2709150",
+ "scaling_group_status": "INSERVICE",
+ "scaling_configuration_id": "1d281494-6085-4579-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": "f06c0112570743b51c0e8fbe1f235bab",
+ "security_groups": [
+ {
+ "id": "8a4b1d5b-0054-419f-84b1-5c8a59ebc829"
+ }
+ ],
+ "create_time": "2015-07-23T02: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": [
+ "EMAIL"
+ ]
+ "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
+ "multi_az_priority_policy": "PICK_FIRST"
+ }
+ ],
+ "total_number": 1,
+ "start_number": 0
+}
+
Overview
+This document describes how to call the APIs of Auto Scaling (AS) to use basic functions of the service.
+
For details about how to use APIs, see API Usage Guidelines.
+
Response Parameters for Querying AS Configurations
+Response parameters are as follows.
+
Parameter description
+
+
Table 1 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+total_number
+ |
+Integer
+ |
+Specifies the total number of resources.
+ |
+
+start_number
+ |
+Integer
+ |
+Specifies the start line number.
+ |
+
+limit
+ |
+Integer
+ |
+Specifies the maximum number of resources to be queried.
+ |
+
+scaling_configurations
+ |
+Array of scaling_configurations objects
+ |
+Specifies the AS configuration list.
+ |
+
+
+
+
+
scaling_configurations field description
+
+
Table 2 scaling_configurations field descriptionParameter
+ |
+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.
+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. The time format complies with UTC.
+ |
+
+scaling_group_id
+ |
+String
+ |
+Specifies the ID of the AS group to which the AS configuration is bound.
+ |
+
+
+
+
+
instance_config field description
+
+
Table 3 instance_config field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+flavorRef
+ |
+String
+ |
+Specifies the ECS flavor ID.
+ |
+
+imageRef
+ |
+String
+ |
+Specifies the image ID. It is same as image_id.
+ |
+
+disk
+ |
+Array
+ |
+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.
+ |
+
+instance_id
+ |
+String
+ |
+This parameter is reserved.
+ |
+
+adminPass
+ |
+String
+ |
+This parameter is reserved.
+ |
+
+personality
+ |
+Array
+ |
+Specifies information about the injected file.
+ |
+
+public_ip
+ |
+Object
+ |
+Specifies the EIP of the ECS.
+ |
+
+user_data
+ |
+String
+ |
+Specifies the Cloud-Init user data, which is encoded using Base64.
+ |
+
+metadata
+ |
+Object
+ |
+Specifies the ECS metadata. For details, see Table 10.
+ |
+
+security_groups
+ |
+Array
+ |
+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.
+ |
+
+
+
+
+
disk field description
+
+
Table 4 disk field descriptionParameter
+ |
+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.
+ |
+
+metadata
+ |
+Object
+ |
+Specifies the metadata for creating disks. For details, see Table 5.
+ |
+
+
+
+
+
+
Table 5 metadata Field Description for Creating DisksParameter
+ |
+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" in Key Management Service API Reference.
+
+ |
+
+
+
+
+
personality field description
+
+
Table 6 personality field descriptionParameter
+ |
+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.
+ |
+
+
+
+
+
public_ip field description
+
+
Table 7 public_ip field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+eip
+ |
+eip object
+ |
+Specifies the EIP automatically assigned to the ECS.
+ |
+
+
+
+
+
eip field description
+
+
Table 8 eip field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+ip_type
+ |
+String
+ |
+Specifies the IP address type.
+ |
+
+bandwidth
+ |
+bandwidth object
+ |
+Specifies the bandwidth of an IP address.
+ |
+
+
+
+
+
bandwidth field description
+
+
Table 9 bandwidth field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+size
+ |
+Integer
+ |
+Specifies the bandwidth (Mbit/s).
+ |
+
+share_type
+ |
+String
+ |
+Specifies the bandwidth sharing type.
+Enumerated values of the sharing type:
+
+ |
+
+charging_mode
+ |
+String
+ |
+Specifies the bandwidth billing mode.
+- traffic: billed by traffic.
+ |
+
+
+
+
+
metadata field description
+
+
Table 10 metadata field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+admin_pass
+ |
+String
+ |
+Specifies the password of the Administrator account for a Windows ECS.
+ |
+
+
+
+
+
Example response
+
{
+ "limit": 20,
+ "total_number": 2,
+ "start_number": 0,
+ "scaling_configurations": [
+ {
+ "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"
+ }
+ ],
+ "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,
+ "metadate": {},
+ "security_groups": [{
+ "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be"
+ }],
+ },
+ "create_time": "2015-07-23T01:04:07Z"
+ },
+ {
+ "tenant": "ce061903a53545dcaddb300093b477d2",
+ "scaling_configuration_id": "24a8c5f3-c713-4aba-ac29-c17101009e5d",
+ "scaling_configuration_name": "config_name_2",
+ "instance_config": {
+ "disk": [
+ {
+ "size": 40,
+ "volume_type": "SATA",
+ "disk_type": "SYS"
+ }
+ ],
+ "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"
+ }],
+ "multi_flavor_priority_policy": "PICK_FIRST"
+ },
+ "create_time": "2015-07-22T01:08:41Z"
+ }
+ ]
+}
+
Response Parameters for Querying Instances in an AS Group
+Response parameters are as follows.
+
Parameter description
+
+
Table 1 Response parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+total_number
+ |
+Integer
+ |
+Specifies the total number of resources.
+ |
+
+start_number
+ |
+Integer
+ |
+Specifies the start line number.
+ |
+
+limit
+ |
+Integer
+ |
+Specifies the maximum number of resources to be queried.
+ |
+
+scaling_group_instances
+ |
+Array of scaling_group_instances objects
+ |
+Specifies details about the instances in the AS group.
+ |
+
+
+
+
+
scaling_group_instances field data structure description
+
+
Table 2 scaling_group_instances field descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+instance_id
+ |
+String
+ |
+Specifies the instance ID.
+ |
+
+instance_name
+ |
+String
+ |
+Specifies the instance name.
+ |
+
+scaling_group_id
+ |
+String
+ |
+Specifies the ID of the AS group to which the instance belongs.
+ |
+
+scaling_group_name
+ |
+String
+ |
+Specifies the name of the AS group to which the instance belongs.
+Supports fuzzy search.
+ |
+
+life_cycle_state
+ |
+String
+ |
+Specifies the instance lifecycle status in the AS group.
+- INSERVICE: The instance is enabled.
- PENDING: The instance is being added to the AS group.
- REMOVING: The instance is being removed from the AS group.
+ |
+
+health_status
+ |
+String
+ |
+Specifies the instance health status.
+- INITIALIZING: The instance is being initialized.
- NORMAL: The instance is functional.
- ERROR: The instance is faulty.
+ |
+
+scaling_configuration_name
+ |
+String
+ |
+Specifies the AS configuration name.
+ |
+
+scaling_configuration_id
+ |
+String
+ |
+Specifies the AS configuration ID.
+If the returned value is not empty, the instance is an ECS automatically created in a scaling action.
+If the returned value is empty, the instance is an ECS manually added to the AS group.
+ |
+
+create_time
+ |
+String
+ |
+Specifies the time when the instance is added to the AS group. The time format complies with UTC.
+ |
+
+protect_from_scaling_down
+ |
+Boolean
+ |
+Specifies the instance protection status.
+ |
+
+
+
+
+
Example response
+
{
+ "limit": 10,
+ "total_number": 1,
+ "start_number": 0,
+ "scaling_group_instances": [
+ {
+ "instance_id": "b25c1589-c96c-465b-9fef-d06540d1945c",
+ "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a",
+ "scaling_group_name": "discuz",
+ "life_cycle_state": "INSERVICE",
+ "health_status": "NORMAL",
+ "scaling_configuration_name": "discuz",
+ "scaling_configuration_id": "ca3dcd84-d197-4c4f-af2a-cf8ba39696ac",
+ "create_time": "2015-07-23T06:47:33Z",
+ "instance_name": "discuz_3D210808",
+ "protect_from_scaling_down": false
+ }
+ ]
+}
+
Basic Concepts
+
+
An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions.
+
AS Configuration
+
An AS configuration is an Elastic Cloud Server (ECS) instance template in an AS group, specifying specifications of the ECS to be added, including the ECS type, vCPU, memory, image, disk, and login mode.
+
AS Policy
+
An AS policy specifies a condition for triggering a scaling action.
+
AS supports the following policies:
+
Alarm: AS automatically increases or decreases the number of instances in an AS group or sets the number of instances to a specified value if Cloud Eye generates an alarm for a configured metric, such as CPU usage.
+
Periodic: AS increases or decreases the number of instances in an AS group or sets the number of instances to a specified value at a configured interval, such as one day, one week, or month.
+
Scheduled: AS automatically increases or decreases the number of instances in an AS group or sets the number of instances to a specified value at a specified time.
+
Instance
+
An instance is an ECS in an AS group.
+
Scaling Action
+
A scaling action adds or removes instances to or from an AS group so that the number of instances in the AS group is the same as the expected number for proper service running.
+
When the number of instances in an AS group is not the same as expected, a scaling action is triggered. Specifically, when the scaling condition is met or you manually change the expected number of instances, a scaling action is triggered.
+
Common Operations
+Prerequisites
You have obtained the Auto Scaling API Reference.
+
+
Creating an AS Configuration
+Scenario
An AS configuration specifies the specifications of the ECSs to be added to an AS group, including the ECS specifications, images, and disks. You can create an AS configuration using an existing ECS or create a new AS configuration.
+
+
Precautions
- If you use a token for authentication, you must call the IAM API to obtain the user's token and add X-Auth-Token to the request message header of ECS API you call.
- The validity period of the token obtained from the IAM service is 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently calling the IAM API.
+
+
Involved APIs
- IAM API used to obtain the token
- API used to query specifications and expansion details about ECSs
- API used to query images
- API used to query SSH key pairs
- API used to create an AS configuration
+
+
+
Procedure
- For details about token authentication, see Token Authentication.
- Send GET https://ECS endpoint/v1/{tenant_id}/cloudservers/flavors to obtain the ECS specifications. For details about the response parameters of the API used to query ECS specifications, see section Response Parameters for Querying ECSs.
- Send GET https://ECS endpoint/v2/{tenant_id}/os-keypairs to obtain the SSH key pair. For details about the response parameters of the API used to query SSH key pairs, see section Response Parameters for Querying SSH Key Pairs.
- Send GET https://IMS endpoint/v2/cloudimages to obtain images. For details about the response parameters of the API used to query images, see section Response Parameters for Querying Images.
- Send POST https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_configuration to create an AS configuration. For detailed parameters, see section "Creating an AS Configuration" in the Auto Scaling API Reference.
Specify the following parameters in the request body:
{
+ "scaling_configuration_name": "as-config-test",
+ "instance_config": {
+ "flavorRef": "103", //ECS flavor ID
+ "imageRef": "627a1223-2ca3-46a7-8d5f-7aef22c74ee6", //Image ID
+ "disk": [
+ {
+ "size": 40,
+ "volume_type": "SATA",
+ "disk_type": "SYS"
+ }
+ ],
+ "key_name": "as-keypair-test" //SSH key pair
+}
+}
+
scaling_configuration_id is returned if the request is successful.
+
+
+
Creating an AS Group
+Scenario
An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions.
+
+
Precautions
- If you use a token for authentication, you must call the IAM API to obtain the user's token and add X-Auth-Token to the request message header of ECS API you call.
- The validity period of the token obtained from the IAM service is 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently calling the IAM API.
+
+
+
Involved APIs
- IAM API used to obtain the token
- API used to query VPCs
- API used to query subnets
- API used to query security groups
- API used to query AS configurations
- API used to create an AS group
+
+
Procedure
- For details about token authentication, see Token Authentication.
- Send GET https://VPC endpoint/v1/{tenant_id}/vpcs to obtain VPCs. Use the ID of one of the obtained VPCs as parameter vpc_id for creating an AS group, such as a8327883-6b07-4497-9c61-68d03ee193. For the response parameters of the API used to query VPCs, see section Response Parameters for Querying VPCs.
- Send GET https://VPC endpoint /v1/{tenant_id}/security-groups to obtain security groups. Use one of the obtained security groups as parameter security_groups for creating an AS group. For the response parameters of the API used to query security groups, see section Response Parameters for Querying Security Groups.
- Send GET https://VPC endpoint /v1/{tenant_id}/subnets?vpc_id=a8327883-6b07-4497-9c61-68d03ee193a to obtain subnets in a specified VPC. For the response parameters of the API used to query subnets, see section Response Parameters for Querying Subnets.
- Send GET https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_configuration to obtain AS configurations. Use the ID of one of the obtained AS configurations as parameter scaling_configuration_id for creating an AS group. For the response parameters of the API used to query AS configurations, see section Response Parameters for Querying AS Configurations.
- Send POST https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_group to create an AS group. For detailed parameters, see section "Creating an AS Group" in the Auto Scaling API Reference.
Specify the following parameters in the request body:
{
+ "scaling_group_name": "as-group-test",
+ "scaling_configuration_id": "47683a91-93ee-462a-a7d7-484c006f4440",
+ "desire_instance_number": 0,
+ "min_instance_number": 0,
+ "max_instance_number": 10,
+ "cool_down_time": 300,
+ "health_periodic_audit_method": "NOVA_AUDIT",
+ "health_periodic_audit_time": 5,
+ "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",
+ "vpc_id": "a8327883-6b07-4497-9c61-68d03ee193a",
+ "networks": [
+ {
+ "id": "3cd35bca-5a10-416f-8994-f79169559870"
+ }
+ ],
+ "security_groups": [
+ {
+ "id": "23b7b999-0a30-4b48-ae8f-ee201a88a6ab"
+ }
+ ]
+}
+
scaling_group_id is returned if the request is successful.
+
+
+
Enabling an AS Group
+Scenario
- An AS group consists of a collection of instances that apply to the same scenario. It is the basis for enabling or disabling AS policies and performing scaling actions.
- Only enabled AS groups support scaling actions.
+
+
Precautions
- If you use a token for authentication, you must call the IAM API to obtain the user's token and add X-Auth-Token to the request message header of ECS API you call.
- The validity period of the token obtained from the IAM service is 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently calling the IAM API.
+
+
Involved APIs
- IAM API used to obtain the token
- API used to query AS groups
- API used to enable or disable an AS group
+
+
Procedure
- For details about token authentication, see Token Authentication.
- Send GET https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_group to obtain AS groups. Use the ID of one of the AS groups as the URI parameter scaling_group_id for enabling an AS group. For the response parameters of the API used to query AS groups, see section Response Parameters for Querying AS Groups.
- Send POST https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_group/{scaling_group_id}/action to enable the AS group. For detailed parameters, see section "Enabling or Disabling an AS Group" in the Auto Scaling API Reference.
Specify the following parameters in the request body:
{
+ "action": "resume"
+}
+
+
+
Creating an AS Policy
+Scenario
An AS policy specifies a condition for triggering a scaling action. When the trigger condition is met, a scaling action occurs.
+
+
Precautions
- If you use a token for authentication, you must call the IAM API to obtain the user's token and add X-Auth-Token to the request message header of ECS API you call.
- The validity period of the token obtained from the IAM service is 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently calling the IAM API.
+
+
Involved APIs
- IAM API used to obtain the token
- API used to query AS groups
- API used to create an AS policy
+
+
Procedure
- For details about token authentication, see Token Authentication.
- Send GET https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_group to obtain AS groups. Use the ID of one of the AS groups as parameter scaling_group_id for creating an AS policy. For the response parameters of the API used to query AS groups, see section Response Parameters for Querying AS Groups.
- Send POST https://AS endpoint/autoscaling-api/v1/{tenant_id}/scaling_policy to create an AS policy, such as a periodic policy which is executed on Sunday, Tuesday, and Thursday. For detailed parameters, see section "Creating an AS Policy" in the Auto Scaling API Reference.
Specify the following parameters in the request body:
{
+ "scaling_policy_name": "as-policy-test",
+ "scaling_policy_action": {
+ "operation": "ADD",
+ "instance_number": 1
+ },
+ "cool_down_time": 900,
+ "scheduled_policy": {
+ "launch_time": "16:00",
+ "recurrence_type": "Weekly",
+ "recurrence_value": "1,3,5",
+ "start_time": "2018-05-04T03:34Z",
+ "end_time": "2018-12-27T03:34Z"
+ },
+ "scaling_policy_type": "RECURRENCE",
+ "scaling_group_id": "5bc3aa02-b83e-454c-aba1-4d2095c68f8b"
+}
+
scaling_policy_id is returned if the request is successful.
+
+
+
ICMP-Port Range Relationship Table
+
+
ICMP Type
+ |
+port_range_min
+ |
+port_range_max
+ |
+
|---|
+
+Any
+ |
+NULL
+ |
+NULL
+ |
+
+Echo
+ |
+8
+ |
+0
+ |
+
+Echo reply
+ |
+0
+ |
+0
+ |
+
+Fragment need DF set
+ |
+3
+ |
+4
+ |
+
+Host redirect
+ |
+5
+ |
+1
+ |
+
+Host TOS redirect
+ |
+5
+ |
+3
+ |
+
+Host unreachable
+ |
+3
+ |
+1
+ |
+
+Information reply
+ |
+16
+ |
+0
+ |
+
+Information request
+ |
+15
+ |
+0
+ |
+
+Net redirect
+ |
+5
+ |
+0
+ |
+
+Net TOS redirect
+ |
+5
+ |
+2
+ |
+
+Net unreachable
+ |
+3
+ |
+0
+ |
+
+Parameter problem
+ |
+12
+ |
+0
+ |
+
+Port unreachable
+ |
+3
+ |
+3
+ |
+
+Protocol unreachable
+ |
+3
+ |
+2
+ |
+
+Reassembly timeout
+ |
+11
+ |
+1
+ |
+
+Source quench
+ |
+4
+ |
+0
+ |
+
+Source route failed
+ |
+3
+ |
+5
+ |
+
+Timestamp reply
+ |
+14
+ |
+0
+ |
+
+Timestamp request
+ |
+13
+ |
+0
+ |
+
+TTL exceeded
+ |
+11
+ |
+0
+ |
+
+
+
+
+
Change History
+
+
Released On
+ |
+What's New
+ |
+
|---|
+
+2021-10-20
+ |
+This release incorporates the following change:
+Change
+Updated response parameters in Response Parameters for Querying ECSs.
+ |
+
+2018-11-08
+ |
+This issue is the first official release.
+ |
+
+
+
+
+
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式
+*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre}
\ No newline at end of file
diff --git a/docs/as/dev/public_sys-resources/danger_3.0-en-us.png b/docs/as/dev/public_sys-resources/danger_3.0-en-us.png
new file mode 100644
index 000000000..47a9c7235
Binary files /dev/null and b/docs/as/dev/public_sys-resources/danger_3.0-en-us.png differ
diff --git a/docs/as/dev/public_sys-resources/delta.gif b/docs/as/dev/public_sys-resources/delta.gif
new file mode 100644
index 000000000..0d1b1f674
Binary files /dev/null and b/docs/as/dev/public_sys-resources/delta.gif differ
diff --git a/docs/as/dev/public_sys-resources/deltaend.gif b/docs/as/dev/public_sys-resources/deltaend.gif
new file mode 100644
index 000000000..cc7da0fc8
Binary files /dev/null and b/docs/as/dev/public_sys-resources/deltaend.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-arrowdn.gif b/docs/as/dev/public_sys-resources/icon-arrowdn.gif
new file mode 100644
index 000000000..84eec9be2
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-arrowdn.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-arrowrt.gif b/docs/as/dev/public_sys-resources/icon-arrowrt.gif
new file mode 100644
index 000000000..39583d168
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-arrowrt.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-caution.gif b/docs/as/dev/public_sys-resources/icon-caution.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-caution.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-danger.gif b/docs/as/dev/public_sys-resources/icon-danger.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-danger.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-huawei.gif b/docs/as/dev/public_sys-resources/icon-huawei.gif
new file mode 100644
index 000000000..a31d60f89
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-huawei.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-note.gif b/docs/as/dev/public_sys-resources/icon-note.gif
new file mode 100644
index 000000000..31be2b039
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-note.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-notice.gif b/docs/as/dev/public_sys-resources/icon-notice.gif
new file mode 100644
index 000000000..409070650
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-notice.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-tip.gif b/docs/as/dev/public_sys-resources/icon-tip.gif
new file mode 100644
index 000000000..c47bae05c
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-tip.gif differ
diff --git a/docs/as/dev/public_sys-resources/icon-warning.gif b/docs/as/dev/public_sys-resources/icon-warning.gif
new file mode 100644
index 000000000..079c79b26
Binary files /dev/null and b/docs/as/dev/public_sys-resources/icon-warning.gif differ
diff --git a/docs/as/dev/public_sys-resources/note_3.0-en-us.png b/docs/as/dev/public_sys-resources/note_3.0-en-us.png
new file mode 100644
index 000000000..57a0e1f53
Binary files /dev/null and b/docs/as/dev/public_sys-resources/note_3.0-en-us.png differ
diff --git a/docs/as/dev/public_sys-resources/notice_3.0-en-us.png b/docs/as/dev/public_sys-resources/notice_3.0-en-us.png
new file mode 100644
index 000000000..fa4b64990
Binary files /dev/null and b/docs/as/dev/public_sys-resources/notice_3.0-en-us.png differ
diff --git a/docs/as/dev/public_sys-resources/popup.js b/docs/as/dev/public_sys-resources/popup.js
new file mode 100644
index 000000000..5305962bc
--- /dev/null
+++ b/docs/as/dev/public_sys-resources/popup.js
@@ -0,0 +1 @@
+var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!=null){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(tooltipTxt){if(document.body==null){return}if(i==0){return}clickFlag=true;var text=eval("jsonData."+tooltipTxt);var bodyWidth=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var st=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){st=0}var leftPos=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=text;dhtmlgoodies_tooltip.style.left=leftPos+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+st+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=leftPos+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+st+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var tooltipWidth=dhtmlgoodies_tooltip.offsetWidth;if(tooltipWidthbodyWidth){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((leftPos+tooltipWidth)-bodyWidth))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((leftPos+tooltipWidth)-bodyWidth)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if(dhtmlgoodies_tooltip!=null&&dhtmlgoodies_tooltip.style!=null){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!=null&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!=null&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}};
\ No newline at end of file
diff --git a/docs/as/dev/public_sys-resources/pygments.css b/docs/as/dev/public_sys-resources/pygments.css
new file mode 100644
index 000000000..49bada08a
--- /dev/null
+++ b/docs/as/dev/public_sys-resources/pygments.css
@@ -0,0 +1 @@
+.hll{background-color:#ffc}.c{color:#069;font-style:italic}.err{color:black}.k{color:#069;font-weight:bold}.ch{color:#069;font-style:italic}.cm{color:#008200}.cp{color:black}.cpf{color:#069;font-style:italic}.c1{color:#008200}.cs{color:#069;font-weight:bold}.gd{color:#000;background-color:#fdd}.ge{font-style:italic}.gr{color:#a00}.gh{color:#999}.gi{color:#000;background-color:#dfd}.go{color:#888}.gp{color:#555}.gs{font-weight:bold}.gu{color:#aaa}.gt{color:#a00}.kc{color:#000080;font-weight:bold}.kd{color:#069;font-weight:bold}.kn{color:#000080;font-weight:bold}.kp{color:#069;font-weight:bold}.kr{color:#000080;font-weight:bold}.kt{color:#069;font-weight:bold}.m{color:blue}.s{color:blue}.na{color:gray}.nt{color:#069;font-weight:bold}.ow{font-weight:bold}.w{color:#bbb}.mb{color:blue}.mf{color:blue}.mh{color:blue}.mi{color:black}.mo{color:blue}.sa{color:blue}.sb{color:blue}.sc{color:#800080}.dl{color:blue}.sd{color:blue}.s2{color:blue}.se{color:blue}.sh{color:blue}.si{color:blue}.sx{color:blue}.sr{color:blue}.s1{color:blue}.ss{color:blue}.il{color:blue}.linenos{width:15px}.linenos{border-right:3px solid #6ce26c;color:#afafaf;text-align:right;padding:0 .5em 0 1em}.codecoloring{line-height:1.1em}.code .highlight pre{font-family:"Consolas","Bitstream Vera Sans Mono","Courier New",Courier,monospace}.code .highlight pre span{font-size:1em}.nb{color:#ff1493}.nv{color:#a70}.nx,.o,.n,.nf{color:black}.vc,.vi{color:#a70}.highlight pre{padding:0 1em}.highlighttable pre{box-sizing:border-box;margin:0}
\ No newline at end of file
diff --git a/docs/as/dev/public_sys-resources/warning_3.0-en-us.png b/docs/as/dev/public_sys-resources/warning_3.0-en-us.png
new file mode 100644
index 000000000..def5c3565
Binary files /dev/null and b/docs/as/dev/public_sys-resources/warning_3.0-en-us.png differ