DescribeApisWithStageNameIntegratedByApp for querying APIs by application and stage - API Gateway

Queries APIs by application and returns the result by environment.

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:DescribeApisWithStageNameIntegratedByApp

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	integer	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 elements

Element	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	object
AppApiRelationInfo	array<object>	The authorization information of the API.
	array<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.	Sun, 02 Jan 2022 16:00:00 GMT

Examples

Success response

JSON format

{
  "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": "Sun, 02 Jan 2022 16:00:00 GMT"
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.