DescribeIpv6EgressOnlyRules

Queries IPv6 egress-only rules that you created.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeIpv6EgressOnlyRules

get

*Ipv6Gateway

acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the IPv6 gateway. You can call the DescribeRegions operation to query the region ID.	cn-huhehaote
Ipv6GatewayId	string	Yes	The ID of the IPv6 gateway.	ipv6gw-bp1rhhs9zjlxukc5e****
Ipv6EgressOnlyRuleId	string	No	The ID of the IPv6 egress-only rule to query.	ipv6py-bp1rr7fq1md8pbb3k****
Name	string	No	The name of the rule.	rulename
InstanceType	string	No	The type of the instance for which you want to configure IPv6 egress-only rules. Valid values: IPv6Address (default): The instance is a single IPv6 address. IPv6Prefix: The instance is an IPv6 CIDR block.	Ipv6Address
InstanceId	string	No	The ID of the IPv6 address for which the IPv6 egress-only rule is configured.	ipv6-bp12uzwhac8tv3xx6****
PageNumber	integer	No	The page number of the list to return. Default value: 1.	1
PageSize	integer	No	The number of entries per page for a paged query. Maximum value: 50. Default value: 10.	10
RegionId	string	Yes	The region ID of the IPv6 gateway. You can call the DescribeRegions operation to query the region ID.	cn-huhehaote

Response elements

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

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.