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.
Debugging
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:
- The required resource types are displayed in bold characters.
- 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:DescribeApis | Read |
|
| 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 |
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 | object [] | No | The tags of objects that match the rule. | Key, Value |
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 |
Response parameters
Examples
Sample success responses
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": "Creates an object\n",
"GroupName": "myGroup2",
"GroupId": "1084f9034c744137901057206b39d2b6",
"CreatedTime": "2016-05-20T18:18:25Z",
"ApiName": "CreateObject\n",
"RegionId": "cn-qingdao",
"ApiPath": "/sqb/",
"ApiMethod": "GET",
"DeployedInfos": {
"DeployedInfo": [
{
"StageName": "RELEASE",
"EffectiveVersion": "20220103170737313",
"DeployedStatus": "DEPLOYED"
}
]
},
"TagList": {
"Tag": [
{
"TagKey": "tagKey",
"TagValue": "tagValue"
}
]
}
}
]
}
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-03-23 | The response structure of the API has changed | see changesets | ||||||||||
| ||||||||||||
2022-09-02 | The request parameters of the API has changed. The response structure of the API has changed | see changesets | ||||||||||
|