All Products
Search

This Product

    Global Accelerator:DescribeCustomRoutingEndpoint

    Document Center

    Global Accelerator:DescribeCustomRoutingEndpoint

    Last Updated:Apr 28, 2024

    Queries a specified endpoint that is associated with 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:DescribeCustomRoutingEndpointRead
    • CustomRoutingEndpoint
      acs:ga:{#regionId}:{#accountId}:customroutingendpoint/{#CustomRoutingEndpointId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

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

    		cn-hangzhou
    EndpointIdstringYes

    The ID of the endpoint.

    		ep-bp1dmlohjjz4kqaun****
    EndpointGroupstringNo

    The ID of the endpoint group.

    		epg-bp1j184jhb9i9ubwf****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

    		String 04F0F334-1335-436C-A1D7-6C044FE73368
    AcceleratorIdstring

    The ID of the GA instance with which the endpoint is associated.

    		ga-bp1odcab8tmno0hdq****
    ListenerIdstring

    The ID of the listener with which the endpoint is associated.

    		lsr-bp1bpn0kn908w4nbw****
    EndpointGroupIdstring

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

    		epg-bp14sz7ftcwwjgrdm****
    EndpointIdstring

    The ID of the endpoint.

    		ep-bp1dmlohjjz4kqaun****
    Typestring

    The backend service type of the endpoint.

    Set the value to PrivateSubNet, which indicates private CIDR blocks.

    		PrivateSubNet
    Endpointstring

    The name of the endpoint (vSwitch).

    		vsw-test01
    TrafficToEndpointPolicystring

    The access policy of traffic for the specified endpoint. Valid values:

    • AllowAll: allows all traffic to the endpoint.
    • DenyAll: denies all traffic to the endpoint.
    • AllowCustom: allows traffic only to specified destinations.
    		DenyAll
    Statestring

    The status of the endpoint.

    		active
    ServiceIdstring

    The service ID to which the managed instance belongs.

    Note Valid only when the ServiceManaged parameter is True.
    		ALB
    ServiceManagedboolean

    Is it a managed instance. Valid values:

    • true
    • false
    		true
    ServiceManagedInfosobject []

    A list of action policies that users can execute on this managed instance.

    Actionstring

    Managed policy action name, Valid values:

    • Create
    • Update
    • Delete
    • Associate
    • UserUnmanaged
    • CreateChild
    		Update
    ChildTypestring

    Sub resource type, Valid values:

    • Listener
    • IpSet
    • EndpointGroup
    • ForwardingRule
    • Endpoint
    • EndpointGroupDestination
    • EndpointPolicy
    Note Only valid when the Action parameter is CreateChild.
    		Listener
    IsManagedboolean

    Is the managed policy action managed, Valid values:

    • true: The managed policy action is managed, and users do not have permission to perform the operation specified in the Action on the managed instance.

    • false: The managed policy action is not managed, and users have permission to perform the operation specified in the Action on the managed instance.

    		false

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "String\t04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "EndpointGroupId": "epg-bp14sz7ftcwwjgrdm****",
  "EndpointId": "ep-bp1dmlohjjz4kqaun****",
  "Type": "PrivateSubNet",
  "Endpoint": "vsw-test01",
  "TrafficToEndpointPolicy": "DenyAll",
  "State": "active",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ]
}

    Error codes

    HTTP status codeError codeError messageDescription
    500UnknownErrorAn error occurred while processing your request. Please try again. If the error persists, please submit a ticket.An error occurred while the request was being processed. Try again later.

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

    Change history

    Change timeSummary of changesOperation
    2023-04-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 500