From 9f6c9f35243f184db45fdf4cefc664f57d7965e8 Mon Sep 17 00:00:00 2001 From: guoyanyan Date: Tue, 4 Oct 2022 07:01:40 +0000 Subject: [PATCH] AS API 20220928 v1 Reviewed-by: Hasko, Vladimir Co-authored-by: guoyanyan Co-committed-by: guoyanyan --- docs/as/api-ref/ALL_META.TXT.json | 612 ++++ docs/as/api-ref/CLASS.TXT.json | 551 ++++ docs/as/api-ref/PARAMETERS.txt | 3 + docs/as/api-ref/as_05_0202.html | 94 + docs/as/api-ref/as_06_0000.html | 27 + docs/as/api-ref/as_06_0100.html | 25 + docs/as/api-ref/as_06_0101.html | 490 +++ docs/as/api-ref/as_06_0102.html | 588 ++++ docs/as/api-ref/as_06_0103.html | 491 +++ docs/as/api-ref/as_06_0104.html | 487 +++ docs/as/api-ref/as_06_0105.html | 153 + docs/as/api-ref/as_06_0106.html | 170 ++ docs/as/api-ref/as_06_0200.html | 23 + docs/as/api-ref/as_06_0201.html | 645 ++++ docs/as/api-ref/as_06_0202.html | 705 +++++ docs/as/api-ref/as_06_0203.html | 593 ++++ docs/as/api-ref/as_06_0204.html | 142 + docs/as/api-ref/as_06_0205.html | 162 + docs/as/api-ref/as_06_0300.html | 19 + docs/as/api-ref/as_06_0301.html | 336 ++ docs/as/api-ref/as_06_0302.html | 153 + docs/as/api-ref/as_06_0303.html | 196 ++ docs/as/api-ref/as_06_0400.html | 37 + docs/as/api-ref/as_06_0401.html | 361 +++ docs/as/api-ref/as_06_0402.html | 389 +++ docs/as/api-ref/as_06_0403.html | 359 +++ docs/as/api-ref/as_06_0404.html | 396 +++ docs/as/api-ref/as_06_0405.html | 422 +++ docs/as/api-ref/as_06_0406.html | 528 ++++ docs/as/api-ref/as_06_0407.html | 585 ++++ docs/as/api-ref/as_06_0408.html | 347 +++ docs/as/api-ref/as_06_0409.html | 417 +++ docs/as/api-ref/as_06_0410.html | 169 ++ docs/as/api-ref/as_06_0411.html | 140 + docs/as/api-ref/as_06_0412.html | 193 ++ docs/as/api-ref/as_06_0500.html | 15 + docs/as/api-ref/as_06_0501.html | 506 +++ docs/as/api-ref/as_06_0600.html | 17 + docs/as/api-ref/as_06_0601.html | 340 +++ docs/as/api-ref/as_06_0602.html | 563 ++++ docs/as/api-ref/as_06_0700.html | 17 + docs/as/api-ref/as_06_0701.html | 246 ++ docs/as/api-ref/as_06_0702.html | 236 ++ docs/as/api-ref/as_06_1000.html | 21 + docs/as/api-ref/as_06_1001.html | 219 ++ docs/as/api-ref/as_06_1002.html | 218 ++ docs/as/api-ref/as_06_1003.html | 233 ++ docs/as/api-ref/as_06_1004.html | 480 +++ docs/as/api-ref/as_06_1100.html | 17 + docs/as/api-ref/as_06_1101.html | 238 ++ docs/as/api-ref/as_06_1102.html | 245 ++ docs/as/api-ref/as_07_0100.html | 17 + docs/as/api-ref/as_07_0101.html | 151 + docs/as/api-ref/as_07_0102.html | 2704 +++++++++++++++++ docs/as/api-ref/as_07_0200.html | 25 + docs/as/api-ref/as_07_0203.html | 83 + docs/as/api-ref/as_07_0204.html | 61 + docs/as/api-ref/as_07_0205.html | 161 + docs/as/api-ref/as_07_0206.html | 39 + docs/as/api-ref/as_07_0207.html | 50 + docs/as/api-ref/as_07_0208.html | 50 + docs/as/api-ref/as_07_0211.html | 72 + docs/as/api-ref/en-us_topic_0045219159.html | 8 + .../public_sys-resources/ExpandCollapse.js | 1 + .../caution_3.0-en-us.png | Bin 0 -> 2752 bytes .../public_sys-resources/commonltr.css | 1 + .../public_sys-resources/commonltr_print.css | 1 + .../public_sys-resources/commonrtl.css | 2 + .../public_sys-resources/danger_3.0-en-us.png | Bin 0 -> 2771 bytes .../as/api-ref/public_sys-resources/delta.gif | Bin 0 -> 836 bytes .../api-ref/public_sys-resources/deltaend.gif | Bin 0 -> 834 bytes .../public_sys-resources/icon-arrowdn.gif | Bin 0 -> 68 bytes .../public_sys-resources/icon-arrowrt.gif | Bin 0 -> 70 bytes .../public_sys-resources/icon-caution.gif | Bin 0 -> 1086 bytes .../public_sys-resources/icon-danger.gif | Bin 0 -> 1086 bytes .../public_sys-resources/icon-huawei.gif | Bin 0 -> 2767 bytes .../public_sys-resources/icon-note.gif | Bin 0 -> 983 bytes .../public_sys-resources/icon-notice.gif | Bin 0 -> 962 bytes .../api-ref/public_sys-resources/icon-tip.gif | Bin 0 -> 879 bytes .../public_sys-resources/icon-warning.gif | Bin 0 -> 1086 bytes .../public_sys-resources/note_3.0-en-us.png | Bin 0 -> 1080 bytes .../public_sys-resources/notice_3.0-en-us.png | Bin 0 -> 1672 bytes docs/as/api-ref/public_sys-resources/popup.js | 1 + .../warning_3.0-en-us.png | Bin 0 -> 3164 bytes docs/as/api-ref/record08.html | 211 ++ 85 files changed, 18257 insertions(+) create mode 100644 docs/as/api-ref/ALL_META.TXT.json create mode 100644 docs/as/api-ref/CLASS.TXT.json create mode 100644 docs/as/api-ref/PARAMETERS.txt create mode 100644 docs/as/api-ref/as_05_0202.html create mode 100644 docs/as/api-ref/as_06_0000.html create mode 100644 docs/as/api-ref/as_06_0100.html create mode 100644 docs/as/api-ref/as_06_0101.html create mode 100644 docs/as/api-ref/as_06_0102.html create mode 100644 docs/as/api-ref/as_06_0103.html create mode 100644 docs/as/api-ref/as_06_0104.html create mode 100644 docs/as/api-ref/as_06_0105.html create mode 100644 docs/as/api-ref/as_06_0106.html create mode 100644 docs/as/api-ref/as_06_0200.html create mode 100644 docs/as/api-ref/as_06_0201.html create mode 100644 docs/as/api-ref/as_06_0202.html create mode 100644 docs/as/api-ref/as_06_0203.html create mode 100644 docs/as/api-ref/as_06_0204.html create mode 100644 docs/as/api-ref/as_06_0205.html create mode 100644 docs/as/api-ref/as_06_0300.html create mode 100644 docs/as/api-ref/as_06_0301.html create mode 100644 docs/as/api-ref/as_06_0302.html create mode 100644 docs/as/api-ref/as_06_0303.html create mode 100644 docs/as/api-ref/as_06_0400.html create mode 100644 docs/as/api-ref/as_06_0401.html create mode 100644 docs/as/api-ref/as_06_0402.html create mode 100644 docs/as/api-ref/as_06_0403.html create mode 100644 docs/as/api-ref/as_06_0404.html create mode 100644 docs/as/api-ref/as_06_0405.html create mode 100644 docs/as/api-ref/as_06_0406.html create mode 100644 docs/as/api-ref/as_06_0407.html create mode 100644 docs/as/api-ref/as_06_0408.html create mode 100644 docs/as/api-ref/as_06_0409.html create mode 100644 docs/as/api-ref/as_06_0410.html create mode 100644 docs/as/api-ref/as_06_0411.html create mode 100644 docs/as/api-ref/as_06_0412.html create mode 100644 docs/as/api-ref/as_06_0500.html create mode 100644 docs/as/api-ref/as_06_0501.html create mode 100644 docs/as/api-ref/as_06_0600.html create mode 100644 docs/as/api-ref/as_06_0601.html create mode 100644 docs/as/api-ref/as_06_0602.html create mode 100644 docs/as/api-ref/as_06_0700.html create mode 100644 docs/as/api-ref/as_06_0701.html create mode 100644 docs/as/api-ref/as_06_0702.html create mode 100644 docs/as/api-ref/as_06_1000.html create mode 100644 docs/as/api-ref/as_06_1001.html create mode 100644 docs/as/api-ref/as_06_1002.html create mode 100644 docs/as/api-ref/as_06_1003.html create mode 100644 docs/as/api-ref/as_06_1004.html create mode 100644 docs/as/api-ref/as_06_1100.html create mode 100644 docs/as/api-ref/as_06_1101.html create mode 100644 docs/as/api-ref/as_06_1102.html create mode 100644 docs/as/api-ref/as_07_0100.html create mode 100644 docs/as/api-ref/as_07_0101.html create mode 100644 docs/as/api-ref/as_07_0102.html create mode 100644 docs/as/api-ref/as_07_0200.html create mode 100644 docs/as/api-ref/as_07_0203.html create mode 100644 docs/as/api-ref/as_07_0204.html create mode 100644 docs/as/api-ref/as_07_0205.html create mode 100644 docs/as/api-ref/as_07_0206.html create mode 100644 docs/as/api-ref/as_07_0207.html create mode 100644 docs/as/api-ref/as_07_0208.html create mode 100644 docs/as/api-ref/as_07_0211.html create mode 100644 docs/as/api-ref/en-us_topic_0045219159.html create mode 100644 docs/as/api-ref/public_sys-resources/ExpandCollapse.js create mode 100644 docs/as/api-ref/public_sys-resources/caution_3.0-en-us.png create mode 100644 docs/as/api-ref/public_sys-resources/commonltr.css create mode 100644 docs/as/api-ref/public_sys-resources/commonltr_print.css create mode 100644 docs/as/api-ref/public_sys-resources/commonrtl.css create mode 100644 docs/as/api-ref/public_sys-resources/danger_3.0-en-us.png create mode 100644 docs/as/api-ref/public_sys-resources/delta.gif create mode 100644 docs/as/api-ref/public_sys-resources/deltaend.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-arrowdn.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-arrowrt.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-caution.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-danger.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-huawei.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-note.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-notice.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-tip.gif create mode 100644 docs/as/api-ref/public_sys-resources/icon-warning.gif create mode 100644 docs/as/api-ref/public_sys-resources/note_3.0-en-us.png create mode 100644 docs/as/api-ref/public_sys-resources/notice_3.0-en-us.png create mode 100644 docs/as/api-ref/public_sys-resources/popup.js create mode 100644 docs/as/api-ref/public_sys-resources/warning_3.0-en-us.png create mode 100644 docs/as/api-ref/record08.html diff --git a/docs/as/api-ref/ALL_META.TXT.json b/docs/as/api-ref/ALL_META.TXT.json new file mode 100644 index 000000000..58cdbd431 --- /dev/null +++ b/docs/as/api-ref/ALL_META.TXT.json @@ -0,0 +1,612 @@ +[ + { + "uri":"en-us_topic_0045219159.html", + "product_code":"as", + "code":"1", + "des":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"as_06_0000.html", + "product_code":"as", + "code":"2", + "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":"api", + "kw":"API", + "title":"API", + "githuburl":"" + }, + { + "uri":"as_06_0100.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":"api", + "kw":"AS Groups", + "title":"AS Groups", + "githuburl":"" + }, + { + "uri":"as_06_0101.html", + "product_code":"as", + "code":"4", + "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. A", + "doc_type":"api", + "kw":"Creating an AS Group,AS Groups,API Reference", + "title":"Creating an AS Group", + "githuburl":"" + }, + { + "uri":"as_06_0102.html", + "product_code":"as", + "code":"5", + "des":"This API is used to query AS groups based on search criteria. The results are displayed by page.Search criteria can be the AS group name, AS configuration ID, AS group st", + "doc_type":"api", + "kw":"Querying AS Groups,AS Groups,API Reference", + "title":"Querying AS Groups", + "githuburl":"" + }, + { + "uri":"as_06_0103.html", + "product_code":"as", + "code":"6", + "des":"This API is used to query details about a specified AS group by group ID.GET /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}Request parametersNoneNoneEx", + "doc_type":"api", + "kw":"Querying AS Group Details,AS Groups,API Reference", + "title":"Querying AS Group Details", + "githuburl":"" + }, + { + "uri":"as_06_0104.html", + "product_code":"as", + "code":"7", + "des":"This API is used to modify a specified AS group.When the AS configuration of an AS group is changed, the existing instances created using the original AS configuration ar", + "doc_type":"api", + "kw":"Modifying an AS Group,AS Groups,API Reference", + "title":"Modifying an AS Group", + "githuburl":"" + }, + { + "uri":"as_06_0105.html", + "product_code":"as", + "code":"8", + "des":"This interface is used to delete a specified AS group.force_delete specifies whether to forcibly delete an AS group, remove the ECS instances and release them when the AS", + "doc_type":"api", + "kw":"Deleting an AS Group,AS Groups,API Reference", + "title":"Deleting an AS Group", + "githuburl":"" + }, + { + "uri":"as_06_0106.html", + "product_code":"as", + "code":"9", + "des":"This interface is used to enable or disable a specified AS group.For a disabled AS group, AS does not automatically trigger any scaling actions. When an AS group has an i", + "doc_type":"api", + "kw":"Enabling or Disabling an AS Group,AS Groups,API Reference", + "title":"Enabling or Disabling an AS Group", + "githuburl":"" + }, + { + "uri":"as_06_0200.html", + "product_code":"as", + "code":"10", + "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":"api", + "kw":"AS Configurations", + "title":"AS Configurations", + "githuburl":"" + }, + { + "uri":"as_06_0201.html", + "product_code":"as", + "code":"11", + "des":"This API is used to create an AS configuration.An AS configuration is a template of ECSs in an AS group. It defines the specifications of the instances to be added to the", + "doc_type":"api", + "kw":"Creating an AS Configuration,AS Configurations,API Reference", + "title":"Creating an AS Configuration", + "githuburl":"" + }, + { + "uri":"as_06_0202.html", + "product_code":"as", + "code":"12", + "des":"This API is used to query AS configurations based on search criteria. The results are displayed by page.Search criteria can be the AS configuration name, image ID, start ", + "doc_type":"api", + "kw":"Querying AS Configurations,AS Configurations,API Reference", + "title":"Querying AS Configurations", + "githuburl":"" + }, + { + "uri":"as_06_0203.html", + "product_code":"as", + "code":"13", + "des":"This interface is used to query details about an AS configuration by configuration ID.GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id", + "doc_type":"api", + "kw":"Querying AS Configuration Details,AS Configurations,API Reference", + "title":"Querying AS Configuration Details", + "githuburl":"" + }, + { + "uri":"as_06_0204.html", + "product_code":"as", + "code":"14", + "des":"This interface is used to delete a specified AS configuration.AS configurations used by AS groups cannot be deleted.DELETE /autoscaling-api/v1/{project_id}/scaling_config", + "doc_type":"api", + "kw":"Deleting an AS Configuration,AS Configurations,API Reference", + "title":"Deleting an AS Configuration", + "githuburl":"" + }, + { + "uri":"as_06_0205.html", + "product_code":"as", + "code":"15", + "des":"This interface is used to batch delete AS configurations.AS configurations used by AS groups cannot be deleted.A maximum of 50 AS configurations can be deleted at a time.", + "doc_type":"api", + "kw":"Batch Deleting AS Configurations,AS Configurations,API Reference", + "title":"Batch Deleting AS Configurations", + "githuburl":"" + }, + { + "uri":"as_06_0300.html", + "product_code":"as", + "code":"16", + "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":"api", + "kw":"Instances in an AS Group", + "title":"Instances in an AS Group", + "githuburl":"" + }, + { + "uri":"as_06_0301.html", + "product_code":"as", + "code":"17", + "des":"This API is used to query instances in an AS group based on search criteria. The results are displayed by page.Search criteria can be the instance lifecycle status, insta", + "doc_type":"api", + "kw":"Querying Instances in an AS Group,Instances in an AS Group,API Reference", + "title":"Querying Instances in an AS Group", + "githuburl":"" + }, + { + "uri":"as_06_0302.html", + "product_code":"as", + "code":"18", + "des":"This interface is used to remove a specified instance from an AS group.You can remove instances only in INSERVICE state and only when the number of instances after the re", + "doc_type":"api", + "kw":"Removing a Specified Instance from an AS Group,Instances in an AS Group,API Reference", + "title":"Removing a Specified Instance from an AS Group", + "githuburl":"" + }, + { + "uri":"as_06_0303.html", + "product_code":"as", + "code":"19", + "des":"Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.A batch op", + "doc_type":"api", + "kw":"Performing Operations on Instances in Batches,Instances in an AS Group,API Reference", + "title":"Performing Operations on Instances in Batches", + "githuburl":"" + }, + { + "uri":"as_06_0400.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":"api", + "kw":"AS Policies", + "title":"AS Policies", + "githuburl":"" + }, + { + "uri":"as_06_0401.html", + "product_code":"as", + "code":"21", + "des":"This API is used to create an AS policy.An AS policy defines whether to increase or decrease the number of instances in an AS group. If the number and the expected number", + "doc_type":"api", + "kw":"Creating an AS Policy,AS Policies,API Reference", + "title":"Creating an AS Policy", + "githuburl":"" + }, + { + "uri":"as_06_0402.html", + "product_code":"as", + "code":"22", + "des":"This API is used to create an AS policy for an AS group or bandwidth.The difference between the V2 and V1 APIs for creating an AS policy is that V2 supports creating an A", + "doc_type":"api", + "kw":"Creating an AS Policy (V2),AS Policies,API Reference", + "title":"Creating an AS Policy (V2)", + "githuburl":"" + }, + { + "uri":"as_06_0403.html", + "product_code":"as", + "code":"23", + "des":"This API is used to modify a specified AS policy.PUT /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}Request parametersRequest parametersParameterManda", + "doc_type":"api", + "kw":"Modifying an AS Policy,AS Policies,API Reference", + "title":"Modifying an AS Policy", + "githuburl":"" + }, + { + "uri":"as_06_0404.html", + "product_code":"as", + "code":"24", + "des":"This API is used to modify a specified AS policy.The difference between the V2 and V1 APIs for modifying an AS policy is that V2 supports modifying a scaling resource typ", + "doc_type":"api", + "kw":"Modifying an AS Policy (V2),AS Policies,API Reference", + "title":"Modifying an AS Policy (V2)", + "githuburl":"" + }, + { + "uri":"as_06_0405.html", + "product_code":"as", + "code":"25", + "des":"This API is used to query AS policies based on search criteria. The results are displayed by page.Search criteria can be the AS policy name, policy type, policy ID, start", + "doc_type":"api", + "kw":"Querying AS Policies,AS Policies,API Reference", + "title":"Querying AS Policies", + "githuburl":"" + }, + { + "uri":"as_06_0406.html", + "product_code":"as", + "code":"26", + "des":"This API is used to query AS policies based on search criteria. The results are displayed by page.The difference between the V2 and V1 APIs for querying AS policies is th", + "doc_type":"api", + "kw":"Querying AS Policies (V2),AS Policies,API Reference", + "title":"Querying AS Policies (V2)", + "githuburl":"" + }, + { + "uri":"as_06_0407.html", + "product_code":"as", + "code":"27", + "des":"This API is used to query all AS policies for a tenant based on search criteria. The results are displayed by page.Search criteria can be the AS resource ID, AS resource ", + "doc_type":"api", + "kw":"Querying All AS Policies (V2),AS Policies,API Reference", + "title":"Querying All AS Policies (V2)", + "githuburl":"" + }, + { + "uri":"as_06_0408.html", + "product_code":"as", + "code":"28", + "des":"This API is used to query details about a specified AS policy by policy ID.GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}Request parametersNoneNo", + "doc_type":"api", + "kw":"Querying AS Policy Details,AS Policies,API Reference", + "title":"Querying AS Policy Details", + "githuburl":"" + }, + { + "uri":"as_06_0409.html", + "product_code":"as", + "code":"29", + "des":"This API is used to query details about a specified AS policy by policy ID.The difference between the V2 and V1 APIs for querying details of an AS policy is that V2 conta", + "doc_type":"api", + "kw":"Querying Details of an AS Policy (V2),AS Policies,API Reference", + "title":"Querying Details of an AS Policy (V2)", + "githuburl":"" + }, + { + "uri":"as_06_0410.html", + "product_code":"as", + "code":"30", + "des":"This interface is used to immediately execute, enable, or disable a specified AS policy.An AS policy can be executed only when the AS group and AS policy are in the INSER", + "doc_type":"api", + "kw":"Executing, Enabling, or Disabling an AS Policy,AS Policies,API Reference", + "title":"Executing, Enabling, or Disabling an AS Policy", + "githuburl":"" + }, + { + "uri":"as_06_0411.html", + "product_code":"as", + "code":"31", + "des":"This interface is used to delete a specified AS policy.DELETE /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}Request parametersNoneNoneExample request", + "doc_type":"api", + "kw":"Deleting an AS Policy,AS Policies,API Reference", + "title":"Deleting an AS Policy", + "githuburl":"" + }, + { + "uri":"as_06_0412.html", + "product_code":"as", + "code":"32", + "des":"This interface is used to enable, disable, or delete AS policies in batches.A batch operation can be performed on a maximum of 20 AS policies at a time.POST /autoscaling-", + "doc_type":"api", + "kw":"Performing Operations on AS Policies in Batches,AS Policies,API Reference", + "title":"Performing Operations on AS Policies in Batches", + "githuburl":"" + }, + { + "uri":"as_06_0500.html", + "product_code":"as", + "code":"33", + "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":"api", + "kw":"AS Policy Execution Logs", + "title":"AS Policy Execution Logs", + "githuburl":"" + }, + { + "uri":"as_06_0501.html", + "product_code":"as", + "code":"34", + "des":"This API is used to query the historical records of AS policy execution based on search criteria. The results are displayed by page.Search criteria can be the log ID, AS ", + "doc_type":"api", + "kw":"Querying AS Policy Execution Logs,AS Policy Execution Logs,API Reference", + "title":"Querying AS Policy Execution Logs", + "githuburl":"" + }, + { + "uri":"as_06_0600.html", + "product_code":"as", + "code":"35", + "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":"api", + "kw":"Scaling Action Logs", + "title":"Scaling Action Logs", + "githuburl":"" + }, + { + "uri":"as_06_0601.html", + "product_code":"as", + "code":"36", + "des":"This API is used to query scaling action logs based on search criteria. The results are displayed by page.Search criteria can be the start time, end time, start line numb", + "doc_type":"api", + "kw":"Querying Scaling Action Logs,Scaling Action Logs,API Reference", + "title":"Querying Scaling Action Logs", + "githuburl":"" + }, + { + "uri":"as_06_0602.html", + "product_code":"as", + "code":"37", + "des":"This API is used to query scaling action logs based on search criteria. The scaling actions include increasing instances and migrating instances to balance load. The resu", + "doc_type":"api", + "kw":"Querying Scaling Action Logs (V2),Scaling Action Logs,API Reference", + "title":"Querying Scaling Action Logs (V2)", + "githuburl":"" + }, + { + "uri":"as_06_0700.html", + "product_code":"as", + "code":"38", + "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":"api", + "kw":"Quotas", + "title":"Quotas", + "githuburl":"" + }, + { + "uri":"as_06_0701.html", + "product_code":"as", + "code":"39", + "des":"This API is used to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant.", + "doc_type":"api", + "kw":"Querying AS Quotas,Quotas,API Reference", + "title":"Querying AS Quotas", + "githuburl":"" + }, + { + "uri":"as_06_0702.html", + "product_code":"as", + "code":"40", + "des":"This interface is used to query the total quotas and used quotas of AS policies and instances of a specified AS group by group ID.GET /autoscaling-api/v1/{project_id}/quo", + "doc_type":"api", + "kw":"Querying AS policy and instance quotas,Quotas,API Reference", + "title":"Querying AS policy and instance quotas", + "githuburl":"" + }, + { + "uri":"as_06_1000.html", + "product_code":"as", + "code":"41", + "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":"api", + "kw":"Tag Management", + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"as_06_1001.html", + "product_code":"as", + "code":"42", + "des":"This API is used to query tags by project ID.GET /autoscaling-api/v1/{project_id}/{resource_type}/tagsRequest parametersNoneNoneExample requestThis example shows how to q", + "doc_type":"api", + "kw":"Querying Tags,Tag Management,API Reference", + "title":"Querying Tags", + "githuburl":"" + }, + { + "uri":"as_06_1002.html", + "product_code":"as", + "code":"43", + "des":"This interface is used to query tags of a specified resource by project ID and resource ID.GET /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tagsRequest ", + "doc_type":"api", + "kw":"Querying Tags of a Resource,Tag Management,API Reference", + "title":"Querying Tags of a Resource", + "githuburl":"" + }, + { + "uri":"as_06_1003.html", + "product_code":"as", + "code":"44", + "des":"This API is used to create or delete a resource tag.Each AS group can have a maximum of 10 tags added to it.POST /autoscaling-api/v1/{project_id}/{resource_type}/{resourc", + "doc_type":"api", + "kw":"Creating or Deleting a Tag,Tag Management,API Reference", + "title":"Creating or Deleting a Tag", + "githuburl":"" + }, + { + "uri":"as_06_1004.html", + "product_code":"as", + "code":"45", + "des":"This API is used to query instances of a specified resource type by project ID.By default, resources and resource tags are in descending order of their creation time.POST", + "doc_type":"api", + "kw":"Querying Resources,Tag Management,API Reference", + "title":"Querying Resources", + "githuburl":"" + }, + { + "uri":"as_06_1100.html", + "product_code":"as", + "code":"46", + "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":"api", + "kw":"API Management", + "title":"API Management", + "githuburl":"" + }, + { + "uri":"as_06_1101.html", + "product_code":"as", + "code":"47", + "des":"This interface is used to query all API versions of the AS service.GET /Request parametersNoneNoneExample requestThis example shows how to query all versions of an API.GE", + "doc_type":"api", + "kw":"Querying API Versions,API Management,API Reference", + "title":"Querying API Versions", + "githuburl":"" + }, + { + "uri":"as_06_1102.html", + "product_code":"as", + "code":"48", + "des":"This interface is used to query a specified API version of the AS service.GET /{api_version}Request parametersNoneNoneExample requestThis example shows how to query V1 AS", + "doc_type":"api", + "kw":"Querying a Specified API Version,API Management,API Reference", + "title":"Querying a Specified API Version", + "githuburl":"" + }, + { + "uri":"as_07_0200.html", + "product_code":"as", + "code":"49", + "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":"api", + "kw":"Permissions Policies and Supported Actions", + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"as_05_0202.html", + "product_code":"as", + "code":"50", + "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":"api", + "kw":"AS Group,Permissions Policies and Supported Actions,API Reference", + "title":"AS Group", + "githuburl":"" + }, + { + "uri":"as_07_0203.html", + "product_code":"as", + "code":"51", + "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":"api", + "kw":"AS Configuration,Permissions Policies and Supported Actions,API Reference", + "title":"AS Configuration", + "githuburl":"" + }, + { + "uri":"as_07_0204.html", + "product_code":"as", + "code":"52", + "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":"api", + "kw":"Instance,Permissions Policies and Supported Actions,API Reference", + "title":"Instance", + "githuburl":"" + }, + { + "uri":"as_07_0205.html", + "product_code":"as", + "code":"53", + "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":"api", + "kw":"AS Policy,Permissions Policies and Supported Actions,API Reference", + "title":"AS Policy", + "githuburl":"" + }, + { + "uri":"as_07_0206.html", + "product_code":"as", + "code":"54", + "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":"api", + "kw":"AS Policy Execution Log,Permissions Policies and Supported Actions,API Reference", + "title":"AS Policy Execution Log", + "githuburl":"" + }, + { + "uri":"as_07_0207.html", + "product_code":"as", + "code":"55", + "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":"api", + "kw":"Scaling Action Log,Permissions Policies and Supported Actions,API Reference", + "title":"Scaling Action Log", + "githuburl":"" + }, + { + "uri":"as_07_0208.html", + "product_code":"as", + "code":"56", + "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":"api", + "kw":"Quota,Permissions Policies and Supported Actions,API Reference", + "title":"Quota", + "githuburl":"" + }, + { + "uri":"as_07_0211.html", + "product_code":"as", + "code":"57", + "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":"api", + "kw":"Tag Management,Permissions Policies and Supported Actions,API Reference", + "title":"Tag Management", + "githuburl":"" + }, + { + "uri":"as_07_0100.html", + "product_code":"as", + "code":"58", + "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":"api", + "kw":"Appendix", + "title":"Appendix", + "githuburl":"" + }, + { + "uri":"as_07_0101.html", + "product_code":"as", + "code":"59", + "des":"This section describes metrics reported by AS to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to view the AS metrics and t", + "doc_type":"api", + "kw":"AS Metrics,Appendix,API Reference", + "title":"AS Metrics", + "githuburl":"" + }, + { + "uri":"as_07_0102.html", + "product_code":"as", + "code":"60", + "des":"This section provides the meanings of error codes returned by AS APIs.{\"error\":{\"code\":\"AS.0001\",\"message\":\"System error.\"}}", + "doc_type":"api", + "kw":"Error Codes,Appendix,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"record08.html", + "product_code":"as", + "code":"61", + "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":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/as/api-ref/CLASS.TXT.json b/docs/as/api-ref/CLASS.TXT.json new file mode 100644 index 000000000..7d2d9ff7a --- /dev/null +++ b/docs/as/api-ref/CLASS.TXT.json @@ -0,0 +1,551 @@ +[ + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"as", + "title":"API Usage Guidelines", + "uri":"en-us_topic_0045219159.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "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":"API", + "uri":"as_06_0000.html", + "doc_type":"api", + "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":"AS Groups", + "uri":"as_06_0100.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "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. A", + "product_code":"as", + "title":"Creating an AS Group", + "uri":"as_06_0101.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to query AS groups based on search criteria. The results are displayed by page.Search criteria can be the AS group name, AS configuration ID, AS group st", + "product_code":"as", + "title":"Querying AS Groups", + "uri":"as_06_0102.html", + "doc_type":"api", + "p_code":"3", + "code":"5" + }, + { + "desc":"This API is used to query details about a specified AS group by group ID.GET /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}Request parametersNoneNoneEx", + "product_code":"as", + "title":"Querying AS Group Details", + "uri":"as_06_0103.html", + "doc_type":"api", + "p_code":"3", + "code":"6" + }, + { + "desc":"This API is used to modify a specified AS group.When the AS configuration of an AS group is changed, the existing instances created using the original AS configuration ar", + "product_code":"as", + "title":"Modifying an AS Group", + "uri":"as_06_0104.html", + "doc_type":"api", + "p_code":"3", + "code":"7" + }, + { + "desc":"This interface is used to delete a specified AS group.force_delete specifies whether to forcibly delete an AS group, remove the ECS instances and release them when the AS", + "product_code":"as", + "title":"Deleting an AS Group", + "uri":"as_06_0105.html", + "doc_type":"api", + "p_code":"3", + "code":"8" + }, + { + "desc":"This interface is used to enable or disable a specified AS group.For a disabled AS group, AS does not automatically trigger any scaling actions. When an AS group has an i", + "product_code":"as", + "title":"Enabling or Disabling an AS Group", + "uri":"as_06_0106.html", + "doc_type":"api", + "p_code":"3", + "code":"9" + }, + { + "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":"AS Configurations", + "uri":"as_06_0200.html", + "doc_type":"api", + "p_code":"2", + "code":"10" + }, + { + "desc":"This API is used to create an AS configuration.An AS configuration is a template of ECSs in an AS group. It defines the specifications of the instances to be added to the", + "product_code":"as", + "title":"Creating an AS Configuration", + "uri":"as_06_0201.html", + "doc_type":"api", + "p_code":"10", + "code":"11" + }, + { + "desc":"This API is used to query AS configurations based on search criteria. The results are displayed by page.Search criteria can be the AS configuration name, image ID, start ", + "product_code":"as", + "title":"Querying AS Configurations", + "uri":"as_06_0202.html", + "doc_type":"api", + "p_code":"10", + "code":"12" + }, + { + "desc":"This interface is used to query details about an AS configuration by configuration ID.GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id", + "product_code":"as", + "title":"Querying AS Configuration Details", + "uri":"as_06_0203.html", + "doc_type":"api", + "p_code":"10", + "code":"13" + }, + { + "desc":"This interface is used to delete a specified AS configuration.AS configurations used by AS groups cannot be deleted.DELETE /autoscaling-api/v1/{project_id}/scaling_config", + "product_code":"as", + "title":"Deleting an AS Configuration", + "uri":"as_06_0204.html", + "doc_type":"api", + "p_code":"10", + "code":"14" + }, + { + "desc":"This interface is used to batch delete AS configurations.AS configurations used by AS groups cannot be deleted.A maximum of 50 AS configurations can be deleted at a time.", + "product_code":"as", + "title":"Batch Deleting AS Configurations", + "uri":"as_06_0205.html", + "doc_type":"api", + "p_code":"10", + "code":"15" + }, + { + "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":"Instances in an AS Group", + "uri":"as_06_0300.html", + "doc_type":"api", + "p_code":"2", + "code":"16" + }, + { + "desc":"This API is used to query instances in an AS group based on search criteria. The results are displayed by page.Search criteria can be the instance lifecycle status, insta", + "product_code":"as", + "title":"Querying Instances in an AS Group", + "uri":"as_06_0301.html", + "doc_type":"api", + "p_code":"16", + "code":"17" + }, + { + "desc":"This interface is used to remove a specified instance from an AS group.You can remove instances only in INSERVICE state and only when the number of instances after the re", + "product_code":"as", + "title":"Removing a Specified Instance from an AS Group", + "uri":"as_06_0302.html", + "doc_type":"api", + "p_code":"16", + "code":"18" + }, + { + "desc":"Add or remove instances to or from an AS group in batches.Configure instance protection or cancel the configuration for the instances in an AS group in batches.A batch op", + "product_code":"as", + "title":"Performing Operations on Instances in Batches", + "uri":"as_06_0303.html", + "doc_type":"api", + "p_code":"16", + "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":"AS Policies", + "uri":"as_06_0400.html", + "doc_type":"api", + "p_code":"2", + "code":"20" + }, + { + "desc":"This API is used to create an AS policy.An AS policy defines whether to increase or decrease the number of instances in an AS group. If the number and the expected number", + "product_code":"as", + "title":"Creating an AS Policy", + "uri":"as_06_0401.html", + "doc_type":"api", + "p_code":"20", + "code":"21" + }, + { + "desc":"This API is used to create an AS policy for an AS group or bandwidth.The difference between the V2 and V1 APIs for creating an AS policy is that V2 supports creating an A", + "product_code":"as", + "title":"Creating an AS Policy (V2)", + "uri":"as_06_0402.html", + "doc_type":"api", + "p_code":"20", + "code":"22" + }, + { + "desc":"This API is used to modify a specified AS policy.PUT /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}Request parametersRequest parametersParameterManda", + "product_code":"as", + "title":"Modifying an AS Policy", + "uri":"as_06_0403.html", + "doc_type":"api", + "p_code":"20", + "code":"23" + }, + { + "desc":"This API is used to modify a specified AS policy.The difference between the V2 and V1 APIs for modifying an AS policy is that V2 supports modifying a scaling resource typ", + "product_code":"as", + "title":"Modifying an AS Policy (V2)", + "uri":"as_06_0404.html", + "doc_type":"api", + "p_code":"20", + "code":"24" + }, + { + "desc":"This API is used to query AS policies based on search criteria. The results are displayed by page.Search criteria can be the AS policy name, policy type, policy ID, start", + "product_code":"as", + "title":"Querying AS Policies", + "uri":"as_06_0405.html", + "doc_type":"api", + "p_code":"20", + "code":"25" + }, + { + "desc":"This API is used to query AS policies based on search criteria. The results are displayed by page.The difference between the V2 and V1 APIs for querying AS policies is th", + "product_code":"as", + "title":"Querying AS Policies (V2)", + "uri":"as_06_0406.html", + "doc_type":"api", + "p_code":"20", + "code":"26" + }, + { + "desc":"This API is used to query all AS policies for a tenant based on search criteria. The results are displayed by page.Search criteria can be the AS resource ID, AS resource ", + "product_code":"as", + "title":"Querying All AS Policies (V2)", + "uri":"as_06_0407.html", + "doc_type":"api", + "p_code":"20", + "code":"27" + }, + { + "desc":"This API is used to query details about a specified AS policy by policy ID.GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}Request parametersNoneNo", + "product_code":"as", + "title":"Querying AS Policy Details", + "uri":"as_06_0408.html", + "doc_type":"api", + "p_code":"20", + "code":"28" + }, + { + "desc":"This API is used to query details about a specified AS policy by policy ID.The difference between the V2 and V1 APIs for querying details of an AS policy is that V2 conta", + "product_code":"as", + "title":"Querying Details of an AS Policy (V2)", + "uri":"as_06_0409.html", + "doc_type":"api", + "p_code":"20", + "code":"29" + }, + { + "desc":"This interface is used to immediately execute, enable, or disable a specified AS policy.An AS policy can be executed only when the AS group and AS policy are in the INSER", + "product_code":"as", + "title":"Executing, Enabling, or Disabling an AS Policy", + "uri":"as_06_0410.html", + "doc_type":"api", + "p_code":"20", + "code":"30" + }, + { + "desc":"This interface is used to delete a specified AS policy.DELETE /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}Request parametersNoneNoneExample request", + "product_code":"as", + "title":"Deleting an AS Policy", + "uri":"as_06_0411.html", + "doc_type":"api", + "p_code":"20", + "code":"31" + }, + { + "desc":"This interface is used to enable, disable, or delete AS policies in batches.A batch operation can be performed on a maximum of 20 AS policies at a time.POST /autoscaling-", + "product_code":"as", + "title":"Performing Operations on AS Policies in Batches", + "uri":"as_06_0412.html", + "doc_type":"api", + "p_code":"20", + "code":"32" + }, + { + "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":"AS Policy Execution Logs", + "uri":"as_06_0500.html", + "doc_type":"api", + "p_code":"2", + "code":"33" + }, + { + "desc":"This API is used to query the historical records of AS policy execution based on search criteria. The results are displayed by page.Search criteria can be the log ID, AS ", + "product_code":"as", + "title":"Querying AS Policy Execution Logs", + "uri":"as_06_0501.html", + "doc_type":"api", + "p_code":"33", + "code":"34" + }, + { + "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":"Scaling Action Logs", + "uri":"as_06_0600.html", + "doc_type":"api", + "p_code":"2", + "code":"35" + }, + { + "desc":"This API is used to query scaling action logs based on search criteria. The results are displayed by page.Search criteria can be the start time, end time, start line numb", + "product_code":"as", + "title":"Querying Scaling Action Logs", + "uri":"as_06_0601.html", + "doc_type":"api", + "p_code":"35", + "code":"36" + }, + { + "desc":"This API is used to query scaling action logs based on search criteria. The scaling actions include increasing instances and migrating instances to balance load. The resu", + "product_code":"as", + "title":"Querying Scaling Action Logs (V2)", + "uri":"as_06_0602.html", + "doc_type":"api", + "p_code":"35", + "code":"37" + }, + { + "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":"Quotas", + "uri":"as_06_0700.html", + "doc_type":"api", + "p_code":"2", + "code":"38" + }, + { + "desc":"This API is used to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant.", + "product_code":"as", + "title":"Querying AS Quotas", + "uri":"as_06_0701.html", + "doc_type":"api", + "p_code":"38", + "code":"39" + }, + { + "desc":"This interface is used to query the total quotas and used quotas of AS policies and instances of a specified AS group by group ID.GET /autoscaling-api/v1/{project_id}/quo", + "product_code":"as", + "title":"Querying AS policy and instance quotas", + "uri":"as_06_0702.html", + "doc_type":"api", + "p_code":"38", + "code":"40" + }, + { + "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":"Tag Management", + "uri":"as_06_1000.html", + "doc_type":"api", + "p_code":"2", + "code":"41" + }, + { + "desc":"This API is used to query tags by project ID.GET /autoscaling-api/v1/{project_id}/{resource_type}/tagsRequest parametersNoneNoneExample requestThis example shows how to q", + "product_code":"as", + "title":"Querying Tags", + "uri":"as_06_1001.html", + "doc_type":"api", + "p_code":"41", + "code":"42" + }, + { + "desc":"This interface is used to query tags of a specified resource by project ID and resource ID.GET /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tagsRequest ", + "product_code":"as", + "title":"Querying Tags of a Resource", + "uri":"as_06_1002.html", + "doc_type":"api", + "p_code":"41", + "code":"43" + }, + { + "desc":"This API is used to create or delete a resource tag.Each AS group can have a maximum of 10 tags added to it.POST /autoscaling-api/v1/{project_id}/{resource_type}/{resourc", + "product_code":"as", + "title":"Creating or Deleting a Tag", + "uri":"as_06_1003.html", + "doc_type":"api", + "p_code":"41", + "code":"44" + }, + { + "desc":"This API is used to query instances of a specified resource type by project ID.By default, resources and resource tags are in descending order of their creation time.POST", + "product_code":"as", + "title":"Querying Resources", + "uri":"as_06_1004.html", + "doc_type":"api", + "p_code":"41", + "code":"45" + }, + { + "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":"API Management", + "uri":"as_06_1100.html", + "doc_type":"api", + "p_code":"2", + "code":"46" + }, + { + "desc":"This interface is used to query all API versions of the AS service.GET /Request parametersNoneNoneExample requestThis example shows how to query all versions of an API.GE", + "product_code":"as", + "title":"Querying API Versions", + "uri":"as_06_1101.html", + "doc_type":"api", + "p_code":"46", + "code":"47" + }, + { + "desc":"This interface is used to query a specified API version of the AS service.GET /{api_version}Request parametersNoneNoneExample requestThis example shows how to query V1 AS", + "product_code":"as", + "title":"Querying a Specified API Version", + "uri":"as_06_1102.html", + "doc_type":"api", + "p_code":"46", + "code":"48" + }, + { + "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":"Permissions Policies and Supported Actions", + "uri":"as_07_0200.html", + "doc_type":"api", + "p_code":"", + "code":"49" + }, + { + "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":"AS Group", + "uri":"as_05_0202.html", + "doc_type":"api", + "p_code":"49", + "code":"50" + }, + { + "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":"AS Configuration", + "uri":"as_07_0203.html", + "doc_type":"api", + "p_code":"49", + "code":"51" + }, + { + "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":"Instance", + "uri":"as_07_0204.html", + "doc_type":"api", + "p_code":"49", + "code":"52" + }, + { + "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":"AS Policy", + "uri":"as_07_0205.html", + "doc_type":"api", + "p_code":"49", + "code":"53" + }, + { + "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":"AS Policy Execution Log", + "uri":"as_07_0206.html", + "doc_type":"api", + "p_code":"49", + "code":"54" + }, + { + "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":"Scaling Action Log", + "uri":"as_07_0207.html", + "doc_type":"api", + "p_code":"49", + "code":"55" + }, + { + "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":"Quota", + "uri":"as_07_0208.html", + "doc_type":"api", + "p_code":"49", + "code":"56" + }, + { + "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":"Tag Management", + "uri":"as_07_0211.html", + "doc_type":"api", + "p_code":"49", + "code":"57" + }, + { + "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":"as_07_0100.html", + "doc_type":"api", + "p_code":"", + "code":"58" + }, + { + "desc":"This section describes metrics reported by AS to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to view the AS metrics and t", + "product_code":"as", + "title":"AS Metrics", + "uri":"as_07_0101.html", + "doc_type":"api", + "p_code":"58", + "code":"59" + }, + { + "desc":"This section provides the meanings of error codes returned by AS APIs.{\"error\":{\"code\":\"AS.0001\",\"message\":\"System error.\"}}", + "product_code":"as", + "title":"Error Codes", + "uri":"as_07_0102.html", + "doc_type":"api", + "p_code":"58", + "code":"60" + }, + { + "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":"record08.html", + "doc_type":"api", + "p_code":"", + "code":"61" + } +] \ No newline at end of file diff --git a/docs/as/api-ref/PARAMETERS.txt b/docs/as/api-ref/PARAMETERS.txt new file mode 100644 index 000000000..6da8d5f07 --- /dev/null +++ b/docs/as/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/as/api-ref/as_05_0202.html b/docs/as/api-ref/as_05_0202.html new file mode 100644 index 000000000..a6b9aa6cf --- /dev/null +++ b/docs/as/api-ref/as_05_0202.html @@ -0,0 +1,94 @@ + + +

