ListNLBTagsForResources--负载均衡-火山引擎

文档中心

导航

ListNLBTagsForResources

最近更新时间：2024.12.04 17:10:14首次发布时间：2024.12.04 17:10:14

调用 ListNLBTagsForResources 接口，查询满足指定条件的标签信息。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListNLBTagsForResources	要执行的操作，取值为ListNLBTagsForResources。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ResourceType	String	是	nlb	资源的类型，取值如下： nlb：NLB实例。 nlb_listener：监听器。 nlb_servergroup：服务器组。
ResourceIds.N	String	否	ResourceIds.1=nlb-273sdsdsrddfp8u2j**&ResourceIds.2=nlb-2fe6fszjgeznk5oxruv0u**	资源的ID。 N：表示资源 ID的序号，取值范围 1～50。多个资源 ID之间使用&分隔。说明您可以调用DescribeNetworkLoadBalancers接口获取NLB实例的ID。您可以调用DescribeNLBListeners接口获取监听器的ID。您可以调用DescribeNLBServerGroups接口获取服务器组的ID。
TagType	String	否	custom	标签类型，取值如下： custom：用户标签。 system：系统标签。说明该参数传入空，表示查询全部类型的标签。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2	根据标签查询资源时指定的标签键。 N：表示标签键的序号，取值范围1～10。多个标签键之间使用&分隔。指定多个标签键时，表示查询同时包含所有指定标签键的资源。说明传入的`TagFilters.N.Key`不存在时，返回为空字符串。
TagFilters.N.Values.N	String	否	TagFilters.1.Value.1=v1&TagFilters.1.Value.2=v2&TagFilters.2.Value.1=v3	资源标签的标签值。第一个N：表示标签键的序号，取值范围 1～10。第二个N：表示标签值的序号，取值范围 1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的资源。多个标签值之间使用&分隔。说明如果传入该参数，则必须先传入`TagFilters.N.Key`。该参数传入空值时，表示查询指定标签键下标签值为空的资源。
NextToken	String	否	caeba0bbb2be03f84eb48b699f0a****	分页查询凭证，用于标记分页的位置，初次调用该接口时无需设置。下次查询时，取值为上一次API调用返回的`NextToken`参数值。
MaxResults	Integer	否	50	单次查询的数量，默认为 10，最大为100。

返回参数

名称	类型	示例值	描述
RequestId	String	2024062415303301022514515207C4****	请求ID。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次调用返回的查询凭证值，返回为空表示没有下一页。
ResourceTags	Array of Struct	--	资源及其附加的标签信息。具体参见下表“ResourceTag”。

ResourceTag

名称	类型	示例值	描述
ResourceType	String	nlb	资源的类型。 nlb：负载均衡实例。 nlb_listener：监听器。 nlb_servergroup：服务器组。
ResourceId	String	nlb-2fe6fszjgeznk5oxruv0u****	资源的ID。
TagKey	String	k1	资源附加标签的标签键。
TagValue	String	v1	资源附加标签的标签值。

请求示例

GET /?Action=ListNLBTagsForResources&Version=2020-04-01&ResourceType=nlb&ResourceIds.1=nlb-273sdsdswep8u2j****&ResourceIds.2=nlb-2fe6fszjgeznk5oxruv0u**** HTTP/1.1
Host: open.volcengineapi.com
Service: clb
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024062415303301022514515207C4****",
        "Action": "ListNLBTagsForResources",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "2024062415303301022514515207C4****",
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "ResourceTags": [
            {
                "ResourceType": "nlb",
                "ResourceId": "nlb-273sdsdswep8u2j****",
                "TagKey": "k1",
                "TagValue": "v1"
            },
            {
                "ResourceType": "nlb",
                "ResourceId": "nlb-2fe6fszjgeznk5oxruv0u****",
                "TagKey": "k2",
                "TagValue": "v2"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。