DescribeApisByApp - API Gateway - Alibaba Cloud Documentation Center

Queries the APIs with which an application is associated.

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:DescribeApisByApp	get	*App `acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	long	Yes	The application ID.	333486644
PageNumber	integer	No	The number of the current page.	1
PageSize	integer	No	The number of entries per page.	10
ApiUid	string	No	The API ID.	b19240592b1b4e74961fb8438ed7550c
ApiName	string	No	The name of the API. The name is used for fuzzy match.	getPersonInfo
Path	string	No	The request path of the API.	/tt
Method	string	No	The request HTTP method of the API.	POST
Description	string	No	The description of the API.	test

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The number of pages to return the results on.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ015
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	2
AppApiRelationInfos	array<object>	The API authorizations.
AppApiRelationInfo	object
ApiId	string	The API ID.	c625795a1e664782a918eaa629e96ab5
AuthorizationSource	string	The authorization source.	SELF
AuthVaildTime	string	The validity period of the authorization.	Sun, 02 Jan 2022 16:00:00 GMT
Description	string	The authorization description.	b1008kz
GroupName	string	The name of the API group.	wb2022012101605749
GroupId	string	The ID of the API group.	38bed48d664149e4b9b5ea576319673f
Operator	string	The authorizer. Valid values: PROVIDER: API owner CONSUMER: API caller	PROVIDER
StageName	string	The environment name.	RELEASE
StageAlias	string	The environment alias.	Online
CreatedTime	string	The time when the authorization was created.	Sun, 02 Jan 2022 16:00:00 GMT
ApiName	string	The API name.	sd2_h5_player_history_competition
RegionId	string	The region ID.	cn-shanghai
Path	string	The request path of the API.	/api/offline/cacheData
Method	string	The HTTP method of the API.	GET

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ015",
  "PageSize": 10,
  "TotalCount": 2,
  "AppApiRelationInfos": {
    "AppApiRelationInfo": [
      {
        "ApiId": "c625795a1e664782a918eaa629e96ab5",
        "AuthorizationSource": "SELF",
        "AuthVaildTime": "Sun, 02 Jan 2022 16:00:00 GMT",
        "Description": "b1008kz",
        "GroupName": "wb2022012101605749",
        "GroupId": "38bed48d664149e4b9b5ea576319673f",
        "Operator": "PROVIDER",
        "StageName": "RELEASE",
        "StageAlias": "Online",
        "CreatedTime": "Sun, 02 Jan 2022 16:00:00 GMT",
        "ApiName": "sd2_h5_player_history_competition",
        "RegionId": "cn-shanghai",
        "Path": "/api/offline/cacheData",
        "Method": "GET"
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details
2024-03-21	The response structure of the API has changed	View Change Details
2022-06-10	The request parameters of the API has changed	View Change Details