AS Group

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

APIs

+

Actions

+

IAM Project

+

+

Enterprise Project

+

+

Creating an AS group

+

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

+

as:groups:create

+

√

+

√

+

Querying AS groups

+

GET /autoscaling-api/v1/{project_id}/scaling_group

+

as:groups:list

+

√

+

√

+

Querying AS group details

+

GET /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}

+

as:groups:get

+

√

+

√

+

Modifying an AS group

+

PUT /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}

+

as:groups:update

+

√

+

√

+

Deleting an AS group

+

DELETE /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}

+

as:groups:delete

+

√

+

√

+

Enabling or disabling an AS group

+

POST /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action

+

as:groups:action

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/as/api-ref/as_06_0000.html b/docs/as/api-ref/as_06_0000.html new file mode 100644 index 000000000..c0fe4efce --- /dev/null +++ b/docs/as/api-ref/as_06_0000.html @@ -0,0 +1,27 @@ + + +

API

+
+
+ +
+ diff --git a/docs/as/api-ref/as_06_0100.html b/docs/as/api-ref/as_06_0100.html new file mode 100644 index 000000000..9569b04af --- /dev/null +++ b/docs/as/api-ref/as_06_0100.html @@ -0,0 +1,25 @@ + + +

AS Groups

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_0101.html b/docs/as/api-ref/as_06_0101.html new file mode 100644 index 000000000..06ec30958 --- /dev/null +++ b/docs/as/api-ref/as_06_0101.html @@ -0,0 +1,490 @@ + + +

Creating an AS Group

+

Function

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. An AS group specifies parameters, such as the maximum number of instances, expected number of instances, minimum number of instances, VPC, subnet, and load balancing.

+
  • Each user can create a maximum of 25 AS groups by default.
  • If ELB is configured, AS automatically binds or unbinds a load balancer to or from an instance when the instance is added or removed from the AS group.
  • If an AS group uses ELB health check, the listening ports on the load balancers must be enabled for the instances in the AS group. Enable the listening ports in security groups.
+
+

URI

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

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_group_name

    +

    Yes

    +

    String

    +

    Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.

    +

    scaling_configuration_id

    +

    No

    +

    String

    +

    Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS Configurations.

    +

    desire_instance_number

    +

    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.

    +

    min_instance_number

    +

    No

    +

    Integer

    +

    Specifies the minimum number of instances. The default value is 0.

    +

    max_instance_number

    +

    No

    +

    Integer

    +

    Specifies the maximum number of instances. The default value is 0.

    +

    cool_down_time

    +

    No

    +

    Integer

    +

    Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.

    +

    After a scaling action is triggered, the system starts the cooldown period. During the cooldown period, scaling actions triggered by alarms will be denied. Scheduled, periodic, and manual scaling actions are not affected.

    +

    lb_listener_id

    +

    No

    +

    String

    +

    Specifies the ID of a classic load balancer listener. The system supports the binding of up to six load balancer listeners, the IDs of which are separated using a comma (,).

    +

    This parameter is alternative to lbaas_listeners.

    +

    lbaas_listeners

    +

    No

    +

    Array of lbaas_listeners objects

    +

    Specifies information about an enhanced load balancer. The system supports the binding of up to six load balancers. This parameter is in list data structure. For details, see Table 3.

    +

    This parameter is alternative to lb_listener_id.

    +

    available_zones

    +

    No

    +

    Array of strings

    +

    Specifies the AZ information. The instances added in a scaling action will be created in a specified AZ. If you do not specify an AZ, the system automatically specifies one. For details, see Availability Zone.

    +

    networks

    +

    Yes

    +

    Array of networks objects

    +

    Specifies network information. The system supports up to five subnets. The first subnet transferred serves as the primary NIC of the ECS by default. This parameter is in data structure. For details, see Table 4.

    +

    security_groups

    +

    No

    +

    Array of security_groups objects

    +

    Specifies the security group information. A maximum of one security group can be selected. This parameter is in data structure. For details, see Table 5.

    +

    If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration.

    +

    vpc_id

    +

    Yes

    +

    String

    +

    Specifies the VPC ID, which can be obtained using the API for querying VPCs. For details, see "Querying VPCs" in Virtual Private Network API Reference.

    +

    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. When load balancing is configured for an AS group, the default value is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT.

    +
    • ELB_AUDIT: indicates the ELB health check, which takes effect in an AS group with a listener.
    • NOVA_AUDIT: indicates the ECS instance health check, which is the health check method delivered with AS.
    +

    health_periodic_audit_time

    +

    No

    +

    Integer

    +

    Specifies the instance health check period. The value can be 1, 5, 15, 60, or 180 in the unit of minutes. 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.

    +

    health_periodic_audit_grace_period

    +

    No

    +

    Integer

    +

    Specifies the grace period for instance health check. The unit is second and value range is 0-86400. The default value is 600.

    +

    The health check grace period starts after an instance is added to an AS group and is enabled. The AS group will start checking the instance status only after the grace period ends.

    +

    This parameter is valid only when the instance health check method of the AS group is ELB_AUDIT.

    +

    instance_terminate_policy

    +

    No

    +

    String

    +

    Specifies the instance removal policy.

    +
    • OLD_CONFIG_OLD_INSTANCE (default): The earlier-created instances based on the earlier-created AS configurations are removed first.
    • OLD_CONFIG_NEW_INSTANCE: The later-created instances based on the earlier-created AS configurations are removed first.
    • OLD_INSTANCE: The earlier-created instances are removed first.
    • NEW_INSTANCE: The later-created instances are removed first.
    +

    notifications

    +

    No

    +

    Array of strings

    +

    Specifies the notification mode.

    +

    EMAIL refers to notification by email.

    +

    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.
    • false: only unbinds the EIP bound to the ECS when deleting the ECS.
    +
    +

    delete_volume

    +

    No

    +

    Boolean

    +
    Specifies whether to delete the data disks attached to the ECS when deleting the ECS. The value can be true or false. The default value is false.
    • true: deletes the data disks attached to the ECS when deleting the ECS.
    • false: only detaches the data disks attached to the ECS when deleting the ECS.
    +
    +

    enterprise_project_id

    +

    No

    +

    String

    +

    Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.

    +
    • If the value is 0 or left blank, the AS group belongs to the default enterprise project.
    • If the value is a UUID, the AS group belongs to the enterprise project corresponding to the UUID.
    +

    If an enterprise project is configured for an AS group, ECSs created in this AS group also belong to this enterprise project. Otherwise, the default enterprise project will be used.

    +

    multi_az_priority_policy

    +

    No

    +

    String

    +

    Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.

    +
    • EQUILIBRIUM_DISTRIBUTE (default): When adjusting the number of instances, ensure that instances in each AZ in the available_zones list is evenly distributed. If instances cannot be added in the target AZ, select another AZ based on the PICK_FIRST policy.
    • PICK_FIRST: When adjusting the number of instances, target AZs are determined in the order in the available_zones list.
    +

    description

    +

    No

    +

    String

    +

    Specifies the description of the AS group. The value can contain 1 to 256 characters.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 lbaas_listeners field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    pool_id

    +

    Yes

    +

    String

    +

    Specifies the backend ECS group ID.

    +

    protocol_port

    +

    Yes

    +

    Integer

    +

    Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic. The port ID ranges from 1 to 65535.

    +

    weight

    +

    Yes

    +

    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. The value of this parameter ranges from 0 to 100.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 4 networks field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    id

    +

    Yes

    +

    String

    +

    Specifies the subnet ID.

    +
    +
    +

    + +
    + + + + + + + + + + + +
    Table 5 security_groups field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    id

    +

    Yes

    +

    String

    +

    Specifies the security group ID.

    +
    +
    +
+
+
  • Example request

    The following example shows how to create an AS group:

    +
    • The AS group is named GroupNameTest.
    • The AS configuration ID is 47683a91-93ee-462a-a7d7-484c006f4440.
    • The VPC ID is a8327883-6b07-4497-9c61-68d03ee193a, and the network ID is 3cd35bca-5a10-416f-8994-f79169559870.
    • The maximum number of instances is 10, the expected number of instances is 0, and the minimum number of instances is 0.
    • The health check method is ECS health check.
    • When adjusting the number of instances, select target AZ based on the PICK FIRST policy.
    +

    The request example is as follows:

    +
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group
+
+{
+    "scaling_group_name": "GroupNameTest",
+    "scaling_configuration_id": "47683a91-93ee-462a-a7d7-484c006f4440",
+    "desire_instance_number": 0,
+    "min_instance_number": 0,
+    "max_instance_number": 10,
+    "health_periodic_audit_method": "NOVA_AUDIT",
+    "vpc_id": "a8327883-6b07-4497-9c61-68d03ee193a",
+    "available_zones": ["XXXa","XXXb"],
+    "networks": [
+        {
+            "id": "3cd35bca-5a10-416f-8994-f79169559870"
+        }
+    ],
+    "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
+
+    "multi_az_priority_policy": "PICK_FIRST"
+}
    +
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 6 Response parameter

    Parameter

    +

    Type

    +

    Description

    +

    scaling_group_id

    +

    String

    +

    Specifies the AS group ID.

    +
    +
    +
+
  • Example response
    {
+    "scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1"
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Groups
+
+
+ diff --git a/docs/as/api-ref/as_06_0102.html b/docs/as/api-ref/as_06_0102.html new file mode 100644 index 000000000..5fe7a5c31 --- /dev/null +++ b/docs/as/api-ref/as_06_0102.html @@ -0,0 +1,588 @@ + + +

Querying AS Groups

+

Function

This API is used to query AS groups based on search criteria. The results are displayed by page.

+
  • Search criteria can be the AS group name, AS configuration ID, AS group status, start line number, and number of records.
  • If no search criteria are specified, a maximum of 20 AS groups can be queried for a tenant by default.
+
+

URI

GET /autoscaling-api/v1/{project_id}/scaling_group

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. AS groups can be searched by all optional parameters in the following table. For details, see the example request.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_name

+

No

+

String

+

Specifies the AS group name.

+

Supports fuzzy search.

+

scaling_configuration_id

+

No

+

String

+

Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS Configurations.

+

scaling_group_status

+

No

+

String

+

Specifies the AS group status. The options are as follows:

+
  • INSERVICE: indicates that the AS group is functional.
  • PAUSED: indicates that the AS group is paused.
  • ERROR: indicates that the AS group malfunctions.
  • DELETING: indicates that the AS group is being deleted.
+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum value is 0, and there is no limit on the maximum value.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+

enterprise_project_id

+

No

+

String

+

Specifies the enterprise project ID. If all_granted_eps is transferred, this API will query AS groups in the enterprise projects that you have permissions to.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    This example shows how to query AS groups with name as-group-test and AS configuration ID 1d281494-6085-4579-b817-c1f813be835f.
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group?scaling_group_name=as-group-test&scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835f
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    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

    +

    Array of scaling_groups objects

    +

    Specifies the scaling group list.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_groups field description

    Parameter

    +

    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 (s).

    +

    lb_listener_id

    +

    String

    +

    Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,).

    +

    lbaas_listeners

    +

    Array of lbaas_listeners objects

    +

    Specifies enhanced load balancers. For details, see Table 4.

    +

    available_zones

    +

    Array of strings

    +

    Specifies the AZ information.

    +

    networks

    +

    Array of networks objects

    +

    Specifies the network information. For details, see Table 5.

    +

    security_groups

    +

    Array of security_groups objects

    +

    Specifies the security group information. For details, see Table 6.

    +

    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. If a scaling action fails, this parameter is used to record errors.

    +

    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

    +

    Array of strings

    +

    Specifies the notification mode.

    +

    EMAIL refers to notification by email.

    +

    delete_publicip

    +

    Boolean

    +

    Specifies whether to delete the EIP bound to the ECS when deleting the ECS.

    +

    delete_volume

    +

    Boolean

    +

    Specifies whether to delete the data disks attached to the 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 AS action.

    +

    multi_az_priority_policy

    +

    String

    +

    Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.

    +

    description

    +

    String

    +

    Specifies the description of the AS group.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 lbaas_listeners field description

    Parameter

    +

    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.

    +
    +
    + +
    + + + + + + + + + +
    Table 5 networks field description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the subnet ID.

    +
    +
    +

    + +
    + + + + + + + + + +
    Table 6 security_groups field description

    Parameter

    +

    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
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Groups
+
+
+ diff --git a/docs/as/api-ref/as_06_0103.html b/docs/as/api-ref/as_06_0103.html new file mode 100644 index 000000000..ab47319a5 --- /dev/null +++ b/docs/as/api-ref/as_06_0103.html @@ -0,0 +1,491 @@ + + +

Querying AS Group Details

+

Function

This API is used to query details about a specified AS group by group ID.

+
+

URI

GET /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query details about the AS group with ID d4e50321-3777-4135-97f8-9f5e9714a4b0.

    +
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/d4e50321-3777-4135-97f8-9f5e9714a4b0
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_group

    +

    scaling_groups object

    +

    Specifies details about the AS group.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_groups field description

    Parameter

    +

    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 (s).

    +

    lb_listener_id

    +

    String

    +

    Specifies the ID of a typical ELB listener. ELB listener IDs are separated using a comma (,).

    +

    lbaas_listeners

    +

    Array of lbaas_listeners objects

    +

    Specifies enhanced load balancers. For details, see Table 4.

    +

    available_zones

    +

    Array of strings

    +

    Specifies the AZ information.

    +

    networks

    +

    Array of networks objects

    +

    Specifies the network information. For details, see Table 5.

    +

    security_groups

    +

    Array of security_groups objects

    +

    Specifies the security group information. For details, see Table 6.

    +

    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. If a scaling action fails, this parameter is used to record errors.

    +

    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

    +

    Array of strings

    +

    Specifies the notification mode.

    +

    EMAIL refers to notification by email.

    +

    delete_publicip

    +

    Boolean

    +

    Specifies whether to delete the EIP bound to the ECS when deleting the ECS.

    +

    delete_volume

    +

    Boolean

    +

    Specifies whether to delete the data disks attached to the 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 AS action.

    +

    multi_az_priority_policy

    +

    String

    +

    Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.

    +

    description

    +

    String

    +

    Specifies the description of the AS group.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 lbaas_listeners field description

    Parameter

    +

    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.

    +
    +
    + +
    + + + + + + + + + +
    Table 5 networks field description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the subnet ID.

    +
    +
    +
