You need to enable JavaScript to run this app.
文档中心
VPN连接

VPN连接

复制全文
下载 pdf
标签
ListTagsForResources-查询标签列表
复制全文
下载 pdf
ListTagsForResources-查询标签列表
调用ListTagsForResources接口,查询满足指定条件的标签信息。​
使用说明​
a.N.b类型的参数中,“N”表示根据标签查询资源时标签信息的序号,需按照数字顺序从1开始填写,取值范围为1~10。多个标签之间使用&分隔。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:ListTagsForResources​
要执行的操作,取值:ListTagsForResources。​
​
Version String 必选 示例值:2020-04-01​
API版本信息。​
​
ResourceType String 必选 示例值:vpngateway​
资源的类型,取值如下:​
  • vpngateway:VPN网关​
  • customergateway:用户网关​
  • vpnconnection:IPsec连接​
  • sslvpnserver:SSL服务端​
  • sslvpnclientcert:SSL客户端证书​
​
ResourceIds.N String 可选 示例值:vgw-273w3e33y2y9s7fap8u2j****​
资源的ID。​
  • 参数 - N:表示资源 ID的序号,单次调用数量上限50个。​
  • 多个资源 ID之间使用&分隔。​
​
TagType String 可选 示例值:custom​
标签类型,取值如下:​
  • custom:用户标签。​
  • system:系统标签。​
该参数不传或传入为空时,查询全部类型的标签。​
​
TagFilters.N.Key String 可选 示例值:k1​
标签的标签键。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与(AND)”,即查询同时添加多个标签键的资源。​
​
TagFilters.N.Values.M String 可选 示例值:v1​
标签的标签值。​
  • 第一个N:表示标签键的序号。​
  • 第二个N:表示标签值的序号,取值范围:1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的资源。​
  • 多个标签值之间用&分隔。​
说明​
  • 若传入该参数,则必须先传入TagFilters.N.Key。​
  • 传入空字符串时,表示查询标签值为空的资源。​
​
NextToken String 可选 示例值:caeba0bbb2be03f84eb48b699f0a****​
分页查询凭证,用于标记分页的位置,初次调用该接口时无需设置。下次查询时,取值为上一次API调用返回的NextToken参数值。​
​
MaxResults Integer 可选 示例值:50​
单次查询的数量,默认为 10,最大为100。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 可选 示例值:2021062415303301022514515207C4****​
请求ID。​
​
ResourceTags Object[] 可选 示例值:-​
资源附加的标签信息。​
ResourceType String 可选 示例值:vpngateway​
资源的类型。​
​
ResourceId String 可选 示例值:vgw-273w3e33y2y9s7fap8u2j****​
资源的ID。​
​
TagKey String 可选 示例值:k1​
资源附加标签的标签键。​
​
TagValue String 可选 示例值:v1​
资源附加标签的标签值。​
​
​
​
请求示例​
​
GET /?Action=ListTagsForResources&Version=2020-04-01&ResourceType=vpngateway&ResourceIds.1=vgw-273w3e33y2y9s7fap8u2j****&ResourceIds.2=vgw-bp15zckdt37pq72zv**** HTTP/1.1​
Host: vpn.cn-beijing.volcengineapi.com​
X-Date: 20251029T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251029/cn-beijing/vpn/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2021062415303301022514515207C4****",​
"Action": "ListTagsForResources",​
"Version": "2020-04-01",​
"Service": "vpn",​
"Region": "cn-beijing"​
},​
"Result": {​
"RequestId": "2021062415303301022514515207C4****",​
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",​
"ResourceTags": [​
{​
"ResourceType": "vpngateway",​
"ResourceId": "vgw-273w3e33y2y9s7fap8u2j****",​
"TagKey": "k1",​
"TagValue": "v1"​
},​
{​
"ResourceType": "vpngateway",​
"ResourceId": "vgw-bp15zckdt37pq72zv****",​
"TagKey": "k2",​
"TagValue": "v2"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
LimitExceeded.Resource​
You've reached the limit on the number of resources that you can operate at one time.​
已达到单次可操作资源数量的上限。​
400​
InvalidResourceType.Malformed​
The specified parameter resource type is invalid.​
资源类型不合法。​
400​
InvalidResourceType.NotFound​
The specified resource type does not exist.​
指定的资源类型不存在。​
400​
InvalidTagType.Malformed​
The specified parameter tag type is invalid.​
标签类型不合法。​
400​
InvalidTagFilterKey.Malformed​
The specified parameter tag filter key is invalid.​
过滤标签键不合法。​
400​
InvalidTagFilterValue.Malformed​
The specified parameter tag filter value is invalid.​
过滤标签值不合法。​
400​
LimitExceeded.TagFilterKey​
You've reached the limit on the number of tag keys that you can filter.​
已达到单次可指定过滤标签键数量的上限。​
400​
LimitExceeded.TagFilterValue​
You've reached the limit on the number of tag values that you can filter.​
已达到单次可指定过滤标签值数量的上限。​
400​
InvalidNextToken.Malformed​
The specified parameter NextToken is invalid.​
查询NextToken不合法。​
400​
InvalidMaxResults.Malformed​
The specified parameter MaxResults is malformed.​
查询数量不合法。​
400​
InvalidTagFilter.Disorder​
The specified index order of tag filter is malformed.​
指定标签过滤项的索引顺序参数格式不合法。​
​
最近更新时间:2026.02.02 11:15:04
这个页面对您有帮助吗?
有用
有用
无用
无用