You need to enable JavaScript to run this app.
文档中心
IPv6网关

IPv6网关

复制全文
下载 pdf
IPv6网关实例
DescribeIpv6Gateways - 查询IPv6网关实例
复制全文
下载 pdf
DescribeIpv6Gateways - 查询IPv6网关实例
调用 DescribeIpv6Gateways 接口,查询满足指定条件的IPv6网关。​
使用说明​
  • 传入多个请求参数,按照传入的参数进行查询,返回符合所有条件的IPv6网关,若没有符合条件的IPv6网关,则返回空值。​
  • 若请求参数非必选参数均未传入,则按照当前登录账号查询,返回当前账号下的所有IPv6网关。​
请求参数​
Action String 必选 示例值:DescribeIpv6Gateways​
要执行的操作,取值:DescribeIpv6Gateways。​
​
Version String 必选 示例值:2020-04-01​
API的版本信息,当前版本为 2020-04-01。​
​
Ipv6GatewayIds.N String 可选 示例值:ipv6gw-hp3rwmtmfhgis****​
IPv6网关实例的ID。​
  • 参数 - N:表示IPv6网关实例ID的序号,取值范围为1 ~ 100,表示指定实例ID时最多可查询100个。​
  • 多个IPv6网关实例ID间使用&分隔。​
​
VpcIds.N String 可选 示例值:vpc-bp1opxu1zkhn00gzv****​
IPv6网关实例关联的VPC ID。​
您可以调用 DescribeVpcs 接口,查询VPC的ID。​
  • 参数 - N:表示VPC实例ID的序号,取值范围为1 ~ 100,表示指定实例ID时最多可查询100个。​
  • 多个VPC ID间使用&分隔。​
​
Name String 可选 示例值:ipv6GW-01​
IPv6网关实例的名称。​
​
ProjectName String 可选 示例值:Project_1​
IPv6网关所属项目的名称。​
  • 该参数不传入或传入为空时,表示查询所有的IPv6网关实例。​
  • 该参数传入不为空时,表示查询属于指定项目的IPv6网关实例。​
​
PageNumber Integer 可选 示例值:1​
列表的页码。默认值为1。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数。最大值为100,默认值为20。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
NextToken String 可选 示例值:caeba0bbb2be03f84eb48b699f0a****​
分页查询凭证,用于标记分页的位置。​
  • 不填则从头开始查询。​
  • 传入之前调用本API返回的NextToken,则从该次API调用标记分页的位置往后开始查询。​
​
MaxResults Integer 可选 示例值:50​
查询的数量,默认为 10,最大为100。​
​
​
​
返回参数​
RequestId String 示例值:2021062415303301022514515207C4****​
请求ID。​
​
TotalCount Integer 示例值:2​
符合条件的IPv6网关总数。​
说明​
本参数即将下线,使用NextToken和MaxResults分页查询时,此参数无意义。​
​
PageNumber Integer 示例值:1​
当前页码。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
PageSize Integer 示例值:10​
当前分页的行数。​
说明​
本参数即将下线,建议您使用NextToken和MaxResults进行分页查询。​
​
NextToken String 示例值:caeba0bbb2be03f84eb48b699f0a****​
本次API调用返回的查询凭证,标记分页的位置,用于下一次查询。返回为空表示没有下一页。​
​
Ipv6Gateways Object[] 示例值:-​
符合条件的IPv6网关实例的详细信息。​
CreationTime String 示例值:2017-12-05T22:40:00+08:00​
IPv6网关实例的创建时间。​
​
UpdateTime String 示例值:2017-12-05T22:40:00+08:00​
IPv6网关实例的修改时间。​
​
Status String 示例值:Available​
IPv6网关实例的运行状态。取值如下:​
  • Creating:创建中。​
  • Deleting:删除中​
  • Available:可用。​
