查询云企业网实例绑定的标签信息。
接口说明
在调用 ListTagResources 接口时,请求参数ResourceId.N和Tag.N.Key至少选择输入一个:
- 如果只输入ResourceId.N,表示要查询指定云企业网实例下已经绑定的标签信息。
- 如果只输入Tag.N.Key,表示要查询已绑定此标签键的所有云企业网实例的信息。
- 如果同时输入ResourceId.N和Tag.N.Key,表示要查询指定云企业网实例下绑定的指定标签的信息。
- 请确保ResourceId.N和Tag.N.Key的值相互对应,如果不对应,则返回结果为空。
- 如果同时输入了多个标签键,则多个标签键之间为与的关系。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:ListTagResources | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ResourceType | string | 是 | 资源类型。取值: Cen,表示云企业网实例。 BandwidthPackage,表示带宽包实例。 TransitRouter,表示转发路由器实例。 TransitRouterVpcAttachment,表示 Vpc 连接实例。 TransitRouterVbrAttachment,表示 Vbr 连接实例。 TransitRouterPeerAttachment,表示跨地域连接实例。 TransitRouterVpnAttachment,表示 Vpn 连接实例。 TransitRouterRouteTable,表示路由表实例。 Flowlog,表示 Flowlog 实例。 TransitRouterMulticastDomain,表示组播域实例。 | cen |
NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
PageSize | integer | 否 | 分批次查询时每批次显示的条目数。取值范围:1~50。默认值:10。 | 10 |
ResourceId | array | 否 | 云企业网实例 ID。 一次最多支持输入 20 个云企业网实例 ID。 | |
string | 否 | 云企业网实例 ID。 一次最多支持输入 20 个云企业网实例 ID。 | cen-8z69wtwqel33lq**** | |
Tag | array<object> | 否 | 云企业网实例的标签信息。 一次最多支持查询 20 个标签。 | |
object | 否 | 云企业网实例的标签信息。 一次最多支持查询 20 个标签。 | ||
Key | string | 否 | 标签键。 一个标签键最多支持输入 64 个字符,不能以 一次最多支持输入 20 个标签的标签键。 | test |
Value | string | 否 | 标签值。 一个标签值最多支持输入 128 个字符,不能以 一次最多支持输入 20 个标签的标签值。 | Bp |
RegionId | string | 否 | 资源实例所属地域 ID。 当资源类型为 Cen 和 BandwidthPackage 不需要填写,其余类型必填。 | cn-hangzhou |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "165B5C86-2033-5954-A89D-4CD83BA06C85",
"TagResources": {
"TagResource": [
{
"ResourceType": "CEN",
"TagValue": "Bp",
"ResourceId": "cen-8z69wtwqel33lq****",
"TagKey": "test"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidTagKey | The tag keys are not valid. | 标签的Key值不合法。 |
400 | InvalidTagValue | The tag values are not valid. | Tag value不合法。 |
400 | MissingParam | %s | - |
400 | InvalidInstanceType.NotFound | The instance type is not found | 参数中指定的实例类型不存在。 |
400 | InvalidInstanceIds.NotFound | The instanceIds are not found | 参数中指定的实例不存在。 |
400 | Forbidden.TagKeys | The request do not allow to operate the tag keys | 无法操作tag key。 |
400 | QuotaExceeded.TagNum | Custom Tags quota exceeded | Tag数量已达到上限。 |
400 | InvalidTagScope.NotFound | The tag scope is not found | Tag scope不合法。 |
400 | Forbidden.NotAllowedCategary | The System tag is not valid | 不允许配置系统tag。 |
400 | Forbidden.TagKeys | The request does not allow operate this tagkeys | 无法操作tag key。 |
400 | SizeLimitExceeded.ResourceIdNum | The ResourceIds parameter's number is exceed , Valid : 20 | - |
400 | BothEmpty.TagsAndResources | Both of Tags and ResourceIds is empty. | Tags和ResourceIds均为空。 |
400 | IllegalParam.NextToken | The parameter NextToken is invalid. | 指定的NextToken无效。请检查参数约束,并在修改后重试。 |
400 | IllegalParam.Region | The specified region is invalid. | 参数中指定的Region不合法。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|