+
  • Example response
    {
+    "scaling_group": {
+      "networks": [
+                {
+                    "id": " a8327883-6b07-4497-9c61-68d03ee193a ",
+                    "ipv6_enable": false,
+                    "ipv6_bandwidth":  null,
+                }
+        ],
+        "available_zones": [
+               "XXXa",
+               "XXXb"
+        ],
+        "detail": null,
+        "scaling_group_name": "api_gateway_modify",
+        "scaling_group_id": "d4e50321-3777-4135-97f8-9f5e9714a4b0",
+        "scaling_group_status": "INSERVICE",
+        "scaling_configuration_id": "53579851-3841-418d-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": "2015-09-01T08:36:10Z",
+        "vpc_id": "3e22f934-800d-4bb4-a588-0b9a76108190",
+        "health_periodic_audit_method": "NOVA_AUDIT",
+        "health_periodic_audit_time": 5,
+        "health_periodic_audit_grace_period": 600,
+        "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",
+        "is_scaling": true,
+        "delete_publicip": false,
+        "notifications": null,
+        "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
+        "activity_type": "MODIFY_ELB",
+        "multi_az_priority_policy": "PICK_FIRST"
+    }
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Groups
+
+
+ diff --git a/docs/as/api-ref/as_06_0104.html b/docs/as/api-ref/as_06_0104.html new file mode 100644 index 000000000..f6f9339c5 --- /dev/null +++ b/docs/as/api-ref/as_06_0104.html @@ -0,0 +1,487 @@ + + +

Modifying an AS Group

+

Function

This API is used to modify a specified AS group.

+
  • When the AS configuration of an AS group is changed, the existing instances created using the original AS configuration are not affected.
  • If no scaling action is being performed, you can modify its subnet and AZ configurations.
  • Changing the number of expected instances in an AS group will trigger a scaling action to add or remove instances to or from the AS group. The number of expected instances must be greater than or equal to the minimum number of instances and less than or equal to the maximum number of instances.
+
+

URI

PUT /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_group_name

    +

    No

    +

    String

    +

    Specifies the AS group name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.

    +

    desire_instance_number

    +

    No

    +

    Integer

    +

    Specifies the expected number of instances.

    +

    The value ranges from the minimum number of instances to the maximum number of instances.

    +

    min_instance_number

    +

    No

    +

    Integer

    +

    Specifies the minimum number of instances.

    +

    max_instance_number

    +

    No

    +

    Integer

    +

    Specifies the maximum number of instances, which is greater than or equal to the minimum number of instances.

    +

    cool_down_time

    +

    No

    +

    Integer

    +

    Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.

    +

    available_zones

    +

    No

    +

    Array of strings

    +

    Specifies the AZ information. The instances added in a scaling action will be created in a specified AZ. If you do not specify an AZ, the system automatically specifies one.

    +

    For details, see Availability Zone.

    +

    You can change the AZ of an AS group only when no scaling action is being performed in the group.

    +

    networks

    +

    No

    +

    Array of networks objects

    +

    Specifies network information. The system supports up to five subnets. The first subnet transferred serves as the primary NIC of the ECS by default. This parameter is in data structure. For details, see Table 4.

    +

    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.
    +

    security_groups

    +

    No

    +

    Array of security_groups objects

    +

    Specifies the security group. A maximum of one security group can be selected. This parameter is in data structure. For details, see Table 5.

    +

    If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration. 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.
    +

    lb_listener_id

    +

    No

    +

    String

    +

    Specifies the ID of a classic load balancer listener. The system supports the binding of up to six load balancer listeners, the IDs of which are separated using a comma (,).

    +

    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.
    +

    lbaas_listeners

    +

    No

    +

    Array of lbaas_listeners objects

    +

    Specifies information about an enhanced load balancer. The system supports the binding of up to six load balancers. This parameter is in list data structure. For details, see Table 3.

    +

    This parameter is alternative to lb_listener_id.

    +

    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. When load balancing is configured for an AS group, the default value is ELB_AUDIT. Otherwise, the default value is NOVA_AUDIT.

    +
    • ELB_AUDIT: indicates the ELB health check, which takes effect in an AS group with a listener.
    • NOVA_AUDIT: indicates the ECS health check, which is the health check method delivered with AS.
    +

    health_periodic_audit_time

    +

    No

    +

    Integer

    +

    Specifies the health check period for the instances in the AS group. The value can be 1, 5, 15, 60, or 180 in the unit of minutes.

    +

    If the value is set to 0, health check is performed every 10 seconds.

    +

    instance_terminate_policy

    +

    No

    +

    String

    +

    Specifies the instance removal policy.

    +
    • OLD_CONFIG_OLD_INSTANCE (default): The earlier-created instances based on the earlier-created AS configurations are removed first.
    • OLD_CONFIG_NEW_INSTANCE: The later-created instances based on the earlier-created AS configurations are removed first.
    • OLD_INSTANCE: The earlier-created instances are removed first.
    • NEW_INSTANCE: The later-created instances are removed first.
    +

    health_periodic_audit_grace_period

    +

    No

    +

    Integer

    +

    Specifies the grace period for instance health check. The unit is second and value range is 0-86400. The default value is 600.

    +

    The health check grace period starts after an instance is added to an AS group and is enabled. The AS group will start checking the instance status only after the grace period ends.

    +

    This parameter is valid only when the instance health check method of the AS group is ELB_AUDIT.

    +

    scaling_configuration_id

    +

    No

    +

    String

    +

    Specifies the AS configuration ID, which can be obtained using the API for querying AS configurations. For details, see Querying AS Configurations.

    +

    notifications

    +

    No

    +

    Array of strings

    +

    Specifies the notification mode.

    +

    EMAIL refers to notification by email.

    +

    delete_publicip

    +

    No

    +

    Boolean

    +

    Specifies whether to delete the EIP bound to the ECS when deleting the ECS. If you do not want to delete the EIP, set this parameter to false. Then, the system only unbinds the EIP from the ECS and reserves the EIP.

    +
    • true: deletes the EIP bound to the ECS when deleting the ECS.
    • false: only unbinds the EIP bound to the ECS when deleting the ECS.
    +

    delete_volume

    +

    No

    +

    Boolean

    +

    Specifies whether to delete the data disks attached to the ECS when deleting the ECS. The value can be true or false. The default value is false.

    +
    • true: deletes the data disks attached to the ECS when deleting the ECS.
    • false: only detaches the data disks attached to the ECS when deleting the ECS.
    +

    enterprise_project_id

    +

    No

    +

    String

    +

    Specifies the enterprise project ID, which is used to specify the enterprise project to which the AS group belongs.

    +
    • If the value is 0 or left blank, the AS group belongs to the default enterprise project.
    • If the value is a UUID, the AS group belongs to the enterprise project corresponding to the UUID.
    +

    If an enterprise project is configured for an AS group, ECSs created in this AS group also belong to this enterprise project. Otherwise, the default enterprise project will be used.

    +

    multi_az_priority_policy

    +

    No

    +

    String

    +

    Specifies the priority policy used to select target AZs when adjusting the number of instances in an AS group.

    +
    • EQUILIBRIUM_DISTRIBUTE (default): When adjusting the number of instances, ensure that instances in each AZ in the available_zones list is evenly distributed. If instances cannot be added in the target AZ, select another AZ based on the PICK_FIRST policy.
    • PICK_FIRST: When adjusting the number of instances, target AZs are determined in the order in the available_zones list.
    +

    description

    +

    No

    +

    String

    +

    Specifies the description of the AS group. The value can contain 1 to 256 characters.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 3 lbaas_listeners field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    pool_id

    +

    Yes

    +

    String

    +

    Specifies the backend ECS group ID.

    +

    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.
    +

    protocol_port

    +

    Yes

    +

    Integer

    +

    Specifies the backend protocol ID, which is the port on which a backend ECS listens for traffic. The port ID ranges from 1 to 65535.

    +

    weight

    +

    Yes

    +

    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. The value of this parameter ranges from 0 to 100.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 4 networks field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    id

    +

    Yes

    +

    String

    +

    Specifies the subnet ID.

    +
    +
    +

    + +
    + + + + + + + + + + + +
    Table 5 security_groups field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    id

    +

    Yes

    +

    String

    +

    Specifies the ID of the security group.

    +
    +
    +
+
  • Example request
    This example shows how to change the name, AS configuration, expected number of instances, minimum number of instances, maximum number of instances, and cooldown period of the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.
    PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1
+
+{
+    "scaling_group_name": "group_1",
+    "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2",
+    "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
+    "desire_instance_number": 1,
+    "min_instance_number": 1,
+    "max_instance_number": 3,
+    "cool_down_time": 200,
+    "multi_az_priority_policy": "PICK_FIRST"
+}
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 6 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_group_id

    +

    String

    +

    Specifies the AS group ID.

    +
    +
    +
+
  • Example response
    {
+    "scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1"
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Groups
+
+
+ diff --git a/docs/as/api-ref/as_06_0105.html b/docs/as/api-ref/as_06_0105.html new file mode 100644 index 000000000..3cab7f392 --- /dev/null +++ b/docs/as/api-ref/as_06_0105.html @@ -0,0 +1,153 @@ + + +

Deleting an AS Group

+

Function

This interface is used to delete a specified AS group.

+
  • force_delete specifies whether to forcibly delete an AS group, remove the ECS instances and release them when the AS group is running instances or performing scaling actions. By default, its value is no, which means not to forcibly delete the AS group.
  • If the value of force_delete is set to no, the AS group can be deleted only when both the following conditions are met:
    • The AS group is performing no scaling action.
    • The number of running ECS instances (current_instance_number) is 0.
    +
+
  • If the value of force_delete is set to yes, the AS group enters the DELETING state, rejecting new requests for scaling actions while completing the existing scaling actions. Then, all ECS instances are removed from the AS group and the AS group is deleted. Note that the manually added ECS instances will be removed from the AS group and the ECS instances automatically created by AS will be automatically deleted.
+
+

URI

DELETE /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}?force_delete=no

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+

force_delete

+

No

+

String

+

Specifies whether to forcibly delete an AS group. Options:

+
  • no (default): indicates that the AS group is not forcibly deleted.
  • yes: indicates to forcibly delete an AS group.
+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to forcibly delete the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.

    +
    DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1?force_delete=yes
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Groups
+
+
+ diff --git a/docs/as/api-ref/as_06_0106.html b/docs/as/api-ref/as_06_0106.html new file mode 100644 index 000000000..21ef2d8b3 --- /dev/null +++ b/docs/as/api-ref/as_06_0106.html @@ -0,0 +1,170 @@ + + +

Enabling or Disabling an AS Group

+

Function

This interface is used to enable or disable a specified AS group.

+

For a disabled AS group, AS does not automatically trigger any scaling actions. When an AS group has an in-progress scaling action, the scaling action does not stop immediately after the AS group is disabled.

+
+
+

URI

POST /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    action

    +

    Yes

    +

    String

    +

    Specifies a flag for enabling or disabling an AS group.

    +
    • resume: enables the AS group.
    • pause: disables the AS group.
    +
    +
    +
+
  • Example request
    This example shows how to enable the AS group with ID a8327883-6b07-4497-9c61-68d03ee193a1.
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1/action
+
+{
+    "action": "resume"
+}
    +
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Groups
+
+
+ diff --git a/docs/as/api-ref/as_06_0200.html b/docs/as/api-ref/as_06_0200.html new file mode 100644 index 000000000..2f451a314 --- /dev/null +++ b/docs/as/api-ref/as_06_0200.html @@ -0,0 +1,23 @@ + + +

AS Configurations

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_0201.html b/docs/as/api-ref/as_06_0201.html new file mode 100644 index 000000000..d635f4849 --- /dev/null +++ b/docs/as/api-ref/as_06_0201.html @@ -0,0 +1,645 @@ + + +

Creating an AS Configuration

+

Function

This API is used to create an AS configuration.

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

URI

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

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_configuration_name

    +

    Yes

    +

    String

    +

    Specifies the AS configuration name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.

    +

    instance_config

    +

    Yes

    +

    Object

    +

    Specifies the ECS configuration. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 instance_config field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    instance_id

    +

    No

    +

    String

    +

    Specifies the ECS ID. When using the existing ECS specifications as the template to create AS configurations, specify this parameter. In this case, the flavorRef, imageRef, disk, and security_groups fields do not take effect.

    +

    If the instance_id field is not specified, flavorRef, imageRef, and disk fields are mandatory.

    +

    flavorRef

    +

    No

    +

    String

    +

    Specifies the ECS flavor ID. A maximum of 10 flavors can be selected. Use a comma (,) to separate multiple flavor IDs. You can obtain its value from the API for querying details about flavors and extended flavor information.

    +

    imageRef

    +

    No

    +

    String

    +

    Specifies the image ID. Its value is the same as that of image_id for specifying the image selected during ECS creation. Obtain the value using the API for querying images. .

    +

    disk

    +

    No

    +

    Array of disk objects

    +

    Specifies the disk group information. System disks are mandatory and data disks are optional. For details, see Table 4.

    +

    key_name

    +

    Yes

    +

    String

    +

    Specifies the name of the SSH key pair used to log in to the ECS.

    +

    personality

    +

    No

    +

    Array of personality objects

    +

    Specifies information about the injected file. Only text files can be injected. A maximum of five files can be injected at a time and the maximum size of each file is 1 KB. For details, see Table 6.

    +

    public_ip

    +

    No

    +

    public_ip object

    +

    Specifies the EIP of the ECS. The EIP can be configured in two ways. For details, see Table 7.

    +
    • Do not use an EIP. In this case, this parameter is unavailable.
    • Automatically assign an EIP. You need to specify the information about the new EIP.
    +

    user_data

    +

    No

    +

    String

    +

    Specifies the user data to be injected during the ECS creation process. Text, text files, and gzip files can be injected.

    +

    Constraints:

    +
    • The content to be injected must be encoded with base64. The maximum size of the content to be injected (before encoding) is 32 KB.
    +

    Examples:

    +
    • Linux
      #! /bin/bash
+echo user_test >> /home/user.txt
      +
    • Windows
      rem cmd
+echo 111 > c:\aaa.txt
      +
    +

    metadata

    +

    No

    +

    metadata object

    +

    Specifies the ECS metadata. For details, see Table 10.

    +

    security_groups

    +

    Yes

    +

    Array of security_groups objects

    +

    Specifies security groups. For details, see Table 11.

    +

    If the security group is specified both in the AS configuration and AS group, scaled ECS instances will be added to the security group specified in the AS configuration. If the security group is not specified in either of them, scaled ECS instances will be added to the default security group. For your convenience, you are advised to specify the security group in the AS configuration.

    +

    market_type

    +

    No

    +

    String

    +

    This parameter is reserved.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 disk field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    size

    +

    Yes

    +

    Integer

    +

    Specifies the disk size. The unit is GB.

    +

    The system disk size ranges from 1 to 1024 and must be greater than or equal to the minimum size (min_disk value) of the system disk specified in the image.

    +

    The data disk size ranges from 10 to 32768.

    +

    volume_type

    +

    Yes

    +

    String

    +

    Specifies the ECS system disk type. The disk type must match the available disk type.

    +
    • SATA: common I/O disk type
    • SAS: high I/O disk type
    • SSD: ultra-high I/O disk type
    • co-p1: high I/O (performance-optimized I) disk type
    • uh-l1: ultra-high I/O (latency-optimized) disk type
    +

    If the specified disk type is not available in the AZ, the disk will fail to create.

    +
    NOTE:

    For HANA, HL1, and HL2 ECSs, use co-p1 and uh-l1 disks. For other ECSs, do not use co-p1 or uh-l1 disks.

    +

    +
    +

    disk_type

    +

    Yes

    +

    String

    +

    Specifies a disk type. The options are as follows:

    +
    • DATA: indicates a data disk.
    • SYS: indicates a system disk.
      NOTE:

      System disk encryption is not supported.

      +
      +
    +

    dedicated_storage_id

    +

    No

    +

    String

    +

    Specifies a DSS device ID for creating an ECS disk.

    +
    NOTE:

    Specify DSS devices for all disks in an AS configuration or not. If DSS devices are specified, all the data stores must belong to the same AZ, and the disk types supported by a DSS device for a disk must be the same as the volume_type value.

    +
    +

    data_disk_image_id

    +

    No

    +

    String

    +

    Specifies the ID of a data disk image used to export data disks of an ECS.

    +

    snapshot_id

    +

    No

    +

    String

    +

    Specifies the disk backup snapshot ID for restoring the system disk and data disks using a full-ECS backup when a full-ECS image is used.

    +
    NOTE:

    Each disk in an AS configuration must correspond to a disk backup in the full-ECS backup by snapshot_id.

    +
    +

    metadata

    +

    No

    +

    metadata object

    +

    Specifies the metadata for creating disks. For details, see Table 5.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 5 metadata Field Description for Creating Disks

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    __system__encrypted

    +

    No

    +

    String

    +

    Specifies encryption in metadata. The value can be 0 (encryption disabled) or 1 (encryption enabled).

    +

    If this parameter does not exist, the disk will not be encrypted by default.

    +
    NOTE:

    System disk encryption is not supported.

    +
    +

    __system__cmkid

    +

    No

    +

    String

    +

    Specifies the CMK ID, which indicates encryption in metadata. This parameter is used with __system__encrypted.

    +
    NOTE:
    • For details about how to obtain the CMK ID, see "Querying the List of CMKs" in Key Management Service API Reference.
    • System disk encryption is not supported.
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 6 personality field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    path

    +

    Yes

    +

    String

    +

    Specifies the path of the injected file.

    +
    • For Linux OSs, specify the path, for example, /etc/foo.txt, for storing the injected file.
    • For Windows, the injected file is automatically stored in the root directory of drive C. You only need to specify the file name, for example, foo. The file name contains only letters and digits.
    +

    content

    +

    Yes

    +

    String

    +

    Specifies the content of the injected file.

    +

    The value must be the information after the content of the injected file is encoded using Base64.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 7 public_ip field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    eip

    +

    Yes

    +

    eip object

    +

    Specifies the EIP automatically assigned to the ECS. For details, see Table 8.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 8 eip field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    ip_type

    +

    Yes

    +

    String

    +

    Specifies the EIP type.

    +

    Enumerated value of the IP address type: 5_bgp (indicates dynamic BGP)

    +

    bandwidth

    +

    Yes

    +

    bandwidth object

    +

    Specifies the bandwidth of an IP address. For details, see Table 9.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 9 bandwidth field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    size

    +

    Yes

    +

    Integer

    +

    Specifies the bandwidth (Mbit/s). The value range is 1 to 500.

    +
    NOTE:
    • The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.
    • The minimum unit for bandwidth varies depending on the bandwidth range.
      • The minimum unit is 1 Mbit/s if the allowed bandwidth size ranges from 0 to 300 Mbit/s (with 300 Mbit/s included).
      • The minimum unit is 50 Mbit/s if the allowed bandwidth size ranges 300 Mbit/s to 500 Mbit/s (with 500 Mbit/s included).
      +
    +
    +

    share_type

    +

    Yes

    +

    String

    +

    Specifies the bandwidth sharing type.

    +

    Enumerated values of the sharing type:

    +
    • PER: dedicated
    +

    Only dedicated bandwidth is available.

    +

    charging_mode

    +

    Yes

    +

    String

    +

    Specifies the bandwidth billing mode.

    +

    traffic: billed by traffic.

    +

    If the parameter value is out of the preceding options, creating the ECS will fail.

    +
    +
    + +
    + + + + + + + + + + + +
    Table 10 metadata field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    admin_pass

    +

    No

    +

    String

    +

    Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is root, and the Windows administrator is Administrator.

    +
    Password complexity requirements:
    • Consists of 8 to 26 characters.
    • Contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters !@$%^-_=+[{}]:,./?
    • The password cannot contain the username or the username in reversed order.
    • The Windows ECS password cannot contain the username, the username in reversed order, or more than two consecutive characters in the username.
    +
    +
    +
    + +
    + + + + + + + + + + + +
    Table 11 security_groups field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    id

    +

    Yes

    +

    String

    +

    Specifies the ID of the security group.

    +
    +
    +
+
  • Example request
    This example shows how to create an AS configuration with name as-config-tlzp, image ID 627a1223-2ca3-46a7-8d5f-7aef22c74ee6, flavor ID s3.xlarge.4, 40 GB SATA system disk, and SSH key name 100vm_key.
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration
+
+{ 
+    "scaling_configuration_name": "as-config-tlzq", 
+    "instance_config": { 
+        "flavorRef": "s3.xlarge.4", 
+        "imageRef": "627a1223-2ca3-46a7-8d5f-7aef22c74ee6", 
+        "disk": [ 
+            { 
+                "size": 40, 
+                "volume_type": "SATA", 
+                "disk_type": "SYS" 
+            } 
+        ], 
+        "key_name": "100vm_key" ,
+	"security_groups": [{
+		"id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be"
+	}], 
+        "multi_flavor_priority_policy": "PICK_FIRST"
+    } 
+}
+
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 12 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_configuration_id

    +

    String

    +

    Specifies the AS configuration ID.

    +
    +
    +
+
  • Example response
    {
+    "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2"
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Configurations
+
+
+ diff --git a/docs/as/api-ref/as_06_0202.html b/docs/as/api-ref/as_06_0202.html new file mode 100644 index 000000000..f73df6993 --- /dev/null +++ b/docs/as/api-ref/as_06_0202.html @@ -0,0 +1,705 @@ + + +

Querying AS Configurations

+

Function

This API is used to query AS configurations based on search criteria. The results are displayed by page.

+
  • Search criteria can be the AS configuration name, image ID, start line number, and number of records.
  • If no search criteria are specified, a maximum of 20 AS configurations can be queried for a tenant by default.
+
+

URI

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

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. AS configurations can be searched by all optional parameters in the following table. For details, see the example request.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_configuration_name

+

No

+

String

+

Specifies the AS configuration name.

+

Supports fuzzy search.

+

image_id

+

No

+

String

+

Specifies the image ID. It is same as imageRef.

+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query the AS configurations with image ID 37ca2b35-6fc7-47ab-93c7-900324809c5c.

    +
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration?image_id=37ca2b35-6fc7-47ab-93c7-900324809c5c
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    total_number

    +

    Integer

    +

    Specifies the total number of query records.

    +

    start_number

    +

    Integer

    +

    Specifies the start line number.

    +

    limit

    +

    Integer

    +

    Specifies the number of query records.

    +

    scaling_configurations

    +

    Array of scaling_configurations objects

    +

    Specifies the AS configuration list.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_configurations field description

    Parameter

    +

    Type

    +

    Description

    +

    scaling_configuration_id

    +

    String

    +

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

    +

    tenant

    +

    String

    +

    Specifies the tenant ID.

    +

    scaling_configuration_name

    +

    String

    +

    Specifies the AS configuration name.

    +

    Supports fuzzy search.

    +

    instance_config

    +

    instance_config object

    +

    Specifies the information about instance configurations.

    +

    create_time

    +

    String

    +

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

    +

    scaling_group_id

    +

    String

    +

    Specifies the ID of the AS group to which the AS configuration is bound.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 instance_config field description

    Parameter

    +

    Type

    +

    Description

    +

    flavorRef

    +

    String

    +

    Specifies the ECS flavor ID.

    +

    imageRef

    +

    String

    +

    Specifies the image ID. It is same as image_id.

    +

    disk

    +

    Array of disk objects

    +

    Specifies the disk group information.

    +

    key_name

    +

    String

    +

    Specifies the name of the SSH key pair used to log in to the ECS.

    +

    key_fingerprint

    +

    String

    +

    Specifies the fingerprint of the SSH key pair used to log in to the ECS.

    +

    instance_name

    +

    String

    +

    This parameter is reserved.

    +

    instance_id

    +

    String

    +

    This parameter is reserved.

    +

    adminPass

    +

    String

    +

    This parameter is reserved.

    +

    personality

    +

    Array of personality objects

    +

    Specifies information about the injected file.

    +

    public_ip

    +

    public_ip object

    +

    Specifies the EIP of the ECS.

    +

    user_data

    +

    String

    +

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

    +

    metadata

    +

    metadata object

    +

    Specifies the ECS metadata. For details, see Table 11.

    +

    security_groups

    +

    Array of security_groups objects

    +

    Specifies the security group information.

    +

    server_group_id

    +

    String

    +

    This parameter is reserved.

    +

    tenancy

    +

    String

    +

    This parameter is reserved.

    +

    dedicated_host_id

    +

    String

    +

    This parameter is reserved.

    +

    market_type

    +

    String

    +

    This parameter is reserved.

    +

    multi_flavor_priority_policy

    +

    String

    +

    This parameter is reserved.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 disk field description

    Parameter

    +

    Type

    +

    Description

    +

    size

    +

    Integer

    +

    Specifies the disk size. The unit is GB.

    +

    volume_type

    +

    String

    +

    Specifies the disk type.

    +

    disk_type

    +

    String

    +

    Specifies whether the disk is a system disk or a data disk. DATA indicates a data disk. SYS indicates a system disk.

    +

    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

    +

    metadata object

    +

    Specifies the metadata for creating disks. For details, see Table 6.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 6 metadata Field Description for Creating Disks

    Parameter

    +

    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.

    +
    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 7 personality field description

    Parameter

    +

    Type

    +

    Description

    +

    path

    +

    String

    +

    Specifies the path of the injected file.

    +

    content

    +

    String

    +

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

    +
    +
    + +
    + + + + + + + + + +
    Table 8 public_ip field description

    Parameter

    +

    Type

    +

    Description

    +

    eip

    +

    eip object

    +

    Specifies the automatically assigned EIP.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 9 eip field description

    Parameter

    +

    Type

    +

    Description

    +

    ip_type

    +

    String

    +

    Specifies the IP address type.

    +

    bandwidth

    +

    bandwidth object

    +

    Specifies the bandwidth of an IP address.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 10 bandwidth field description

    Parameter

    +

    Type

    +

    Description

    +

    size

    +

    Integer

    +

    Specifies the bandwidth (Mbit/s).

    +

    share_type

    +

    String

    +

    Specifies the bandwidth sharing type.

    +

    Enumerated values of the sharing type:

    +
    • PER: dedicated
    +

    charging_mode

    +

    String

    +

    Specifies the bandwidth billing mode.

    +
    • traffic: billed by traffic.
    +
    +
    + +
    + + + + + + + + + +
    Table 11 metadata field description

    Parameter

    +

    Type

    +

    Description

    +

    admin_pass

    +

    String

    +

    Specifies the password of the Administrator account for a Windows ECS.

    +
    +
    + +
    + + + + + + + + + +
    Table 12 security_groups field description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the security group ID.

    +
    +
    +
+
  • 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"
+        }
+    ]
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Configurations
+
+
+ diff --git a/docs/as/api-ref/as_06_0203.html b/docs/as/api-ref/as_06_0203.html new file mode 100644 index 000000000..efec04e09 --- /dev/null +++ b/docs/as/api-ref/as_06_0203.html @@ -0,0 +1,593 @@ + + +

Querying AS Configuration Details

+

Function

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

+
+

URI

GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_configuration_id

+

Yes

+

String

+

Specifies an AS configuration ID, which is unique globally. For details, see Querying AS Configuration Details.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query details about the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86.

    +
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/6afe46f9-7d3d-4046-8748-3b2a1085ad86
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_configuration

    +

    scaling_configurations object

    +

    Provides AS configuration details.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_configurations field description

    Parameter

    +

    Type

    +

    Description

    +

    scaling_configuration_id

    +

    String

    +

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

    +

    tenant

    +

    String

    +

    Specifies the tenant ID.

    +

    scaling_configuration_name

    +

    String

    +

    Specifies the AS configuration name.

    +

    Supports fuzzy search.

    +

    instance_config

    +

    instance_config object

    +

    Specifies the information about instance configurations.

    +

    create_time

    +

    String

    +

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

    +

    scaling_group_id

    +

    String

    +

    Specifies the ID of the AS group to which the AS configuration is bound.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 instance_config field description

    Parameter

    +

    Type

    +

    Description

    +

    flavorRef

    +

    String

    +

    Specifies the ECS flavor ID.

    +

    imageRef

    +

    String

    +

    Specifies the image ID. It is same as image_id.

    +

    disk

    +

    Array of disk objects

    +

    Specifies the disk group information.

    +

    key_name

    +

    String

    +

    Specifies the name of the SSH key pair used to log in to the ECS.

    +

    key_fingerprint

    +

    String

    +

    Specifies the fingerprint of the SSH key pair used to log in to the ECS.

    +

    instance_name

    +

    String

    +

    This parameter is reserved.

    +

    instance_id

    +

    String

    +

    This parameter is reserved.

    +

    adminPass

    +

    String

    +

    This parameter is reserved.

    +

    personality

    +

    Array of personality objects

    +

    Specifies information about the injected file.

    +

    public_ip

    +

    public_ip object

    +

    Specifies the EIP of the ECS.

    +

    user_data

    +

    String

    +

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

    +

    metadata

    +

    metadata object

    +

    Specifies the ECS metadata. For details, see Table 11.

    +

    security_groups

    +

    Array of security_groups objects

    +

    Specifies the security group information.

    +

    server_group_id

    +

    String

    +

    This parameter is reserved.

    +

    tenancy

    +

    String

    +

    This parameter is reserved.

    +

    dedicated_host_id

    +

    String

    +

    This parameter is reserved.

    +

    market_type

    +

    String

    +

    This parameter is reserved.

    +

    multi_flavor_priority_policy

    +

    String

    +

    This parameter is reserved.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 5 disk field description

    Parameter

    +

    Type

    +

    Description

    +

    size

    +

    Integer

    +

    Specifies the disk size. The unit is GB.

    +

    volume_type

    +

    String

    +

    Specifies the disk type.

    +

    disk_type

    +

    String

    +

    Specifies whether the disk is a system disk or a data disk. DATA indicates a data disk. SYS indicates a system disk.

    +

    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

    +

    metadata object

    +

    Specifies the metadata for creating disks. For details, see Table 6.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 6 personality field description

    Parameter

    +

    Type

    +

    Description

    +

    path

    +

    String

    +

    Specifies the path of the injected file.

    +

    content

    +

    String

    +

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

    +
    +
    + +
    + + + + + + + + + +
    Table 7 public_ip field description

    Parameter

    +

    Type

    +

    Description

    +

    eip

    +

    eip object

    +

    Specifies the automatically assigned EIP.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 8 eip field description

    Parameter

    +

    Type

    +

    Description

    +

    ip_type

    +

    String

    +

    Specifies the IP address type.

    +

    bandwidth

    +

    bandwidth object

    +

    Specifies the bandwidth of an IP address.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 9 bandwidth field description

    Parameter

    +

    Type

    +

    Description

    +

    size

    +

    Integer

    +

    Specifies the bandwidth (Mbit/s).

    +

    share_type

    +

    String

    +

    Specifies the bandwidth sharing type.

    +

    Enumerated values of the sharing type:

    +
    • PER: dedicated
    +

    charging_mode

    +

    String

    +

    Specifies the bandwidth billing mode.

    +
    • traffic: billed by traffic.
    +
    +
    + +
    + + + + + + + + + +
    Table 10 metadata field description

    Parameter

    +

    Type

    +

    Description

    +

    admin_pass

    +

    String

    +

    Specifies the password of the Administrator account for a Windows ECS.

    +
    +
    + +
    + + + + + + + + + +
    Table 11 security_groups field description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the security group ID.

    +
    +
    +
+
  • Example response
    {
+    "scaling_configuration": {
+        "tenant": "ce061903a53545dcaddb300093b477d2",
+        "scaling_configuration_id": "6afe46f9-7d3d-4046-8748-3b2a1085ad86",
+        "scaling_configuration_name": " config_name_1",
+        "instance_config": {
+            "disk": [
+                {
+                    "size": 40,
+                    "volume_type": "SATA",
+                    "disk_type": "SYS"
+                },
+                {
+                    "size": 100,
+                    "volume_type": "SATA",
+                    "disk_type": "DATA"
+                }
+            ],
+            "adminPass": "***",
+            "personality": null,
+            "instance_name": null,
+            "instance_id": null,
+            "flavorRef": "103",
+            "imageRef": "37ca2b35-6fc7-47ab-93c7-900324809c5c",
+            "key_name": "keypair01",
+            "public_ip": null,
+            "user_data": null,
+            "metadata": {},
+            "security_groups": [{
+                 "id": "6c22a6c0-b5d2-4a84-ac56-51090dcc33be"
+            }],
+            "multi_flavor_priority_policy": "PICK_FIRST"
+        },
+        "create_time": "2015-07-23T01:04:07Z"
+    }
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Configurations
+
+
+ diff --git a/docs/as/api-ref/as_06_0204.html b/docs/as/api-ref/as_06_0204.html new file mode 100644 index 000000000..88b704955 --- /dev/null +++ b/docs/as/api-ref/as_06_0204.html @@ -0,0 +1,142 @@ + + +

Deleting an AS Configuration

+

Function

This interface is used to delete a specified AS configuration.

+

AS configurations used by AS groups cannot be deleted.

+
+
+

URI

DELETE /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_ configuration _id

+

Yes

+

String

+

Specifies the AS configuration ID. For details, see Querying AS Configurations.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to delete the AS configuration with ID 6afe46f9-7d3d-4046-8748-3b2a1085ad86.

    +
    DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configuration/6afe46f9-7d3d-4046-8748-3b2a1085ad86
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Configurations
+
+
+ diff --git a/docs/as/api-ref/as_06_0205.html b/docs/as/api-ref/as_06_0205.html new file mode 100644 index 000000000..02eb66139 --- /dev/null +++ b/docs/as/api-ref/as_06_0205.html @@ -0,0 +1,162 @@ + + +

Batch Deleting AS Configurations

+

Function

This interface is used to batch delete AS configurations.

+
  • AS configurations used by AS groups cannot be deleted.
  • A maximum of 50 AS configurations can be deleted at a time.
+
+

URI

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

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_configuration_id

    +

    Yes

    +

    Array of strings

    +

    Specifies the AS configuration ID. For details, see Querying AS Configurations.

    +
    +
    +
+
  • Example request
    This example shows how to delete the AS configurations with IDs config1 and config2 in a batch.
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_configurations
+
+{
+    "scaling_configuration_id": [
+        "config1",
+        "config2"
+    ]
+}
    +
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Configurations
+
+
+ diff --git a/docs/as/api-ref/as_06_0300.html b/docs/as/api-ref/as_06_0300.html new file mode 100644 index 000000000..a1341edbf --- /dev/null +++ b/docs/as/api-ref/as_06_0300.html @@ -0,0 +1,19 @@ + + +

Instances in an AS Group

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_0301.html b/docs/as/api-ref/as_06_0301.html new file mode 100644 index 000000000..e0a081e86 --- /dev/null +++ b/docs/as/api-ref/as_06_0301.html @@ -0,0 +1,336 @@ + + +

Querying Instances in an AS Group

+

Function

This API is used to query instances in an AS group based on search criteria. The results are displayed by page.

+
  • Search criteria can be the instance lifecycle status, instance health status, instance protection status, start line number, and number of records in the AS group.
  • If no search criteria are specified, a maximum of 20 instances in an AS group can be queried by default.
+
+

URI

GET /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/list

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. Instances in an AS group can be searched by all optional parameters in the following table. For details, see the example request.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+

life_cycle_state

+

No

+

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

+

No

+

String

+

Specifies the instance health status.

+
  • INITIALIZING: The instance is initializing.
  • NORMAL: The instance is normal.
  • ERROR: The instance is abnormal.
+

protect_from_scaling_down

+

No

+

String

+

Specifies the instance protection status.

+
  • true: Instance protection is enabled.
  • false: Instance protection is disabled.
+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    This example shows how to query enabled, healthy instances in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a.
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?life_cycle_state=INSERVICE&health_status=NORMAL
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    total_number

    +

    Integer

    +

    Specifies the total number of query records.

    +

    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.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_group_instances field description

    Parameter

    +

    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
+        }
+    ]
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instances in an AS Group
+
+
+ diff --git a/docs/as/api-ref/as_06_0302.html b/docs/as/api-ref/as_06_0302.html new file mode 100644 index 000000000..58190637a --- /dev/null +++ b/docs/as/api-ref/as_06_0302.html @@ -0,0 +1,153 @@ + + +

Removing a Specified Instance from an AS Group

+

Function

This interface is used to remove a specified instance from an AS group.

+
  • You can remove instances only in INSERVICE state and only when the number of instances after the removal is greater than or equal to the minimum number of instances allowed.
+
+
  • You can remove instances from an AS group only when no scaling action is in progress.
+

URI

DELETE /autoscaling-api/v1/{project_id}/scaling_group_instance/{instance_id}?instance_delete=yes

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

instance_id

+

Yes

+

String

+

Specifies the instance ID. For details, see Querying Instances in an AS Group.

+

instance_delete

+

No

+

String

+

Specifies whether an instance is deleted when it is removed from the AS group.

+

Options:

+
  • no (default): The instance will not be deleted.
  • yes: The instance will be deleted.
+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to remove but not delete the instance with ID b25c1589-c96c-465b-9fef-d06540d1945c from an AS group.

    +
    DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/b25c1589-c96c-465b-9fef-d06540d1945c?instance_delete=no
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instances in an AS Group
+
+
+ diff --git a/docs/as/api-ref/as_06_0303.html b/docs/as/api-ref/as_06_0303.html new file mode 100644 index 000000000..ba8541c07 --- /dev/null +++ b/docs/as/api-ref/as_06_0303.html @@ -0,0 +1,196 @@ + + +

Performing Operations on Instances in Batches

+

Function

  • Add or remove instances to or from an AS group in batches.
  • Configure instance protection or cancel the configuration for the instances in an AS group in batches.
+
  • A batch operation can be performed on a maximum of 10 instances at a time. After instances are added to an AS group, the number of instances in the AS group cannot be greater than the maximum number of instances. After instances are removed from an AS group, the number of instances in the AS group cannot be less than the minimum number of instances.
  • 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.
  • To add instances to an AS group, ensure that the AZ of the instances falls within that of the AS group.
  • Only instances in INSERVICE state can be removed from an AS group. Instance protection can be enabled or disabled only for INSERVICE instances.
  • When the capacity of an AS group is automatically decreased, the instances with instance protection enabled will not be removed from the AS group.
  • If the listener bound to the instance to be removed is the same as the listener in the AS group, the listener will be unbound from the instance. If the listener bound to the instance to be removed is different from the listener in the AS group, the binding relationship between the listener and instance will be reserved.
+
+
+

URI

POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    instances_id

    +

    Yes

    +

    Array of strings

    +

    Specifies the ECS ID.

    +

    instance_delete

    +

    No

    +

    String

    +

    Specifies whether to delete an instance when it is removed from an AS group.

    +

    Options:

    +
    • no (default): The instance will not be deleted.
    • yes: The instance will be deleted.
    +

    This parameter takes effect only when the action is set to REMOVE.

    +

    action

    +

    Yes

    +

    String

    +

    Specifies an action to be performed on instances in batches. The options are as follows:

    +
    • ADD: adds instances to the AS group.
    • REMOVE: removes instances from the AS group.
    • PROTECT: enables instance protection.
    • UNPROTECT: disables instance protection.
    +
    +
    +
+
  • Example request
    This example shows how to remove and delete instances with IDs instance_id_1 and instance_id_2 from the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a in a batch.
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_instance/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/action
+
+{
+    "action": "REMOVE",
+    "instances_id": [
+        "instance_id_1",
+        "instance_id_2"
+    ],
+    "instance_delete": "yes"
+}
    +
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Instances in an AS Group
+
+
+ diff --git a/docs/as/api-ref/as_06_0400.html b/docs/as/api-ref/as_06_0400.html new file mode 100644 index 000000000..cdfa7f0d9 --- /dev/null +++ b/docs/as/api-ref/as_06_0400.html @@ -0,0 +1,37 @@ + + +

AS Policies

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_0401.html b/docs/as/api-ref/as_06_0401.html new file mode 100644 index 000000000..db70cb9b6 --- /dev/null +++ b/docs/as/api-ref/as_06_0401.html @@ -0,0 +1,361 @@ + + +

Creating an AS Policy

+

Function

This API is used to create an AS policy.

+
  • An AS policy defines whether to increase or decrease the number of instances in an AS group. If the number and the expected number of instances in an AS group are different due to the execution of the AS policy, AS automatically adjusts the number of instances to the expected.
  • AS supports the following policies: alarm-triggered policy, periodic policy, and scheduled policy.
  • In the execution of the AS policy, you can set the number of instances to be scaled or perform a scaling action according to a percentage specified in the AS policy.
+
+

URI

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

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_policy_name

    +

    Yes

    +

    String

    +

    Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.

    +

    scaling_group_id

    +

    Yes

    +

    String

    +

    Specifies the AS group ID, which can be obtained using the API for querying AS groups. For details, see Querying AS Groups.

    +

    scaling_policy_type

    +

    Yes

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.
    • SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.
    • RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically.
    +

    alarm_id

    +

    No

    +

    String

    +

    Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.

    +

    After you create an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.

    +

    scheduled_policy

    +

    No

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect. For details, see Table 3.

    +

    scaling_policy_action

    +

    No

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 4.

    +

    cool_down_time

    +

    No

    +

    Integer

    +

    Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scheduled_policy field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    launch_time

    +

    Yes

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    No

    +

    String

    +

    Specifies the periodic triggering type. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    No

    +

    String

    +

    Specifies the day when a periodic scaling action is triggered. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
    +

    start_time

    +

    No

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC. The default value is the local time.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    No

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +

    When the scaling action is triggered periodically, the end time cannot be earlier than the current and start time.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scaling_policy_action field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    operation

    +

    No

    +

    String

    +

    Specifies the operation to be performed. The default operation is ADD.

    +
    • ADD: adds specified number of instances to the AS group.
    • REMOVE/REDUCE: removes or reduces specified number of instances from the AS group.
    • SET: sets the number of instances in the AS group.
    +

    instance_number

    +

    No

    +

    Integer

    +

    Specifies the number of instances to be operated. The default number is 1. The value range is as follows for a default quota:

    +
    • If operation is set to SET, the value range is 0 to 200.
    • If operation is set to ADD, REMOVE, or REDUCE, the value range is 1 to 200.
    +
    NOTE:

    Either instance_number or instance_percentage is required.

    +
    +

    instance_percentage

    +

    No

    +

    Integer

    +

    Specifies the percentage of instances to be operated. You can increase, decrease, or set the number of instances in an AS group to the specified percentage of the current number of instances. If operation is set to ADD, REMOVE or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.

    +

    If neither instance_number nor instance_percentage is specified, the number of instances to be operated is 1.

    +

    Either instance_number or instance_percentage is required.

    +
    +
    +
+
  • Example request
    This example shows how to create a periodic AS policy named as-policy-7a75. The policy takes effect from 2015-12-14T03:34Z through 2015-12-27T03:34Z. During this period, one instance will be added to AS group with ID 5bc3aa02-b83e-454c-aba1-4d2095c68f8b at 16:00 every day.
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy
+
+{
+    "scaling_policy_name": "as-policy-7a75",
+    "scaling_policy_action": {
+        "operation": "ADD",
+        "instance_number": 1
+    },
+    "cool_down_time": 900,
+    "scheduled_policy": {
+        "launch_time": "16:00",
+        "recurrence_type": "Daily",
+        "start_time": "2015-12-14T03:34Z",
+        "end_time": "2015-12-27T03:34Z"
+    },
+    "scaling_policy_type": "RECURRENCE",
+    "scaling_group_id": "5bc3aa02-b83e-454c-aba1-4d2095c68f8b"
+}
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 5 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +
    +
    +
