DescribeIpv6EgressOnlyRules - Virtual Private Cloud - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the IPv6 gateway is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-huhehaote
Ipv6GatewayId	string	Yes	The ID of the IPv6 gateway.	ipv6gw-bp1rhhs9zjlxukc5e****
Ipv6EgressOnlyRuleId	string	No	The ID of the egress-only rule that you want to query.	ipv6py-bp1rr7fq1md8pbb3k****
Name	string	No	The name of the rule.	rulename
InstanceType	string	No	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.	Ipv6Address
InstanceId	string	No	The ID of the instance that is associated with the IPv6 address to which the egress-only rule is applied.	ipv6gw-bp1rhhs9zjlxukc5e****
PageNumber	integer	No	The number of the page to return. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page. Maximum value: 50. Default value: 10.	10
RequestId	string	The ID of the request.	E16671B7-DEA6-48E0-8E9C-41913DAD44DD
PageNumber	integer	The number of the returned page. Default value: 1.	1
TotalCount	integer	The total number of entries returned.	1
Ipv6EgressOnlyRules	array<object>	The details about the egress-only rules.
	object
Status	string	The status of the egress-only rule.	Available
Description	string	The description of the egress-only rule.	ruledescription
Ipv6EgressOnlyRuleId	string	The ID of the egress-only rule.	ipv6py-bp1rr7fq1md8pbb3k****
InstanceId	string	The ID of the instance to which the egress-only rule applies.	ipv6gw-bp1rhhs9zjlxukc5e****
InstanceType	string	The type of the instance to which the egress-only rule applies.	Ipv6Address
Name	string	The name of the egress-only rule.	rulename

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "E16671B7-DEA6-48E0-8E9C-41913DAD44DD",
  "PageNumber": 1,
  "TotalCount": 1,
  "Ipv6EgressOnlyRules": {
    "Ipv6EgressOnlyRule": [
      {
        "Status": "Available",
        "Description": "ruledescription",
        "Ipv6EgressOnlyRuleId": "ipv6py-bp1rr7fq1md8pbb3k****",
        "InstanceId": "ipv6gw-bp1rhhs9zjlxukc5e****",
        "InstanceType": "Ipv6Address",
        "Name": "rulename"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-28	API Description Update	View Change Details