DescribeApisByBackend - API Gateway - Alibaba Cloud Documentation Center

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeApisByBackend	get	*Backend `acs:apigateway:{#regionId}:{#accountId}:backend/{#BackendId}`	none	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 parameters

Parameter	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	array<object>	The information about the returned API list.
ApiInfo	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

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation

No change history