El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.
- What's New
- Function Overview
- Service Overview
- Getting Started
- User Guide
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
APIs
- AS Groups
- AS Configurations
- Instances
-
AS Policies
- Creating an AS Policy
- Creating an AS Policy (V2)
- Modifying an AS Policy
- Modifying an AS Policy (V2)
- Querying AS Policies Bound to an AS Group
- Querying AS Policies Bound to a Scaling Resource (V2)
- Querying AS Policies (V2)
- Querying an AS Policy
- Querying an AS Policy (V2)
- Executing, Enabling, or Disabling an AS Policy
- Deleting an AS Policy
- Batch Managing AS Policies
- AS Policy Execution Logs
- Scaling Action Logs
- Quotas
- Notifications
- Lifecycle Hooks
- Tags
- Planned Tasks
- API Version Query
- Application Examples
- Permissions and Supported Actions
- Appendix
- Change History
- SDK Reference
-
FAQ
-
General
- What Are Restrictions on Using AS?
- Must I Use AS Together With ELB and Cloud Eye?
- Is AS Billed?
- Will an Abrupt Change in Monitoring Metric Values Trigger an Unnecessary Scaling Action?
- How Many AS Policies and AS Configurations Can I Create and Use?
- Can AS Automatically Scale Up or Down vCPUs, Memory, and Bandwidth of ECSs?
- What Is an AS Quota?
- How Do I Fix the Error "The key pair does not exist" When I Connect to an Instance?
- What Types of EIP and Shared Bandwidths Can Be Adjusted by AS?
- What Types of ECS and HECS Instances Can Be Scaled by AS?
- If the OS of an ECS Instance in an AS Group Is Upgraded, Can AS Automatically Add Instances with the Newest OS During the Next Scale-out Action?
- Can AS Add Yearly/Monthly ECS Instances When It Scales Out an AS Group?
- Can AS Increase Bandwidths as Required?
- AS Group
-
AS Policy
- How Many AS Policies Can I Enable?
- What Are the Conditions to Trigger an Alarm-based AS Policy?
- What Is a Cooldown Period and Why Is It Required?
- Can AS Scale Capacity Based on Custom Monitoring by Cloud Eye?
- What Monitoring Metrics for an AS Group Will Be Affected If VM Tools Are Not Installed on the Instances in the Group?
- What Can I Do If an AS Policy Fails to Be Enabled?
- How Do I Install the Agent on Instances in an AS Group to Use Agent Monitoring Metrics?
-
Instance
- How Do I Prevent Instances Manually Added to an AS Group from Being Automatically Removed?
- When There Are Multiple Flavors Included in the AS Configuration of an AS Group, What Order Are the Flavors Selected in During Scale-out Events?
- When an Instance Is Removed from an AS Group and Deleted, Is the Application Data Saved?
- Can I Add Yearly/Monthly ECS Instances to an AS Group?
- Can the System Automatically Delete the Instances Added Based on an AS Policy When They Are Not Required?
- What Is the Expected Number of Instances?
- How Do I Delete an ECS Instance Created in a Scaling Action?
- Will a Yearly/Monthly ECS Instance Be Deleted If It Becomes Unhealthy?
- How Do I Handle Unhealthy Instances in an AS Group?
- Why Instances in an AS Group Keep Failing Health Checks and Getting Deleted and Recreated?
- How Do I Prevent Instances from Being Automatically Removed from an AS Group?
- Why Is an Instance that Was Removed from an AS Group and Deleted Still Displayed in the ECS List?
- Do I Need to Bind an EIP to an Instance Before I Manually Add the Instance to an AS Group?
- Can I Apply the Configurations of an Existing Instance in an AS Group to Instances to Be Added in the Future?
- Will the System Bind a New EIP or an Existing One a Newly Added ECS Instance?
-
Others
- How Can I Automatically Deploy My Application on an Instance?
- How Does Cloud-Init Affect the AS Service?
- Why Can't I Use a Key File to Log In to an ECS?
- Do I Need to Configure an EIP in an AS Configuration When a Load Balancer Has Been Enabled for an AS Group?
- How Do I Enable Automatic Initialization of EVS Disks on Instances that Have Been Added to an AS Group During Scaling Actions?
-
General
- Videos
- Glossary
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Best Practices
- Quick Start
- AS Management
-
FAQs
-
General
- What Are Restrictions on Using AS?
- Are ELB and Cloud Eye Mandatory for AS?
- Is AS Billed?
- Does an Abrupt Change on Monitoring Indicator Values Cause an Incorrect Scaling Action?
- How Many AS Policies and AS Configurations Can I Create and Use?
- Can AS Automatically Scale Up or Down vCPUs, Memory, and Bandwidth of ECSs?
- What Is the AS Quota?
- Why is a message displayed indicating that the key pair does not exist and the operation is discontinued when several users under the same account operate AS resources?
- AS Group
-
AS Policy
- How Many AS Policies Can Be Enabled?
- What Are the Conditions to Trigger an Alarm in the AS Policy?
- What Is a Cooldown Period? Why Is It Required?
- Can AS Scale Capacity Based on Custom Monitoring of Cloud Eye?
- What Will Monitoring Metrics for an AS Group Be Affected If VM Tools Are Not Installed on ECSs?
- What Can I Do If an AS Policy Fails to Be Enabled?
- How Can I Install the Agent Plug-in on the Instances in an AS Group to Use Agent Monitoring Metrics?
-
Instance
- How Do I Prevent Instances Manually Added to an AS Group from Being Removed Automatically?
- What Are the Sequence of Selecting Flavors in Multi-Flavor AS Configuration?
- Will the Application Data on an Instance Be Retained After the Instance Is Removed from an AS Group and Deleted?
- Can I Add ECSs Charged in Yearly/Monthly Mode?
- Can Instances That Have Been Added Based on an AS Policy Be Automatically Deleted When They Are Not Required?
- What Is the Expected Number of Instances?
- How Do I Delete an ECS Created in a Scaling Action?
- Will a Yearly/Monthly ECS Be Deleted When the ECS Becomes Faulty?
- How Should I Handle Abnormal Instances in an AS Group?
- What Can I Do If Instances in an AS Group Frequently Fail in Health Checks and Are Deleted and Then Created Repeatedly?
- How Do I Prevent ECSs from Being Removed from an AS Group Automatically?
- Why Is an Instance Removed and Deleted from an AS Group Still Displayed in the ECS List?
-
Others
- What Can I Do to Enable My Application to Be Automatically Deployed on an Instance?
- How Does Cloud-Init Affect the AS Service?
- How Can I Run Existing Services on an Instance Newly Added to an AS Group?
- Why Cannot I Use a Key File to Log In to an ECS?
- Do I Need to Configure an EIP in an AS Configuration When A Load Balancer Has Been Enabled in an AS Group?
- How Can I Enable Automatic Initialization of EVS Disks of Instances That Have Been Added in a Scaling Action to an AS Group?
-
General
- Change History
-
API Reference (ME-Abu Dhabi Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
API
- AS Groups
- AS Configurations
- Instances in an AS Group
-
AS Policies
- Creating an AS Policy
- Creating an AS Policy (V2)
- Modifying an AS Policy
- Modifying an AS Policy (V2)
- Querying AS Policies
- Querying AS Policies (V2)
- Querying All AS Policies (V2)
- Querying AS Policy Details
- Querying Details of an AS Policy (V2)
- Executing, Enabling, or Disabling an AS Policy
- Deleting an AS Policy
- Performing Operations on AS Policies in Batches
- AS Policy Execution Logs
- Scaling Action Logs
- Quotas
- Notifications
- Lifecycle Hook
- Tag Management
- API Management
- Permissions Policies and Supported Actions
- Appendix
- Change History
-
User Guide (Paris Regions)
- Service Overview
- Best Practices
- Quick Start
- AS Management
-
FAQs
-
General
- What Are Restrictions on Using AS?
- Must I Use AS Together With ELB and Cloud Eye?
- Will an Abrupt Change in Monitoring Metric Values Trigger an Unnecessary Scaling Action?
- How Many AS Policies and AS Configurations Can I Create and Use?
- How Do I Fix the Error "The key pair does not exist" When I Connect to an Instance?
- AS Group
-
AS Policy
- How Many AS Policies Can I Enable?
- What Are the Conditions to Trigger an Alarm-based AS Policy?
- What Is a Cooldown Period and Why Is It Required?
- What Monitoring Metrics for an AS Group Will Be Affected If VM Tools Are Not Installed on the Instances in the Group?
- What Can I Do If an AS Policy Fails to Be Enabled?
-
Instance
- How Do I Prevent Instances Manually Added to an AS Group from Being Automatically Removed?
- When an Instance Is Removed from an AS Group and Deleted, Is the Application Data Saved?
- Can AS Automatically Delete Instances Added Based on an AS Policy When They Are Not Required?
- What Is the Expected Number of Instances?
- How Do I Delete an ECS Instance Created in a Scaling Action?
- How Do I Handle Unhealthy Instances in an AS Group?
- Why Instances in an AS Group Keep Failing Health Checks and Getting Deleted and Recreated?
- How Do I Prevent Instances from Being Automatically Removed from an AS Group?
- Why Is an Instance that Was Removed from an AS Group and Deleted Still Displayed in the ECS List?
-
Others
- How Can I Automatically Deploy My Application on an Instance?
- Why Can't I Use a Key File to Log In to an ECS?
- Do I Need to Configure an EIP in an AS Configuration When a Load Balancer Has Been Enabled for an AS Group?
- How Do I Enable Automatic Initialization of EVS Disks on Instances that Have Been Added to an AS Group During Scaling Actions?
-
General
- Change History
- API Reference (Paris Regions)
-
User Guide (Kuala Lumpur Region)
- Service Overview
- Best Practices
- Quick Start
- AS Management
-
FAQs
-
General
- What Are Restrictions on Using AS?
- Must I Use AS Together With ELB and Cloud Eye?
- Is AS Billed?
- Will an Abrupt Change in Monitoring Metric Values Trigger an Unnecessary Scaling Action?
- How Many AS Policies and AS Configurations Can I Create and Use?
- Can AS Automatically Scale Up or Down vCPUs, Memory, and Bandwidth of ECSs?
- What Is an AS Quota?
- How Do I Fix the Error "The key pair does not exist" When I Connect to an Instance?
- AS Group
-
AS Policy
- How Many AS Policies Can I Enable?
- What Are the Conditions to Trigger an Alarm-based AS Policy?
- What Is a Cooldown Period and Why Is It Required?
- Can AS Scale Capacity Based on Custom Monitoring by Cloud Eye?
- What Monitoring Metrics for an AS Group Will Be Affected If VM Tools Are Not Installed on the Instances in the Group?
- What Can I Do If an AS Policy Fails to Be Enabled?
- How Do I Install the Agent on Instances in an AS Group to Use Agent Monitoring Metrics?
-
Instance
- How Do I Prevent Instances Manually Added to an AS Group from Being Automatically Removed?
- When There Are Multiple Flavors Included in the AS Configuration of an AS Group, What Order Are the Flavors Selected in During Scale-out Events?
- When an Instance Is Removed from an AS Group and Deleted, Is the Application Data Saved?
- Can I Add Yearly/Monthly ECS Instances to an AS Group?
- Can the System Automatically Delete the Instances Added Based on an AS Policy When They Are Not Required?
- What Is the Expected Number of Instances?
- How Do I Delete an ECS Instance Created in a Scaling Action?
- Will a Yearly/Monthly ECS Instance Be Deleted If It Becomes Unhealthy?
- How Do I Handle Unhealthy Instances in an AS Group?
- Why Instances in an AS Group Keep Failing Health Checks and Getting Deleted and Recreated?
- How Do I Prevent Instances from Being Automatically Removed from an AS Group?
- Why Is an Instance that Was Removed from an AS Group and Deleted Still Displayed in the ECS List?
-
Others
- How Can I Automatically Deploy My Application on an Instance?
- How Does Cloud-Init Affect the AS Service?
- Why Can't I Use a Key File to Log In to an ECS?
- Do I Need to Configure an EIP in an AS Configuration When a Load Balancer Has Been Enabled for an AS Group?
- How Do I Enable Automatic Initialization of EVS Disks on Instances that Have Been Added to an AS Group During Scaling Actions?
-
General
- Change History
-
API Reference (Kuala Lumpur Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
APIs
- AS Groups
- AS Configurations
- Instances in an AS Group
-
AS Policies
- Creating an AS Policy
- Creating an AS Policy (V2)
- Modifying an AS Policy
- Modifying an AS Policy (V2)
- Querying AS Policies
- Querying AS Policies (V2)
- Querying All AS Policies (V2)
- Querying AS Policy Details
- Executing, Enabling, or Disabling an AS Policy
- Deleting an AS Policy
- Performing Operations on AS Policies in Batches
- AS Policy Execution Logs
- Scaling Action Logs
- Quotas
- Notifications
- Lifecycle Hook
- Tag Management
- API Management
- Permissions Policies and Supported Actions
- Appendix
- Change History
-
User Guide (Ankara Region)
- Service Overview
- Best Practices
- Quick Start
- AS Management
-
FAQs
-
General
- What Are Restrictions on Using AS?
- Must I Use AS Together With ELB and Cloud Eye?
- Will an Abrupt Change in Monitoring Metric Values Trigger an Unnecessary Scaling Action?
- How Many AS Policies and AS Configurations Can I Create and Use?
- How Do I Fix the Error "The key pair does not exist" When I Connect to an Instance?
- AS Group
-
AS Policy
- How Many AS Policies Can I Enable?
- What Are the Conditions to Trigger an Alarm-based AS Policy?
- What Is a Cooldown Period and Why Is It Required?
- What Monitoring Metrics for an AS Group Will Be Affected If VM Tools Are Not Installed on the Instances in the Group?
- What Can I Do If an AS Policy Fails to Be Enabled?
-
Instance
- How Do I Prevent Instances Manually Added to an AS Group from Being Automatically Removed?
- When an Instance Is Removed from an AS Group and Deleted, Is the Application Data Saved?
- Can AS Automatically Delete Instances Added Based on an AS Policy When They Are Not Required?
- What Is the Expected Number of Instances?
- How Do I Delete an ECS Instance Created in a Scaling Action?
- How Do I Handle Unhealthy Instances in an AS Group?
- Why Instances in an AS Group Keep Failing Health Checks and Getting Deleted and Recreated?
- How Do I Prevent Instances from Being Automatically Removed from an AS Group?
- Why Is an Instance that Was Removed from an AS Group and Deleted Still Displayed in the ECS List?
-
Others
- How Can I Automatically Deploy My Application on an Instance?
- How Does Cloud-Init Affect the AS Service?
- Why Can't I Use a Key File to Log In to an ECS?
- Do I Need to Configure an EIP in an AS Configuration When a Load Balancer Has Been Enabled for an AS Group?
- How Do I Enable Automatic Initialization of EVS Disks on Instances that Have Been Added to an AS Group During Scaling Actions?
-
General
- Change History
-
API Reference (Ankara Region)
- Before You Start
- API Overview
- Calling APIs
- Getting Started
-
APIs
- AS Groups
- AS Configurations
- Instances
-
AS Policies
- Creating an AS Policy
- Creating an AS Policy (V2)
- Modifying an AS Policy
- Modifying an AS Policy (V2)
- Querying AS Policies Bound to an AS Group
- Querying AS Policies Bound to a Scaling Resource (V2)
- Querying AS Policies (V2)
- Querying an AS Policy
- Querying an AS Policy (V2)
- Executing, Enabling, or Disabling an AS Policy
- Deleting an AS Policy
- Batch Managing AS Policies
- AS Policy Execution Logs
- Scaling Action Logs
- Quotas
- Notifications
- Lifecycle Hooks
- API Version Query
- Permissions and Supported Actions
- Appendix
- Change History
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
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
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
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
Specifies filter criteria with any tag included. A maximum of 10 keys can be contained. For details, see Table 3.
not_tags
No
Array
Specifies filter criteria without tags included. A maximum of 10 keys can be contained. For details, see Table 3.
not_tags_any
No
Array
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.
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
Specifies fuzzy search. For details, see Table 4.
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
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" }] }
- Example request when action is set to filter
Response Message
- Response parameters
Table 5 Response parameters Parameter
Type
Description
resources
Array
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
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.
- 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 }
- Example response when action is set to filter
Returned Values
- Normal
- 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot