All Products
Search
Document Center

API Gateway:DescribeDeployedApis

Last Updated:Mar 01, 2024

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

Operation description

  • This operation is intended for API callers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeDeployedApisRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringNo

The ID of the API group.

63be9002440b4778a61122f14c2b2bbb
StageNamestringNo

The name of the runtime environment. Valid values:

  • RELEASE
  • TEST
RELEASE
ApiIdstringNo

The ID of the API.

c076144d7878437b8f82fb85890ce6a0
ApiNamestringNo

The name of the API. The name is used for fuzzy match.

weather
PageNumberintegerNo

The number of the page to return. Pages start from page 1. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10
EnableTagAuthbooleanNo

Specifies whether to enable tag verification.

true
Tagobject []No

The list of tags.

KeystringNo

The tag key.

appname
ValuestringNo

The tag value.

testapp
ApiPathstringNo

The request path of the API.

/st4
ApiMethodstringNo

The HTTP method of the API request.

POST

Response parameters

ParameterTypeDescriptionExample
object
PageNumberinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BZ002
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

2
DeployedApisobject []

The returned API information. It is an array consisting of DeployedApiItem data.

Visibilitystring

Indicates whether the API is public. Valid values:

  • PUBLIC
  • PRIVATE
PUBLIC
ApiIdstring

The API ID.

c076144d7878437b8f82fb85890ce6a0
Descriptionstring

The API description.

Queries objects by page
GroupNamestring

The name of the API group to which the API belongs.

myGroup3
GroupIdstring

The API group ID.

63be9002440b4778a61122f14c2b2bbb
DeployedTimestring

The time when the API was published. The time is displayed in UTC.

2016-07-23T08:28:48Z
StageNamestring

The environment name. Valid values:

  • RELEASE
  • TEST
RELEASE
ApiNamestring

The API name.

DescribeObjects
RegionIdstring

The region ID of the API.

cn-qingdao
ApiPathstring

The request path of the API.

/trademark/search
ApiMethodstring

The HTTP method of the API request.

POST

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2022-09-02The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ApiPath
    Added Input Parameters: ApiMethod
Output ParametersThe response structure of the API has changed.