DescribeIpv6EgressOnlyRules--IPv6网关-火山引擎

文档中心

立即注册

导航

DescribeIpv6EgressOnlyRules

最近更新时间：2024.01.11 10:32:56首次发布时间：2023.01.10 10:28:03

调用 DescribeIpv6EgressOnlyRules 接口，查询满足指定条件的仅主动出规则。

调用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的IPv6公网带宽，若没有符合条件的IPv6公网带宽，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有IPv6公网带宽。

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeIpv6EgressOnlyRules	要执行的操作，取值为DescribeIpv6EgressOnlyRules。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
Ipv6GatewayId	String	是	ipv6gw-hp3rwmtmfhgis****	IPv6网关的ID。您可以调用 DescribeIpv6Gateways 接口，查询IPv6网关的ID。
InstanceId	String	否	eip-hp3nxjkfxn5pnhgl5****	仅主动出规则关联的IPv6公网带宽ID。
Ipv6Address	String	否	2408:XXXX:153:3921:851c:c435:7b12:1c5f	仅主动出规则作用的IPv6地址。
Ipv6EgressOnlyRuleIds.N	String	否	ipv6py-fhjshfsfweryew****	仅主动出规则的ID。参数 - N：表示仅主动出规则ID的序号，取值范围为1 ～ 100，表示指定仅主动出规则ID时最多可查询100个。多个仅主动出规则ID间使用&分隔。
Name	String	否	rulename	仅主动出规则的名称。
PageNumber	Integer	否	1	列表的页码，起始值为1，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1～100，默认值为20。
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	202106241530330102251****	请求ID。
TotalCount	Integer	2	符合条件的仅主动出规则总数。说明本参数即将下线，使用`NextToken`和`MaxResults`分页查询时，此参数无意义。
PageNumber	Integer	1	当前页码。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
PageSize	Integer	10	当前分页的行数。说明本参数即将下线，建议您使用`NextToken`和`MaxResults`进行分页查询。
NextToken	String	caeba0bbb2be03f84eb48b699f0a****	本次API调用返回的查询凭证，标记分页的位置，用于下一次查询。返回为空表示没有下一页。
Ipv6EgressRules	Array	-	符合条件的仅主动出规则的详细信息。具体请参见下表“ Ipv6EgressRules结构”。

Ipv6EgressRules结构

参数名称	类型	示例值	描述
Ipv6EgressOnlyRuleId	String	ipv6py-fhjshfsfweryew****	仅主动出规则的ID。
Name	String	rulename	仅主动出规则的名称。
Description	String	descriptionforrule	仅主动出规则的描述信息。
InstanceId Status	String String	eip-hp3nxjkfxn5pnhgl5**** Available	待添加仅主动出规则的IPv6公网带宽ID。 IPv6仅主动出规则的运行状态。 Creating：创建中。 Available：可用。

请求示例

GET /?Action=DescribeIpv6EgressOnlyRules&Version=2020-04-01&Ipv6GatewayId=ipv6gw-hp3rwmtmfhgis**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: vpc

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106241530330102251****",
        "Action": "DescribeIpv6EgressOnlyRules",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-guangzhou"
    }, 
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "TotalCount":2,
        "PageNumber": 1,
        "PageSize": 20,
        "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
        "Ipv6EgressRules": [
            {
                "Ipv6EgressOnlyRuleId": "ipv6py-fhjshfsfweryew***",
                "Name": "rulename",
                "Description": "",
                "InstanceId": "eip-hp3nxjkfxn5pnhgl5****",
                "Status": "Available"
    }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
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	LimitExceeded.Ipv6EgressOnlyRule	You've reached the limit on the number of Ipv6EgressOnlyRule IDs that you can describe.	已达到可查询的IPv6仅主动出规则的ID数量上限。
404	InvalidRouteNextHop.NotFound	The specified next hop does not exist.	指定的下一跳不存在。