+
  • Example response
    {
+    "scaling_policy_id": "0h327883-324n-4dzd-9c61-68d03ee191dd"
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0402.html b/docs/as/api-ref/as_06_0402.html new file mode 100644 index 000000000..2d10fc20b --- /dev/null +++ b/docs/as/api-ref/as_06_0402.html @@ -0,0 +1,389 @@ + + +

Creating an AS Policy (V2)

+

Function

This API is used to create an AS policy for an AS group or bandwidth.

+

The difference between the V2 and V1 APIs for creating an AS policy is that V2 supports creating an AS policy for adjusting bandwidth and differentiating scaling resources by their types.

+
+

URI

POST /autoscaling-api/v2/{project_id}/scaling_policy

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_policy_name

    +

    Yes

    +

    String

    +

    Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.

    +

    scaling_resource_id

    +

    Yes

    +

    String

    +

    Specifies the scaling resource ID, which is the unique ID of an AS group or bandwidth.

    +
    • If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the unique AS group ID.
    • If scaling_resource_type is set to BANDWIDTH, this parameter indicates the unique bandwidth ID.
    +

    scaling_resource_type

    +

    Yes

    +

    String

    +

    Specifies the scaling resource type.

    +
    • AS group: SCALING_GROUP
    • Bandwidth: BANDWIDTH
    +

    scaling_policy_type

    +

    Yes

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.
    • SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.
    • RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically.
    +

    alarm_id

    +

    No

    +

    String

    +

    Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.

    +

    After you create an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.

    +

    You can obtain the parameter value by querying Cloud Eye alarm rules.

    +

    scheduled_policy

    +

    No

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect. For details, see Table 3.

    +

    scaling_policy_action

    +

    No

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 4.

    +

    cool_down_time

    +

    No

    +

    Integer

    +

    Specifies the cooldown period (in seconds). The value ranges from 0 to 86400 and is 300 by default.

    +

    description

    +

    No

    +

    String

    +

    Specifies the description of the AS policy. The value can contain 1 to 256 characters.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scheduled_policy field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    launch_time

    +

    Yes

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    No

    +

    String

    +

    Specifies the periodic triggering type. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    No

    +

    String

    +

    Specifies the day when a periodic scaling action is triggered. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
      NOTE:

      When recurrence_type is set to Daily, this parameter does not take effect.

      +
      +
    +

    start_time

    +

    No

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC. The default value is the local time.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    No

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. This parameter is mandatory when scaling_policy_type is set to RECURRENCE. When the scaling action is triggered periodically, the end time cannot be earlier than the current and start time.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scaling_policy_action field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    operation

    +

    No

    +

    String

    +
    Specifies the operation to be performed. The default operation is ADD.
    • If scaling_resource_type is set to SCALING_GROUP, the following operations are supported:
      • ADD: indicates adding instances.
      • REMOVE/REDUCE: indicates removing or reducing instances.
      • SET: indicates setting the number of instances to a specified value.
      +
    • If scaling_resource_type is set to BANDWIDTH, the following operations are supported:
      • ADD: indicates adding instances.
      • REDUCE: indicates reducing instances.
      • SET: indicates setting the number of instances to a specified value.
      +
    +
    +

    size

    +

    No

    +

    Integer

    +

    Specifies the operation size. The value is an integer from 0 to 300. The default value is 1. This parameter can be set to 0 only when operation is set to SET.

    +
    • If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the number of instances. The value is an integer from 0 to 300 and the default value is 1.
    • If scaling_resource_type is set to BANDWIDTH, this parameter indicates the bandwidth (Mbit/s). The value is an integer from 1 to 300 and the default value is 1.
    • If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set.
    +

    percentage

    +

    No

    +

    Integer

    +

    Specifies the percentage of instances to be operated. If operation is set to ADD, REMOVE, or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.

    +
    • If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set. If neither size nor percentage is set, the default value of size is 1.
    • If scaling_resource_type is set to BANDWIDTH, percentage is unavailable.
    +

    limits

    +

    No

    +

    Integer

    +

    Specifies the operation restrictions.

    +

    If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s.

    +
    • If operation is set to ADD, this parameter indicates the maximum bandwidth allowed.
    • If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed.
    +
    +
    +
+
+
  • Example request
    This example shows how to create an alarm policy named hth_aspolicy_1 with the following configurations: The alarm rule ID is al1513822380493GvlJKZwA8; when the alarm threshold is reached according to the alarm rule, the bandwidth with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6 will be increased by 1 Mbit/s until the bandwidth reaches 10 Mbit/s.
    POST https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy
+
+{ 
+    "alarm_id": "al1513822380493GvlJKZwA8",
+    "cool_down_time": 900,
+    "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
+    "scaling_resource_type": "BANDWIDTH",
+    "scaling_policy_action": {
+           "size": 1,
+           "operation": "ADD",
+           "limits": 10
+    },
+    "scaling_policy_name": "hth_aspolicy_1",
+    "scaling_policy_type": "ALARM"
+}
    +
    +
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 5 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +
    +
    +
  • Example response
    { 
+     "scaling_policy_id": "0h327883-324n-4dzd-9c61-68d03ee191dd"  
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0403.html b/docs/as/api-ref/as_06_0403.html new file mode 100644 index 000000000..eaa5552a7 --- /dev/null +++ b/docs/as/api-ref/as_06_0403.html @@ -0,0 +1,359 @@ + + +

Modifying an AS Policy

+

Function

This API is used to modify a specified AS policy.

+
+

URI

PUT /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_policy_id

+

Yes

+

String

+

Specifies an AS policy ID. For details, see Querying AS Policies.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_policy_name

    +

    No

    +

    String

    +

    Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.

    +

    scaling_policy_type

    +

    No

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.
    • SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.
    • RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically.
    +

    alarm_id

    +

    No

    +

    String

    +

    Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.

    +

    After you modify an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.

    +

    You can obtain the parameter value by querying Cloud Eye alarm rules.

    +

    scheduled_policy

    +

    No

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect. For details, see Table 3.

    +

    scaling_policy_action

    +

    No

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 4.

    +

    cool_down_time

    +

    No

    +

    Integer

    +

    Specifies the cooldown period (in seconds). The value ranges from 0 to 86400.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scheduled_policy field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    launch_time

    +

    Yes

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    No

    +

    String

    +

    Specifies the periodic triggering type. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    No

    +

    String

    +

    Specifies the day when a periodic scaling action is triggered. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
    +

    start_time

    +

    No

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    No

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +

    When the scaling action is triggered periodically, the end time cannot be earlier than the current and start time.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scaling_policy_action field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    operation

    +

    No

    +

    String

    +

    Specifies the operation to be performed. The default operation is ADD.

    +
    • ADD: adds specified number of instances to the AS group.
    • REMOVE/REDUCE: removes or reduces specified number of instances from the AS group.
    • SET: sets the number of instances in the AS group.
    +

    instance_number

    +

    No

    +

    Integer

    +

    Specifies the number of instances to be operated. The default number is 1. The value range is as follows for a default quota:

    +
    • If operation is set to SET, the value range is 0 to 200.
    • If operation is set to ADD, REMOVE, or REDUCE, the value range is 1 to 200.
    +
    NOTE:

    Either instance_number or instance_percentage is required.

    +
    +

    instance_percentage

    +

    No

    +

    Integer

    +

    Specifies the percentage of instances to be operated. You can increase, decrease, or set the number of instances in an AS group to the specified percentage of the current number of instances. If operation is set to ADD, REMOVE or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.

    +

    If neither instance_number nor instance_percentage is specified, the number of instances to be operated is 1.

    +

    Either instance_number or instance_percentage is required.

    +
    +
    +
+
  • Example request

    This example shows how to modify the periodic AS policy with ID 0h327883-324n-4dzd-9c61-68d03ee191dd for an AS group with two instances. The modification is as follows: The AS policy name is changed to policy_01, and the modification is executed at 16:00 every day from 2016-01-08T17:31Z through 2016-02-08T17:31Z.

    +
    PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/0h327883-324n-4dzd-9c61-68d03ee191dd
+
+{
+    "scaling_policy_type": "RECURRENCE",
+    "scaling_policy_name": "policy_01",
+    "scheduled_policy": {
+        "launch_time": "16:00",
+        "recurrence_type": "Daily",
+        "end_time": "2016-02-08T17:31Z",
+        "start_time": "2016-01-08T17:31Z"
+    },
+    "scaling_policy_action": {
+        "operation": "SET",
+        "instance_number": 2
+    }
+}
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +

    Parameter

    +

    Type

    +

    Description

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +
    +
    +
+
  • Example response
    {
+    "scaling_policy_id": "0h327883-324n-4dzd-9c61-68d03ee191dd"
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0404.html b/docs/as/api-ref/as_06_0404.html new file mode 100644 index 000000000..a8ec51072 --- /dev/null +++ b/docs/as/api-ref/as_06_0404.html @@ -0,0 +1,396 @@ + + +

Modifying an AS Policy (V2)

+

Function

This API is used to modify a specified AS policy.

+

The difference between the V2 and V1 APIs for modifying an AS policy is that V2 supports modifying a scaling resource type.

+
+

URI

PUT /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_policy_id

+

Yes

+

String

+

Specifies an AS policy ID. For details, see Querying AS Policies (V2).

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_policy_name

    +

    No

    +

    String

    +

    Specifies the AS policy name. The name contains only letters, digits, underscores (_), and hyphens (-), and cannot exceed 64 characters.

    +

    scaling_policy_type

    +

    No

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM (corresponding to alarm_id): indicates that the scaling action is triggered by an alarm.
    • SCHEDULED (corresponding to scheduled_policy): indicates that the scaling action is triggered as scheduled.
    • RECURRENCE (corresponding to scheduled_policy): indicates that the scaling action is triggered periodically.
    +

    scaling_resource_id

    +

    No

    +

    String

    +

    Specifies the scaling resource ID, which is the ID of a unique AS group or bandwidth.

    +

    scaling_resource_type

    +

    No

    +

    String

    +

    Specifies the scaling resource type.

    +
    • AS group: SCALING_GROUP
    • Bandwidth: BANDWIDTH
    +

    alarm_id

    +

    No

    +

    String

    +

    Specifies the alarm rule ID. This parameter is mandatory when scaling_policy_type is set to ALARM. After this parameter is specified, the value of scheduled_policy does not take effect.

    +

    After you modify an alarm policy, the system automatically adds an alarm triggering activity of the autoscaling type to the alarm_actions field in the alarm rule specified by the parameter value.

    +

    You can obtain the parameter value by querying Cloud Eye alarm rules.

    +

    scheduled_policy

    +

    No

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. This parameter is mandatory when scaling_policy_type is set to SCHEDULED or RECURRENCE. After this parameter is specified, the value of alarm_id does not take effect. For details, see Table 3.

    +

    scaling_policy_action

    +

    No

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 4.

    +

    cool_down_time

    +

    No

    +

    Integer

    +

    Specifies the cooldown period (in seconds). The value ranges from 0 to 86400.

    +

    description

    +

    No

    +

    String

    +

    Specifies the description of the AS policy. The value can contain 1 to 256 characters.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scheduled_policy field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    launch_time

    +

    Yes

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    No

    +

    String

    +

    Specifies the periodic triggering type. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    No

    +

    String

    +

    Specifies the day when a periodic scaling action is triggered. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
    +

    start_time

    +

    No

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    No

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC. This parameter is mandatory when scaling_policy_type is set to RECURRENCE.

    +

    When the scaling action is triggered periodically, the end time cannot be earlier than the current and start time.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scaling_policy_action field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    operation

    +

    No

    +

    String

    +
    Specifies the operation to be performed. The default operation is ADD.
    • If scaling_resource_type is set to SCALING_GROUP, the following operations are supported:
      • ADD: indicates adding instances.
      • REMOVE/REDUCE: indicates removing or reducing instances.
      • SET: indicates setting the number of instances to a specified value.
      +
    • If scaling_resource_type is set to BANDWIDTH, the following operations are supported:
      • ADD: indicates adding instances.
      • REDUCE: indicates reducing instances.
      • SET: indicates setting the number of instances to a specified value.
      +
    +
    +

    size

    +

    No

    +

    Integer

    +

    Specifies the operation size. The value is an integer from 0 to 300. The default value is 1. This parameter can be set to 0 only when operation is set to SET.

    +
    • If scaling_resource_type is set to SCALING_GROUP, this parameter indicates the number of instances. The value is an integer from 0 to 300 and the default value is 1.
    • If scaling_resource_type is set to BANDWIDTH, this parameter indicates the bandwidth (Mbit/s). The value is an integer from 1 to 300 and the default value is 1.
    • If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set.
    +

    percentage

    +

    No

    +

    Integer

    +

    Specifies the percentage of instances to be operated. If operation is set to ADD, REMOVE, or REDUCE, the value of this parameter is an integer from 1 to 20000. If operation is set to SET, the value is an integer from 0 to 20000.

    +
    • If scaling_resource_type is set to SCALING_GROUP, either size or percentage can be set. If neither size nor percentage is set, the default value of size is 1.
    • If scaling_resource_type is set to BANDWIDTH, percentage is unavailable.
    +

    limits

    +

    No

    +

    Integer

    +

    Specifies the operation restrictions.

    +

    If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s.

    +
    • If operation is set to ADD, this parameter indicates the maximum bandwidth allowed.
    • If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed.
    +
    +
    +

    +
+
+
  • Example request

    This example shows how to modify an AS policy with ID 0h327883-324n-4dzd-9c61-68d03ee191dd. The modification is as follows: The AS policy name is changed to hth_aspolicy_1; the alarm ID is changed to al1513822380493GvlJKZwA8; the cooldown period is changed to 900 seconds; the policy execution action is to add a bandwidth of 1 Mbit/s until the bandwidth reaches 10 Mbit/s.

    +
    PUT https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/0h327883-324n-4dzd-9c61-68d03ee191dd
+
+{
+    "alarm_id": "al1513822380493GvlJKZwA8",
+    "cool_down_time": 900,
+    "scaling_policy_action": {
+           "size": 1,
+           "operation": "ADD",
+           "limits": 10
+    },
+    "scaling_policy_name": "hth_aspolicy_1",
+    "scaling_policy_type": "ALARM"
+}
    +
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 5 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +
    +
    +
+
  • Example response
    { 
+     "scaling_policy_id": "0h327883-324n-4dzd-9c61-68d03ee191dd"  
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0405.html b/docs/as/api-ref/as_06_0405.html new file mode 100644 index 000000000..7d79b5c69 --- /dev/null +++ b/docs/as/api-ref/as_06_0405.html @@ -0,0 +1,422 @@ + + +

Querying AS Policies

+

Function

This API is used to query AS policies based on search criteria. The results are displayed by page.

+
  • Search criteria can be the AS policy name, policy type, policy ID, start line number, and number of records.
  • If no search criteria are specified, a maximum of 20 AS policies for a specified AS group can be queried for a tenant by default.
+
+

URI

GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_group_id}/list

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. AS policies can be searched by all optional parameters in the following table. For details, see the example request.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+

scaling_policy_name

+

No

+

String

+

Specifies the AS policy name.

+

Supports fuzzy search.

+

scaling_policy_type

+

No

+

String

+

Specifies the AS policy type.

+
  • ALARM: alarm policy
  • SCHEDULED: scheduled policy
  • RECURRENCE: periodic policy
+

scaling_policy_id

+

No

+

String

+

Specifies the AS policy ID.

+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    This example shows how to query scheduled AS policies named as-policy-test in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a.
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/list?scaling_policy_name=as-policy-test&scaling_policy_type=SCHEDULED
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    total_number

    +

    Integer

    +

    Specifies the total number of query records.

    +

    start_number

    +

    Integer

    +

    Specifies the start line number.

    +

    limit

    +

    Integer

    +

    Specifies the maximum number of resources to be queried.

    +

    scaling_policies

    +

    Array of scaling_policies objects

    +

    Specifies scaling policies. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_policies field description

    Parameter

    +

    Type

    +

    Description

    +

    scaling_group_id

    +

    String

    +

    Specifies the AS group ID.

    +

    scaling_policy_name

    +

    String

    +

    Specifies the AS policy name.

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +

    policy_status

    +

    String

    +

    Specifies the AS policy status.

    +
    • INSERVICE: The AS policy is enabled.
    • PAUSED: The AS policy is disabled.
    • EXECUTING: The AS policy is being executed.
    +

    scaling_policy_type

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.
    • SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.
    • RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id.
    +

    alarm_id

    +

    String

    +

    Specifies the alarm ID.

    +

    scheduled_policy

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. For details, see Table 4.

    +

    scaling_policy_action

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 5.

    +

    cool_down_time

    +

    Integer

    +

    Specifies the cooldown period (s).

    +

    create_time

    +

    String

    +

    Specifies the time when an AS policy was created. The time format complies with UTC.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scheduled_policy field description

    Parameter

    +

    Type

    +

    Description

    +

    launch_time

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    String

    +

    Specifies the type of a periodically triggered scaling action.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    String

    +

    Specifies the frequency at which scaling actions are triggered.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
    +

    start_time

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 5 scaling_policy_action field description

    Parameter

    +

    Type

    +

    Description

    +

    operation

    +

    String

    +

    Specifies the scaling action.

    +
    • ADD: adds specified number of instances to the AS group.
    • REMOVE: removes specified number of instances from the AS group.
    • SET: sets the number of instances in the AS group.
    +

    instance_number

    +

    Integer

    +

    Specifies the number of instances to be operated.

    +

    instance_percentage

    +

    Integer

    +

    Specifies the percentage of instances to be operated.

    +
    +
    +
+
  • Example response
    {
+    "limit": 20,
+    "total_number": 1,
+    "start_number": 0,
+    "scaling_policies": [
+        {
+            "scaling_policy_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3",
+            "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a",
+            "scaling_policy_name": "as-policy-test",
+            "scaling_policy_type": "SCHEDULED",
+            "scheduled_policy": {
+                "launch_time": "2015-07-24T01:21Z"
+            },
+            "cool_down_time": 300,
+            "scaling_policy_action": {
+                "operation": "REMOVE",
+                "instance_number": 1
+            },
+            "policy_status": "INSERVICE",
+            "create_time": "2015-07-24T01:09:30Z"
+        }
+    ]
+}
    +
+
+

Returned Value

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0406.html b/docs/as/api-ref/as_06_0406.html new file mode 100644 index 000000000..9f0ff4383 --- /dev/null +++ b/docs/as/api-ref/as_06_0406.html @@ -0,0 +1,528 @@ + + +

Querying AS Policies (V2)

+

Function

This API is used to query AS policies based on search criteria. The results are displayed by page.

+
  • The difference between the V2 and V1 APIs for querying AS policies is that V2 contains scaling resource types in response messages.
  • Search criteria can be the AS policy name, policy type, policy ID, start line number, and number of records.
  • If no search criteria are specified, a maximum of 20 AS policies for specified resources can be queried for a tenant by default.
+
+

URI

GET /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_resource_id}/list

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. AS policies can be searched by all optional parameters in the following table. For details, see the example request.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_resource_id

+

Yes

+

String

+

Specifies the scaling resource ID.

+

scaling_policy_name

+

No

+

String

+

Specifies the AS policy name.

+

Supports fuzzy search.

+

scaling_policy_type

+

No

+

String

+

Specifies the AS policy type.

+
  • ALARM: alarm policy
  • SCHEDULED: scheduled policy
  • RECURRENCE: periodic policy
+

scaling_policy_id

+

No

+

String

+

Specifies the AS policy ID.

+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    This example shows how to query all periodic AS policies for resources with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6.
    GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/8ade64b5-d685-40b8-8582-4ce306ea37a6/list?scaling_policy_type=RECURRENCE
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    total_number

    +

    Integer

    +

    Specifies the total number of query records.

    +

    start_number

    +

    Integer

    +

    Specifies the start line number.

    +

    limit

    +

    Integer

    +

    Specifies the maximum number of resources to be queried.

    +

    scaling_policies

    +

    Array of scaling_policies objects

    +

    Specifies AS policies. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_policies field description

    Parameter

    +

    Type

    +

    Description

    +

    scaling_policy_name

    +

    String

    +

    Specifies the AS policy name.

    +

    Supports fuzzy search.

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +

    scaling_resource_id

    +

    String

    +

    Specifies the scaling resource ID.

    +

    scaling_resource_type

    +

    String

    +

    Specifies the scaling resource type.

    +
    • AS group: SCALING_GROUP
    • Bandwidth: BANDWIDTH
    +

    policy_status

    +

    String

    +

    Specifies the AS policy status.

    +
    • INSERVICE: The AS policy is enabled.
    • PAUSED: The AS policy is disabled.
    • EXECUTING: The AS policy is being executed.
    +

    scaling_policy_type

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.
    • SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.
    • RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id.
    +

    alarm_id

    +

    String

    +

    Specifies the alarm ID.

    +

    scheduled_policy

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. For details, see Table 4.

    +

    scaling_policy_action

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 5.

    +

    cool_down_time

    +

    Integer

    +

    Specifies the cooldown period (s).

    +

    create_time

    +

    String

    +

    Specifies the time when an AS policy was created. The time format complies with UTC.

    +

    meta_data

    +

    meta_data object

    +

    Provides additional information. For details, see Table 6.

    +

    description

    +

    String

    +

    Specifies the AS policy description.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scheduled_policy field description

    Parameter

    +

    Type

    +

    Description

    +

    launch_time

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    String

    +

    Specifies the type of a periodically triggered scaling action.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    String

    +

    Specifies the frequency at which scaling actions are triggered.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
    +

    start_time

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 5 scaling_policy_action field description

    Parameter

    +

    Type

    +

    Description

    +

    operation

    +

    String

    +

    Specifies the scaling action.

    +
    • ADD: indicates adding instances.
    • REDUCE: indicates reducing instances.
    • SET: indicates setting the number of instances to a specified value.
    +

    size

    +

    Integer

    +

    Specifies the number of instances to be operated.

    +

    percentage

    +

    Integer

    +

    Specifies the percentage of instances to be operated.

    +

    limits

    +

    Integer

    +

    Specifies the operation restrictions.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 6 meta_data field description

    Parameter

    +

    Type

    +

    Description

    +

    metadata_bandwidth_share_type

    +

    String

    +

    Specifies the bandwidth sharing type in the bandwidth scaling policy.

    +

    metadata_eip_id

    +

    String

    +

    Specifies the EIP ID for the bandwidth in the bandwidth scaling policy.

    +

    metadata_eip_address

    +

    String

    +

    Specifies the EIP for the bandwidth in the bandwidth scaling policy.

    +
    +
    +
  • Example response
    {
+    "limit": 20,
+    "total_number": 3,
+    "start_number": 0,
+    "scaling_policies": [
+        {
+            "scaling_policy_id": "803a35a5-38fb-4d27-a042-496c14bc1fb8",
+            "scaling_policy_name": "as-policy-7a75",
+            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
+            "scaling_resource_type": "SCALING_GROUP",
+            "scaling_policy_type": "RECURRENCE",
+            "scheduled_policy": {
+                "launch_time": "03:30",
+                "recurrence_type": "Daily",
+                "start_time": "2017-08-28T03:08Z",
+                "end_time": "2017-09-01T03:08Z"
+            },
+            "cool_down_time": 900,
+            "scaling_policy_action": {
+                "operation": "ADD",
+                "size": 1
+            },
+            "policy_status": "INSERVICE",
+            "create_time": "2017-08-31T03:02:41Z"
+        },
+        {
+            "scaling_policy_id": "535fd67e-276b-409c-879e-52f4e09e14bb",
+            "scaling_policy_name": "as-policy-7a75",
+            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
+            "scaling_resource_type": "SCALING_GROUP",
+            "scaling_policy_type": "RECURRENCE",
+            "scheduled_policy": {
+                "launch_time": "21:30",
+                "recurrence_type": "Daily",
+                "start_time": "2017-08-27T21:08Z",
+                "end_time": "2017-08-31T21:08Z"
+            },
+            "cool_down_time": 900,
+            "scaling_policy_action": {
+                "operation": "ADD",
+                "size": 1
+            },
+            "policy_status": "INSERVICE",
+            "create_time": "2017-08-31T07:35:05Z"
+        },
+        {
+            "scaling_policy_id": "37df92f8-73cb-469e-a420-c15f445d2ee1",
+            "scaling_policy_name": "as-policy-7a75",
+            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
+            "scaling_resource_type": "SCALING_GROUP",
+            "scaling_policy_type": "RECURRENCE",
+            "scheduled_policy": {
+                "launch_time": "22:30",
+                "recurrence_type": "Daily",
+                "start_time": "2017-08-27T22:08Z",
+                "end_time": "2017-08-31T22:08Z"
+            },
+            "cool_down_time": 900,
+            "scaling_policy_action": {
+                "operation": "ADD",
+                "size": 1
+            },
+            "policy_status": "INSERVICE",
+            "create_time": "2017-08-31T07:41:06Z"
+        }
+    ]
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Values

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0407.html b/docs/as/api-ref/as_06_0407.html new file mode 100644 index 000000000..f3f3738bb --- /dev/null +++ b/docs/as/api-ref/as_06_0407.html @@ -0,0 +1,585 @@ + + +

Querying All AS Policies (V2)

+

Function

This API is used to query all AS policies for a tenant based on search criteria. The results are displayed by page.

+
  • Search criteria can be the AS resource ID, AS resource type, AS policy name, AS policy ID, alarm ID, start line number, number of records, and sorting method.
  • If no search criteria are specified, a maximum of 20 AS policies can be queried for a tenant by default.
+

The bandwidth scaling policy configured for a released EIP still occupies the quota of bandwidth scaling policy. The policy is only visible to the account and its IAM users with the global permissions.

+
+
+

URI

GET /autoscaling-api/v2/{project_id}/scaling_policy

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. AS policies can be searched by all optional parameters in the following table. For details, see the example request.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_resource_id

+

No

+

String

+

Specifies the scaling resource ID.

+

scaling_resource_type

+

No

+

String

+

Specifies the scaling resource type.

+
  • AS group: SCALING_GROUP
  • Bandwidth: BANDWIDTH
+

scaling_policy_name

+

No

+

String

+

Specifies the AS policy name.

+

Supports fuzzy search.

+

scaling_policy_id

+

No

+

String

+

Specifies the AS policy ID.

+

scaling_policy_type

+

No

+

String

+

Specifies the AS policy type.

+
  • ALARM: alarm policy
  • SCHEDULED: scheduled policy
  • RECURRENCE: periodic policy
+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+

sort_by

+

No

+

String

+

Specifies the sorting method.

+
  • POLICY_NAME: AS policies are sorted by name.
  • TRIGGER_CONDITION: AS policies are sorted by trigger condition. For example, in ascending order, alarm policies are first, and others are sorted in ascending order based on the latest triggering time.
  • CREATE_TIME: AS policies are sorted based on the creation time.
+

order

+

No

+

String

+

Specifies the sorting order.

+
  • ASC: ascending order
  • DESC: descending order
+

enterprise_project_id

+

No

+

String

+

Specifies the enterprise project ID. If all_granted_eps is transferred, this API will query AS groups in the enterprise projects that you have permissions to.

+

alarm_id

+

No

+

String

+

Specifies the alarm rule ID.

+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    This example shows how to query all periodic AS policies for resources with ID 8ade64b5-d685-40b8-8582-4ce306ea37a6.
    GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy?scaling_resource_id=8ade64b5-d685-40b8-8582-4ce306ea37a6&scaling_policy_type=RECURRENCE
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    total_number

    +

    Integer

    +

    Specifies the total number of query records.

    +

    start_number

    +

    Integer

    +

    Specifies the start line number.

    +

    limit

    +

    Integer

    +

    Specifies the maximum number of resources to be queried.

    +

    scaling_policies

    +

    Array of scaling_policies objects

    +

    Specifies AS policies. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_policies field description

    Parameter

    +

    Type

    +

    Description

    +

    scaling_policy_name

    +

    String

    +

    Specifies the AS policy name.

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +

    scaling_resource_id

    +

    String

    +

    Specifies the scaling resource ID.

    +

    scaling_resource_type

    +

    String

    +

    Specifies the scaling resource type.

    +
    • AS group: SCALING_GROUP
    • Bandwidth: BANDWIDTH
    +

    policy_status

    +

    String

    +

    Specifies the AS policy status.

    +
    • INSERVICE: The AS policy is enabled.
    • PAUSED: The AS policy is disabled.
    • EXECUTING: The AS policy is being executed.
    +

    scaling_policy_type

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.
    • SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.
    • RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id.
    +

    alarm_id

    +

    String

    +

    Specifies the alarm ID.

    +

    scheduled_policy

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. For details, see Table 4.

    +

    scaling_policy_action

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 5.

    +

    cool_down_time

    +

    Integer

    +

    Specifies the cooldown period (s).

    +

    create_time

    +

    String

    +

    Specifies the time when an AS policy was created. The time format complies with UTC.

    +

    meta_data

    +

    meta_data object

    +

    Provides additional information. For details, see Table 6.

    +

    description

    +

    String

    +

    Specifies the AS policy description.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scheduled_policy field description

    Parameter

    +

    Type

    +

    Description

    +

    launch_time

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    String

    +

    Specifies the type of a periodically triggered scaling action.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    String

    +

    Specifies the frequency at which scaling actions are triggered.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
    +

    start_time

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 5 scaling_policy_action field description

    Parameter

    +

    Type

    +

    Description

    +

    operation

    +

    String

    +

    Specifies the scaling action.

    +
    • ADD: indicates adding instances.
    • REDUCE: indicates reducing instances.
    • SET: indicates setting the number of instances to a specified value.
    +

    size

    +

    Integer

    +

    Specifies the number of instances to be operated.

    +

    percentage

    +

    Integer

    +

    Specifies the percentage of instances to be operated.

    +

    limits

    +

    Integer

    +

    Specifies the operation restrictions.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 6 meta_data field description

    Parameter

    +

    Type

    +

    Description

    +

    metadata_bandwidth_share_type

    +

    String

    +

    Specifies the bandwidth sharing type in the bandwidth scaling policy.

    +

    metadata_eip_id

    +

    String

    +

    Specifies the EIP ID for the bandwidth in the bandwidth scaling policy.

    +

    metadata_eip_address

    +

    String

    +

    Specifies the EIP for the bandwidth in the bandwidth scaling policy.

    +
    +
    +
  • Example response
    {
+    "limit": 20,
+    "total_number": 3,
+    "start_number": 0,
+    "scaling_policies": [
+        {
+            "scaling_policy_id": "803a35a5-38fb-4d27-a042-496c14bc1fb8",
+            "scaling_policy_name": "as-policy-7a75",
+            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
+            "scaling_resource_type": "SCALING_GROUP",
+            "scaling_policy_type": "RECURRENCE",
+            "scheduled_policy": {
+                "launch_time": "03:30",
+                "recurrence_type": "Daily",
+                "start_time": "2017-08-28T03:08Z",
+                "end_time": "2017-09-01T03:08Z"
+            },
+            "cool_down_time": 900,
+            "scaling_policy_action": {
+                "operation": "ADD",
+                "size": 1
+            },
+            "policy_status": "INSERVICE",
+            "create_time": "2017-08-31T03:02:41Z"
+        },
+        {
+            "scaling_policy_id": "535fd67e-276b-409c-879e-52f4e09e14bb",
+            "scaling_policy_name": "as-policy-7a75",
+            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
+            "scaling_resource_type": "SCALING_GROUP",
+            "scaling_policy_type": "RECURRENCE",
+            "scheduled_policy": {
+                "launch_time": "21:30",
+                "recurrence_type": "Daily",
+                "start_time": "2017-08-27T21:08Z",
+                "end_time": "2017-08-31T21:08Z"
+            },
+            "cool_down_time": 900,
+            "scaling_policy_action": {
+                "operation": "ADD",
+                "size": 1
+            },
+            "policy_status": "INSERVICE",
+            "create_time": "2017-08-31T07:35:05Z",
+"meta_data": {
+                "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
+                "metadata_eip_address": "255.255.255.255"
+            }
+        },
+        {
+            "scaling_policy_id": "37df92f8-73cb-469e-a420-c15f445d2ee1",
+            "scaling_policy_name": "as-policy-7a75",
+            "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
+            "scaling_resource_type": "SCALING_GROUP",
+            "scaling_policy_type": "RECURRENCE",
+            "scheduled_policy": {
+                "launch_time": "22:30",
+                "recurrence_type": "Daily",
+                "start_time": "2017-08-27T22:08Z",
+                "end_time": "2017-08-31T22:08Z"
+            },
+            "cool_down_time": 900,
+            "scaling_policy_action": {
+                "operation": "ADD",
+                "size": 1
+            },
+            "policy_status": "INSERVICE",
+            "create_time": "2017-08-31T07:41:06Z",
+"meta_data": {
+                "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
+                "metadata_eip_address": "255.255.255.255"
+            }
+        }
+    ]
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Values

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0408.html b/docs/as/api-ref/as_06_0408.html new file mode 100644 index 000000000..9ec91195c --- /dev/null +++ b/docs/as/api-ref/as_06_0408.html @@ -0,0 +1,347 @@ + + +

Querying AS Policy Details

+

Function

This API is used to query details about a specified AS policy by policy ID.

+
+

URI

GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_policy_id

+

Yes

+

String

+

Specifies the AS policy ID.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query details about the AS policy with ID fd7d63ce-8f5c-443e-b9a0-bef9386b23b3.

    +
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/fd7d63ce-8f5c-443e-b9a0-bef9386b23b3
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_policy

    +

    scaling_policy object

    +

    Specifies details about the AS policy. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_policy field description

    Parameter

    +

    Type

    +

    Description

    +

    scaling_group_id

    +

    String

    +

    Specifies the AS group ID.

    +

    scaling_policy_name

    +

    String

    +

    Specifies the AS policy name.

    +

    Supports fuzzy search.

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +

    policy_status

    +

    String

    +

    Specifies the AS policy status.

    +
    • INSERVICE: The AS policy is enabled.
    • PAUSED: The AS policy is disabled.
    • EXECUTING: The AS policy is being executed.
    +

    scaling_policy_type

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.
    • SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.
    • RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id.
    +

    alarm_id

    +

    String

    +

    Specifies the alarm ID.

    +

    scheduled_policy

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. For details, see Table 4.

    +

    scaling_policy_action

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 5.

    +

    cool_down_time

    +

    Integer

    +

    Specifies the cooldown period (s).

    +

    create_time

    +

    String

    +

    Specifies the time when an AS policy was created. The time format complies with UTC.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scheduled_policy field description

    Parameter

    +

    Type

    +

    Description

    +

    launch_time

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    String

    +

    Specifies the type of a periodically triggered scaling action.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    String

    +

    Specifies the frequency at which scaling actions are triggered.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
    +

    start_time

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 5 scaling_policy_action field description

    Parameter

    +

    Type

    +

    Description

    +

    operation

    +

    String

    +

    Specifies the scaling action.

    +
    • ADD: adds specified number of instances to the AS group.
    • REMOVE: removes specified number of instances from the AS group.
    • SET: sets the number of instances in the AS group.
    +

    instance_number

    +

    Integer

    +

    Specifies the number of instances to be operated.

    +

    instance_percentage

    +

    Integer

    +

    Specifies the percentage of instances to be operated.

    +
    +
    +
+
  • Example response
    {
+    "scaling_policy": {
+        "scaling_policy_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3",
+        "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a",
+"scaling_policy_name": "Scheduled 1",
+        "scaling_policy_type": "SCHEDULED",
+        "scheduled_policy": {
+            "launch_time": "2015-07-24T01:21Z"
+        },
+        "cool_down_time": 300,
+        "scaling_policy_action": {
+            "operation": "REMOVE",
+            "instance_number": 1
+        },
+        "policy_status": "INSERVICE",
+        "create_time": "2015-07-24T01:09:30Z"
+    }
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0409.html b/docs/as/api-ref/as_06_0409.html new file mode 100644 index 000000000..ca57e5709 --- /dev/null +++ b/docs/as/api-ref/as_06_0409.html @@ -0,0 +1,417 @@ + + +

Querying Details of an AS Policy (V2)

+

Function

This API is used to query details about a specified AS policy by policy ID.

+

The difference between the V2 and V1 APIs for querying details of an AS policy is that V2 contains scaling resource types in response messages.

+
+

URI

GET /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_policy_id

+

Yes

+

String

+

Specifies the AS policy ID.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query details about the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361.

    +
    GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    scaling_policy

    +

    scaling_policy object

    +

    Specifies details about the AS policy. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_policy field description

    Parameter

    +

    Type

    +

    Description

    +

    scaling_resource_id

    +

    String

    +

    Specifies the scaling resource ID.

    +

    scaling_resource_type

    +

    String

    +

    Specifies the scaling resource type.

    +
    • AS group: SCALING_GROUP
    • Bandwidth: BANDWIDTH
    +

    scaling_policy_name

    +

    String

    +

    Specifies the AS policy name.

    +

    Supports fuzzy search.

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +

    policy_status

    +

    String

    +

    Specifies the AS policy status.

    +
    • INSERVICE: The AS policy is enabled.
    • PAUSED: The AS policy is disabled.
    • EXECUTING: The AS policy is being executed.
    +

    scaling_policy_type

    +

    String

    +

    Specifies the AS policy type.

    +
    • ALARM: indicates that the scaling action is triggered by an alarm. A value is returned for alarm_id, and no value is returned for scheduled_policy.
    • SCHEDULED: indicates that the scaling action is triggered as scheduled. A value is returned for scheduled_policy, and no value is returned for alarm_id, recurrence_type, recurrence_value, start_time, or end_time.
    • RECURRENCE: indicates that the scaling action is triggered periodically. Values are returned for scheduled_policy, recurrence_type, recurrence_value, start_time, and end_time, and no value is returned for alarm_id.
    +

    alarm_id

    +

    String

    +

    Specifies the alarm ID.

    +

    scheduled_policy

    +

    scheduled_policy object

    +

    Specifies the periodic or scheduled AS policy. For details, see Table 4.

    +

    scaling_policy_action

    +

    scaling_policy_action object

    +

    Specifies the scaling action of the AS policy. For details, see Table 5.

    +

    cool_down_time

    +

    Integer

    +

    Specifies the cooldown period (s).

    +

    create_time

    +

    String

    +

    Specifies the time when an AS policy was created. The time format complies with UTC.

    +

    meta_data

    +

    meta_data object

    +

    Provides additional information. For details, see Table 6.

    +

    description

    +

    String

    +

    Specifies the AS policy description.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scheduled_policy field description

    Parameter

    +

    Type

    +

    Description

    +

    launch_time

    +

    String

    +

    Specifies the time when the scaling action is triggered. The time format complies with UTC.

    +
    • If scaling_policy_type is set to SCHEDULED, the time format is YYYY-MM-DDThh:mmZ.
    • If scaling_policy_type is set to RECURRENCE, the time format is hh:mm.
    +

    recurrence_type

    +

    String

    +

    Specifies the type of a periodically triggered scaling action.

    +
    • Daily: indicates that the scaling action is triggered once a day.
    • Weekly: indicates that the scaling action is triggered once a week.
    • Monthly: indicates that the scaling action is triggered once a month.
    +

    recurrence_value

    +

    String

    +

    Specifies the frequency at which scaling actions are triggered.

    +
    • If recurrence_type is set to Daily, the value is null, indicating that the scaling action is triggered once a day.
    • If recurrence_type is set to Weekly, the value ranges from 1 (Sunday) to 7 (Saturday). The digits refer to dates in each week and separated by a comma, such as 1,3,5.
    • If recurrence_type is set to Monthly, the value ranges from 1 to 31. The digits refer to the dates in each month and separated by a comma, such as 1,10,13,28.
    +

    start_time

    +

    String

    +

    Specifies the start time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +

    end_time

    +

    String

    +

    Specifies the end time of the scaling action triggered periodically. The time format complies with UTC.

    +

    The time format is YYYY-MM-DDThh:mmZ.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 5 scaling_policy_action field description

    Parameter

    +

    Type

    +

    Description

    +

    operation

    +

    String

    +

    Specifies the scaling action.

    +
    • ADD: indicates adding instances.
    • REDUCE: indicates reducing instances.
    • SET: indicates setting the number of instances to a specified value.
    +

    size

    +

    Integer

    +

    Specifies the operation size.

    +

    percentage

    +

    Integer

    +

    Specifies the percentage of instances to be operated.

    +

    limits

    +

    Integer

    +

    Specifies the operation restrictions.

    +
    +
    +

    + +
    + + + + + + + + + + + + + + + + + +
    Table 6 meta_data field description

    Parameter

    +

    Type

    +

    Description

    +

    metadata_bandwidth_share_type

    +

    String

    +

    Specifies the bandwidth sharing type in the bandwidth scaling policy.

    +

    metadata_eip_id

    +

    String

    +

    Specifies the EIP ID for the bandwidth in the bandwidth scaling policy.

    +

    metadata_eip_address

    +

    String

    +

    Specifies the EIP for the bandwidth in the bandwidth scaling policy.

    +
    +
    +
+
  • Example response
    {
+    "scaling_policy": {
+           "scaling_policy_id": "906f73ff-56e8-41b2-a005-8157d0c60361",
+           "scaling_policy_name": "hth_aspolicy_1",
+           "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
+           "scaling_resource_type": "BANDWIDTH",
+           "scaling_policy_type": "ALARM",
+           "alarm_id": "al1513822380493GvlJKZwA8",
+           "scheduled_policy": {
+           },
+           "cool_down_time": 900,
+           "scaling_policy_action": {
+                  "operation": "ADD",
+                  "size": 1,
+                  "limits": 111
+           },
+           "policy_status": "INSERVICE",
+           "create_time": "2018-03-21T08:03:35Z",
+           "meta_data": {
+               "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
+               "metadata_eip_address": "255.255.255.255"
+           }
+    }
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0410.html b/docs/as/api-ref/as_06_0410.html new file mode 100644 index 000000000..4a99d4f20 --- /dev/null +++ b/docs/as/api-ref/as_06_0410.html @@ -0,0 +1,169 @@ + + +

Executing, Enabling, or Disabling an AS Policy

+

Function

This interface is used to immediately execute, enable, or disable a specified AS policy.

+

An AS policy can be executed only when the AS group and AS policy are in the INSERVICE state. Otherwise, the execution fails.

+
+

URI

POST /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_policy_id

+

Yes

+

String

+

Specifies the AS policy ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    action

    +

    Yes

    +

    String

    +

    Specifies the operation for an AS policy.

    +
    • execute: immediately executes the AS policy.
    • resume: enables the AS group.
    • pause: disables the AS group.
    +
    +
    +
+
  • Example request
    This example shows how to immediately execute the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361.
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361/action
+
+{
+    "action": "execute"
+}
    +
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0411.html b/docs/as/api-ref/as_06_0411.html new file mode 100644 index 000000000..3c8159896 --- /dev/null +++ b/docs/as/api-ref/as_06_0411.html @@ -0,0 +1,140 @@ + + +

Deleting an AS Policy

+

Function

This interface is used to delete a specified AS policy.

+
+

URI

DELETE /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_policy_id

+

Yes

+

String

+

Specifies the AS policy ID.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to delete the AS policy with ID 906f73ff-56e8-41b2-a005-8157d0c60361.

    +
    DELETE https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policy/906f73ff-56e8-41b2-a005-8157d0c60361
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0412.html b/docs/as/api-ref/as_06_0412.html new file mode 100644 index 000000000..0889d71c5 --- /dev/null +++ b/docs/as/api-ref/as_06_0412.html @@ -0,0 +1,193 @@ + + +

Performing Operations on AS Policies in Batches

+

Function

This interface is used to enable, disable, or delete AS policies in batches.

+
  • A batch operation can be performed on a maximum of 20 AS policies at a time.
+
+

URI

POST /autoscaling-api/v1/{project_id}/scaling_policies/action

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    scaling_policy_id

    +

    Yes

    +

    Array of strings

    +

    Specifies the AS policy ID.

    +

    action

    +

    Yes

    +

    String

    +

    Specifies an action to be performed on AS policies in batches. The options are as follows:

    +
    • delete: deletes AS policies.
    • resume: enables AS policies.
    • pause: disables AS policies.
    +

    force_delete

    +

    No

    +

    String

    +

    Specifies whether to forcibly delete an AS policy. If the value is set to no, in-progress AS policies cannot be deleted. Options:

    +
    • no (default): indicates that the AS policy is not forcibly deleted.
    • yes: indicates that the AS policy is forcibly deleted.
    +

    This parameter is available only when action is set to delete.

    +

    delete_alarm

    +

    No

    +

    String

    +

    Specifies whether to delete the alarm rule used by the alarm policy. The value can be yes or no (default).

    +

    This parameter is available only when action is set to delete.

    +
    +
    +
  • Example request

    This example shows how to enable the AS policies with IDs policy_id1 and policy_id2 in a batch.

    +
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_policies/action
+
+{
+    "action": "resume",
+    "scaling_policy_id": [
+        "policy_id1",
+        "policy_id2"
+    ]
+}
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policies
+
+
+ diff --git a/docs/as/api-ref/as_06_0500.html b/docs/as/api-ref/as_06_0500.html new file mode 100644 index 000000000..708692cba --- /dev/null +++ b/docs/as/api-ref/as_06_0500.html @@ -0,0 +1,15 @@ + + +

AS Policy Execution Logs

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_0501.html b/docs/as/api-ref/as_06_0501.html new file mode 100644 index 000000000..4ae7bfe70 --- /dev/null +++ b/docs/as/api-ref/as_06_0501.html @@ -0,0 +1,506 @@ + + +

Querying AS Policy Execution Logs

+

Function

This API is used to query the historical records of AS policy execution based on search criteria. The results are displayed by page.

+
  • Search criteria can be the log ID, AS resource type, AS resource ID, policy execution type, start time, end time, start line number, and number of records.
  • If no search criteria are specified, a maximum of 20 AS policy execution logs can be queried by default.
+
+

URI

GET /autoscaling-api/v1/{project_id}/scaling_policy_execute_log/{scaling_policy_id}

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. AS policy execution logs can be searched by all optional parameters in the following table. For details, see the example request.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_policy_id

+

Yes

+

String

+

Specifies the AS policy ID.

+

log_id

+

No

+

String

+

Specifies the ID of an AS policy execution log.

+

scaling_resource_type

+

No

+

String

+

Specifies the scaling resource type.

+
  • AS group: SCALING_GROUP
  • Bandwidth: BANDWIDTH
+

scaling_resource_id

+

No

+

String

+

Specifies the scaling resource ID.

+

execute_type

+

No

+

String

+

Specifies the AS policy execution type.

+
  • SCHEDULED: automatically triggered at a specified time point
  • RECURRENCE: automatically triggered at a specified time period
  • ALARM: alarm-triggered
  • MANUAL: manually triggered
+

start_time

+

No

+

String

+

Specifies the start time that complies with UTC for querying AS policy execution logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ.

+

end_time

+

No

+

String

+

Specifies the end time that complies with UTC for querying AS policy execution logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ.

+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    This example shows how to query the AS policy execution log with ID 05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6.
    GET https://{Endpoint}/autoscaling-api/v1/edcb94a885a84ed3a3fdf8ea4d2741da/scaling_policy_execute_log/05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    total_number

    +

    Integer

    +

    Specifies the total number of query records.

    +

    start_number

    +

    Integer

    +

    Specifies the start line number.

    +

    limit

    +

    Integer

    +

    Specifies the maximum number of resources to be queried.

    +

    scaling_policy_execute_log

    +

    Array of scaling_policy_execute_log objects

    +

    Specifies the AS policy execution logs. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_policy_execute_log field description

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the AS policy execution status.

    +
    • SUCCESS: The AS policy has been executed.
    • FAIL: Executing the AS policy failed.
    • EXECUTING: The AS policy is being executed.
    +

    failed_reason

    +

    String

    +

    Specifies the AS policy execution failure.

    +

    execute_type

    +

    String

    +

    Specifies the AS policy execution type.

    +
    • SCHEDULED: automatically triggered at a specified time point
    • RECURRENCE: automatically triggered at a specified time period
    • ALARM: alarm-triggered
    • MANUAL: manually triggered
    +

    execute_time

    +

    String

    +

    Specifies the time when an AS policy was executed. The time format complies with UTC.

    +

    id

    +

    String

    +

    Specifies the ID of an AS policy execution log.

    +

    tenant_id

    +

    String

    +

    Specifies the project ID.

    +

    scaling_policy_id

    +

    String

    +

    Specifies the AS policy ID.

    +

    scaling_resource_type

    +

    String

    +

    Specifies the scaling resource type.

    +
    • AS group: SCALING_GROUP
    • Bandwidth: BANDWIDTH
    +

    scaling_resource_id

    +

    String

    +

    Specifies the scaling resource ID.

    +

    old_value

    +

    String

    +

    Specifies the source value.

    +

    desire_value

    +

    String

    +

    Specifies the target value.

    +

    limit_value

    +

    String

    +

    Specifies the operation restrictions.

    +

    If scaling_resource_type is set to BANDWIDTH and operation is not SET, this parameter takes effect and the unit is Mbit/s.

    +

    In this case:

    +
    • If operation is set to ADD, this parameter indicates the maximum bandwidth allowed.
    • If operation is set to REDUCE, this parameter indicates the minimum bandwidth allowed.
    +

    type

    +

    String

    +

    Specifies the AS policy execution type.

    +
    • ADD: indicates adding instances.
    • REMOVE: indicates reducing instances.
    • SET: indicates setting the number of instances to a specified value.
    +

    job_records

    +

    Array of job_records objects

    +

    Specifies the tasks contained in a scaling action based on an AS policy. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 job_records field description

    Parameter

    +

    Type

    +

    Description

    +

    job_name

    +

    String

    +

    Specifies the task name.

    +

    record_type

    +

    String

    +

    Specifies the record type.

    +
    • API: API calling type
    • MEG: message type
    +

    record_time

    +

    String

    +

    Specifies the record time.

    +

    request

    +

    String

    +

    Specifies the request body. This parameter is valid only if record_type is set to API.

    +

    response

    +

    String

    +

    Specifies the response body. This parameter is valid only if record_type is set to API.

    +

    code

    +

    String

    +

    Specifies the returned code. This parameter is valid only if record_type is set to API.

    +

    message

    +

    String

    +

    Specifies the message. This parameter is valid only if record_type is set to MEG.

    +

    job_status

    +

    String

    +

    Specifies the execution status of the task.

    +
    • SUCCESS: The task is successfully executed.
    • FAIL: The task failed to be executed.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + +
    Table 5 meta_data field description

    Parameter

    +

    Type

    +

    Description

    +

    metadata_bandwidth_share_type

    +

    String

    +

    Specifies the bandwidth sharing type in the bandwidth scaling policy.

    +

    metadata_eip_id

    +

    String

    +

    Specifies the EIP ID for the bandwidth in the bandwidth scaling policy.

    +

    metadataeip_address

    +

    String

    +

    Specifies the EIP for the bandwidth in the bandwidth scaling policy.

    +
    +
    +
+
  • Example response
    {
+  "limit": 20,
+  "scaling_policy_execute_log": [
+    {
+      "id": "b86e4175-30cb-4b1e-a332-83f9ee472c58",
+      "status": "SUCCESS",
+      "type": "REMOVE",
+      "tenant_id": "0428982a1b8039f42f01c005edde7c0d",
+      "scaling_resource_type": "SCALING_GROUP",
+      "scaling_resource_id": "1f2d3e73-7ef6-40b3-a8fa-514b68eccaa7",
+      "scaling_policy_id": "05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6",
+      "old_value": "1",
+      "desire_value": "0",
+      "limit_value": "0",
+      "execute_time": "2019-03-18T16:00:00Z",
+      "execute_type": "RECURRENCE",
+      "job_records": [
+        {
+          "message": "modify desire number of scaling group",
+          "job_name": "ADJUST_VM_NUMBERS",
+          "record_type": "MEG",
+          "record_time": "2019-03-18T16:00:00Z",
+          "job_status": "SUCCESS"
+        }
+      ]
+    }
+  ],
+  "total_number": 1,
+  "start_number": 0
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Values

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: AS Policy Execution Logs
+
+
+ diff --git a/docs/as/api-ref/as_06_0600.html b/docs/as/api-ref/as_06_0600.html new file mode 100644 index 000000000..b2811f2c2 --- /dev/null +++ b/docs/as/api-ref/as_06_0600.html @@ -0,0 +1,17 @@ + + +

Scaling Action Logs

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_0601.html b/docs/as/api-ref/as_06_0601.html new file mode 100644 index 000000000..b21c6aa94 --- /dev/null +++ b/docs/as/api-ref/as_06_0601.html @@ -0,0 +1,340 @@ + + +

Querying Scaling Action Logs

+

Function

This API is used to query scaling action logs based on search criteria. The results are displayed by page.

+
  • Search criteria can be the start time, end time, start line number, and number of records.
  • If no search criteria are specified, a maximum of 20 scaling action logs can be queried by default.
+
+

URI

GET /autoscaling-api/v1/{project_id}/scaling_activity_log/{scaling_group_id}

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. Scaling action logs can be searched by all optional parameters in the following table. For details, see the example request.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+

start_time

+

No

+

String

+

Specifies the start time that complies with UTC for querying scaling action logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ.

+

end_time

+

No

+

String

+

Specifies the end time that complies with UTC for querying scaling action logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ.

+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    This example shows how to query the scaling action logs of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a.
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_activity_log/e5d27f5c-dd76-4a61-b4bc-a67c5686719a
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    total_number

    +

    Integer

    +

    Specifies the total number of query records.

    +

    start_number

    +

    Integer

    +

    Specifies the start line number.

    +

    limit

    +

    Integer

    +

    Specifies the maximum number of resources to be queried.

    +

    scaling_activity_log

    +

    Array of scaling_activity_log objects

    +

    Specifies scaling action logs. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_activity_log field description

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the status of the scaling action.

    +
    • SUCCESS: The scaling action has been performed.
    • FAIL: Performing the scaling action failed.
    • DOING: The scaling action is being performed.
    +

    start_time

    +

    String

    +

    Specifies the start time of the scaling action. The time format must comply with UTC.

    +

    end_time

    +

    String

    +

    Specifies the end time of the scaling action. The time format must comply with UTC.

    +

    id

    +

    String

    +

    Specifies the scaling action log ID.

    +

    instance_removed_list

    +

    String

    +

    Specifies the names of the instances removed from the AS group after the scaling action is complete. The instance names are separated using commas (,).

    +

    instance_deleted_list

    +

    String

    +

    Specifies the names of the instances removed and deleted from the AS group after the scaling action is complete. The instance names are separated using commas (,).

    +

    instance_added_list

    +

    String

    +

    Specifies the names of the instances added to the AS group after the scaling action is complete. The instance names are separated using commas (,).

    +

    scaling_value

    +

    String

    +

    Specifies the number of added or removed instances in the scaling action.

    +

    description

    +

    String

    +

    Specifies the description of the scaling action.

    +

    instance_value

    +

    Integer

    +

    Specifies the number of instances in the AS group.

    +

    desire_value

    +

    Integer

    +

    Specifies the expected number of instances for the scaling action.

    +
    +
    +
+
  • Example response
    {
+  "limit": 20,
+  "scaling_activity_log": [
+    {
+      "id": "66e0f775-c4ac-4b52-9d5c-f93ba217aa5f",
+      "instance_value": 1,
+      "desire_value": 0,
+      "scaling_value": 1,
+      "start_time": "2019-03-18T16:00:11Z",
+      "end_time": "2019-03-18T16:00:32Z",
+      "instance_added_list": null,
+      "instance_deleted_list": "as-config-bblh-ONQE551S",
+      "instance_removed_list": null,
+      "status": "SUCCESS",
+      "description": "{\"reason\":[{\"change_reason\":\"RECURRENCE\",\"old_value\":1,\"scaling_policy_name\":\"as-policy-bvfk\",\"change_time\":\"2019-03-18T16:00:00Z\",\"new_value\":0,\"scaling_policy_id\":\"05545d3d-ccf9-4bca-ae4f-1e5e73ca0bf6\"}]}"
+    },
+    {
+      "id": "c3a1fff6-84a3-4cbc-8ac0-e3b0f645ecd8",
+      "instance_value": 0,
+      "desire_value": 1,
+      "scaling_value": 1,
+      "start_time": "2019-03-16T10:21:11Z",
+      "end_time": "2019-03-16T10:25:12Z",
+      "instance_added_list": "as-config-bblh-ONQE551S",
+      "instance_deleted_list": null,
+      "instance_removed_list": null,
+      "status": "SUCCESS",
+      "description": "{\"reason\":[{\"change_reason\":\"DIFF\",\"old_value\":0,\"change_time\":\"2019-03-16T10:21:11Z\",\"new_value\":1}]}"
+    },
+    "total_number": 2,
+    "start_number": 0
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Scaling Action Logs
+
+
+ diff --git a/docs/as/api-ref/as_06_0602.html b/docs/as/api-ref/as_06_0602.html new file mode 100644 index 000000000..f4bc811a8 --- /dev/null +++ b/docs/as/api-ref/as_06_0602.html @@ -0,0 +1,563 @@ + + +

Querying Scaling Action Logs (V2)

+

Function

This API is used to query scaling action logs based on search criteria. The scaling actions include increasing instances and migrating instances to balance load. The results are displayed by page.

+
  • The difference between the V2 and V1 APIs for querying scaling action logs is that V2 displays more detailed action logs, such as ELB migration logs.
  • Search criteria can be the start time, end time, start line number, number of records, and scaling action type.
  • If no search criteria are specified, a maximum of 20 scaling action logs can be queried by default.
+
+

URI

GET /autoscaling-api/v2/{project_id}/scaling_activity_log/{scaling_group_id}

+

You can type the question mark (?) and ampersand (&) at the end of the URI to define multiple search criteria. Scaling action logs can be searched by all optional parameters in the following table. For details, see the example request.

+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+

log_id

+

No

+

String

+

Specifies the scaling action log ID.

+

start_time

+

No

+

String

+

Specifies the start time that complies with UTC for querying scaling action logs. The format of the start time is yyyy-MM-ddThh:mm:ssZ.

+

end_time

+

No

+

String

+

Specifies the end time that complies with UTC for querying scaling action logs. The format of the end time is yyyy-MM-ddThh:mm:ssZ.

+

start_number

+

No

+

Integer

+

Specifies the start line number. The default value is 0. The minimum parameter value is 0.

+

limit

+

No

+

Integer

+

Specifies the number of query records. The default value is 20. The value range is 0 to 100.

+

type

+

No

+

String

+

Specifies the types of the scaling actions to be queried. Different types are separated by commas (,).

+
  • NORMAL: indicates a common scaling action.
  • MANUAL_REMOVE: indicates manually removing instances from an AS group.
  • MANUAL_DELETE: indicates manually removing and deleting instances from an AS group.
  • MANUAL_ADD: indicates manually adding instances to an AS group.
  • ELB_CHECK_DELETE: indicates that instances are removed from an AS group and deleted based on the ELB health check result.
  • AUDIT_CHECK_DELETE: indicates that instances are removed from an AS group and deleted based on the OpenStack audit.
  • DIFF: indicates that the number of expected instances is different from the actual number of instances.
  • MODIFY_ELB: indicates the load balancer migration.
+

status

+

No

+

String

+

Specifies the status of the scaling action.

+
  • SUCCESS: The scaling action has been performed.
  • FAIL: Performing the scaling action failed.
  • DOING: The scaling action is being performed.
+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query the scaling action logs of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a. The start time is 2018-11-22T00:00:00Z, and the end time is 2018-11-22T14:00:00Z.

    +
    GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_activity_log/e5d27f5c-dd76-4a61-b4bc-a67c5686719a?start_time=2018-11-22T00:00:00Z&end_time=2018-11-22T14:00:00Z
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    total_number

    +

    Integer

    +

    Specifies the total number of query records.

    +

    start_number

    +

    Integer

    +

    Specifies the start line number.

    +

    limit

    +

    Integer

    +

    Specifies the maximum number of resources to be queried.

    +

    scaling_activity_log

    +

    Array of scaling_activity_log objects

    +

    Specifies scaling action logs. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 scaling_activity_log field description

    Parameter

    +

    Type

    +

    Description

    +

    status

    +

    String

    +

    Specifies the status of the scaling action.

    +
    • SUCCESS: The scaling action has been performed.
    • FAIL: Performing the scaling action failed.
    • DOING: The scaling action is being performed.
    +

    start_time

    +

    String

    +

    Specifies the start time of the scaling action. The time format must comply with UTC.

    +

    end_time

    +

    String

    +

    Specifies the end time of the scaling action. The time format must comply with UTC.

    +

    id

    +

    String

    +

    Specifies the scaling action log ID.

    +

    instance_removed_list

    +

    Array of scaling_instance objects

    +

    Specifies names of the ECSs that are removed from the AS group in a scaling action. For details, see Table 4.

    +

    instance_deleted_list

    +

    Array of scaling_instance objects

    +

    Specifies names of the ECSs that are removed from the AS group and deleted in a scaling action. For details, see Table 4.

    +

    instance_added_list

    +

    Array of scaling_instance objects

    +

    Specifies names of the ECSs that are added to the AS group in a scaling action. For details, see Table 4.

    +

    instance_failed_list

    +

    Array of scaling_instance objects

    +

    Specifies the ECSs for which a scaling action fails. For details, see Table 4.

    +

    instance_standby_list

    +

    Array of scaling_instance objects

    +

    Specifies the ECSs that are set to standby mode or for which standby mode is canceled in a scaling action. For details, see Table 4. This parameter is reserved.

    +

    scaling_value

    +

    String

    +

    Specifies the number of added or deleted instances during the scaling.

    +

    description

    +

    String

    +

    Specifies the description of the scaling action.

    +

    instance_value

    +

    Integer

    +

    Specifies the number of instances in the AS group.

    +

    desire_value

    +

    Integer

    +

    Specifies the expected number of instances for the scaling action.

    +

    lb_bind_success_list

    +

    Array of modify_lb objects

    +

    Specifies the load balancers that are bound to the AS group. For details, see Table 5.

    +

    lb_bind_failed_list

    +

    Array of modify_lb objects

    +

    Specifies the load balancers that failed to be bound to the AS group. For details, see Table 5.

    +

    lb_unbind_success_list

    +

    Array of modify_lb objects

    +

    Specifies the load balancers that are unbound from the AS group. For details, see Table 5.

    +

    lb_unbind_failed_list

    +

    Array of modify_lb objects

    +

    Specifies the load balancers that failed to be unbound from the AS group. For details, see Table 5.

    +

    type

    +

    String

    +

    Specifies the type of the scaling action.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 4 scaling_instance field description

    Parameter

    +

    Type

    +

    Description

    +

    instance_name

    +

    String

    +

    Specifies the ECS name.

    +

    instance_id

    +

    String

    +

    Specifies the ECS ID.

    +

    failed_reason

    +

    String

    +

    Specifies the cause of the instance scaling failure.

    +

    failed_details

    +

    String

    +

    Specifies details of the instance scaling failure.

    +

    instance_config

    +

    String

    +

    Specifies the information about instance configurations.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 5 modify_lb field description

    Parameter

    +

    Type

    +

    Description

    +

    lbaas_listener

    +

    lbaas_listener object

    +

    Specifies information about an enhanced load balancer. For details, see Table 6.

    +

    listener

    +

    String

    +

    Specifies information about a classic load balancer.

    +

    failed_reason

    +

    String

    +

    Specifies the cause of a load balancer migration failure.

    +

    failed_details

    +

    String

    +

    Specifies the details of a load balancer migration failure.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 6 lbaas_listener field description

    Parameter

    +

    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 port, 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.

    +
    +
    +
+
  • Example response
    {
+    "limit": 20,
+    "scaling_activity_log": [
+    {
+      "id": "8753a18c-931d-4cb8-8d49-6c99396af348",
+      "instance_value": 0,
+      "desire_value": 0,
+      "scaling_value": 0,
+      "start_time": "2018-11-22T13:46:20Z",
+      "end_time": "2018-11-22T13:47:38Z",
+      "status": "SUCCESS",
+      "lb_bind_success_list": [
+        {
+          "lbaas_listener": {
+            "weight": 1,
+            "listener_id": null,
+            "pool_id": "0f0a9dd8-2e1d-4432-8ca2-49adc75aa662",
+            "protocol_port": 82
+          }
+        }
+      ],
+      "lb_bind_failed_list": [],
+      "lb_unbind_success_list": [],
+      "lb_unbind_failed_list": [],
+      "type": "MODIFY_ELB"
+    },
+    {
+      "id": "44152cf2-a005-4507-b6e9-66a2a64eff52",
+      "instance_value": 0,
+      "desire_value": 1,
+      "scaling_value": 1,
+      "start_time": "2018-11-22T13:44:22Z",
+      "end_time": "2018-11-22T13:46:02Z",
+      "instance_added_list": [
+        {
+          "instance_id": "8e273bac-d303-46dc-9883-628be2294bdf",
+          "instance_name": "as-config-t66a_9W8L9SSK"
+        }
+      ],
+      "instance_deleted_list": [],
+      "instance_removed_list": [],
+      "instance_failed_list": [],
+      "status": "SUCCESS",
+      "description": "{\"reason\":[{\"change_reason\":\"MANNUAL\",\"old_value\":0,\"change_time\":\"2018-11-22T13:44:19Z\",\"new_value\":1}]}",
+      "type": "NORMAL"
+    }
+],
+    "total_number": 2,
+    "start_number": 0
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Scaling Action Logs
+
+
+ diff --git a/docs/as/api-ref/as_06_0700.html b/docs/as/api-ref/as_06_0700.html new file mode 100644 index 000000000..1ec0c3680 --- /dev/null +++ b/docs/as/api-ref/as_06_0700.html @@ -0,0 +1,17 @@ + + +

Quotas

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_0701.html b/docs/as/api-ref/as_06_0701.html new file mode 100644 index 000000000..010d22611 --- /dev/null +++ b/docs/as/api-ref/as_06_0701.html @@ -0,0 +1,246 @@ + + +

Querying AS Quotas

+

Function

This API is used to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant.

+
+

URI

GET /autoscaling-api/v1/{project_id}/quotas

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant.

    +
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/quotas
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    quotas

    +

    quotas object

    +

    Specifies quota details. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + +
    Table 3 quotas field description

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    Array of resources objects

    +

    Specifies resources. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 resources field description

    Parameter

    +

    Type

    +

    Description

    +

    type

    +

    String

    +

    Specifies the quota type.

    +
    • scaling_Group: AS group quota
    • scaling_Config: AS configuration quota
    • scaling_Policy: AS policy quota
    • scaling_Instance: instance quota
    • bandwidth_scaling_policy: bandwidth scaling policy quota
    +

    used

    +

    Integer

    +

    Specifies the used amount of the quota.

    +

    When type is set to scaling_Policy or scaling_Instance, this parameter is reserved, and the system returns -1 as the parameter value. You can query the used quota of AS policies and AS instances in a specified AS group. For details, see Querying AS policy and instance quotas.

    +

    quota

    +

    Integer

    +

    Specifies the total quota.

    +

    max

    +

    Integer

    +

    Specifies the quota upper limit.

    +
    +
    +
+
  • Example response
    {
+    "quotas": {
+        "resources": [
+            {
+                "type": "scaling_Group",
+                "used": 2,
+                "quota": 25,
+                "max": 50
+            },
+            {
+                "type": "scaling_Config",
+                "used": 3,
+                "quota": 100,
+                "max": 200
+            },
+            {
+                "type": "scaling_Policy",
+                "used": -1,
+                "quota": 50,
+                "max": 50
+            },
+            {
+                "type": "scaling_Instance",
+                "used": -1,
+                "quota": 200,
+                "max": 1000
+            },
+            {
+                "type": "bandwidth_scaling_policy",
+                "used": 1,
+                "quota": 10,
+                "max": 100
+            }
+        ]
+    }
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Quotas
+
+
+ diff --git a/docs/as/api-ref/as_06_0702.html b/docs/as/api-ref/as_06_0702.html new file mode 100644 index 000000000..c78a2d2f9 --- /dev/null +++ b/docs/as/api-ref/as_06_0702.html @@ -0,0 +1,236 @@ + + +

Querying AS policy and instance quotas

+

Function

This interface is used to query the total quotas and used quotas of AS policies and instances of a specified AS group by group ID.

+
+

URI

GET /autoscaling-api/v1/{project_id}/quotas/{scaling_group_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

scaling_group_id

+

Yes

+

String

+

Specifies the AS group ID.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query the total quotas and used quotas of the AS policies and instances in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a.

    +
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/quotas/e5d27f5c-dd76-4a61-b4bc-a67c5686719a
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    quotas

    +

    quotas object

    +

    Specifies quota details. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + +
    Table 3 quotas field description

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    Array of resources objects

    +

    Specifies resources. For details, see Table 4.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 4 resources field description

    Parameter

    +

    Type

    +

    Description

    +

    type

    +

    String

    +

    Specifies the quota type.

    +
    • scaling_Policy: indicates AS policies.
    • scaling_Instance: indicates instances.
    +

    used

    +

    Integer

    +

    Specifies the used quota.

    +

    quota

    +

    Integer

    +

    Specifies the total quota.

    +

    max

    +

    Integer

    +

    Specifies the quota upper limit.

    +
    +
    +
+
  • Example response
    {
+    "quotas": {
+        "resources": [
+            {
+                "type": "scaling_Policy",
+                "used": 2,
+                "quota": 50,
+                "max": 50
+            },
+            {
+                "type": "scaling_Instance",
+                "used": 0,
+                "quota": 200,
+                "max": 1000
+            }
+        ]
+    }
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Quotas
+
+
+ diff --git a/docs/as/api-ref/as_06_1000.html b/docs/as/api-ref/as_06_1000.html new file mode 100644 index 000000000..37af4d366 --- /dev/null +++ b/docs/as/api-ref/as_06_1000.html @@ -0,0 +1,21 @@ + + +

Tag Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_1001.html b/docs/as/api-ref/as_06_1001.html new file mode 100644 index 000000000..b39a01dd3 --- /dev/null +++ b/docs/as/api-ref/as_06_1001.html @@ -0,0 +1,219 @@ + + +

Querying Tags

+

Function

This API is used to query tags by project ID.

+
+

URI

GET /autoscaling-api/v1/{project_id}/{resource_type}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type. The option is as follows:

+

scaling_group_tag: indicates that the resource type is an AS group.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query resource tags of an AS group.

    +
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/tags
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of tags objects

    +

    Specifies the resource tag.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 Tag field description

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the resource tag key.

    +

    values

    +

    Array of strings

    +

    Specifies the resource tag values.

    +
    +
    +
+
  • Example response
     {
+    "tags": [
+        {
+            "key": "ENV15",
+            "values": [
+                "ENV15"
+            ]
+        },
+        {
+            "key": "111",
+            "values": [
+                ""
+            ]
+        },
+        {
+            "key": "environment",
+            "values": [
+                "DEV"
+            ]
+        },
+        {
+            "key": "ENV151",
+            "values": [
+                "ENV151"
+            ]
+        },
+        {
+            "key": "ENV152",
+            "values": [
+                "ENV152"
+            ]
+        }
+     ]
+ }
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because an internal service error occurred.

    +

    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 server has received an invalid response.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is currently unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/as/api-ref/as_06_1002.html b/docs/as/api-ref/as_06_1002.html new file mode 100644 index 000000000..8b9f6590f --- /dev/null +++ b/docs/as/api-ref/as_06_1002.html @@ -0,0 +1,218 @@ + + +

Querying Tags of a Resource

+

Function

This interface is used to query tags of a specified resource by project ID and resource ID.

+
+

URI

GET /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type. The option is as follows:

+

scaling_group_tag: indicates that the resource type is an AS group.

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query the resource tags of the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a.

    +
    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    tags

    +

    Array of ResourceTag objects

    +

    Specifies resource tags. For details, see Table 3.

    +

    sys_tags

    +

    Array of ResourceTag objects

    +

    Specifies system resource tags. For details, see Table 3.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 ResourceTag field description

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the resource tag key.

    +

    value

    +

    String

    +

    Specifies the resource tag value.

    +
    +
    +
+
  • Example response
     {
+    "tags": [
+        {
+            "key": "ENV15",
+            "value": "ENV15"
+        },
+        {
+            "key": "ENV151",
+            "value": "ENV151"
+        },
+        {
+            "key": "ENV152",
+            "value": "ENV152"
+        }
+    ],
+    "sys_tags": null 
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because an internal service error occurred.

    +

    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 server has received an invalid response.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is currently unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/as/api-ref/as_06_1003.html b/docs/as/api-ref/as_06_1003.html new file mode 100644 index 000000000..8a568f996 --- /dev/null +++ b/docs/as/api-ref/as_06_1003.html @@ -0,0 +1,233 @@ + + +

Creating or Deleting a Tag

+

Function

This API is used to create or delete a resource tag.

+
+

Each AS group can have a maximum of 10 tags added to it.

+

URI

POST /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags/action

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type. The option is as follows:

+

scaling_group_tag: indicates that the resource type is an AS group.

+

resource_id

+

Yes

+

String

+

Resource ID

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    Yes

    +

    Array of ResourceTag objects

    +

    Specifies the tag list. For details, see Table 3.

    +

    If action is set to delete, the tag structure cannot be missing, and the key cannot be left blank or an empty string.

    +

    action

    +

    Yes

    +

    String

    +

    Operation ID (case sensitive)

    +
    • delete: indicates deleting a tag.
    • create: indicates creating a tag. If the same key value already exists, it will be overwritten.
    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 ResourceTag field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the resource tag key. Tag keys of a resource must be unique.

    +
    • A tag key contains a maximum of 36 Unicode characters and cannot be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).
    • When action is set to delete, the tag character set is not verified, and a key contains a maximum of 127 Unicode characters.
    +

    value

    +

    No

    +

    String

    +

    Specifies the resource tag value.

    +
    • A tag value contains a maximum of 43 Unicode characters and can be left blank. It can contain only digits, letters, hyphens (-), underscores (_), and at signs (@).
    • When action is set to delete, the tag character set is not verified, and a value contains a maximum of 255 Unicode characters. If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key.
    +
    +
    +
+
  • Example request

    This example shows how to create two resource tags (key = ENV15 and value = ENV15) and (key = ENV151 and value = ENV151) in the AS group with ID e5d27f5c-dd76-4a61-b4bc-a67c5686719a.

    +
    POST https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/e5d27f5c-dd76-4a61-b4bc-a67c5686719a/tags/action
+
+{ 
+  "tags": [
+    { 
+        "key": "ENV15", 
+        "value": "ENV15" 
+    }, 
+    { 
+        "key": "ENV151", 
+        "value": "ENV151" 
+    }
+    ], 
+  "action": "create" 
+}
    +
+
+

Response Message

  • Response parameters

    None

    +
  • Example response

    None

    +
+
+

Returned Values

  • Normal

    204

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because an internal service error occurred.

    +

    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 server has received an invalid response.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is currently unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/as/api-ref/as_06_1004.html b/docs/as/api-ref/as_06_1004.html new file mode 100644 index 000000000..a5be606e6 --- /dev/null +++ b/docs/as/api-ref/as_06_1004.html @@ -0,0 +1,480 @@ + + +

Querying Resources

+

Function

This API is used to query instances of a specified resource type by project ID.

+

By default, resources and resource tags are in descending order of their creation time.

+
+

URI

POST /autoscaling-api/v1/{project_id}/{resource_type}/resource_instances/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

resource_type

+

Yes

+

String

+

Specifies the resource type. An example value is scaling_group_tag.

+
+
+
+

Request Message

  • Request parameters +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 Request parameters

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    tags

    +

    No

    +

    Array of Tag objects

    +

    Specifies filter criteria with tags included. A maximum of 10 keys can be contained. The structure body must be complete. For details, see Table 3.

    +

    tags_any

    +

    No

    +

    Array of Tag objects

    +

    Specifies filter criteria with any tag included. A maximum of 10 keys can be contained. For details, see Table 3.

    +

    not_tags

    +

    No

    +

    Array of Tag objects

    +

    Specifies filter criteria without tags included. A maximum of 10 keys can be contained. For details, see Table 3.

    +

    not_tags_any

    +

    No

    +

    Array of Tag objects

    +

    Specifies filter criteria without any tag included. A maximum of 10 keys can be contained. For details, see Table 3.

    +

    limit

    +

    No

    +

    String

    +

    Specifies the maximum number of query records. The maximum value is 1000, and the minimum value is 1.

    +
    • If the action value is count, this parameter is invalid.
    • If the action value is filter, the default value is 1000.
    +

    marker

    +

    No

    +

    String

    +

    Marks the paging location (index position). You are advised to use the offset parameter to set the index position.

    +

    Marks the paging location (resource ID or index location).

    +

    action

    +

    Yes

    +

    String

    +

    Specifies the operation, which can be filter or count.

    +
    • filter: indicates that resources are filtered by tag and the resources meeting the search criteria are returned on pages.
    • count: indicates that resources are searched by tag and the number of resources meeting the search criteria is returned.
    +

    offset

    +

    No

    +

    String

    +

    Specifies the index position. The query starts from the next image indexed by this parameter. The value must be a non-negative number.

    +

    You do not need to specify this parameter when querying resources on the first page. When you query resources on subsequent pages, set the value of offset to the location returned in the response body for the previous query.

    +
    • If the action value is count, this parameter is invalid.
    • If the action value is filter, the default value is 0.
    +

    matches

    +

    No

    +

    Array of match objects

    +

    Specifies fuzzy search. For details, see Table 4.

    +

    without_any_tag

    +

    Yes

    +

    Boolean

    +

    If this parameter is set to true, all resources without tags are queried. In this case, the tags, tags_any, not_tags, and not_tags_any fields are ignored.

    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 3 Tag field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the resource tag key. It contains a maximum of 127 Unicode characters. It cannot be left blank (This parameter is not verified in the search process.) A maximum of 10 keys are allowed and the key cannot be left blank or an empty string. Each key must be unique.

    +

    values

    +

    Yes

    +

    Array of strings

    +

    Specifies resource tag values. A value contains a maximum of 255 Unicode characters. A key contains a maximum of 10 values. Each value of the same key must be unique.

    +
    • The asterisk (*) is reserved for the system. If the value starts with *, it indicates that fuzzy match is performed for the digits following *. The value cannot contain only asterisks (*).
    • If the values are null (not default), it indicates any_value (querying any value). The resources contain one or multiple values listed in values will be found and displayed.
    +
    +
    + +
    + + + + + + + + + + + + + + + + +
    Table 4 match field description

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    key

    +

    Yes

    +

    String

    +

    Specifies the key parameter to be matched.

    +

    The parameter value can only be resource_name.

    +

    value

    +

    Yes

    +

    String

    +

    Specifies the value. The value is a fixed dictionary value. A value contains a maximum of 255 Unicode characters. If the value is an empty string or resource_id, exact match is used.

    +
    +
    +
+
+
  • Example request
    • Example request when action is set to filter

      This example shows how to query AS group resources of a tenant using the following search criteria: including tag (key = key1 and value = value), excluding tag (key = key2 and value = value2), index position 100, and maximum number of records 100.

      +
      POST https: //{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/resource_instances/action
+
+{
+	"offset": "100",
+	"limit": "100",
+	"action": "filter",
+	"matches": [{
+		"key": "resource_name",
+		"value": "resource1"
+	}],
+	"not_tags": [{
+		"key": "key2",
+		"values": ["value2"]
+	}],
+	"tags": [{
+		"key": "key1",
+		"values": ["value1"]
+	}]
+}
      +
    +
    • Example request when action is set to count
      This example shows how to query the number of AS group resources for a tenant using the following search criteria: including the tag (key = key1 and value = value) and excluding the tag (key = key2 and value = value2).
      POST https: //{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group_tag/resource_instances/action
+
+{
+	"action": "count",
+	"not_tags": [{
+		"key": "key2",
+		"values": ["value2"]
+	}],
+	"tags": [{
+		"key": "key1",
+		"values": ["value1"]
+	},
+	{
+		"key": "key2",
+		"values": ["value1",
+		"value2"]
+	}],
+	"matches": [{
+		"key": "resource_name",
+		"value": "resource1"
+	}]
+}
      +
      +
    +
+

Response Message

  • Response parameters +
    + + + + + + + + + + + + + + + + + +
    Table 5 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    resources

    +

    Array of Resource objects

    +

    Specifies tag resources. For details, see Table 6.

    +

    total_count

    +

    Integer

    +

    Specifies the total number of records. When action is set to count, only this parameter is returned. The values of resources and marker are not returned.

    +

    marker

    +

    String

    +

    Specifies the paging location identifier.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + +
    Table 6 Resource field description

    Parameter

    +

    Type

    +

    Description

    +

    resource_id

    +

    String

    +

    Specifies the resource ID.

    +

    resource_detail

    +

    String

    +

    Specifies the resource details.

    +

    tags

    +

    Array of ResourceTag objects

    +

    Specifies tags. If there is no tag, tags is taken as an empty array by default. For details, see Table 7.

    +

    resource_name

    +

    String

    +

    Specifies the resource name. If there is no resource, this parameter is an empty string by default.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 7 ResourceTag field description

    Parameter

    +

    Type

    +

    Description

    +

    key

    +

    String

    +

    Specifies the resource tag key. It contains a maximum of 36 Unicode characters.

    +

    value

    +

    String

    +

    Specifies the resource tag value. It contains a maximum of 36 Unicode characters.

    +
    +
    +
  • Example response
    • Example response when action is set to filter
      {
+	"resources": [{
+		"resource_id": "64af4b6f-ec51-4436-8004-7a8f30080c87",
+		"resource_detail": "SCALING_GROUP_TAG",
+		"tags": [{
+			"key": "key1","value": "value1"
+		}],
+		"resource_name": "as_scaling_group_1"
+	},
+	{
+		"resource_id": "7122ef51-604b-40e7-b9b2-1de4cd78dc60",
+		"resource_detail": "SCALING_GROUP_TAG",
+		"tags": [{
+			"key": "key1","value": "value1"
+		}],
+		"resource_name": "as_scaling_group_2"
+	},
+	"marker": "2",
+	"total_count": 2
+}
      +
    • Example response when action is set to count
      {
+       "total_count": 1000
+}
      +
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Values

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Tag Management
+
+
+ diff --git a/docs/as/api-ref/as_06_1100.html b/docs/as/api-ref/as_06_1100.html new file mode 100644 index 000000000..3d18beafc --- /dev/null +++ b/docs/as/api-ref/as_06_1100.html @@ -0,0 +1,17 @@ + + +

API Management

+
+
+ + +
+
Parent topic: API
+
+
+ diff --git a/docs/as/api-ref/as_06_1101.html b/docs/as/api-ref/as_06_1101.html new file mode 100644 index 000000000..811ee19d6 --- /dev/null +++ b/docs/as/api-ref/as_06_1101.html @@ -0,0 +1,238 @@ + + +

Querying API Versions

+

Function

This interface is used to query all API versions of the AS service.

+
+

URI

GET /

+
+

Request Message

  • Request parameters

    None

    +
  • Example request
    This example shows how to query all versions of an API.
    GET https://{Endpoint}/
    +
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 1 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    versions

    +

    Array of versions objects

    +

    Specifies the API versions.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 2 versions field description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the API version ID.

    +

    links

    +

    Array of links objects

    +

    Specifies the API URL. For details, see Table 3.

    +

    min_version

    +

    String

    +

    Specifies the earliest supported API version number.

    +

    status

    +

    String

    +

    Specifies the API version status.

    +
    • CURRENT: indicates a primary version.
    • SUPPORTED: indicates an earlier version which is still supported.
    • DEPRECATED: indicates a deprecated version which may be deleted later.
    +

    updated

    +

    String

    +

    Specifies the release date of an API version.

    +

    version

    +

    String

    +

    Specifies the latest supported API version number.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 3 links field description

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the API Uniform Resource Locator (URL).

    +

    rel

    +

    String

    +

    Specifies the API URL dependency.

    +
    +
    +
+
  • Example response
    {
+  "versions": [
+    {
+      "id": "v1",
+      "links": [
+        {
+          "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/",
+          "rel": "self"
+        }
+      ],
+      "min_version": "",
+      "status": "CURRENT",
+      "updated": "2016-06-30T00:00:00Z",
+      "version": ""
+    },
+    {
+      "id": "v2",
+      "links": [
+        {
+          "href": "https://as.XXX.mycloud.com/autoscaling-api/v2/",
+          "rel": "self"
+        }
+      ],
+      "min_version": "",
+      "status": "SUPPORTED",
+      "updated": "2018-03-30T00:00:00Z",
+      "version": ""
+    }
+  ]
+}
+
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: API Management
+
+
+ diff --git a/docs/as/api-ref/as_06_1102.html b/docs/as/api-ref/as_06_1102.html new file mode 100644 index 000000000..c7fe76752 --- /dev/null +++ b/docs/as/api-ref/as_06_1102.html @@ -0,0 +1,245 @@ + + +

Querying a Specified API Version

+

Function

This interface is used to query a specified API version of the AS service.

+
+

URI

GET /{api_version}

+ +
+ + + + + + + + + + + +
Table 1 Parameter description

Parameter

+

Mandatory

+

Type

+

Description

+

api_version

+

Yes

+

String

+

Specifies the ID of the AS API version.

+
+
+
+

Request Message

  • Request parameters

    None

    +
  • Example request

    This example shows how to query V1 AS API.

    +
    GET https://{Endpoint}/v1
    +
+
+

Response Message

  • Response parameters +
    + + + + + + + + + +
    Table 2 Response parameters

    Parameter

    +

    Type

    +

    Description

    +

    version

    +

    version object

    +

    Specifies a specified API version.

    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Table 3 version field description

    Parameter

    +

    Type

    +

    Description

    +

    id

    +

    String

    +

    Specifies the API version ID.

    +

    links

    +

    Array of links objects

    +

    Specifies the API URL. For details, see Table 4.

    +

    min_version

    +

    String

    +

    Specifies the earliest supported API version number.

    +

    status

    +

    String

    +

    Specifies the API version status.

    +
    • CURRENT: indicates a primary version.
    • SUPPORTED: indicates an earlier version which is still supported.
    • DEPRECATED: indicates a deprecated version which may be deleted later.
    +

    updated

    +

    String

    +

    Specifies the release date of an API version.

    +

    version

    +

    String

    +

    Specifies the latest supported API version number.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 4 links field description

    Parameter

    +

    Type

    +

    Description

    +

    href

    +

    String

    +

    Specifies the API Uniform Resource Locator (URL).

    +

    rel

    +

    String

    +

    Specifies the API URL dependency.

    +
    +
    +
+
  • Example response
    {
+  "version": {
+    "id": "v1",
+    "links": [
+      {
+        "href": "https://as.XXX.mycloud.com/autoscaling-api/v1/",
+        "rel": "self"
+      }
+    ],
+    "min_version": "",
+    "status": "CURRENT",
+    "updated": "2016-06-30T00:00:00Z",
+    "version": ""
+  }
+}
    +
+
+

Returned Values

  • Normal

    200

    +
  • Abnormal +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Returned Value

    +

    Description

    +

    400 Bad Request

    +

    The server failed to process the request.

    +

    401 Unauthorized

    +

    You must enter the username and password to access the requested page.

    +

    403 Forbidden

    +

    You are forbidden to access the requested page.

    +

    404 Not Found

    +

    The server could not find the requested page.

    +

    405 Method Not Allowed

    +

    You are not allowed to use the method specified in the request.

    +

    406 Not Acceptable

    +

    The response generated by the server could not be accepted by the client.

    +

    407 Proxy Authentication Required

    +

    You must use the proxy server for authentication so that the request can be processed.

    +

    408 Request Timeout

    +

    The request timed out.

    +

    409 Conflict

    +

    The request could not be processed due to a conflict.

    +

    500 Internal Server Error

    +

    Failed to complete the request because of an internal service error.

    +

    501 Not Implemented

    +

    Failed to complete the request because the server does not support the requested function.

    +

    502 Bad Gateway

    +

    Failed to complete the request because the request is invalid.

    +

    503 Service Unavailable

    +

    Failed to complete the request because the system is unavailable.

    +

    504 Gateway Timeout

    +

    A gateway timeout error occurred.

    +
    +
    +
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: API Management
+
+
+ diff --git a/docs/as/api-ref/as_07_0100.html b/docs/as/api-ref/as_07_0100.html new file mode 100644 index 000000000..d6b086ba4 --- /dev/null +++ b/docs/as/api-ref/as_07_0100.html @@ -0,0 +1,17 @@ + + + +

Appendix

+ +

+
+ +
+ +
+ diff --git a/docs/as/api-ref/as_07_0101.html b/docs/as/api-ref/as_07_0101.html new file mode 100644 index 000000000..27d6a3f29 --- /dev/null +++ b/docs/as/api-ref/as_07_0101.html @@ -0,0 +1,151 @@ + + +

AS Metrics

+

Function

This section describes metrics reported by AS to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to view the AS metrics and the alarms generated by Cloud Eye for AS.

+
+

Namespace

SYS.AS

+
+

Metrics

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Metric

+

Name

+

Description

+

Value Range

+

Remarks

+

cpu_util

+

CPU Usage

+

Average CPU usage of all instances in a monitored object

+

≥ 0%

+

The monitored object is an AS group.

+

mem_util

+

Memory Usage

+

Average memory usage of all instances in a monitored object

+

≥ 0%

+

The monitored object is an AS group.

+
NOTE:

This metric is unavailable if the image has no OTC Tools installed.

+
+

network_incoming_bytes_rate_inband

+

Inband Incoming Rate

+

Average number of incoming bytes per second on all instances in a monitored object

+

≥ 0

+

The monitored object is an AS group.

+

network_outgoing_bytes_rate_inband

+

Inband Outgoing Rate

+

Average number of outgoing bytes per second on all instances in a monitored object

+

≥ 0

+

The monitored object is an AS group.

+

instance_num

+

Number of Instances

+

Number of available instances in a monitored object

+

≥ 0

+

The monitored object is an AS group.

+

Available ECSs are INSERVICE instances in an AS group.

+

disk_read_bytes_rate

+

Disks Read Rate

+

Number of bytes read from all instances in a monitored object per second

+

≥ 0

+

The monitored object is an AS group.

+

disk_write_bytes_rate

+

Disks Write Rate

+

Number of bytes written to all instances in a monitored object per second

+

≥ 0

+

The monitored object is an AS group.

+

disk_read_requests_rate

+

Disk Read Requests

+

Number of read requests sent to all instances in a monitored object per second

+

≥ 0

+

The monitored object is an AS group.

+

disk_write_requests_rate

+

Disks Write Requests

+

Number of write requests sent to all instances in a monitored object per second

+

≥ 0

+

The monitored object is an AS group.

+
+
+
  • The image based on which the target ECS is created must have OTC Tools installed. Otherwise, the Memory Usage and Disk Usage metrics are unavailable. For details about how to install the OTC Tools, visit https://github.com/UVP-Tools/UVP-Tools/.
  • For details about whether your OS supports the Memory Usage, Inband Outgoing Rate, and Inband Incoming Rate metrics, see Elastic Cloud Server User Guide.
+
+
+

Dimension

+
+ + + + + + + +

Key

+

Value

+

AutoScalingGroup

+

AS group ID

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/as/api-ref/as_07_0102.html b/docs/as/api-ref/as_07_0102.html new file mode 100644 index 000000000..a0555ce6b --- /dev/null +++ b/docs/as/api-ref/as_07_0102.html @@ -0,0 +1,2704 @@ + + +

Error Codes

+

Description

This section provides the meanings of error codes returned by AS APIs.

+
+

Example of Returned Error Information

{"error":{"code":"AS.0001","message":"System error."}}

+
+

Error Code Description

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

HTTP Status Code

+

Error Code

+

Error Message

+

Description

+

Solution

+

500

+

AS.0001

+

System error.

+

System error.

+

Try again later or contact technical support.

+

400

+

AS.0002

+

Request body is null.

+

The message body is empty.

+

Enter a valid message body.

+

401

+

AS.0005

+

The token of the header in the request is null.

+

The header in the request carries no or an empty token.

+

Enter a valid token.

+

401

+

AS.0006

+

The token of the header in the request is incorrect.

+

The header in the request carries an incorrect, invalid, or expired token.

+

Enter a valid token.

+

404

+

AS.0007

+

The requested resource [%s] could not be found.

+

The requested resources are not found.

+

Use the correct URL parameter.

+

400

+

AS.0008

+

Incorrect ProjectID.

+

The project id value carried in the URL is different from that resolved from the token.

+

Check whether the parameter in the URL matches that in the token.

+

403

+

AS.0011

+

You do not have the rights to perform the operation.

+

You do not have the rights to perform the operation.

+

Check whether te_admin, as_adm, or other required roles exist.

+

400

+

AS.0022

+

Request body error

+

The request is invalid.

+

Check whether the request body is in standard JSON format or whether an unsupported parameter exists.

+

400

+

AS.0026

+

Scaling action is not allowed in the cooling duration.

+

No scaling action is allowed in the cooldown period.

+

Try again later.

+

400

+

AS.0031

+

Policy doesn't allow [%s] to be performed.

+

Fine-grained authentication failed because no authentication item is specified.

+

Add the required authorization item.

+

400

+

AS.0033

+

The api version is illegal, only v1 and v2.

+

Invalid API ID.

+

Enter a correct API ID.

+

400

+

AS.0034

+

Failed to execute the policy because the AS group is in active state.

+

Failed to trigger the AS policy because a scaling action in the AS group is in progress.

+

An AS policy can be automatically triggered only when there is no in-progress scaling action in the AS group. Try again later.

+

400

+

AS.1001

+

The value of parameter Start number is invalid.

+

The start number value is invalid.

+

Enter a valid start number value.

+

400

+

AS.1002

+

The value of parameter Limit is invalid.

+

The limit value is invalid.

+

Enter a valid limit value.

+

400

+

AS.1003

+

The AS configuration ID is null.

+

The AS configuration ID is empty.

+

Add an AS configuration ID.

+

400

+

AS.1004

+

The AS configuration does not exist.

+

The AS configuration does not exist.

+

Use a correct AS configuration ID.

+

400

+

AS.1006

+

The AS configuration is in use.

+

The AS configuration is being used by an AS group and cannot be deleted.

+

Change this AS configuration for the AS group to another one and delete the AS configuration.

+

400

+

AS.1007

+

The AS configuration name is null.

+

The AS configuration name is empty.

+

Add an AS configuration name.

+

400

+

AS.1008

+

The AS configuration name is too long.

+

The AS configuration name is too long.

+

Use an AS configuration name of proper length.

+

400

+

AS.1009

+

The AS group ID is null.

+

The AS group ID is not specified.

+

Add an AS group ID.

+

400

+

AS.1011

+

The instance configuration information is null.

+

The instance_config field is not specified.

+

Enter a valid instance_config value.

+

400

+

AS.1014

+

The image ID in the AS configuration is null.

+

The image ID is not specified.

+

Add an image ID.

+

400

+

AS.1015

+

The image in the AS configuration does not exist.

+

The image in the AS configuration does not exist.

+

Use a correct image ID.

+

400

+

AS.1016

+

The specification ID in the AS configuration cannot be null.

+

The flavor ID is not specified.

+

Add a flavor ID.

+

400

+

AS.1017

+

The specification [%s] in the AS configuration does not exist.

+

The flavor of the AS configuration does not exist.

+

Use a correct flavor ID.

+

400

+

AS.1018

+

The specification [%s] and image is not match.

+

The flavor and image do not match.

+

Check whether the flavor matches the image. If not, modify the configuration.

+

400

+

AS.1019

+

The disk of this type is not applicable to the ECS.

+

The flavor and disk do not match.

+

Check whether the flavor matches the disk type. If not, change the resources.

+

400

+

AS.1021

+

The image in the AS configuration is not activated.

+

The image in the AS configuration is not activated.

+

Use a correct image ID.

+

400

+

AS.1022

+

The image in the AS configuration is not available.

+

The image in the AS configuration is unavailable.

+

Use a correct image ID.

+

400

+

AS.1023

+

Invalid AS configuration name.

+

The AS configuration name is invalid.

+

Use a valid AS configuration name.

+

400

+

AS.1024

+

The number of AS configurations exceeds the upper limit.

+

The number of AS configurations exceeds the upper limit.

+

Delete idle AS configurations or apply for a higher quota.

+

400

+

AS.1025

+

The user login mode in the AS configuration is not unique.

+

The user login mode in the AS configuration is not unique.

+

Use account-and-password or key-pair login mode only.

+

400

+

AS.1026

+

The user login mode in the AS configuration is empty.

+

The user login mode in the AS configuration is empty.

+

Enter a valid key_name value.

+

400

+

AS.1027

+

The scaling config personality is invalid.

+

The user AS configuration is invalid.

+

Enter a valid personality value.

+

400

+

AS.1028

+

The disk in the AS configuration is null.

+

The disk in the AS configuration is empty.

+

Enter a valid disk value.

+

400

+

AS.1029

+

The number of system disks in the AS configuration is invalid.

+

The number of system disks in the AS configuration is invalid.

+

Ensure that there is only one system disk.

+

400

+

AS.1030

+

The size of the system disk in the AS configuration is less than the specification required.

+

The size of the system disk in the AS configuration is smaller than the requirement.

+

Use a proper system disk size.

+

400

+

AS.1031

+

The size of the disk in the AS configuration is not correct.

+

The size of the disk in the AS configuration is invalid.

+

Use a proper disk size.

+

400

+

AS.1032

+

The ECS type [%s] in the AS configuration do not support 24 disks.

+

The number of disks in the AS configuration exceeds 24.

+

Ensure that the number of disks does not exceed the limit.

+

400

+

AS.1033

+

Parameter volumeType in the AS configuration is invalid.

+

The volumeType of the disk in the AS configuration is invalid.

+

Use a valid volume_type value.

+

400

+

AS.1034

+

Parameter diskType in the AS configuration is invalid.

+

The diskType in the AS configuration is invalid.

+

Use a valid disk_type value.

+

400

+

AS.1035

+

Parameter adminPass in the AS configuration is invalid.

+

The password in the AS configuration fails to meet the complexity requirements.

+

Use passwords that meet complexity requirements.

+

400

+

AS.1036

+

32-bit operating system (OS) does not support the specification [%s] with 4G memory.

+

The memory of 32-bit OS exceeds 4 GB.

+

Change the image or the policy.

+

400

+

AS.1038

+

Batch deleting the AS configuration failed.

+

Deleting AS configurations in batches fails.

+

If this error code is returned, use parameter Message to obtain the configuration ID and the failure cause.

+

400

+

AS.1039

+

The number of AS configurations is beyond the maximum limit.

+

The number of AS configurations to be deleted in batches exceeds the upper limit.

+

Delete a maximum of 50 AS configurations at a time.

+

400

+

AS.1040

+

The list of AS config to be deleted is null.

+

The AS configuration list is empty.

+

Add the IDs of the AS configurations to be deleted in batches.

+

400

+

AS.1041

+

The eip info of scaling config is null.

+

The eip field in the public_ip field is empty.

+

Ensure that the eip field is not empty when specifying the public_ip field.

+

400

+

AS.1042

+

The bandwidth size of eip is invalid.

+

The bandwidth size is invalid.

+

Enter a valid bandwidth.

+

400

+

AS.1043

+

The eip type of scaling config is invalid.

+

The EIP type is invalid.

+

Use a valid EIP type.

+

400

+

AS.1044

+

The bandwidth charging mode of eip is invalid.

+

The bandwidth billing model of the AS configuration is invalid.

+

Use a valid bandwidth billing model.

+

400

+

AS.1045

+

The bandwidth type of eip is invalid.

+

The bandwidth type is invalid.

+

Use a valid bandwidth.

+

400

+

AS.1046

+

The bandwidth size of eip is null.

+

The bandwidth size is not specified.

+

Add the bandwidth value of the AS configuration.

+

400

+

AS.1049

+

Parameter userdata in the AS configuration is invalid.

+

Parameter userdata in the AS configuration is invalid.

+

Use a valid userdata.

+

400

+

AS.1050

+

The user login mode in the AS configuration is illegal.

+

The user login mode in the AS configuration is invalid.

+

Use a valid login mode.

+

400

+

AS.1052

+

Parameter metadata in the AS configuration is invalid.

+

The metadata in the AS configuration is invalid.

+

Use a valid metadata, whose maximum length is 512 bytes and the key value cannot contain spaces, $, or periods(.).

+

400

+

AS.1053

+

The data image is not available.

+

The data image in the AS configuration is unavailable.

+

Use a valid data image.

+

400

+

AS.1054

+

The size of the data disk in the AS configuration is less than the data image required.

+

The size of the data disk in the AS configuration is smaller than what the data image requires.

+

Use a proper data disk.

+

400

+

AS.1055

+

The system disk is not support to data image.

+

A data disk image cannot be used to create a system disk.

+

Refer to the error code description.

+

400

+

AS.1056

+

The data image in the AS configuration does not exist.

+

The data image in the AS configuration does not exist.

+

Use a valid data image ID.

+

400

+

AS.1057

+

The DSS of the disk in the AS configuration is not available.

+

The selected DSS device is unavailable.

+

Use a correct DSS device.

+

400

+

AS.1058

+

The type of dss in the AS configuration is incorrect.

+

The selected DSS device does not support the disk type.

+

Change the DSS device or disk type.

+

400

+

AS.1059

+

The capacity of dss in the AS configuration is not enough.

+

The storage space on the selected DSS device is insufficient.

+

Change the DSS device.

+

400

+

AS.1060

+

DSS and EVS are used together in the AS configuration.

+

You can use either DSS or EVS disks in an AS configuration.

+

Refer to the error code description.

+

400

+

AS.1061

+

The DSS does not belong to the same AZ in the AS configuration.

+

The selected DSS devices must be in the same AZ.

+

Change DSS devices so that they are in the same AZ.

+

400

+

AS.1062

+

The number of EVS disks with snapshot IDs in the AS configuration is different from that of EVS disks specified in the full-ECS image.

+

The number of disks with snapshot IDs in the AS configuration is different from that of EVS disks specified in the full-ECS image.

+

Refer to the error code description.

+

400

+

AS.1063

+

The disk data backup in a full-ECS image cannot be used to restore the disk in DSS.

+

The disk data backup in a full-ECS image is used to restore the disk in DSS.

+

Refer to the error code description.

+

400

+

AS.1064

+

The data disk you have selected will be restored using the disk data backup in the full-ECS image. Then, data mirroring will be unavailable.

+

Your selected data disk will recover from the disk backup in the full-ECS image, and data mirroring is unavailable now.

+

Refer to the error code description.

+

400

+

AS.1065

+

ECS resources specified in the AS configuration belong to different AZs.

+

The VMs in the AS configuration do not belong to the same AZ.

+

Use ECS resources (specifications, images, disk) in the same AZ.

+

400

+

AS.1066

+

The AS configuration contains EVS disks with invalid snapshot IDs.

+

The AS configuration contains EVS disks with invalid snapshot IDs.

+

Use a correct snapshot ID.

+

400

+

AS.1067

+

The value of parameter Offset number is invalid.

+

Parameter offset is invalid.

+

Use a valid offset value.

+

400

+

AS.1074

+

The value of parameter Marker is invalid.

+

Parameter marker is invalid.

+

Use a valid marker value.

+

400

+

AS.1075

+

The image ID is invalid.

+

Image ID in the AS configuration is invalid.

+

Use a correct image ID.

+

400

+

AS.1085

+

Invalid multi flavor priority policy.

+

The priority policy used in multi-flavor AS configuration is invalid.

+

Use a valid multi_flavor_priority_policy value.

+

400

+

AS.1086

+

AS configuration is not available for AS group

+

The AS configuration is unavailable.

+

Replace the AS configuration in the AS group.

+

400

+

AS.1087

+

The number of flavors in the AS config exceeds the upper limit.

+

The number of flavors in the AS configuration reaches the upper limit.

+

Ensure that the number of flavors in the AS configuration does not exceed the upper limit.

+

400

+

AS.1088

+

The image in the AS configuration you selected is unavailable for the AZ [%s] in AS group.

+

The image in the AS configuration is not available in the AZ of the AS group.

+

Change another AS configuration or AZ for the AS group.

+

400

+

AS.1090

+

Flavor {0} in the AS configuration is incompatible with the image architecture.

+

The selected flavor is incompatible with the image architecture.

+

Ensure that the selected flavor is compatible with the image architecture.

+

400

+

AS.2002

+

The name of the AS group is null.

+

The AS group name is empty.

+

Add an AS group name.

+

400

+

AS.2003

+

The AS group name is too long.

+

The AS group name is too long.

+

Use an AS group name of proper length.

+

400

+

AS.2004

+

Invalid min or max number of instances in the AS group.

+

The maximum or minimum number of instances is invalid.

+

Enter correct maximum/minimum number of instances for the AS group.

+

400

+

AS.2005

+

The expected number cannot be less than the minimum number of instances or greater than the maximum number of instances.

+

The expected number of instances in the AS group is invalid.

+

Enter a valid number of expected instances for the AS group.

+

400

+

AS.2006

+

Invalid cooldown period of the AS group.

+

The cooldown period in the AS group is invalid.

+

Enter a valid cooldown period for the AS group.

+

400

+

AS.2007

+

The AS group does not exist.

+

The AS group does not exist.

+

Use a correct AS group ID.

+

400

+

AS.2008

+

Invalid execution action of the AS group.

+

The scaling action of the AS group is invalid.

+

Use a correct scaling action for the AS group.

+

400

+

AS.2009

+

The AS group ID is null.

+

The AS group ID is not specified.

+

Add an AS group ID.

+

400

+

AS.2010

+

The expected number of instances in the AS group cannot be smaller than the number of instances for which instance protection has been configured.

+

The expected number of instances in the AS group cannot be smaller than the number of instances for which instance protection has been configured.

+

Ensure that the number of expected instances is no less than the protected instances, or change the expected number of instances after canceling instance protection.

+

400

+

AS.2011

+

Invalid AZ in AS group.

+

The AZ in the AS group is invalid.

+

Use a valid value.

+

400

+

AS.2012

+

The VPC of the AS group does not exist.

+

The VPC of the AS group does not exist.

+

Use a valid value.

+

400

+

AS.2013

+

Parameter networks in the AS group is invalid.

+

Parameter networks in the AS group is invalid.

+

Use a valid value.

+

400

+

AS.2014

+

The security group of the AS group does not exist.

+

The security group of the AS group does not exist.

+

Use a valid value.

+

400

+

AS.2015

+

Parameter listenerId in the AS group is invalid.

+

The load balancer listener of the AS group is invalid.

+

Use a valid value.

+

400

+

AS.2016

+

The listener of the AS group does not belong to the vpc.

+

The VPC to which the ELB listener in the AS group belongs is different from the VPC in the AS group.

+

Change the VPC ID or ELB listener ID.

+

400

+

AS.2017

+

The ID of the VPC in the AS group is null.

+

The VPC ID in the AS group is not specified.

+

Add a VPC ID.

+

400

+

AS.2018

+

No AS configuration is in the AS group.

+

No AS is configured in the AS group.

+

Enable the AS group after adding an AS configuration to the AS group.

+

400

+

AS.2019

+

The value of the parameter that specifies whether to forcibly delete an AS group is invalid.

+

The value of the parameter that specifies whether to forcibly delete an AS group is invalid.

+

Use a valid value.

+

400

+

AS.2020

+

The scaling group status is illegal.

+

The AS group status is invalid.

+

You are not allowed to perform the operation when the AS group is in the current status.

+

400

+

AS.2021

+

The current number of instances in the AS group is not 0.

+

Deleting the AS group fails because there are instances in it.

+

Before deleting the AS group, deleting its instances.

+

400

+

AS.2022

+

The AS group name contains invalid characters.

+

The AS group name contains invalid characters.

+

Use a correct AS group name.

+

400

+

AS.2023

+

The number of AS groups exceeds the upper limit.

+

The number of AS groups exceeds the upper limit.

+

Delete idle AS groups or apply for a higher quota.

+

400

+

AS.2024

+

The number of subnets in the AS group exceeds the upper limit.

+

The number of subnets in the AS group exceeds the upper limit.

+

Ensure that the number of subnets does not exceed the upper limit.

+

400

+

AS.2025

+

The number of security groups in the AS group exceeds the upper limit.

+

The number of security groups in the AS group exceeds the upper limit.

+

Ensure that the number of security groups does not exceed the upper limit.

+

400

+

AS.2026

+

The type of listeners in the AS group is not unique.

+

There are ELB listeners of different types in the AS group.

+

lb_listener_id is alternative to lbaas_listeners.

+

400

+

AS.2027

+

The subnet of the AS group does not belong to the vpc.

+

The VPC to which some subnets in the AS group belong is different with the VPC in the AS group.

+

Change the VPC ID or subnet.

+

400

+

AS.2028

+

The modified expected number of instances is the same as the original number.

+

The new expected number of instances is the same as the original number.

+

Refer to the error code description.

+

400

+

AS.2029

+

Invalid health check method of the AS group.

+

The health check method for instances in the AS group is incorrect.

+

Use a valid health_periodic_audit_method value.

+

400

+

AS.2030

+

You are not allowed to modify the lb, AZ, subnet, and security information when the number of instances in the AS group is not 0, the AS group is scaling, or the AS group is in Inservice status.

+

You are not allowed to modify the load balancer, AZ, subnet, or security group information when there are instances in the AS group, the AS group is scaling, or the AS group is in Inservice state.

+

Check the number of instances in the AS group and the status of the AS group, or try again later.

+

400

+

AS.2031

+

Invalid health check period of the AS group.

+

The health check period of the AS group is invalid.

+

Use a valid health_periodic_audit_time value.

+

400

+

AS.2032

+

Invalid instance removal policy.

+

The instance removal policy for the AS group is invalid.

+

Use a valid instance_terminate_policy value.

+

400

+

AS.2033

+

You are not allowed to perform the operation when the AS group is in current [%s] status.

+

You are not allowed to perform the operation when the AS group is in the current status.

+

Refer to the error code description.

+

400

+

AS.2034

+

Invalid notification method of the AS group.

+

The notification method for the AS group is invalid.

+

Use a valid notification method.

+

400

+

AS.2035

+

The number of instances manually added to the AS group exceeds the maximum number of the instances required in the AS group.

+

The number of ECSs in the AS group is greater than the upper limit because some ECSs are manually added.

+

Add a proper number of ECSs or increase the maximum number of instances in the AS group.

+

400

+

AS.2036

+

The number of instances manually deleted is less than the minimum number of the instances required in the AS group.

+

The number of ECSs in the AS group is smaller than the lower limit because some ECSs are manually deleted.

+

Delete a proper number of ECSs or decrease the minimum number of instances in the AS group.

+

400

+

AS.2037

+

The number of listeners in the AS group exceeds the upper limit.

+

The number of ELB listeners in the AS group reaches the upper limit.

+

Select a proper number of load balancer listeners.

+

400

+

AS.2038

+

The type [%s] of ECS in the AZ you selected has been sold out.

+

The ECSs of this type have been sold out in the AZ specified for this AS group.

+

Refer to the error code description. Change the AZ of the AS group or change the AS configuration for the AS group.

+

400

+

AS.2039

+

Parameter protocolPort of the AS group is invalid.

+

Parameter protocolPort of the AS group is invalid.

+

Use a valid protocolPort.

+

400

+

AS.2040

+

Parameter weight of the AS group is invalid.

+

Parameter weight of the AS group is invalid.

+

Use a valid weight.

+

400

+

AS.2042

+

Parameter pool of lbaas in the AS group is invalid.

+

The load balancer pool in the AS group is invalid.

+

Use a valid pool.

+

400

+

AS.2043

+

There is not avalid volume in the AZ [%s] you selected.

+

Storage resources of this type are sold out or do not exist in the AZ specified for this AS group.

+

Refer to the error code description. Change the AZ of the AS group or change the AS configuration for the AS group.

+

400

+

AS.2044

+

The AZ in the AS group is not available.

+

The AZ in the AS group is invalid.

+

Refer to the error code description. Change the AZ of the AS group.

+

400

+

AS.2045

+

The min or max number of instances in the AS group exceeds the upper limit.

+

The minimum or maximum number of instances in the AS group exceeds the limit.

+

Enter proper maximum and minimum numbers of instances for the AS group.

+

400

+

AS.2046

+

Invalid health check grace period of the AS group.

+

The grace period for the instance health check is invalid.

+

Use a valid health_periodic_audit_grace_period value.

+

400

+

AS.2047

+

The AS group is in active status.

+

Failed to modify load balancer parameters because a scaling action is ongoing.

+

Wait until the scaling action is complete and modify the load balancer parameters again.

+

400

+

AS.2053

+

Invalid multi az priority policy.

+

The priority policy used for multiple AZs in the AS group is invalid.

+

Change the priority policy used for multiple AZs in the AS group.

+

400

+

AS.2054

+

The AS group is in active status.

+

Failed to change the AZ because a scaling action is ongoing.

+

Wait until the scaling action is complete and change the AZ again.

+

400

+

AS.3002

+

Invalid AS policy type.

+

The AS policy type is invalid.

+

Use a valid scaling_policy_type value.

+

400

+

AS.3003

+

The information about the AS policy is null.

+

When the AS policy is scheduled or periodic, parameter scheduled_policy is empty.

+

Use a valid scheduled_policy value.

+

400

+

AS.3004

+

Invalid recurrence type in the AS policy.

+

The period type is incorrect.

+

Use a valid recurrence_type value.

+

400

+

AS.3005

+

The end time of the scaling action triggered periodically is empty.

+

The end time is not specified for a periodic AS policy.

+

Enter a valid end_time value.

+

400

+

AS.3006

+

The format of the end time for the scaling action triggered periodically is incorrect.

+

The format of the end time for the periodically triggered scaling action is incorrect.

+

Use a correct format for the end time.

+

400

+

AS.3007

+

The end time of the scaling action triggered periodically must be later than the current time.

+

The end time of the scaling action triggered periodically must be later than the current time.

+

Ensure that the end time is later than the current time.

+

400

+

AS.3008

+

Parameter lanchTime in the AS policy is null.

+

The triggering time is not specified.

+

Enter a valid launch_time value.

+

400

+

AS.3009

+

The format of parameter lanchTime is incorrect.

+

The triggering time format is incorrect.

+

Use a correct triggering time format.

+

400

+

AS.3010

+

The triggering time of the scheduled policy must be later than the current time.

+

The triggering time of the scaling action triggered at a scheduled time must be later than the current time.

+

Ensure that the triggering time of the scheduled policy is later than the current time.

+

400

+

AS.3011

+

The AS policy type is null.

+

The AS policy type is not specified.

+

Enter a valid scaling_policy_type value.

+

400

+

AS.3012

+

Invalid cooldown period in the AS policy.

+

The cooldown period in the AS policy is invalid.

+

Enter a valid cool_down_time value.

+

400

+

AS.3013

+

The AS policy name is null.

+

The AS policy name is not specified.

+

Enter a valid scaling_policy_name value.

+

400

+

AS.3014

+

The length of the AS policy name is invalid.

+

The length of the AS policy name is invalid.

+

Enter a valid scaling_policy_name value.

+

400

+

AS.3015

+

The action in the AS policy is null.

+

The execution action in the AS policy is not specified.

+

Enter a valid scaling_policy_action value.

+

400

+

AS.3016

+

The operation to perform the action in the AS policy is null.

+

The operation to perform the execution action in the AS policy is not specified.

+

Enter a valid operation value.

+

400

+

AS.3017

+

The operation to perform the action in the AS policy action is invalid.

+

The operation to perform the action in the AS policy is invalid.

+

Enter a valid operation value.

+

400

+

AS.3018

+

The number of instances which action in the AS policy operates on is invalid.

+

The number of instances to which the AS policy applies is invalid.

+

Enter a valid instance_number value.

+

400

+

AS.3019

+

The AS group ID in the AS policy cannot be null.

+

The AS group ID in the AS policy is not specified.

+

Add an AS group ID.

+

400

+

AS.3020

+

The AS policy does not exist.

+

The AS policy does not exist.

+

Use a correct AS policy ID.

+

400

+

AS.3021

+

The AS policy ID cannot be null.

+

The AS policy ID is not specified.

+

Add an AS policy ID.

+

400

+

AS.3022

+

The action of the AS policy request body is invalid.

+

The action of the AS policy request body is invalid.

+

Use a valid action value.

+

400

+

AS.3023

+

The period type of the AS policy is null.

+

The period type of the AS policy is empty.

+

Use a valid recurrence_type value.

+

400

+

AS.3024

+

The value of the period type of the AS policy is null.

+

The value of the periodically triggered tasks of the AS policy is empty.

+

Add a valid recurrence_value value.

+

400

+

AS.3025

+

The value of period type of the AS policy is invalid.

+

The period type of the AS policy is invalid.

+

Use a valid recurrence_type value.

+

400

+

AS.3026

+

The alarm ID in the AS policy is null.

+

The alarm ID in the AS policy is empty.

+

Add an alarm ID.

+

400

+

AS.3027

+

The AS policy must be in the inservice status when the AS policy is performed.

+

The AS group must be in service when the AS policy is performed.

+

Enable the AS group and try again.

+

400

+

AS.3028

+

The format of the start time for the scaling action triggered periodically is incorrect.

+

The format of the start time for the periodically triggered scaling action is incorrect.

+

Use a correct format for the start time.

+

400

+

AS.3029

+

The start time of the scaling action triggered periodically must be earlier than the end time.

+

The start time of the periodically triggered scaling action must be earlier than the end time.

+

Ensure that the start time of the periodic policy is earlier than the end time.

+

400

+

AS.3030

+

The alarm in the AS policy does not exist.

+

The alarm rule in the AS policy does not exist.

+

Modify the alarm rule used by the AS policy.

+

400

+

AS.3031

+

Invalid AS policy name.

+

The AS policy name is invalid.

+

Enter a valid scaling_policy_name value.

+

400

+

AS.3032

+

The number of AS policies exceeds the upper limit.

+

The number of AS policies exceeds the upper limit.

+

Delete idle AS policies or apply for a higher quota.

+

400

+

AS.3033

+

The triggering time of the periodic policy is not included in the effective time of the policy.

+

The triggering time of the periodic policy falls outside the effective time range of the policy.

+

Ensure that the triggering time of the periodic policy is within the range from the start time to the end time.

+

400

+

AS.3034

+

The alarm ID in the AS policy is being used by another AS group.

+

The alarm ID in the AS policy is being used by another AS group.

+

Refer to the error code description. An alarm ID can be used only by the AS policy in one AS group at a time.

+

400

+

AS.3035

+

The percentage of instances which action in the AS policy operates on is invalid.

+

The percentage of instances to which the AS policy applies is invalid.

+

Use a valid instance_percentage value.

+

400

+

AS.3036

+

The action in the AS policy operates is not unique.

+

The action in the AS policy operates is not unique.

+

Select one from instance_percentage or instance_number.

+

400

+

AS.3037

+

The scaling resource type in the AS policy is invalid.

+

The resource type in the AS policy is invalid.

+

Use a valid scaling_resource_type value.

+

400

+

AS.3038

+

The AS policy is in executing status.

+

The AS policy is being executed and cannot be executed again.

+

Try again later.

+

400

+

AS.3040

+

The adjustment by policy reached the limit

+

The number of modifications to scaling resources in the AS policy has reached the upper limit.

+

Refer to the error code description.

+

400

+

AS.3041

+

The scaling resource ID in the AS policy is null.

+

The scaling resource ID in the AS policy is not specified.

+

Enter a valid AS resource ID in the AS policy.

+

400

+

AS.3042

+

The scaling resource in the AS policy does not exist.

+

The scaling resource in the AS policy does not exist.

+

Enter a valid AS resource ID in the AS policy.

+

400

+

AS.3043

+

The limit which action in the AS policy operates on is invalid.

+

The value of parameter limits in the AS policy is invalid.

+

Use a valid limits value in the AS policy.

+

400

+

AS.3045

+

Failed to delete policies in a batch.

+

Failed to delete policies in batches.

+

If this error code is returned, use parameter Message to obtain the policy ID and the failure cause.

+

400

+

AS.3046

+

Failed to resume policies in a batch.

+

Failed to enable policies in batches.

+

If this error code is returned, use parameter Message to obtain the policy ID and the failure cause.

+

400

+

AS.3047

+

Failed to pause policies in a batch.

+

Failed to disable policies in batches.

+

If this error code is returned, use parameter Message to obtain the policy ID and the failure cause.

+

400

+

AS.3048

+

The value of the parameter that specifies whether to forcibly delete the policy is invalid.

+

The value of the parameter that specifies whether to forcibly delete the policy is invalid.

+

Use a valid force_delete value.

+

400

+

AS.3049

+

The list of AS policies to be batched is empty.

+

The list of AS policies on which a batch operation is to be performed is empty.

+

Add the IDs of the AS policies to be operated in batches.

+

400

+

AS.3050

+

The alarm ID in the AS policy is illegal.

+

The format of the alarm ID in the AS policy is incorrect.

+

Use an alarm ID in correct format.

+

400

+

AS.3054

+

The scaling resource type in the AS policy is null.

+

The scaling resource type in the AS policy cannot be left blank.

+

Use a valid scaling_resource_type value.

+

400

+

AS.3055

+

The scaling resource ID in the AS policy is format wrong.

+

The scaling resource ID in the scaling policy is invalid.

+

Enter a valid AS resource ID in the AS policy.

+

400

+

AS.3056

+

The value of the parameter that specifies whether to delete the alarm in the AS policy is invalid.

+

The value of the alarm rule used for deleting the scaling policy is invalid.

+

Use a valid delete_alarm value.

+

400

+

AS.3057

+

The value of parameter sort_by in the request is invalid.

+

The sort_by value in the request is invalid.

+

Use a valid sort_by value.

+

400

+

AS.3058

+

The value of parameter order in the request is invalid.

+

The order value in the request is invalid.

+

Use a valid order value.

+

400

+

AS.4000

+

The value of parameter start_number in the request for the instance is invalid.

+

The start_number value in the instance request is invalid.

+

Use a valid start_number value.

+

400

+

AS.4001

+

The value of parameter limit in the request for the instance is invalid.

+

The limit value in the instance request is invalid.

+

Use a valid limit value.

+

400

+

AS.4003

+

The value of parameter life_cycle_state in the instance request is invalid.

+

The life_cycle_state value in the instance request is invalid.

+

Use a valid life_cycle_state value.

+

400

+

AS.4004

+

The value of parameter health_status in the request for the instance is invalid.

+

The health_status value in the instance request is invalid.

+

Use a valid health_status value.

+

400

+

AS.4005

+

Parameter scaling_group_id in the request for the instance does not exist.

+

The scaling_group_id in the instance request does not exist.

+

Use a correct scaling_group_id.

+

400

+

AS.4006

+

The instance does not exist.

+

The instance does not exist.

+

Use a correct instance ID.

+

400

+

AS.4007

+

The value of the parameter that specifies whether to delete the instance is invalid.

+

The value of the parameter that specifies whether to delete the instance is invalid.

+

Use a valid value.

+

400

+

AS.4008

+

The start time format of the log about the expected number of the instances is incorrect.

+

The start time format of the log about the expected number of the instances is incorrect.

+

Use a correct format.

+

400

+

AS.4009

+

The end time format of the log about expected number of the instances is incorrect.

+

The end time format of the log about expected number of the instances is incorrect.

+

Use a correct format.

+

400

+

AS.4010

+

Parameter start_number in the request for the log about the expected number of instances is invalid.

+

The start_number in the request for the log about the expected number of instances is invalid.

+

Use a valid start_number value.

+

400

+

AS.4011

+

The value of parameter limit in the request for the log about the expected number of instances is invalid.

+

The value of limit in the request for the log about the expected number of instances is invalid.

+

Use a valid limit value.

+

400

+

AS.4012

+

The value of parameter logId in the request for the log about the expected number of instances is invalid.

+

The logId in the request for the log about the expected number of instances is invalid.

+

Use a valid logId value.

+

400

+

AS.4013

+

The list of instances to be deleted is null.

+

The list of instances to be deleted is empty.

+

Add instances to be deleted.

+

400

+

AS.4014

+

The instances do not belong to the same AS group.

+

The instances do not belong to the same AS group.

+

Select instances in the same AS group.

+

400

+

AS.4015

+

The instance is not in the inservice status.

+

The instance is not in inservice state.

+

Select an inservice instance.

+

400

+

AS.4016

+

Failed to delete the instance because the instance is charged by month or year.

+

The instance cannot be deleted because it is charged by month or year.

+

Refer to the error code description.

+

400

+

AS.4017

+

The requested instance is null.

+

The requested instance is empty.

+

Enter a valid instance.

+

400

+

AS.4018

+

The action of the body in the request to operate the instance is invalid.

+

The value of the request body action of the batch instance operation is invalid.

+

Use a valid value.

+

400

+

AS.4019

+

The list of instances to be added to the AS group is empty.

+

The list of instances to be added to the AS group is empty.

+

Enter a valid instance.

+

400

+

AS.4020

+

The AZ to which the instance belongs is not within the AZ in the AS group.

+

The AZ to which the instance belongs is different from the AZ to which the AS group belongs.

+

Select a proper instance for the AZ.

+

400

+

AS.4021

+

The VPC to which the instance belongs is different from the VPC in the AS group.

+

The VPC to which the instance belongs is different from the VPC in the AS group.

+

Select a proper instance for the VPC.

+

400

+

AS.4022

+

The number of instances added to the AS group exceeds the upper limit.

+

The number of instances added to the AS group exceeds the upper limit.

+

Add a proper number of instances.

+

400

+

AS.4023

+

The added instance has already existed.

+

The added instance already exists.

+

Select another valid instance.

+

400

+

AS.4024

+

The instance is not in the active status.

+

The added instance is not in the active state.

+

Select an active instance.

+

400

+

AS.4026

+

The number of instances deleted exceeds the upper limit.

+

The number of instances deleted exceeds the upper limit.

+

Delete a proper number of instances.

+

400

+

AS.4027

+

The added instance has already existed in other AS group.

+

The instance has already been added to another AS group.

+

Select another valid instance.

+

400

+

AS.4028

+

The AS instance ID cannot be null.

+

The instance ID cannot be left blank.

+

Use a correct instance ID.

+

400

+

AS.4029

+

Failed to add instances in a batch.

+

Failed to batch add instances.

+

If this error code is returned, use parameter Message to obtain the instance ID and the failure cause.

+

400

+

AS.4030

+

Failed to delete instances in a batch.

+

Failed to delete instances in batches.

+

If this error code is returned, use parameter Message to obtain the instance ID and the failure cause.

+

400

+

AS.4032

+

The list of instances is null.

+

The list of instances is empty.

+

Refer to the error code description.

+

400

+

AS.4033

+

Failed to set instance protection in a batch.

+

Failed to set instance protection in a batch.

+

If this error code is returned, use parameter Message to obtain the instance ID and the failure cause.

+

400

+

AS.4043

+

The number of instances exceeds the upper limit.

+

The number of instances for batch operations exceeds the upper limit.

+

Ensure that the number of instances for batch operations is no more than 10 at a time.

+

400

+

AS.7012

+

The ELB listener is unavailable.

+

The ELB listener does not exist.

+

Modify the ELB listener information.

+

400

+

AS.7019

+

The number of private IP addresses in the subnet is insufficient.

+

Private IP addresses in the subnet are insufficient.

+

Modify the subnet information and enable the AS group.

+

400

+

AS.7022

+

The key pair does not exist.

+

The SSH key of the AS configuration does not exist.

+

Replace the AS configuration in the AS group.

+

400

+

AS.7044

+

The tag of this resource is null

+

The tag of this resource is empty.

+

Use a valid value.

+

400

+

AS.7045

+

The number of tags exceeded.

+

The maximum number of tags has been reached.

+

Add a maximum of 10 tags.

+

400

+

AS.7046

+

The tags in the resource is invalid.

+

The tag is invalid.

+

Use a valid tag.

+

400

+

AS.7047

+

The value of tag in the resource is too long.

+

The tag value is too long.

+

Use a valid value.

+

400

+

AS.7048

+

The resource type in this operation with tag is invalid.

+

The resource type in this operation with tag is invalid.

+

Use a valid value.

+

400

+

AS.7049

+

The action in this operation with tag is invalid.

+

The action in this operation with tag is invalid.

+

Use a valid value.

+

400

+

AS.7050

+

The key of tag cannot be duplicate.

+

The key of tag is duplicate.

+

Use a valid value.

+

400

+

AS.7052

+

The matches in the resource is invalid.

+

The matches value is invalid.

+

Use a valid matches value.

+

400

+

AS.7054

+

The value of tag cannot be duplicate.

+

A key in the tag has duplicate values.

+

Check and change the duplicate values in the tag.

+

400

+

AS.7059

+

The enterprise project does not exist.

+

The selected enterprise project does not exist.

+

Use an existing enterprise project.

+

400

+

AS.7060

+

The enterprise project is unavailable.

+

The enterprise project is unavailable.

+

Use an available enterprise project.

+

400

+

AS.7061

+

The value of scaling tag is null.

+

The value of the tag is empty.

+

Use a valid value.

+

400

+

AS.7062

+

The key of scaling tag is null.

+

The key of the tag is empty.

+

Use a valid value.

+

400

+

AS.7063

+

The key of scaling tag is too long.

+

The tag key is too long.

+

Use a valid value.

+

400

+

AS.7065

+

The value of parameter enterprise_project_id in the request is invalid.

+

The request parameter enterprise_project_id is invalid.

+

Use a valid enterprise_project_id.

+

400

+

AS.7111

+

Insufficient instance quota.

+

Insufficient ECS quota.

+

Release idle ECSs or apply for a higher ECS quota.

+

400

+

AS.7112

+

Insufficient volume quota.

+

Insufficient EVS disk quota.

+

Release idle ECSs or increase the upper limit of disks.

+

400

+

AS.7113

+

Insufficient elastic ip quota.

+

Insufficient EIP quota.

+

Release idle EIPs or increase the upper limit of EIPs.

+

400

+

AS.7114

+

Insufficient ram quota.

+

Insufficient ECS memory quota.

+

Release idle ECSs or apply for a higher ECS memory quota.

+

400

+

AS.7115

+

Insufficient cpu quota.

+

Insufficient ECS vCPU quota.

+

Release idle ECSs or increase the upper limit of ECS vCPUs.

+

400

+

AS.9001

+

The format of the start time of the scaling activity log is incorrect.

+

The format of the start time of the scaling log is incorrect.

+

Use a valid value.

+

400

+

AS.9002

+

The format of the end time for the scaling action log is incorrect.

+

The format of the end time for the scaling log is incorrect.

+

Use a valid value.

+

400

+

AS.9003

+

The value of parameter start_number in the request for the scaling activity log is invalid.

+

The start_number in the request for the scaling log is invalid.

+

Use a valid value.

+

400

+

AS.9004

+

The value of parameter limit in the request for the scaling activity log is invalid.

+

The limit in the request for the scaling log is invalid.

+

Use a valid value.

+

400

+

AS.9005

+

The value of parameter log_id in the request for the scaling log is invalid.

+

The logId in the request for the scaling log is invalid.

+

Use a valid value.

+

400

+

AS.9007

+

The format of the execute time in the request is incorrect.

+

The time format of the AS policy execution log is incorrect.

+

Use a valid value.

+

400

+

AS.9008

+

The value of parameter start_number in the request is invalid.

+

Parameter start_number in the AS policy execution log is invalid.

+

Use a valid value.

+

400

+

AS.9009

+

The value of parameter limit in the request is invalid.

+

Parameter limit in the AS policy execution log is invalid.

+

Use a valid value.

+

400

+

AS.9010

+

The value of parameter log_id in the request is invalid.

+

Parameter logId in the AS policy execution log is invalid.

+

Use a valid value.

+

400

+

AS.9011

+

The value of parameter scaling_resource_id in the request is invalid.

+

The resource ID in the AS policy execution log is invalid.

+

Use a valid value.

+

400

+

AS.9012

+

The value of parameter type in the request for the scaling activity log is invalid.

+

The type in the request for the scaling action log is invalid.

+

Use a valid type value.

+

400

+

AS.9013

+

The value of parameter status in the request for the scaling activity log is invalid.

+

The status in the request for the scaling action log is invalid.

+

Use a valid value.

+
+
+
+
+
+
+
Parent topic: Appendix
+
+
+ diff --git a/docs/as/api-ref/as_07_0200.html b/docs/as/api-ref/as_07_0200.html new file mode 100644 index 000000000..6941b6ac7 --- /dev/null +++ b/docs/as/api-ref/as_07_0200.html @@ -0,0 +1,25 @@ + + +

Permissions Policies and Supported Actions

+
+
+ +
+ diff --git a/docs/as/api-ref/as_07_0203.html b/docs/as/api-ref/as_07_0203.html new file mode 100644 index 000000000..1fba31903 --- /dev/null +++ b/docs/as/api-ref/as_07_0203.html @@ -0,0 +1,83 @@ + + +

AS Configuration

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

APIs

+

Actions

+

IAM Project

+

+

Enterprise Project

+

+

Creating an AS configuration

+

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

+

as:configs:create

+

√

+

√

+

Querying AS configurations

+

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

+

as:configs:list

+

√

+

√

+

Querying AS configuration details

+

GET /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}

+

as:configs:get

+

√

+

√

+

Deleting an AS configuration

+

DELETE /autoscaling-api/v1/{project_id}/scaling_configuration/{scaling_configuration_id}

+

as:configs:delete

+

√

+

√

+

Batch deleting AS configurations

+

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

+

as:configs:batchDelete

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/as/api-ref/as_07_0204.html b/docs/as/api-ref/as_07_0204.html new file mode 100644 index 000000000..41bb9ea47 --- /dev/null +++ b/docs/as/api-ref/as_07_0204.html @@ -0,0 +1,61 @@ + + +

Instance

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

APIs

+

Actions

+

IAM Project

+

+

Enterprise Project

+

+

Querying instances in an AS group

+

GET /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/list

+

as:instances:list

+

√

+

√

+

Removing instances from an AS group

+

DELETE /autoscaling-api/v1/{project_id}/scaling_group_instance/{instance_id}

+

as:instances:delete

+

√

+

√

+

Performing operations on instances in batches

+

POST /autoscaling-api/v1/{project_id}/scaling_group_instance/{scaling_group_id}/action

+

as:instances:batchAction

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/as/api-ref/as_07_0205.html b/docs/as/api-ref/as_07_0205.html new file mode 100644 index 000000000..ea64b3679 --- /dev/null +++ b/docs/as/api-ref/as_07_0205.html @@ -0,0 +1,161 @@ + + +

AS Policy

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

APIs

+

Actions

+

IAM Project

+

+

Enterprise Project

+

+

Creating an AS policy

+

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

+

as:policies:create

+

√

+

√

+

Modifying an AS policy

+

PUT /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}

+

as:policies:update

+

√

+

√

+

Querying AS policies

+

GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_group_id}/list

+

as:policies:list

+

√

+

√

+

Querying AS policy details

+

GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}

+

as:policies:get

+

√

+

√

+

Executing, enabling, or disabling an AS policy

+

POST /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}/action

+

as:policies:action

+

√

+

√

+

Deleting an AS policy

+

DELETE /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}

+

as:policies:delete

+

√

+

√

+

Creating an AS policy

+

POST /autoscaling-api/v2/{project_id}/scaling_policy

+

as:policies:create

+

√

+

√

+

Modifying an AS policy

+

PUT /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}

+

as:policies:update

+

√

+

√

+

Querying AS policies

+

GET /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_resource_id}/list

+

as:policies:list

+

√

+

√

+

Querying AS policies

+

GET /autoscaling-api/v2/{project_id}/scaling_policy{? scaling_resource_id, scaling_resource_type ,scaling_policy_name, scaling_policy_id,scaling_policy_type,start_number,limit,sort_by,order,enterprise_project_id}

+

as:groups:get

+

as:policies:list

+

√

+

√

+

Querying AS policy details

+

GET /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}

+

as:policies:get

+

√

+

√

+

Performing operations on AS policies in batches

+

POST /autoscaling-api/v1/{project_id}/scaling_policies/action

+

as:policies:batchAction

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/as/api-ref/as_07_0206.html b/docs/as/api-ref/as_07_0206.html new file mode 100644 index 000000000..dd066b3ca --- /dev/null +++ b/docs/as/api-ref/as_07_0206.html @@ -0,0 +1,39 @@ + + +

AS Policy Execution Log

+
+
+ + + + + + + + + + + + + +

Permission

+

APIs

+

Actions

+

IAM Project

+

+

Enterprise Project

+

+

Querying AS policy execution logs

+

GET /autoscaling-api/v1/{project_id}/scaling_policy_execute_log/{scaling_policy_id}

+

as:policyExecuteLogs:list

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/as/api-ref/as_07_0207.html b/docs/as/api-ref/as_07_0207.html new file mode 100644 index 000000000..1324151f3 --- /dev/null +++ b/docs/as/api-ref/as_07_0207.html @@ -0,0 +1,50 @@ + + +

Scaling Action Log

+
+
+ + + + + + + + + + + + + + + + + + + +

Permission

+

APIs

+

Actions

+

IAM Project

+

+

Enterprise Project

+

+

Querying scaling action logs

+

GET /autoscaling-api/v1/{project_id}/scaling_activity_log/{scaling_group_id}

+

as:acivityLogs:list

+

√

+

√

+

Querying scaling action logs (V2)

+

GET /autoscaling-api/v2/{project_id}/scaling_activity_log/{scaling_group_id}

+

as:acivityLogs:list

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/as/api-ref/as_07_0208.html b/docs/as/api-ref/as_07_0208.html new file mode 100644 index 000000000..437f67a4f --- /dev/null +++ b/docs/as/api-ref/as_07_0208.html @@ -0,0 +1,50 @@ + + +

Quota

+
+
+ + + + + + + + + + + + + + + + + + + +

Permission

+

APIs

+

Actions

+

IAM Project

+

+

Enterprise Project

+

+

Querying AS quotas

+

GET /autoscaling-api/v1/{project_id}/quotas

+

as:quotas:get

+

√

+

√

+

Querying AS policy and instance quotas

+

GET /autoscaling-api/v1/{project_id}/quotas/{scaling_group_id}

+

as:quotas:get

+

√

+

√

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/as/api-ref/as_07_0211.html b/docs/as/api-ref/as_07_0211.html new file mode 100644 index 000000000..a4aef050a --- /dev/null +++ b/docs/as/api-ref/as_07_0211.html @@ -0,0 +1,72 @@ + + +

Tag Management

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

APIs

+

Actions

+

IAM Project

+

+

Enterprise Project

+

+

Querying tags

+

GET /autoscaling-api/v1/{project_id}/{resource_type}/tags

+

as:tags:list

+

√

+

×

+

Querying tags of a resource

+

GET /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags

+

as:tags:get

+

√

+

×

+

Updating or deleting a tag

+

POST /autoscaling-api/v1/{project_id}/{resource_type}/{resource_id}/tags/action

+

as:tags:set

+

√

+

×

+

Querying resources

+

POST /autoscaling-api/v1/{project_id}/{resource_type}/resource_instances/action

+

as:tagResources:list

+

√

+

×

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/as/api-ref/en-us_topic_0045219159.html b/docs/as/api-ref/en-us_topic_0045219159.html new file mode 100644 index 000000000..9e91f0b70 --- /dev/null +++ b/docs/as/api-ref/en-us_topic_0045219159.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+ diff --git a/docs/as/api-ref/public_sys-resources/ExpandCollapse.js b/docs/as/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 000000000..3f1b7db00 --- /dev/null +++ b/docs/as/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}}; \ No newline at end of file diff --git a/docs/as/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/as/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..60f60762138fe7d98fa081415cf26a4943897779 GIT binary patch literal 2752 zcmV;x3P1IUP)pPa!Eu%RCwC$n`u~-F-BFk{0Y@>jH&Wt02T)4n7aXBssVicB` zOX`JaF2{q_2~&#?rkP8$id|Xfs23G(+0lTGT0tnFxgZFMIx;xG$R>Lr2ng2sFhB=q zSd{Td_5QEx{V+WDJooe7@Bg{)|8u`XpV~`~ZvvYTAfN{@5<(zAAd&!qNCE^R2@oI< zNq|5k0e^NPrRGdyW8`F%MH7XH|3P8=s2${2dg49z003YAM?%tm1!4=85P2aZJs3WS zG6CT8kCv0C(eT;v!9vu9jP&3oZEw^8HmnQ6+clMCL4mv(zK?)Ob8&M#`$%sr@v0v& z@zoUHs-n619H>uFER~Aj==ntk06q~XtAWrX`-(7l=)GLjQP?!@q z{@ZTZw0`amLgo~4vvd&0Pxryp)QHy>ob2%4P9)V*SX4zr!(BuoQ>IK9!d&k>z1cqI z{8L;})njUE#LIJj>h%6Q^ZVF{wB;i;Qi+5h9}NJn%x@raKm6;fW+Fl#T`67idLh|4 zu~b$4-1hhHTVfMtV@>p)0G=3ns@?Zq+;oGKv z*YE#+n>`1!`TpdYF4yhs&w)&meoVo}#+v$ur`WVKNyq<%YnFsZMC$eXSc!Bf$)AMeNOrxm z98up?0IbZ4d1uoLyuSG}0{xcY?H+G%68SDpqp0{6ZmtR(?ChBNKk$ZxK&chd%Fub9B!C3$z*oSdfKP$^R+Au*=jW--Q5@}8T8wOFz(A> z+jPJi0CSN!@M}8~J+m~H+qJd0$mL8L?}^W38D?fiTvJtZ_QG{CGOx1j!^2co2eNIY zE_th}e&*28WCEs4)4Ngh`F*TJs&5jrEg}J*$>Ry|NTs@Q5S4XS*jiLGYupV!l}OmJ zCkyWg!}|T(8zmGK-@ggmTpXX4Lzd^H6d8Ibpk8+o_km$bMW>TS}&FY)P96F+{d%+84 z0FbR#^Wj0eUL$0WrHtk7-A3#N4!~oiv))WDwoq|!rza!b-MC#_%g6i5bZq+f?}v+A z&dvOM*6oz`?o(Suoq{*R_pvM}5O;^mT)Ww?Z7fftAwAED0FP9BCXZ)ZL<03qVuSdN zP8xtRONCq}V{LHL13e@F7rC5Q7nL%1)>HuEPG%TvZ9T=8(JF40lp-DCMCkm>9oo4$ zp2gbI0)X_(**fDB#*QLr-bCyM4&cnWE2QR3>%BzUvd0>L#Q|n|$1Tk60kC$33wat1 zyP`b|;`hpR?G6;%TDEA7?qPdG5~XG3DCEwFEmXV^*atUP1r?Q*Z6tf#C@HG~z|7R7 z%W^bSHmKdEz8|Y+XCNKoj5;@$;5Eqx+bjkplCo$bd!u65ur3Iht+xK#S>J1CGr+PQ z0C$JWZS8>kO3xnquB&Tk(E(-;v|eN5zDOk!LKaKgc6D>}Jxa^U*&dP9D~M#(l4Wdd zEW5NF>oE`jQ&SV}G+O8_@4Ge+!`aD+oB8?teVaq?BU0GA1xO_l=1nQrAx&+WdOB8S#d?X;+5%{W zL%$q0tP5gqR7{WS^|&#ETLM_$tqfODr{F@Wvh7$L9&xbkIv%IZL`G<~%z?=et2Z8l(~lTRu|vXblrbH{CQq;M*jC6P7 zAFJjO7P_e26);09x-VYJYSS8{M>uNB=$!_=`UBu*VJQICR{ab{qy@7TIM~}!cc+es zuSRv+yK8E024LzW_fF?DH>qIv7JK9}8Okgb+deq(_=yx1KZZPwhLE7)i2By(j4ulc zZ0X+G=!}W_*0i+)j$M5C6#K-`Q^PI#NC$_uZf2|)Q-QCDmtJxjn1b~m%uQ)q7k*!v<@zee~^S^yy8n;SIv9h!z@F~L` zuV;E)#MIP`TP3BWq~-E)te=ie;#EKP>`x<4qruHp!K;f(yPS8hZ8~d0reR}ajZ`A( z(HeW)kgTXvuy(`eEDH)`tWfsw@ySLcm z71)pX#Is~7?MOOfjY2*gfad0Vq-SPfE=p#UyBs4UBW!G}*%&$+h}RorbCI@}bUZGD z(D`DX7<2A;EnO+wSMkI5S3ZiysJKOPz zXHjNr`1+U~!-i@z2TQevhO_F+9anqo4qDp6*s z{^#^#iMhy}=wm-XjcU;ayd~S zjKa+^{((2(%#||Kxw$%iyNf&$A}5<97d+PwF{vJcqF5t}K17 zWA47SPe$ba7&NE7d;EGLztWTQN_%qi?{fFvpbejgc;mTn%wk=QtX`o_PVsJli{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/as/api-ref/public_sys-resources/commonltr_print.css b/docs/as/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 000000000..a59823141 --- /dev/null +++ b/docs/as/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/as/api-ref/public_sys-resources/commonrtl.css b/docs/as/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 000000000..947a9a033 --- /dev/null +++ b/docs/as/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. 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/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/as/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..47a9c723532a0ac410285e5152684262127922bf GIT binary patch literal 2771 zcmV;^3M}=BP)pPg-Jv~RCwC$oO@7HS02Ydnp$REOA{(Mow8*Mm>A3h9MeO=6 zYU>mmT}9emv9DQm*RJeXc5T5Q!v0 zB$5b`NFqdtL=w?OklwC|&JB*_kR*g*P1STeQY~6uB+{*;B2i1mw!HxCh>m7?uX_kB zZW668hPGS7cBvYGjjLu-T2{ta(MHkoqDQ**khXqXE?M&}B*qkwZb{|!wVV0PLl1U( zh|@k2Pt@e8KI2W7%cc| zO7%;oh!GEaKI?~$MKHY5t{0Ps=^60OI`;KR@k?HRh+XkChOueL!}QpzFXL=(zz|LUxf|B{Fmxd{EXn6tyV1mZmG!*PMf2b20p#%- z`o8%ZVfQ~su(20?SHHrs3D0@S-1|flxSZIlFT0HsqCq!dAXirJ4@lTnmkYTz0`t-t zoL%_-P1mIvW2W1<$B}7tG*?~Z^s+@a=y&VTO-%?Gh7Jy#@{?>}D?H+5hs1sBQ0R>W z$rPxPB0JS9by>2#BO!*;vNGmn#B$c!n|>2>7?JiN4?lg9=9Ul^WTvn;zkmZNJ#I@f zXfLYayW|WUHCNr9F<}t$c#W4#+=3U8s&%wF9keEQnyx}+}N<*(D-{;R$ zaL&lM{`n*i9mMK`CvfP6+g4qiUbYCAy$P8{NBGDGJ>#mRNP+|zE_)NFmo4(hwYIv@ zj4}Jw)#_@YXz^U^wkl+5Ed$yU@(x$pVxcJ-ZmXBjPZHcyBPNTQ@jT3znFTMzB|S?h0gxfpz6m)AA4I1f{{Z$&2y zk3ciVjBaWI{dcTHs?p)HH*sm#raQmUz>fucJ<0Wt1$&7Yo{Gv8hdf^6w-o?Tw&YWcsTM+dBoLi8 zm#bgrQM3K5ud%~av^tvIiFi|^-&R4OlHQ{uGz@8In6F1rD1F94&As{c8*2bi=#8{A z)KIlQhtnC$?tCJxvO0({nRs+qm1oR!Z=IKnF2v^f{N$t{)~t1Vv2?ngNK$nuGEKO< zzf@ihKvc#!1ci#0h8lzrHSz1+9!LmL<7})$rq&Yk)GWTA^F~0u-~E0TNjvu-Q)}t} z)&}+s8s@*>B2&1%Q%tPac=st8NJG2{;%siGF;7#NJH;& zhtmrs6i)v0ou4BeO^#u2egO+IQwUR3_$5wT3!n{#&@*Jsx3K<;Tq+W^T~4H!KR$~@ zu5|Zlat{Mw&iD(0QiW8dAv|#;hS6ylMyC;;I1(Y)o!@mEZ@FnQU-ZJ$IBKhr$d&Y3 z@~n?c&GxedN!C@{=B92P%iuKA4P5P zF?T5M7UQl=?_?r5^a9HdpCWnaAVwy9ACNdxCO+iz-A9L25o0p3%IfG+5=G4$jjDT3 z_rX_P#9mZ`W{jEERu|5u25kR1=sC=`>*|qQT57FGWQv;}!j;wgsVgZ&P^ySbnS#<_ z@{wsQcZWQgM(3rkuisR2@ddhKm zm>y`QU}}cvFx#%9zncRR0f}5m+=3T>`k`rb(CYH78vp)0Ee*BEwGqTVll7BY1|4qD zR@y0eaw?7*EAlWsiJLyTGjpW6UP@ltw4HQIDv2=#er2YNQnNeHL|TgfF7e2O?@1my zh~&SD2{!g(;QB4N?2Xi&J%utn0;xtv zkRbctK7@An=2gu(9Ra)bZS!9G@?)aLPe-neAnxr2otkuaibwkB-UtAuk5dGci8mbQ zpHD?%2tDKXzEY@Rj-@xHWo6{`Gk44bDS}ZNOehT|CG6gP2Ggpt~a%lW$PyZ(R zi8N$tEzX8o&aMocNSD04oR)@K6nZ1(%xk%iRHX^nOsp#j+)(^s?wgdX$fl*dQ#vN{kQBLN_&` z(}>jJm$ns&TBh$jOxAo08KVLl?;k50S@-!F7S4`i=H$SR@bCXNvu5pPHYX!BHAMhH=PbZLgf2GrXYPBlYfJrz}; z)`4zn0@|b`lo3(5nj87CARk+Pp-;mw(B7`!W7{6u*6MHG>-993S9MlnGP}b>T0X$Q z*4=p=+dA4SslE}Gg;&WhtYpG)6U!Ea29!H%?ahd^54+^o0V28#9s2{xQ^UKnb$1>s zUY^}9i2&9v4QJu(xOPbdVAh?wt?d92zi^J^&vgoySb1+qmmi0B}` Z`Y-il7nw201!5QImN;7^FeRDuvlieQm$nqSgH2#ST^0cx)=Dn zcnY!FJo_HPt-fVW+YdiB+UT#;6V;vF(d}+cR@IeV(d8~pF{?8>qtl(5 z-l&f3hz@sXMqTY}N84?I)T&mtqU9C|*g%8DFx{Fx6Im5iuF|X}%dCt_S87;LjI4+X zS7=Dl>numvWx_9&xPzYqFMxz!h@dKJnV+WiNj6zrg25Bat1rHX34YcM&(@mM25EsKp^s$!A zn#VD|u6s{$op5YkSDD^r^tisfo6%**9APOOq(ypevUm*eg627JCCoz;t2Wm=9wHzA zIZpn)d?D?0K6~e%(5n+Y{``IW_383vZ~ype`|Z!iyVvi|9^OBm{E(}2>Xh(M9J1dY2CIYT07X)PL*D{uoU3SWSe zM5)Z@cZj(9E!*Rn@%yj8UtL_@?zGcisVAyCyQACPnyjiTyQ0fonqpRGc1EW=HN8j060m^=i($GodnU3fs$8X6OO{y~m9EsVpcq*Z6|T^b zqSslDvde-aqopiG$tAYJ8Zb!15?a()3^veUF{}|ZIT4x8)aYX^Swx02G;(1<(UEpq zsD~82sYp46Jp6zr)7XK2NT3kbfI%9Tw8DeMU;_=7#;04Wd;7XW>CRXi!yzvnE_|I|r wZ*w5M>1_7SKcT}DJ@4vn|M>OS_UPly>%-H_{r>p;)5Xs}-+pgDf7s~DJ6{D>Q~&?~ literal 0 HcmV?d00001 diff --git a/docs/as/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/as/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 0000000000000000000000000000000000000000..84eec9be2f2ce458e888f8a9b803f9387247726a GIT binary patch literal 68 zcmZ?wbhEHbzkByxQ$u Mo$o?7J5~m305MV#!~g&Q literal 0 HcmV?d00001 diff --git a/docs/as/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/as/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 0000000000000000000000000000000000000000..39583d168d6db303b366b5b8c1780698a6bb6017 GIT binary patch literal 70 zcmZ?wbhEHbEMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/as/api-ref/public_sys-resources/icon-danger.gif b/docs/as/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 0000000000000000000000000000000000000000..079c79b263f4b48089f3b3256154c73e7699593f GIT binary patch literal 1086 zcmW+#YfRQ<6hA3LZMyP?V}KhnEtF{Q4vGxS52AozEVM85nq$#%tv8gRF!3GhgM?_) zd5Luv3SKrXFTGCpn$y>EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/as/api-ref/public_sys-resources/icon-huawei.gif b/docs/as/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 0000000000000000000000000000000000000000..a31d60f895af919d33855217ca02daf4093136d7 GIT binary patch literal 2767 zcmV;=3NZCYNk%w1VaEV40Oo%H*MEWRpQG)+!RUX6`tR@RDKg4%aM+KK_}}3B+S#H2 z0rt<*_Nl4!k%7|y4fwgY^uNNg00pZ61NzIz@q2NyEiLIHE%S?g^NEbfKt%9!YU?yQ z^qh&+U}WbD8{q&E?Mq9<013DN2H5})@N8$u01CkX3Fs9f^{bWHKuGLFOZ1kS)=*aD z01@p=RQ9r(>pemK^YiUeQPU6`>94W!hk53YleQ2Q>_SB7aCr2fj@; z@a|n&?qX^0W?<$J9`9pa@`8Bj9VzWnT-qQk!yqQl01W6ECF?mp=LHtlFgo|Iv-PHs z+HiFBprpVM7yReuz5od5zrUyu5$;)5@{gDATVup9HOgRO=U{2(0u;*t3-Hg-^OuGE z;N9vkH}7a--=Co1Fg#jPP{_r^k&B8kCM0%mZLFxL@$v9KH8SJk;?~sDy0^BTnwV%{ zUQ9zlgnfM9U}wHiP~xwz{`dCrZ*%7e7{X9d^{Afom69VE761SLA^8LW004ggEC2ui z0LK6@000O7fPaF6goTEOh>41ejE#|lU+C8$A-c{-jb1$W_sAqMbtN`+RZ#DGFR(dnrcRE3N%f+!F;*y7(oOv#1FPiAwy#YP$z^Q7U<_8BLs** zMSr>_(L`oBgxA?;z>x3<218xJ;14v)$l4!yG&Wrk_I1$$0*;vB$B=#`at4uppizkb zkVG1Zq>_oSkp_`a7SaZiZXiMjk!m2q29j+I!X%PpB5B5wO%5V}2qJRl1%NsHfxr&G z=|x^!dAKu_41Dql0y7LOA)N(0dcZ^rABfh-m_;ITB$a5UdB~$fR(S{-NTzYfmPE#Z z$dyBCddM0`(jjJQ3^=Hu0tmpW@WUTds1O^W zCv4aPqTVsWsFRSgiX^m^Dgr8zYZ&qdl5-rgEs}5?A_tOhoSJHxtD4)WAg_+-CV)r$ z0l^3=PP3O0e*huI221P;!@n>Lqi=>hZs_9&J75vyw2nR*>5$YWnFy(5hH1$EwSHt- z2&Y^c@+FZL3&QBRsy<8z0uiv;-+usJMIdJZ34w1G1pu?}1~|L$M-&7rk*ppEBV3oW z3{UE?w2~S^sl>(pGc6ETQUgwH}48uSiAJo0SA(QX~FrGzYvq#TC0!EGVmk{K=`YG64w z*^4Iq2N`U_YT26(@Ww;iA6V3a3V*n8!U;+!QN-&o;K;WJKrdVR4kI*6wC0H)Z8+gt z8&Y|wjA~4X(?lBohtwStGUbrnULHxSg=BE{y8s3-FXI^_2KJ7l* zPUi?^WVSHxgDj2s;6@ith~r!?-DM$hAerqT7$efv{s0FgQSEnvBN74j@P$DTKnvHC zONlTuy0+nk2Y*mO7rMX%Cg?#AOZY{0)h5f{2_S7&W;+3~xxv`varUz{DmpF%e^`f&wJ41t9(5fhwzv1mBc| z0U*EuBM2j%FvtTFnh*k5Fk|UZh`TZf2my8Qf){uKMUtgzel#qE{5o z`T+owlz=pEZ~#HrKnm`Pm2OzzgBhrem4EOJodD;_ahfxf-U+}Ak|4_v=x&*|EE67c z`G;K+;#whFp8pE*u^;}yhknQwAj5S;KNQlDsB)$xqbbb@AmI*w_<|O)xy2+vAOLDp z8yCVE${l#|oS_`S5dZ^$BP4;HUf`rVX&Fy4%@bn4W7;49dBA^~$q>dQOL?8kgXdnQvsYOnDfj24t0FVQ&GJsH);SXF0X(+eq z0|aFCq_QkQ2uwgnL@)|$U)!lnaS7A<-BO9Aav~Zq1~shtZ;*=2X&Qw1zoAY~flO_x zQ=i%a0w5p*o16;-5U|cJ{sE(En`{^}sx}@hzy~=vDN0qkRui}|sdcU4U8UAnL&&wT ze-NTA73oVe_41G0LefE{2Z>hMA+geI=u@QtfIkQT2`1nUZwBxt8^}v-apD4J9dHDm z*r2j$RqI-*fP_WBP>(V+WFp;)q}Cd-rO7KqPBT@AJ}!>D^n`Dbmde!NE;eOIpur!e zT2+HIfiCh&!V$`4~D_J+6+9nP?X4+~QQR3Nd6O>yUni+~O!R{(#Yf%|x3 zV=w6V57*_SoPYe_5lO*{ETyMCXS!kI{qmTJC@5?}tYs@Z`Gp%cnIOCjX8WdC#YjMN znOSg%0i?hn3uwZe>0DG@D8{!L9NVviU!0?6(AlZm;xWpa)Zb-c0Yf<`I615cvC$3@R|NPo+jf8PRu)%BB zhMd<%u5!4#ylXATHvtr$a54bk<~ZL%26n#lMX-S98Gr)LaZUq?L;OQXHv|E!0Ok|h zR|}ywHv~IJbrC%JsW+&2(zpJHJ2XAlm3#yMI(PL)OS76>Px~OC`E{mNAnK0zLI%qI z)ZlJG?RXaiuD@;tv`>NzH;90J?Vk56!rvj>leB^Xjy?$j0N@7pwE`ImPx(Jo;pSvu Vyd?-=a{xfJ@}LjB=qC{f06U7uGEOJ7jGVWt0R$WZ8s=je-u*DOe&kq9}!i z4KyN^y7WUtlMt&*F%bljtRbDEJamX6>@vOi{twMwE+=kqtJr%yLc-a1j}Z>-)`f9GBO%WDhy=L0>5=eLzUZCI?G``P_| zXl3c^-NL}=_M!Zh=FG7pU)shB58htr9~}O0uVbq2_rt-Fxv_(zmmdB7)lfOReyZ>D zrqum6#Z#+~moGM-oS4Ziby(A(@4L&ZrWcR4wV&_mTide#$G4kXKF-|cGp}2pJe$2t GE&l)<3Z_>8 literal 0 HcmV?d00001 diff --git a/docs/as/api-ref/public_sys-resources/icon-notice.gif b/docs/as/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 0000000000000000000000000000000000000000..409070650a49518feb1624c624d814c3bfa63d2e GIT binary patch literal 962 zcmb7D&r8&C5S<{wSd_qn6)U)w5LOaRh!N}_*49lD)S!dZp@M<3gPIX|@UR9-fz+X3 zAaT9)OY{xZtO-;RC85Vab;JEUNIMS5f^r$7-e%-XK`j{0+N$CsgpRd6B1wp z8dw-cH^rU^H4`&7qgabf)l^K`l!66{q9$U(CKRO5%W5pfY)s&YQ6n`HBR0ZTum%`N zgC%I8hQ+`JG_WvCAt-W$sIn@BKCDG1qQWW^a=`*c7G+i@s0S(ZDv1&+K_2`7O-#cM z=m!ZX1Z#kSG+3e)Jg^wpfCd(Yb5TZ)U=a!DwsG z)Z`|1ejMK4ap%CHj;%+>T6=D++5I=uBbQ$fZ48cf{hV1}9&Njl-I}i7e0#6Hdug@s zsr-57_=gLr&9Ros$k}}M>tJ77=hEJ}iPaZ%8|P+gUbS|Oj}5I{|5nZZc)C1$e*Rj` d`09hYXJ4M@PhCx)dHK8WZo1*|*q+^V@*ncduk8Q; literal 0 HcmV?d00001 diff --git a/docs/as/api-ref/public_sys-resources/icon-tip.gif b/docs/as/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 0000000000000000000000000000000000000000..c47bae05c9fd17c02a851d96cfac67bf194498d8 GIT binary patch literal 879 zcmchWKWmj?48@OdDOZPr)a61!OE4yGD)salg#|^Ix$qIEF#uk)V>D{95e^!2r`i+9t# zTMu5YtUcd+@#gp0tDE;9ug>oLIzL$6dOx4-t#2PKExu1KulwoYeD?Os#mVO%AMWih HO|EMGZQ&sWI^~+e%qWysRPK%BSD+f4-fabAGq;|Cf|4nO{(o zMH%#n$oXf^sdM5SJ4e1UbEeM389O82RCB6M#VI=_KP%=$orn{5LVlIau{svV?3jS$ z$Q-F7am0>L02|Q2!ZN1G^Z2J`V#a3VX;G<~iYc3tSAnLeiI}hnc~O{UH5OwwCTPT} zks65+8-W$70S3`f30dfY7}$UY7M95y@-?2QvMPChphYF3!YbtLLIs*E%B)Oq4^fy^ z5+zoGJ>&tI*hU=i4-s$()c}KNsKh9AfEd_-1{V3`d>b_$i;xcz{y>Y0S(uP3>_P>a zLM((Fku(B;E{r2+xJ8u612VCVIG_oJ;Sj0;2GQ7rEa(6+umMf}M1C4=)Odu8AxQWG zEh;Aearj(=d;4Z^LLYN*6+asU?Nbl3^Q%D|{s@6Xj}(aZHwkoj-~bw*1FnSd;0aX! zUW<-TPD&b;6s;@zw7K~4mF9cDuK&BQ;b_N-Cj%R=CnEjde9%~1kk}vYY^@mTTNm%F z?mbrf*~d#iX;?ITDf(MHQdK;&p(ek&e9qe?*&A0E)mG(1s`J*pn^#ttId4vCXjV$j zj464u)2F9Q$V#0!dHk4(FDB#D&wP^f0*q1)G?4!%Xe>;ROD~Oee-}xfJUd+aa_0AK zFP$vgR2te>+%}b$hVw&Ni`yT>F5LNRM@_utk68Piwi5??BLBpCcb8mx|3c*1x!xZJ zKU!7(#h8s(^x)5*w=Z0K{=a9#qeoHU|0&%MiU0rr literal 0 HcmV?d00001 diff --git a/docs/as/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/as/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..57a0e1f53377b28fd80ceb393b035f8d9b8b392a GIT binary patch literal 1080 zcmV-81jqY{P)pI>PbXFRA}Dqnq7z+RTRg6r`*v5D@IBmL~4s5$SN3-f`YICkrqS^ z3O*?4J{4psT?>Nv;P$DA4|YKmeJd1v=!+{-P(e)MT23E4 zfpM5g?!;YNyXOywggfWv-aG#}pA%7499KRz`7Lmw98Q!I<#3`LPLvbnaH1TQ5UMEG zlVk_b1{y%CK&5Na8Kh~iV1CQyHSIUD=$Ui|Y1(mW{t2nlnW!hpqTT3)%#9tQ2@Hwc z4!jG@4brq%Pm%+`OlEvYXy4{GY5awd{We?gCpulWuT{Z9`oN)jk~9ZtI#ba@Tm#IC$eXI#i?GB7 z@C|Siuxi7{ffK+jzyrW_z5t&id2Xi{7fGOZ7RUNhF z=`q(YYu4B2zr}fA1-My6UW~A&C(H`Z0J{sqLLYb>ST?)$UTJH~j4 z)U5D`kx~@HyTBjADBwh`9UcOHGnaO3gx+o=^sFTdqcDs&7cD!S1Y1R9DJQENmMBXi zUX68u7SqPL=oS0?tDydiCJNY=lMCxo@cxg;Iw&H0tZv&cB5#jSkGc8v45{4-xAi@+ zH#c^6Llb3aTk2cp0#8`%*2*ZSb3DivIwje71|rV*JnwHI2e{V0 z?L}VtT_k|}D>qFKHz^_)cUMxtxkDBWXzz2D1oirfKkqs5Z>m~O`i+$JJR1>-NN>fsG-Q5hHbmeou}1??2@ zp;^{uvz{qy3k557pH|h^|K(Paf~;?wS^K(J)S`9Ki+p;|vZBS3*BostG+QG&8PgN& z=@C2h$ubuxBJTs&=XH#%UFPZrh=oAMNN{DPG_uReuDWcPESRPGOKD;{Otwcu3X@*QY`k0+@}-e yxT4{IZgHXpLI!Q!9RCwC$n{8}UWfaGMW8J;IUE8&LY1fUhGLTVa3!QBW+ZA*L=y*M3rfr5il?z?dJZieJ#47>M$@*mD4$1ecadv1qsU1#wR$;qu4Bmh4yS`Hi)ReG=4*#e zajgEV5YlLPaKTMvrW)|6L6Y@JtlU|tX}9u@d<^;|8a!TJ`kRn8mKIZX-z)%<^+`jn z738I}>P{CwooQ#@mc8ItdHsQ6rsk%O$iLY)*x7Zcj%}lwEK@`-=;otzSyX+&p9{kzQYbgSF@Q=2Qy+?#VW0=Vy|cYT&lQ@%;A2YQ{hH z9%ov+34{hBa~SnWOw39F;7p5`9$z4G?cJ)An*I*rb~&khdI=d8h1SkK)If-j5C2TB z8p4%r<<^31tR|Tw4Xs1QHMjMk20}yD8f4p%dXd_$me9Z-SWPlj8%nUOe;>LpUUAI& z1+$nxI~Q3>q`9q!{1-nPlEMa4o@e_SGSdvCrzn))J%_ut?ipfIn4e4CD=Pq4zT@D? zqk$|@wV{L*qfBG7mtFghv-Lntl$pcnz~kwNI)BUSUuvgmQEXp5=UThz?DmmjlsW$V z@)3#dyh6UbBYa%QD%n4gom-Glu20@0My{Xs3VRpaU9=0QxbJP-J)Pz^`?kOW30Tn z@ufYqb@gL4$<)8N0%S?kG%v#(IqvH7UvcW1v+a@N8!}9Baks0-uUUYP1beE1+)Q)S zUobczB2ql)J>S90pM1~e2X4k70q-59;@Rj(Ixc6Ok_Z$V@dbE+GNTrV;HlFQ=lRMeN%CX^J*|inqrfX$fdWuECU& zYE~#M%8xCgqI||*N`--7Xw)BgEZ#bB0-qYhW>q--LhLmBU*r0E*5+4PP+l2n2}rtV z_qXh+#jl32SrvAyo2R)OD=o_BoyYIMW>x6y_Tety7r)3^eF8`TK$3KP{`eA2F}YpN zxa|~0YP$+*PB&3e-M~W&UFbFHknL5q%yVT?GB=Ox3?p^VEh7*N@$03nevU0%RA*Qe zy8Bd~e78Ejsl=~x+vYF$e)B!#In3BC3Kw>)rNi4F>6}lnndnzTghB(1f9&nZP({}9 z<_Y#X?@5R5*rUdbm zZ9zPQB)-@t_#f`t1VTsxAtZr72uUD>BoIOp2q6gsLP&yt3mvdY+y=oIIs7M?<}pwN SX0_=60000=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/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/as/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 0000000000000000000000000000000000000000..def5c3565da51684d78479f45904c0360844c243 GIT binary patch literal 3164 zcmV-i45RajP)pR4oO5oRCwC$oPSW0cb>;zfj~mSuLKN~5E4Ot2?$cVg1bfW*MgmP zwXW?r{^)GC>z&@*cI;fk*-bA_)*65J|u{1o1b~sY9&bgB!&FtPHC|>aqwkEf8t)sIV8a zy`l<$fv1-750WZjrUfER4&AbBw(qRs>9xxN*j}-pMOzA)VQ&y-TOiWJv9nVR=-IGB zL`2wi-rWtmJCwYrnwtLq8d^@54N{_E#qc2?d98FYUt9|#UM6CV$k!5{lNa$(kHW9K zOnWgQF}`S;)25`yKPRE0?;CL9SWtgolNa zrBRX}cY`9==aUXcrj$ru%8RMoU&9MOUrS=-S8j{+s~_?FOYc$kFAFFdtPOe${ncT1 z{rLzf8V%)-DtvDE-wqmRZ8xCPYAJtA<5`q3{Ob`bjZO9Fv|84D-@EVUj$Eg)=@6=E z@#L*7W|qCq*W!xRyz%}azq+NTrIL{{k5{wx9=$&5QFz+d73A@UdA>TE#nbrfC(X3B z8(6fZ$fI-Rsms(id`VH^EXwBij$f6Q%6pGy`z7a}PPWn1d>+=6lPmX*Un}gz{Ox!v z`WEl|IDGSOT%3|O*G+D{rZj7N?NbLjt(LV5jh=HqnA?U z8mrYxV|c!gMHxe<(a3REu1^wRwhaLAc*#s3m+W-80O+~e%iEuijH}D~<%`(7rkqDg z=TTZb2dmA-!DFZR&9(3NZQo)rQeiLlD~pmzCp{Of?FN2YE1pz;Th3*$^KYlnx3rR& zpyJ_&X0!Fj%Xs-G%lKj0eA3fW0mv9`|G!E9Ya~lJ`Po^X-Lx2KsErPD79Hj+q@gxm z{Mlkoes-3_qjQ5Er(oy{Vq#*j+H8D$A>2z=-J3vbyTSAQk0(04Sglr))oM!O z`@CekFQuSwX(c8)8igX37UN~i63tz8`Qdaso8^aiGyN2A&2A@2H4T81Uv&6wZ?)Oj zTifJC_?WSn~TqB!^hRw*Ad4e7J~3dFR=6G>_8NdnsMLm)G}au^{sd3m-1x^#e`g zF3xz6x-4W*PjVBduE|UGaf6#U1-aQM6tVOT40?@sz!ZhmW+Or>@p4-Zv4VXye+OW7 zc`+d&A#@sz?CP00DZSLHz!o=IttMHmrqgKTxg*zuw$4$Jkz99N$7-|j*1@mnmSvB7 zO=WExR-28GkWk(!3-#*~r7p`oB}P+1qz`Ts(`7QTajn||ZQHTiBYWfRy#Q?8q@~Mb zVxKK9=<$~3C;^C&N<0(TEz8Di8z5P&W>aZ0G0`z}8jaMCZ=XmZMWeykeJP-en=p}N zQr=uQi}bWqx=f~kF79@>Z|%3c-P>cc{E{db1WhEfM8nqKxzqiJbY}y$o33o;>9xz* zUQson-E%k07oQ_VqoK9kz%l!D08Tq~beT*pkf^ z4(PF1`pDEKqI8;gLeoonS}MI}GariryW_5*SlZ-;)XNs|tUjBo*UTssvHYZ9)NlJ) z_By_sKLd-UZ%SNTyvWApvWyA2xbs6QE?m4wVctygq*taq{STT*zcFP3uVFUm(>{fsnY2byQucdN-4PVNGGwlltbpW(qxPn=t@v%0g@(xlo8u|zNX$;Tj zL~B0)v5_*bKys%(iq>`m{r&x%z8c|~$V_b_07FC0fQu6zCMG;gOl!LV)wFmvmglg* zQ8R8V_1h;>NK8;+wORT1?%)IOmvT)cCaCB#nI=Te-qC2U(nDqS8QysRkk_a3)aCm} zq?bP(MW@xWs-)NJe1QW+nJCD~rsrxeyN)(b$ZgNE*Rg8RgYE+A=jS;+kQlUu{`Kmaq-Zo)ZC1bW*X)SP zB&*dleDyW$_FJ1<>AK4LvN>#CQ_ki!<><89`&-$rmo4DrXSKYw{l~;e&UndGvBREY zdBhz%GStSin-=p=&;OneA1vbs!`1gR{w#YP5zt^s>sevrzAfWX_)uEYBrfUeBv}`^qrW~HGWfKsmsDE zOQ*BGS9P4Wl`RF-yksh zy60FsZNNwVNWragKrk^ve!4rg7mMBdVO@#NOI{X#h4i#kMn*=saPcD79Zs)o<((?G z^^%CiJRf_Q&GJKDpRI*9vNO}^G#dG@zTAL%%&<4GWyKs~qN8as7&HHba-?wT_zK+{<0Kls4ZZI zwt3@|Ua`~d_}Me*beT*+rNNJ9iBKqFak*TiXf(`~bowmtSfv`EtT@NZqPks+{a z5!JMKPh8~>&n-znE|bw}==6Ccb0>biz(smmDwnVHu}ZPEji zzW45)-n*6<0^#-C^K4pKLR_4Zk&zJ&pEynB{*O3#>=aGS=dlkuD9FiX!}lillwCC0 z-?hEgU&dQ|syVhNu(h$+M6CR&JD%9FMMGhZ|GG+tIg8TOds)AHF)ylW?m2UG5RP)x z8t}<_w^)soA(EXPo(HDmU3a@1zaW|JX{#K%Oq;}A@|fXl@p%B-Ez8C%ib2W{N|$?g zkBuLwVmzkfoqdk=b-RuZv4S>9rqBJ{sq>hQNv?~2V>^dfL1TD6U)yB#J4cCkVw)_#|7FHwSFj&?I903+@}Q+?E}XNC3Nz=CN(ZZjK1= zEPb1Cd{SB4f1Go_kMMN4^{(v-b4ID$mhCyd8&;L{vU{JFmp>h)qCi-YZ!0DoBh||m zu>a`Eo9X_gaoZQ>jE+kpfEdXop55erJD^6gL|Bn;DJE=@t~lNAw+sx9aIkUClqxYW z=nj}aF^#ZTB`nJSYa&gTT1nApc>bmLzAo-6E0000 + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Released On

+

Description

+

2021-10-20

+

Modified the following content:

+

Modified the type of the available_zones parameter and optimized the networks description in Creating an AS Group and Querying AS Groups.

+

2019-10-30

+

Added the following content:

+
  • Added the without_any_tag parameter.
+

2019-09-30

+

Added the following content:

+ +

2019-05-31

+

Added the following content:

+ +

Modified the following content:

+ +

2019-04-30

+

Added the following content:

+ +

2019-03-31

+

Added the following content:

+
  • Added the multi_flavor_priority_policy, multi_az_priority_policy, and instance_config parameters.
  • Added error codes AS.1085, AS.1086, AS.1087, AS.1088, AS.2053, and AS.7016 to Error Codes.
+

Modified the following content:

+
  • Modified error codes AS.1017, AS.1018, AS.1032, AS.1036, AS.2038, and AS.2043 in Error Codes.
+

2019-02-28

+

Added the following content:

+ +

Modified the following content:

+
  • Optimized the document, including the function description and parameter description of each API, as well as the format of request and response examples.
+

2018-11-30

+

Added the following content:

+ +

Modified the following content:

+

Modified error codes AS.2015, AS.2035, and AS.2042 in Error Codes.

+

2018-09-30

+

Added the following content:

+ +

2018-08-30

+

Modified the following content:

+ +

2018-08-14

+

Modified the following content:

+

Accepted in OTC-3.2/Agile 09.2018.

+

2018-07-30

+

Modified the following content:

+
  • Added the AS bandwidth feature.
  • Added error codes AS.3050, AS.7061, AS.7062, and AS.7063 to Error Codes.
  • Modified error code AS.7047 in Error Codes.
+

2018-05-30

+

Modified the following content:

+ + +

2018-04-30

+

Modified the following content:

+ +

2018-03-30

+

Modified the following content:

+ +

2018-01-30

+

Modified the following content:

+ +

2017-11-30

+
Modified the following content:
  • Added the function of increasing or decreasing the number of instances in an AS group according to the percentage preset in the AS policy.
  • Added AS monitoring metrics.
  • Added the following error codes: AS.1019, AS.1020, AS.1053 to AS.1061, AS.2042, AS.2043, AS.3035, and AS.3036.
  • Added parameters dedicated_storage_id and data_disk_image_id.
+
+

2017-09-30

+
Modified the following content: +
+

2017-07-30

+

Modified the following content:

+

Added tag management.

+

2017-03-30

+

Modified the following content:

+

Added error codes AS.2015, AS.2026, AS.2039, and AS.2040 to Error Codes.

+

2016-12-30

+

Modified the following content:

+ +

2016-10-29

+

Modified the following content:

+

Added the metadata field to Creating an AS Configuration.

+

Added error codes AS.7011, AS.1049, AS.1050, and AS.1052 to Error Codes.

+

2016-10-09

+

Modified the following content:

+

Modified the volume_type description in Creating an AS Configuration.

+

2016-08-25

+

Modified the following content:

+
  • Added regions and terminals for the CCE, RDS, and DNS services.
+

2016-08-09

+

Modified the following content:

+

Changed the maximum user data length to 32 KB in Creating an AS Configuration.

+

2016-06-30

+

Modified the following content:

+
  • Modified parameter description in this document because an AS group has supported the binding of multiple ELB listeners.
  • Added error codes AS.2037 and AS.3034 to Error Codes.
+

2016-06-16

+

Modified the following content:

+ +

2016-06-02

+

Modified the following content:

+ +

2016-05-05

+

Modified the following content:

+
  • Deleted Parameter Type Description from Appendix, and added parameter type information to each API in the document body.
+

2016-04-14

+

Modified the following content:

+ + +

2016-03-09

+

This issue is the first official release.

+
+
+
+