All Products
Search
Document Center

Virtual Private Cloud:DescribeIpv6EgressOnlyRules

Last Updated:Jan 29, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeIpv6EgressOnlyRulesRead
  • Ipv6Gateway
    acs:vpc:{#regionId}:{#accountId}:ipv6gateway/{#Ipv6GatewayId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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
Ipv6GatewayIdstringYes

The ID of the IPv6 gateway.

ipv6gw-bp1rhhs9zjlxukc5e****
Ipv6EgressOnlyRuleIdstringNo

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

ipv6py-bp1rr7fq1md8pbb3k****
NamestringNo

The name of the rule.

rulename
InstanceTypestringNo

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
InstanceIdstringNo

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

ipv6gw-bp1rhhs9zjlxukc5e****
PageNumberintegerNo

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

1
PageSizeintegerNo

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

10

Response parameters

ParameterTypeDescriptionExample
object
PageSizeinteger

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

10
RequestIdstring

The ID of the request.

E16671B7-DEA6-48E0-8E9C-41913DAD44DD
PageNumberinteger

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

1
TotalCountinteger

The total number of entries returned.

1
Ipv6EgressOnlyRulesobject []

The details about the egress-only rules.

Statusstring

The status of the egress-only rule.

Available
Descriptionstring

The description of the egress-only rule.

ruledescription
Ipv6EgressOnlyRuleIdstring

The ID of the egress-only rule.

ipv6py-bp1rr7fq1md8pbb3k****
InstanceIdstring

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

ipv6gw-bp1rhhs9zjlxukc5e****
InstanceTypestring

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

Ipv6Address
Namestring

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.