Query APIs by backend service - API Gateway

Queries APIs in the draft or published state that are created by using a specified backend service.

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

apigateway:DescribeApisByBackend

get

*Backend

acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}

None

Request parameters

Parameter	Type	Required	Description	Example
BackendId	string	Yes	The ID of the backend service.	4ac69b7a17524781b275ed4c5eb25c54
StageName	string	No	The environment to which the API is published. Valid values: RELEASE PRE TEST If you do not specify this parameter, APIs in the draft state are returned.	PRE
PageSize	integer	No	The number of entries to return on each page.	10
PageNumber	integer	No	The number of the current page.	1

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The number of the current page.	1
RequestId	string	The ID of the request.	CEB6EC62-B6C7-5082-A45A-45A204724AC2
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of entries returned.	1
ApiInfoList	object
ApiInfo	array<object>	The information about the returned API list.
	object
ApiId	string	The ID of the API.	20bcdc9453524b78a8beb1f6de21edb7
Description	string	The description of the API.	test
GroupName	string	The name of the API group.	testApiGroup
GroupId	string	The ID of the API group.	15bcdc9453524b7gs8beb1f6de21edb7
Path	string	The request path of the API.	/test
Method	string	The request method of the API.	GET
ApiName	string	The name of the API.	testApi

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "CEB6EC62-B6C7-5082-A45A-45A204724AC2",
  "PageSize": 10,
  "TotalCount": 1,
  "ApiInfoList": {
    "ApiInfo": [
      {
        "ApiId": "20bcdc9453524b78a8beb1f6de21edb7",
        "Description": "test",
        "GroupName": "testApiGroup",
        "GroupId": "15bcdc9453524b7gs8beb1f6de21edb7",
        "Path": "/test",
        "Method": "GET",
        "ApiName": "testApi"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.