- What's New
- Function Overview
- Service Overview
- Billing
- Getting Started
-
User Guide
- Permissions Management
- Elastic IP
- EIP Billing
- EIP Pool
- Shared Bandwidth
- Shared Data Package
- Global EIPs
- Global Internet Gateways
- Global Internet Bandwidths
- Global Connection Bandwidths
- Cloud Eye Monitoring
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- APIs
- API V3
- Native OpenStack Neutron APIs V2.0
- Application Examples
- Permissions Policies and Supported Actions
- Appendix
- Change History
- SDK Reference
-
FAQs
-
Product Consultation
- Managing Quotas
- How Do I Assign or Retrieve a Specific EIP?
- Why Is an EIP Newly Assigned the Same as the One I Released?
- Can I Buy a Specific EIP?
- Does an EIP Change Over Time?
- Why Can't I Find My Purchased EIP on the Management Console?
- What Is the EIP Assignment Policy?
- Can an EIP Be Used or Migrated Across Accounts?
- How Do I Query the Traffic Usage of My EIP?
- Do I Need to Configure a Shared Data Package for Use After It Is Purchased?
- Can I Change the Dedicated Bandwidth Used by an EIP to a Shared Bandwidth?
- How Many ECSs Can I Bind an EIP To?
- What Are the Differences Between EIP, Private IP Address, and Virtual IP Address?
- What Are the Differences Among a Bandwidth Add-On Package, Shared Data Package, and Shared Bandwidth?
- When Should I Use Premium BGP and Are There Any Limitations on Using Premium BGP?
- Why My EIPs Are Frozen? How Do I Unfreeze My EIPs?
-
Billing and Payments
- How Is an EIP Billed?
- How Do I Change My EIP Billing Mode Between Pay-per-Use and Yearly/Monthly?
- How Do I Change the Billing Option of a Pay-per-Use EIP Between By Bandwidth and By Traffic?
- Why Am I Still Being Billed After My EIP Has Been Unbound or Released?
- When Will I Be Billed for Reservation Price?
-
EIP Binding and Unbinding
- How Do I Access an ECS with an EIP Bound from the Internet?
- How Can I Unbind an Existing EIP from an Instance and Bind Another EIP to the Instance?
- Can I Bind an EIP of an ECS to Another ECS?
- Can I Bind an EIP to a Cloud Resource in Another Region?
- Can Multiple EIPs Be Bound to an ECS?
- What Are the Differences Between Unbinding and Releasing an EIP?
-
Bandwidth
- How Do I Increase a Bandwidth to Be More Than 300 Mbit/s?
- What Bandwidth Types Are Available?
- How Many EIPs Can I Add to Each Shared Bandwidth?
- What Are the Differences Between a Dedicated Bandwidth and a Shared Bandwidth?
- What Are Inbound Bandwidth and Outbound Bandwidth?
- How Do I Know If My EIP Bandwidth Has Been Exceeded?
- What Are the Differences Between Public Bandwidth and Private Bandwidth?
- Can I Increase a Yearly/Monthly Bandwidth and Decrease It Later?
- What Is the Relationship Between Bandwidth and Upload/Download Rate?
- What Are the Differences Among Static BGP, Dynamic BGP, and Premium BGP?
-
Connectivity
- What Are the Priorities of the Custom Route and EIP If Both Are Configured for an ECS to Enable the ECS to Access the Internet?
- Why Can't My ECS Access the Internet Even After an EIP Is Bound?
- What Should I Do If an EIP Cannot Be Pinged?
- How Do I Unblock an EIP?
- Why Is There Network Jitter or Packet Loss During Cross-Border Communications?
- Why Does the Download Speed of My ECS Is Slow?
-
Product Consultation
- Videos
- Glossary
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Quick Start
-
Elastic IP
- EIP Overview
- Assigning an EIP and Binding It to an ECS
- Assigning an EIP
- Binding an EIP to an Instance
- Unbinding an EIP from an Instance
- Releasing an EIP
- Changing Dedicated Bandwidth Size of an EIP
- Unbinding an EIP from an ECS and Releasing the EIP
- Modifying an EIP Bandwidth
- Exporting EIP Information
- Managing EIP Tags
- Shared Bandwidth
- Monitoring
-
FAQs
-
Product Consultation
- What Is a Quota?
- How Do I Assign or Retrieve a Specific EIP?
- Why Is an EIP Newly Assigned the Same as the One I Released?
- What Are the Differences Between EIP, Private IP Address, and Virtual IP Address?
- Can an EIP That Uses Dedicated Bandwidth Be Changed to Use Shared Bandwidth?
- Can I Bind an EIP to Multiple ECSs?
- What Are the Differences Between the Primary and Extension NICs of ECSs?
- What Is the EIP Assignment Policy?
- Can I Assign a Specific EIP?
- Can a Bandwidth Be Used by Multiple Accounts?
- How Do I Unbind an EIP from an Instance and Bind a New EIP to the Instance?
- Why Can't I Find My Assigned EIP on the Management Console?
- EIP Binding and Unbinding
-
Bandwidth
- What Is the Bandwidth Size Range?
- How Do I Increase a Bandwidth to Be More Than 300 Mbit/s?
- What Bandwidth Types Are Available?
- Is There a Limit to the Number of EIPs That Can Be Added to Each Shared Bandwidth?
- What Are the Differences Between a Dedicated Bandwidth and a Shared Bandwidth?
- What Are Inbound Bandwidth and Outbound Bandwidth?
- How Do I Know If My EIP Bandwidth Limit Has Been Exceeded?
- What Are the Differences Between Public Bandwidth and Private Bandwidth?
- What Is the Relationship Between Bandwidth and Upload/Download Rate?
- Connectivity
-
Product Consultation
- Change History
- API Reference (ME-Abu Dhabi Region)
-
User Guide (Kuala Lumpur Region)
- Service Overview
- Quick Start
- EIP
- Shared Bandwidth
- Monitoring
-
FAQs
- Product Consultation
- EIP Binding and Unbinding
-
Bandwidth
- What Is the Bandwidth Size Range?
- What Bandwidth Types Are Available?
- Is There a Limit to the Number of EIPs That Can Be Added to Each Shared Bandwidth?
- What Are the Differences Between a Dedicated Bandwidth and a Shared Bandwidth? Can a Dedicated Bandwidth Be Changed to a Shared Bandwidth or the Other Way Around?
- Connectivity
- Change History
- API Reference (Kuala Lumpur Region)
- User Guide (Ankara Region)
- API Reference (Ankara Region)
-
User Guide (ME-Abu Dhabi Region)
- General Reference
Copied.
Querying EIPs by Tag
Function
This API is used to query EIPs by tag.
URI
POST /v2.0/{project_id}/publicips/resource_instances/action
Table 1 describes the parameters.
Name |
Mandatory |
Description |
---|---|---|
project_id |
Yes |
Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
Request Message
- Request parameter
Table 2 Request parameter Parameter
Type
Mandatory
Description
tags
Array of tags objects
No
Specifies the included tags. A maximum of 10 tag keys are allowed for each query operation. Each tag key can have up to 10 tag values. The structure body must be included. The tag key cannot be left blank or set to an empty string. Each tag key must be unique, and each tag value in a tag must be unique.
limit
Integer
No
Sets the page size. This parameter is not available when action is set to count. The default value is 1000 when action is set to filter. The maximum value is 1000, and the minimum value is 1. The value cannot be a negative number.
offset
Integer
No
Specifies the index position. The query starts from the next piece of data indexed by this parameter. This parameter is not required when you query data on the first page. The value in the response returned for querying data on the previous page will be included in this parameter for querying data on subsequent pages. This parameter is not available when action is set to count. If action is set to filter, the value must be a number, and the default value is 0. The value cannot be a negative number.
action
String
Yes
Specifies the operation to perform. The value can only be filter (filtering) or count (querying the total number).
The value filter indicates pagination query. The value count indicates that the total number of query results meeting the search criteria will be returned.
matches
Array of match objects
No
Specifies the search criteria. The tag key is the field to match. Currently, only resource_name is supported. The tag value indicates the matched value. This field is a fixed dictionary value.
Table 3 Description of the tags field Name
Mandatory
Type
Description
key
Yes
String
Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.)
values
Yes
Array of strings
Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The values are in the OR relationship.
- Example request 1: Setting action to filter
POST https://{Endpoint}/v2.0/{project_id}/publicips/resource_instances/action { "offset": "0", "limit": "100", "action": "filter", "matches": [ { "key": "resource_name", "value": "resource1" } ], "tags": [ { "key": "key1", "values": [ "*value1", "value2" ] } ] }
- Example request 2: Setting action to count
{ "action": "count", "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ], "matches": [ { "key": "resource_name", "value": "resource1" } ] }
Response Message
- Response parameter
Table 5 Response parameter Name
Type
Description
resources
Array of resource objects
Specifies the resource object list. For details, see Table 6.
total_count
Integer
Specifies the total number of query records.
Table 6 resource objects Name
Type
Description
resource_id
String
Specifies the resource ID.
resource_detail
Object
Specifies the resource details. Resource details are used for extension. This parameter is left blank by default.
tags
Array of tags objects
Specifies the tag list. This parameter is an empty array by default if there is no tag. For details, see Table 7.
resource_name
String
Specifies the resource name. This parameter is an empty string by default if there is no resource name.
Table 7 Description of the tags field Name
Mandatory
Type
Description
key
Yes
String
Specifies the tag key. The value can contain a maximum of 127 Unicode characters. The tag key cannot be left blank. (This parameter is not verified during the search process.)
value
Yes
String
Specifies the tag value list. Each value can contain a maximum of 255 Unicode characters. An empty list for values indicates any value. The values are in the OR relationship.
- Example response 1: Setting action to filter
{ "resources": [ { "resource_detail": null, "resource_id": "cdfs_cefs_wesas_12_dsad", "resource_name": "resouece1", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value1" } ] } ], "total_count": 1000 }
- Example response 2: Setting action to count
{ "total_count": 1000 }
Status Code
See Status Codes.
Error Code
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