Queries the information about tags that are added to a Cloud Enterprise Network (CEN) instance.
Operation description
To call this operation, you must set at least one of ResourceId.N and Tag.N.Key.
-
If you set only ResourceId.N, the tags that are added to the specified CEN instances are returned.
-
If you set only Tag.N.Key, the CEN instances that have the specified tags are returned.
-
If you set both ResourceId.N and Tag.N.Key, the specified tags that are added to the specified CEN instances are returned.
- Make sure that the CEN instance specified by ResourceId.N has the tag specified by Tag.N.Key. Otherwise, the response returns null.
- If multiple tag keys are specified, the logical operator among these tag keys is AND.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
cen:ListTagResources | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ResourceType | string | Yes | The type of the resource to which you want to add the tag. Valid values: Cen: CEN instance BandwidthPackage: bandwidth plan TransitRouter: transit router TransitRouterVpcAttachment: virtual private cloud (VPC) connection TransitRouterVbrAttachment: virtual border router (VBR) connection TransitRouterPeerAttachment: inter-region connection TransitRouterVpnAttachment: VPN connection TransitRouterRouteTable: route table Flowlog: flow log TransitRouterMulticastDomain: multicast domain | cen |
NextToken | string | No | The token that determines the start point of the query. Valid values:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
PageSize | integer | No | The number of entries to return on each page. Valid values: 1 to 50. Default value: 10. | 10 |
ResourceId | array | No | The IDs of the CEN instances. You can specify at most 20 IDs in each call. | |
string | No | The IDs of the CEN instances. You can specify at most 20 IDs in each call. | cen-8z69wtwqel33lq**** | |
Tag | array<object> | No | The information about the tags that are added to the CEN instance. You can query at most 20 tags in each call. | |
object | No | The information about the tags that are added to the CEN instance. You can query at most 20 tags in each call. | ||
Key | string | No | The tag key. The tag key cannot exceed 64 characters in length, and cannot start with You can specify at most 20 tag keys. | test |
Value | string | No | The tag value. The tag value cannot exceed 128 characters in length, and cannot start with You can specify at most 20 tag values. | Bp |
RegionId | string | No | The ID of the region where the resource is deployed. You can ignore this parameter if ResourceType is set to Cen or BandwidthPackage. | cn-hangzhou |
Response parameters
Examples
Sample success responses
JSON
format
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "165B5C86-2033-5954-A89D-4CD83BA06C85",
"TagResources": {
"TagResource": [
{
"ResourceType": "CEN",
"TagValue": "Bp",
"ResourceId": "cen-8z69wtwqel33lq****",
"TagKey": "test"
}
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | InvalidTagKey | The tag keys are not valid. | The error message returned because the specified tag key is invalid. |
400 | InvalidTagValue | The tag values are not valid. | The error message returned because the specified tag value is invalid. |
400 | MissingParam | %s | - |
400 | InvalidInstanceType.NotFound | The instance type is not found | The error message returned because the specified instance type does not exist. |
400 | InvalidInstanceIds.NotFound | The instanceIds are not found | The error message returned because the specified instance does not exist. |
400 | Forbidden.TagKeys | The request do not allow to operate the tag keys | The error message returned because you cannot manage the specified tag key. |
400 | QuotaExceeded.TagNum | Custom Tags quota exceeded | The error message returned because the number of tags has reached the upper limit. |
400 | InvalidTagScope.NotFound | The tag scope is not found | The error message returned because the specified tag scope is invalid. |
400 | Forbidden.NotAllowedCategary | The System tag is not valid | The error message returned because you cannot configure system tags. |
400 | Forbidden.TagKeys | The request does not allow operate this tagkeys | The error message returned because you cannot manage the specified tag key. |
400 | SizeLimitExceeded.ResourceIdNum | The ResourceIds parameter's number is exceed , Valid : 20 | - |
400 | BothEmpty.TagsAndResources | Both of Tags and ResourceIds is empty. | The error message returned because the Tags and ResourceIds parameters are not set. |
400 | IllegalParam.NextToken | The parameter NextToken is invalid. | The error message returned because the NextToken parameter is set to an invalid value. Check the value and try again. |
400 | IllegalParam.Region | The specified region is invalid. | The error message returned because the specified region is invalid. |
400 | InvalidParameter | Invalid parameter. | The error message returned because the parameter is set to an invalid value. |
400 | Unauthorized | The AccessKeyId is unauthorized. | The error message returned because you do not have the permissions to perform this operation. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|