ListTagsForResources--文件存储 vePFS-火山引擎

文档中心

导航

ListTagsForResources

最近更新时间：2024.06.25 14:48:51首次发布时间：2024.02.08 11:04:22

调用 ListTagsForResources 接口通过标签筛选 vePFS 资源。

请求参数

参数	类型	是否必选	示例值	描述
ResourceType	String	是	filesystem	需要筛选的资源类型，取值说明如下： `filesystem`：表示 vePFS 实例。
ResourceIds	Array of String	否	[ "vepfs-cn0212gzmh2xs**", "vepfs-cn0212gz1h2xs**" ]	需要筛选的资源 ID 列表，每次最多支持传入 50 个资源 ID，每个 ID 间用英文逗号（,）分隔。说明您可以调用 DescribeFileSystems 接口查询目标地域下所有文件系统的基本信息，包括文件系统 ID。 `ResourceIds` 和 `TagFilters` 不能同时为空且不能同时传入。
TagFilters	Array of TagFilter	否	[ { "Key": "key", "Value": "value" } ]	标签过滤器列表，说明如下：每次最多可传入 10 个标签键值对。传入多个标签键值对时，多个 `Key` 为与关系，同一个 `Key` 下的不同 `Value` 为或关系。说明 `ResourceIds` 和 `TagFilters` 不能同时为空且不能同时传入。
PageSize	Integer	否	10	每页记录数。取值为 1~100 间的整数，默认为 10。
PageNumber	Integer	否	1	标签列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。

TagFilter

参数	类型	是否必选	示例值	描述
Key	String	是	key	需要筛选的标签键。
Value	String	否	value	需要筛选的标签值。

返回参数

参数	类型	示例值	描述
ResourceTags	Array of ResourceTag	详情请参见返回示例	符合条件的资源列表。
PageSize	Integer	10	每页记录数。取值为 1~100 间的整数，默认为 10。
PageNumber	Integer	1	标签列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为 1。
TotalCount	Integer	10	符合条件的标签总个数。

ResourceTag

参数	类型	示例值	描述
TagKey	String	key	标签键。
TagValue	String	value	标签值。
ResourceId	String	vepfs-cnbjae7f81a5****	绑定该标签的资源 ID。
ResourceType	String	instance	绑定该标签的资源类型。

示例

请求示例

POST /?Action=ListTagsForResources&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTOGJhY2E1NTdkZGFmNDg0Yjk0ZDFiNjE5Y2NjZjI****/20230907/cn-beijing/vepfs/request, SignedHeaders=host;x-date;x-content-sha256;content-type, Signature=7f1119a75111535b1d6e7929700f22e1474af0fb4fe26c59f5ac5cdba0cc****
Content-Type: application/json; charset=utf-8
X-Content-Sha256: 567112abe45bd6a09504fd244237f14c0ba120491da0d35097afd54d87bd****
X-Date: 20230907T124910Z
{
    "ResourceType": "filesystem",
    "ResourceIds": [
        "vepfs-cn0212gzmh2xs****",
        "vepfs-cn0212gz1h2xs****"
    ],
    "TagFilters": [
        {
            "Key": "key",
            "Value": "value"
        }
    ],
    "PageSize": 10,
    "PageNumber": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "ListTagsForResources",
        "Version": "2022-01-01",
        "Service": "vepfs",
        "Region": "cn-beijing"
    },
    "Result": {
        "ResourceTags": [
            {
                "ResourceType": "instance",
                "ResourceId": "vepfs-cnbjae7f81a5****",
                "TagKey": "key",
                "TagValue": "value"
            }
        ],
        "PageSize": 10,
        "PageNumber": 1,
        "TotalCount": 10
    }
}