Queries egress-only rules.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
RegionId String Yes cn-huhehaote

The ID of the region where the IPv6 gateway is deployed. You can call the DescribeRegions operation to query the most recent region list.

Ipv6GatewayId String Yes ipv6gw-bp1rhhs9zjlxukc5e****

The ID of the IPv6 gateway.

Ipv6EgressOnlyRuleId String No ipv6py-bp1rr7fq1md8pbb3k****

The ID of the egress-only rule that you want to query.

Name String No rulename

The name of the rule.

InstanceType String No Ipv6Address

The type of the instance to which you want to apply the egress-only rule. Set the value to

Ipv6Address, which specifies that the egress-only rule applies to an IPv6 address.

InstanceId String No ipv6gw-bp1rhhs9zjlxukc5e****

The ID of the instance that is associated with the IPv6 address to which the egress-only rule is applied.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 50. Default value: 10.

Action String Yes DescribeIpv6EgressOnlyRules

The operation that you want to perform. Set the value to DescribeIpv6EgressOnlyRules.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page. Maximum value: 50. Default value: 10.

RequestId String E16671B7-DEA6-48E0-8E9C-41913DAD44DD

The ID of the request.

PageNumber Integer 1

The number of the returned page. Default value: 1.

TotalCount Integer 1

The total number of entries returned.

Ipv6EgressOnlyRules Array of Ipv6EgressOnlyRule

The details about the egress-only rules.

Ipv6EgressOnlyRule
Status String Available

The status of the egress-only rule.

Description String ruledescription

The description of the egress-only rule.

Ipv6EgressOnlyRuleId String ipv6py-bp1rr7fq1md8pbb3k****

The ID of the egress-only rule.

InstanceId String ipv6gw-bp1rhhs9zjlxukc5e****

The ID of the instance to which the egress-only rule applies.

InstanceType String Ipv6Address

The type of the instance to which the egress-only rule applies.

Name String rulename

The name of the egress-only rule.

Examples

Sample requests

http(s)://[Endpoint]/?RegionId=cn-huhehaote
&Ipv6GatewayId=ipv6gw-bp1rhhs9zjlxukc5e****
&Ipv6EgressOnlyRuleId=ipv6py-bp1rr7fq1md8pbb3k****
&Name=rulename
&InstanceType=Ipv6Address
&InstanceId=ipv6gw-bp1rhhs9zjlxukc5e****
&PageNumber=1
&PageSize=10
&Action=DescribeIpv6EgressOnlyRules
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeIpv6EgressOnlyRulesResponse>
    <PageSize>10</PageSize>
    <RequestId>E16671B7-DEA6-48E0-8E9C-41913DAD44DD</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Ipv6EgressOnlyRules>
        <Status>Available</Status>
        <Description>ruledescription</Description>
        <Ipv6EgressOnlyRuleId>ipv6gwpy-123456xxxxxxxx</Ipv6EgressOnlyRuleId>
        <InstanceId>i-123456xxxxxxxx</InstanceId>
        <InstanceType>Ipv6Address</InstanceType>
        <Name>rulename</Name>
    </Ipv6EgressOnlyRules>
</DescribeIpv6EgressOnlyRulesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "E16671B7-DEA6-48E0-8E9C-41913DAD44DD",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "Ipv6EgressOnlyRules" : {
    "Status" : "Available",
    "Description" : "ruledescription",
    "Ipv6EgressOnlyRuleId" : "ipv6gwpy-123456xxxxxxxx",
    "InstanceId" : "i-123456xxxxxxxx",
    "InstanceType" : "Ipv6Address",
    "Name" : "rulename"
  }
}

Error codes

For a list of error codes, see Service error codes.