ListTagResources - 查询IPAM已绑定的标签列表_专有网络VPC(VPC)-阿里云帮助中心

查询资源标签列表。

接口说明

使用说明

请求中至少指定参数ResourceId.N或Tag.N（Tag.N.Key与Tag.N.Value），以确定检索对象。
Tag.N是资源的标签，由一个键值对组成。仅指定Tag.N.Key时，则返回该标签键关联的所有标签值。仅指定Tag.N.Value会报错。
如果您同时指定Tag.N和ResourceId.N筛选标签，则ResourceId.N必须满足所有输入的标签键值对。
如果您同时指定多个标签键值对，返回结果为同时包含被指定的多个键值对的资源。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:ListTagResources	list	Ipam acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId} IpamPool acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId} IpamScope acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	资源所属的地域 ID。	cn-hangzhou
ResourceId	array	否	资源 ID 列表。
ResourceId	string	否	资源 ID。最多支持输入 50 个资源 ID。说明参数ResourceId.N或Tag.N（Tag.N.Key与Tag.N.Value）至少输入一个。	ipam-ccxbnsbhew0d6t****
ResourceType	string	是	资源类型。取值： IPAM：表示资源类型为 IPAM。 IPAMSCOPE：表示资源类型为 IPAM 作用范围。 IPAMPOOL：表示资源类型为 IPAM 地址池。	IPAM
Tag	array<object>	否	标签列表。
Tag	object	否	标签列表。
Key	string	否	资源的标签键。最多支持 20 个标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。说明参数ResourceId.N或Tag.N（Tag.N.Key与Tag.N.Value）至少输入一个。	FinanceDept
Value	string	否	资源的标签值。最多支持 20 个标签值。一旦传入该值，可以为空字符串。最多支持 128 个字符，不能包含`http://`或者`https://`。说明参数ResourceId.N或Tag.N（Tag.N.Key与Tag.N.Value）至少输入一个。	FinanceJoshua
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~50，默认值为 10。	20

返回参数

名称	类型	描述	示例值
	object	返回的信息列表。
TagResources	array<object>	绑定标签的资源信息。
TagResource	object	绑定标签的资源信息。
TagKey	string	标签键。	FinanceDept
TagValue	string	标签值。	FinanceJoshua
ResourceId	string	资源 ID。	ipam-uq5dcfc2eqhpf4****
ResourceType	string	资源类型。取值： IPAM：表示资源类型为 IPAM。 IPAMSCOPE：表示资源类型为 IPAM 作用范围。 IPAMPOOL：表示资源类型为 IPAM 地址池。	IPAM
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	请求 ID。	672053AB-90C9-5693-AB96-458F137A5ED6

示例

正常返回示例

JSON格式

{
  "TagResources": [
    {
      "TagKey": "FinanceDept",
      "TagValue": "FinanceJoshua",
      "ResourceId": "ipam-uq5dcfc2eqhpf4****",
      "ResourceType": "IPAM"
    }
  ],
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "672053AB-90C9-5693-AB96-458F137A5ED6"
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParamSize.ResourceIds	The number of Param ResourceIds exceeded the limit.	传入的ResourceIds参数超过数量限制。
400	IllegalParamSize.Tags	The number of Parameter Tags exceeded the limit.	传入的Tags参数超过数量限制。
400	MissingParameter.ResourceIds	The input parameter ResourceIds that is mandatory for processing this request is not supplied.	参数ResourceIds未传入。
400	MissingParameter.ResourceType	The input parameter ResourceType that is mandatory for processing this request is not supplied.	参数ResourceType未传入。
400	MissingParameter.TagsAndResourceIds	The input parameter Tags and ResourceIds that is mandatory for processing this request is not supplied.	参数Tags及ResourceIds未传入。
400	MissingParameter.Tags	The input parameter Tags that is mandatory for processing this request is not supplied.	参数Tags未传入。
400	DuplicatedParam.TagKey	TagKey duplicate.	TagKey参数重复。
400	IllegalParam.TagKey	The input parameter TagKey is invalid.	参数TagKey非法。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-09-12	OpenAPI 错误码发生变更	查看变更详情