​
VpcId String 示例值:vpc-bp67acfmxazb4p****​
IPv6网关实例关联的VPC ID。​
​
Description String 示例值:descriptionforIPv6GW​
IPv6网关实例的描述信息。​
​
Ipv6GatewayId String 示例值:ipv6gw-hp3rwmtmfhgis****​
IPv6网关实例的ID。​
​
RouteTableId String 示例值:rt-3tbe3o0tn849ovie****​
IPv6网关实例关联的路由表ID。​
​
Name String 示例值:ipv6GW-01​
IPv6网关实例的名称。​
​
ProjectName String 示例值:Project_1​
IPv6网关所属项目的名称。​
​
Tags Object[] 示例值:-​
IPv6网关的标签信息。​
Key String 示例值:k1​
标签键。​
​
Value String 示例值:v1​
标签值。​
​
​
​
​
​
请求示例​
​
GET /?Action=DescribeIpv6Gateways&Version=2020-04-01&Ipv6GatewayIds.1=ipv6gw-hp3rwmtmfhgis****&Ipv6GatewayIds.2=ipv6gw-hp3y0l3ln89j8**** HTTP/1.1​
Host: vpc.cn-beijing.volcengineapi.com​
Region: cn-beijing​
Service: vpc​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeIpv6Gateways",​
"Version": "2020-04-01",​
"Service": "vpc",​
"Region": "cn-beijing"​
},​
"Result": {​
"Ipv6Gateways": [​
{​
"Name": "ipv6GW-01",​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"VpcId": "vpc-bp67acfmxazb4p****",​
"Status": "Available",​
"UpdateTime": "2017-12-05T22:40:00+08:00",​
"Description": "descriptionforIPv6GW",​
"ProjectName": "Project_1",​
"CreationTime": "2017-12-05T22:40:00+08:00",​
"RouteTableId": "rt-3tbe3o0tn849ovie****",​
"Ipv6GatewayId": "ipv6gw-hp3rwmtmfhgis****"​
}​
],​
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",​
"PageNumber": 1,​
"PageSize": 10,​
"RequestId": "2021062415303301022514515207C4****",​
"TotalCount": 2​
}​
}​
​
错误码​
公共错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
DryRunOperation​
Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.​
该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。​
400​
IdempotentParameterMismatch​
Arguments on this idempotent request are inconsistent with arguments used in previous request(s).​
此幂等请求的参数与前一个请求中使用的参数不一致。​
400​
InvalidMaxResults.Malformed​
The specified parameter MaxResults is malformed.​
查询数量不合法。​
400​
InvalidNextToken.Malformed​
The specified parameter NextToken is invalid.​
查询 NextToken 不合法。​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
InvalidParameter.ClientTokenMalformed​
The specified parameter ClientToken is malformed.​
指定的参数ClientToken格式不合法,长度不能超过64个ASCII字符。​
400​
InvalidTagFilter.Disorder​
The specified index order of tag filter is malformed.​
指定标签过滤项的索引顺序参数格式不合法。​
400​
InvalidTagFilterKey.Malformed​
The specified parameter tag filter key is invalid.​
过滤标签键不合法。​
400​
InvalidTagFilterValue.Malformed​
The specified parameter tag filter value is invalid.​
过滤标签值不合法。​
400​
LimitExceeded.Ipv6GatewayId​
You've reached the limit on the number of Ipv6Gateway IDs that you can describe.​
已达到可查询的IPv6网关的ID数量上限。​
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​
LimitExceeded.VpcId​
You've reached the limit on the number of VPC IDs that you can describe.​
已达到可查询的VPC ID数量上限。​
400​
MissingParameter​
The request is missing a required parameter.​
该请求缺少必要参数。​
409​
InvalidOperation.Conflict​
The specified resource operation conflicts.​
指定的资源操作冲突。​
412​
IdempotentProcessing​
The request uses the same client token as a previous one that is still in process.​
幂等请求处理中。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。​
​
​
最近更新时间:2026.09.28 10:48:57
这个页面对您有帮助吗?
有用
有用
无用
无用