All Products
Search
Document Center

Global Accelerator:ListCustomRoutingEndpointTrafficPolicies

Last Updated:Jul 31, 2024

Queries the traffic policies of an endpoint that belongs to a custom routing listener.

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
ga:ListCustomRoutingEndpointTrafficPolicieslist
  • CustomRoutingEndpointTrafficPolicy
    acs:ga:*:{#accountId}:ga/{#gaId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the Global Accelerator (GA) instance. Set the value to cn-hangzhou.

cn-hangzhou
PageNumberstringNo

The page number. Default value: 1.

1
PageSizestringNo

The number of entries per page. Valid values: 1 to 50. Default value: 10.

10
AcceleratorIdstringYes

The ID of the GA instance to which the traffic policies belong.

ga-bp1odcab8tmno0hdq****
ListenerIdstringNo

The ID of the listener to which the traffic policies belong.

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstringNo

The ID of the endpoint group to which the traffic policies belong.

lsr-bp1bpn0kn908w4nbw****
EndpointIdstringNo

The ID of the endpoint to which the traffic policies belong.

ep-bp16jdc00bhe97sr5****
AddressstringNo

The IP address of the traffic destination.

10.0.XX.XX

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
Policiesarray<object>

A list of traffic policies.

object
AcceleratorIdstring

The ID of the GA instance to which the endpoint belongs.

ga-bp1odcab8tmno0hdq****
ListenerIdstring

The ID of the custom routing listener to which the endpoint belongs.

lsr-bp1bpn0kn908w4nbw****
EndpointGroupIdstring

The ID of the endpoint group to which the endpoint belongs.

lsr-bp1bpn0kn908w4nbw****
EndpointIdstring

The ID of the endpoint to which the traffic policy belongs.

ep-bp14sz7ftcwwjgrdm****
PolicyIdstring

The ID of the traffic policy.

ply-bp1dmlohjjz4kqaun****
Addressstring

The IP addresses of the traffic policies.

10.0.XX.XX
PortRangesarray<object>

The port range of the traffic policy.

object
FromPortinteger

The first port of the port range used by the traffic destination to process requests.

80
ToPortinteger

The last port of the port range used by the traffic destination to process requests.

80
ServiceIdstring

The ID of the service that manages the instance.

Note This parameter is returned only if the value of ServiceManaged is true.
ALB
ServiceManagedboolean

Indicates whether the instance is managed. Valid values:

  • true: The GA instance is managed.
  • false: The GA instance is not managed.
true
ServiceManagedInfosarray<object>

The actions that users can perform on the managed instance.

Note
  • This parameter is returned only if the value of ServiceManaged is true.
  • Users can perform only specific actions on a managed instance.
  • object
    Actionstring

    The name of the action on the managed instance. Valid values:

    • Create: Create an instance.
    • Update: Update the current instance.
    • Delete: Delete the current instance.
    • Associate: Reference the current instance.
    • UserUnmanaged: Unmanage the instance.
    • CreateChild: Create a child resource in the current instance.
    Update
    ChildTypestring

    The type of the child resource. Valid values:

    • Listener: listener.
    • IpSet: acceleration region.
    • EndpointGroup: endpoint group.
    • ForwardingRule: forwarding rule.
    • Endpoint: endpoint.
    • EndpointGroupDestination: protocol mapping of an endpoint group associated with a custom routing listener.
    • EndpointPolicy: traffic policy of an endpoint associated with a custom routing listener.
    Note This parameter is returned only if the value of Action is CreateChild.
    Listener
    IsManagedboolean

    Indicates whether the specified actions are managed. Valid values:

    • true: The specified actions are managed, and users cannot perform the specified actions on the managed instance.
    • false: The specified actions are not managed, and users can perform the specified actions on the managed instance.
    false

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
      "TotalCount": 1,
      "PageSize": 10,
      "PageNumber": 1,
      "Policies": [
        {
          "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
          "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
          "EndpointGroupId": "lsr-bp1bpn0kn908w4nbw****",
          "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
          "PolicyId": "ply-bp1dmlohjjz4kqaun****",
          "Address": "10.0.XX.XX",
          "PortRanges": [
            {
              "FromPort": 80,
              "ToPort": 80
            }
          ],
          "ServiceId": "ALB",
          "ServiceManaged": true,
          "ServiceManagedInfos": [
            {
              "Action": "Update",
              "ChildType": "Listener",
              "IsManaged": false
            }
          ]
        }
      ]
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400NoPermissionNo permissions.No permissions.

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

    Change history

    Change timeSummary of changesOperation
    2024-07-11The Error code has changedView Change Details
    2023-07-20The internal configuration of the API is changed, but the call is not affectedView Change Details