DescribeApisWithStageNameIntegratedByApp - API Gateway - Alibaba Cloud Documentation Center

Queries APIs by application and returns the result by environment.

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:DescribeApisWithStageNameIntegratedByApp	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	long	Yes	The application ID.	2386789
PageNumber	integer	No	The page number of the page to return.	1
PageSize	integer	No	The number of entries per page.	10
ApiUid	string	No	The API ID.	b19240592b1b4e74961fb8438ed7550c
ApiName	string	No	The API name.	ApiName
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 API description. The description can be up to 200 characters in length.	test

Response parameters

Parameter	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The request ID.	6C87A26A-6A18-4B8E-8099-705278381A2C
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	2
AppApiRelationInfos	array<object>	The authorization information of the API.
AppApiRelationInfo	object
ApiId	string	The API ID.	c625795a1e664782a918eaa629e96ab5
AuthorizationSource	string	The authorization source.	SELF
Description	string	The API description.	b1008kz
GroupName	string	The name of the API group.	manager_vehicles
GroupId	string	The ID of the API group.	38bed48d664149e4b9b5ea576319673f
Operator	string	The authorizer. Valid values: PROVIDER: the API owner CONSUMER: the API caller	PROVIDER
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 request HTTP method of the API.	POST
StageNameAndAuth	object	The mapping information between environments and authorizations.
	string	The environment name.	RELEASE

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "6C87A26A-6A18-4B8E-8099-705278381A2C",
  "PageSize": 10,
  "TotalCount": 2,
  "AppApiRelationInfos": {
    "AppApiRelationInfo": [
      {
        "ApiId": "c625795a1e664782a918eaa629e96ab5",
        "AuthorizationSource": "SELF",
        "Description": "b1008kz",
        "GroupName": "manager_vehicles",
        "GroupId": "38bed48d664149e4b9b5ea576319673f",
        "Operator": "PROVIDER",
        "CreatedTime": "Sun, 02 Jan 2022 16:00:00 GMT",
        "ApiName": "sd2_h5_player_history_competition",
        "RegionId": "cn-shanghai",
        "Path": "/api/offline/cacheData",
        "Method": "POST",
        "StageNameAndAuth": {
          "key": "RELEASE"
        }
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history