ListTagResources - 查询一个或多个网关已经绑定的标签列表

查询一个或多个网关已经绑定的标签列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hcs-sgw:ListTagResources

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID，可以通过接口 DescribeRegions 查看可用的地域 ID。	cn-hangzhou
ResourceRegionId	string	否	资源区域 ID。	cn-hangzhou
ResourceType	string	是	资源类型定义。唯一取值：GATEWAY。	GATEWAY
NextToken	string	否	用来返回更多结果。第一次查询不需要提供这个参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的 token 继续查询。	212db86sca4384811e0b5e8707ec21345
ResourceId	array	否	网关 ID 列表, 可以同时查询 N 个网关的标签，说明 ResourceId 和 Tag 不能同时为空，请至少填写其中一项。	gw-uf6wjk5xxxxxxx
	string	否	网关 ID 列表, 可以同时查询 N 个网关的标签，N 的取值范围：1~50。说明 ResourceId.N 参数和 Tag.N.Key 参数至少传入一个。	gw-uf6wjk5xxxxxxx
Tag	array<object>	否	标签。说明 ResourceId 和 Tag 不能同时为空，请至少填写其中一项。
	object	否
Key	string	否	标签键。可以同时查询 N 个标签键，N 的取值范围：1~20。不允许传入空字符串。说明 ResourceId.N 参数和 Tag.N.Key 参数至少传入一个。	testkey1
Value	string	否	标签键对应的标签值。可以同时查询 N 个标签值，N 的取值范围：1~20。允许传入空字符串。	testvalue1

返回参数

名称	类型	描述	示例值
	object
NextToken	string	如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的 token 继续查询。	212db86sca4384811e0b5e8707ec21345
RequestId	string	请求 ID。	47A514A1-4B77-4E30-B4C5-2A880650B3FD
TagResources	object
TagResource	array<object>	查询到的网关和标签的信息。
	object
ResourceType	string	资源类型。ALIYUN::HCS_SGW::GATEWAY 即云存储网关。	ALIYUN::HCS_SGW::GATEWAY
TagValue	string	标签键对应的标签值。	testvalue1
ResourceId	string	网关 ID。	47A514A1-4B77-4E30-B4C5-2A880650B3FD
TagKey	string	标签键。	testkey1

示例

正常返回示例

JSON格式

{
  "NextToken": "212db86sca4384811e0b5e8707ec21345",
  "RequestId": "47A514A1-4B77-4E30-B4C5-2A880650B3FD",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "ALIYUN::HCS_SGW::GATEWAY",
        "TagValue": "testvalue1",
        "ResourceId": "47A514A1-4B77-4E30-B4C5-2A880650B3FD\t",
        "TagKey": "testkey1\t"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息
400	MissingParameter.ResourceIds	The parameter - ResourceIds.N should not be null.
400	MissingParameter.Tags	The parameter - Tags should not be null.
400	Missing.TagKey	The Tag.N.Key parameter is blank.
400	InvalidParameter.TagKey	The Tag.N.Key parameter is invalid.
400	InvalidParameter.TagValue	The Tag.N.Value parameter is invalid.
400	InvalidParameter.ResourceType	The ResourceType parameter is invalid.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.
400	MissingParameter.TagOrResourceId	The specified Tags and ResourcesIds are not allow to both empty.
400	NumberExceed.ResourceIds	The ResourceIds parameter's number is exceed , Valid : 50
400	NumberExceed.Tags	The Tags parameter's number is exceed , Valid : 20
403	PermissionDenied.Scope	The specified operator not have permission to set Scope value.
403	PermissionDenied.TagOwnerUid	The specified operator not have permission to set TagOwnerUid value.
403	PermissionDenied.TagOwnerBid	The specified operator not have permission to set TagOwnerBid value.
403	NoPermissionKey.Operator	These keys are not permission for this operator.
403	NoPermissionKey.Scope	These keys are not permission for this scope.
403	NoPermissionKey.Category	These keys are not permission for this category.
403	NoPermission.SystemTag	The operator is not permission for the system tag.
403	NoPermission.Operator	The operator is not permission for this operate.
404	InvalidResourceType.NotFound	The ResourceType provided does not exist in our records.
404	InvalidResourceId.NotFound	The specified ResourceId is not found in our records.

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

变更历史

更多信息，参考变更详情。