Query a list of APIs with DescribeApis - API Gateway - Alibaba Cloud - API Gateway

Queries a list of APIs that are being defined.

Operation description

This operation is intended for API callers.
This operation returns a list of all APIs that are being defined. The basic information about these APIs is also returned in the list.
This operation returns all APIs that are being edited, regardless of their environments. The returned definitions may be different from the definitions in the environments.

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

get

*ApiGroup

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

None

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The API group ID.	c4a4d2de657548a2bd485d5d4df42b4a
ApiId	string	No	The API ID.	f68c19ee3bd1478fb58aa05ce8ae9b5a
ApiName	string	No	The API name. The name is used for fuzzy match.	weather
CatalogId	string	No	The category ID.	1553414085247362
Visibility	string	No	Specifies whether the API is public. Valid values: PUBLIC: The API is public. If you publish the definition of a public API to the production environment, the definition is displayed on the APIs page for all users. PRIVATE: The API is private. If you publish an API group that contains a private API in Alibaba Cloud Marketplace, the API is not displayed in Alibaba Cloud Marketplace.	PUBLIC
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
EnableTagAuth	boolean	No	Specifies whether to enable tag verification.	true
Tag	array<object>	No	The tags of objects that match the rule.	Key, Value
	object	No
Key	string	No	The tag key.	key
Value	string	No	The tag value.	value
ApiPath	string	No	The request path of the API.	/illegal/query
ApiMethod	string	No	The HTTP method of the API request.	GET
UnDeployed	boolean	No	Specifies whether to filter unpublished APIs.	true
StageName	string	No	The environment in which you want to perform this operation. Valid values: RELEASE: the production environment PRE: the staging environment TEST: the test environment	RELEASE

Response elements

Element	Type	Description	Example
	object
PageNumber	integer	The page number of the returned page.	3
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BZ002
PageSize	integer	The number of entries returned per page.	15
TotalCount	integer	The total number of returned entries.	32
ApiSummarys	object
ApiSummary	array<object>	The queried API definitions.
	array<object>
Visibility	string	Indicates whether the API is public. Valid values: PUBLIC: The API is public. PRIVATE: The API is private.	PUBLIC
ApiId	string	The API ID.	5af418828f0344a3b588c0cc1331a3bc
ModifiedTime	string	The time when the API was modified. The time is displayed in UTC.	2016-07-23T08:28:48Z
Description	string	The API description.	Create object API
GroupName	string	The name of the API group to which the API belongs.	myGroup2
GroupId	string	The API group ID.	1084f9034c744137901057206b39d2b6
CreatedTime	string	The time when the API was created. The time is displayed in UTC.	2016-05-20T18:18:25Z
ApiName	string	The API name.	Create object
RegionId	string	The ID of the region to which the API belongs.	cn-qingdao
ApiPath	string	The request path of the API.	/sqb/
ApiMethod	string	The HTTP method of the API request.	GET
DeployedInfos	object
DeployedInfo	array<object>	The API publishing statuses.
	object	The API publishing status.
StageName	string	Stage Name: RELEASE: production environment PRE: staging environment TEST: test environment	RELEASE
EffectiveVersion	string	The deployed version.	20220103170737313
DeployedStatus	string	The deployment status. Valid values: DEPLOYED and NONDEPLOYED.	DEPLOYED
TagList	object
Tag	array<object>	The tags that are added to the APIs.
	object	The information about the array object.
TagKey	string	The tag key.	tagKey
TagValue	string	The tag value.	tagValue

Examples

Success response

JSON format

{
  "PageNumber": 3,
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ002",
  "PageSize": 15,
  "TotalCount": 32,
  "ApiSummarys": {
    "ApiSummary": [
      {
        "Visibility": "PUBLIC",
        "ApiId": "5af418828f0344a3b588c0cc1331a3bc",
        "ModifiedTime": "2016-07-23T08:28:48Z",
        "Description": "Create object API",
        "GroupName": "myGroup2",
        "GroupId": "1084f9034c744137901057206b39d2b6",
        "CreatedTime": "2016-05-20T18:18:25Z",
        "ApiName": "Create object",
        "RegionId": "cn-qingdao",
        "ApiPath": "/sqb/",
        "ApiMethod": "GET",
        "DeployedInfos": {
          "DeployedInfo": [
            {
              "StageName": "RELEASE",
              "EffectiveVersion": "20220103170737313",
              "DeployedStatus": "DEPLOYED"
            }
          ]
        },
        "TagList": {
          "Tag": [
            {
              "TagKey": "tagKey",
              "TagValue": "tagValue"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.