Use DescribeDeployedApis to query APIs deployed to a specified environment - API Gateway - Alibaba Cloud - API Gateway

Queries the APIs that have been published to a specified environment.

Operation description

This API is intended for API providers.

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

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The ID of the API group.	63be9002440b4778a61122f14c2b2bbb
StageName	string	No	The name of the runtime environment. Valid values: RELEASE TEST	RELEASE
ApiId	string	No	The ID of the API.	c076144d7878437b8f82fb85890ce6a0
ApiName	string	No	The name of the API. The name is used for fuzzy match.	weather
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 10.	10
EnableTagAuth	boolean	No	Specifies whether to enable tag verification.	true
Tag	array<object>	No	The tags.
	object	No
Key	string	No	The tag key.	appname
Value	string	No	The tag value.	testapp
ApiPath	string	No	The request path of the API.	/st4
ApiMethod	string	No	The HTTP method of the API request.	POST

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	1
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ002
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	2
DeployedApis	object
DeployedApiItem	array<object>	The returned API information. It is an array consisting of DeployedApiItem data.
	object
Visibility	string	Indicates whether the API is public. Valid values: PUBLIC PRIVATE	PUBLIC
ApiId	string	The ID of the API.	c076144d7878437b8f82fb85890ce6a0
Description	string	The description of the API.	Paginated list of objects
GroupName	string	The name of the group to which the API belongs.	myGroup3
GroupId	string	The ID of the API group.	63be9002440b4778a61122f14c2b2bbb
DeployedTime	string	The publising time (UTC) of the API.	2016-07-23T08:28:48Z
StageName	string	The name of the runtime environment. Valid values: RELEASE TEST	RELEASE
ApiName	string	The name of the API.	Obtains the list of objects
RegionId	string	The region where the API is located.	cn-qingdao
ApiPath	string	The request path of the API.	/trademark/search
ApiMethod	string	The HTTP method of the API request.	POST

Examples

Success response

JSON format

{
  "PageNumber": 1,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ002",
  "PageSize": 10,
  "TotalCount": 2,
  "DeployedApis": {
    "DeployedApiItem": [
      {
        "Visibility": "PUBLIC",
        "ApiId": "c076144d7878437b8f82fb85890ce6a0",
        "Description": "Paginated list of objects",
        "GroupName": "myGroup3",
        "GroupId": "63be9002440b4778a61122f14c2b2bbb",
        "DeployedTime": "2016-07-23T08:28:48Z",
        "StageName": "RELEASE",
        "ApiName": "Obtains the list of objects",
        "RegionId": "cn-qingdao",
        "ApiPath": "/trademark/search",
        "ApiMethod": "POST"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.