All Products
Search
Document Center

API Gateway:DescribeAppsByApiProduct

Last Updated:Jul 31, 2025

Queries authorized applications by API product.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:DescribeAppsByApiProductget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ApiProductIdstringYes

The ID of the API product.

117b7a64a8b3f064eaa4a47ac62aac5e
PageNumberintegerNo

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

1
PageSizeintegerNo

The number of entries per page. Maximum value: 100. Default value: 10.

10
AppNamestringNo

The application name.

testApp

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

AC866798-62D3-52F4-8AB5-CA149A53984F
PageSizeinteger

The number of entries per page.

10
PageNumberinteger

The page number.

1
TotalCountinteger

The total number of returned entries.

4
AuthorizedAppsarray<object>

The information about authorized applications.

AuthorizedAppobject
AppNamestring

The application name.

APP_02580_DEV
Descriptionstring

The authorization description.

Test share with nsc qiming
AuthValidTimestring

The expiration time of the authorization. The time is in GMT. An empty value indicates that the authorization does not expire.

2023-06-17T03:41:53Z
AppIdlong

The application ID.

110982419
Extendstring

The extended information.

extra info
AuthorizedTimestring

The time when the authorization was created. The time is in GMT.

2016-07-21T06:17:20Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "AC866798-62D3-52F4-8AB5-CA149A53984F",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 4,
  "AuthorizedApps": {
    "AuthorizedApp": [
      {
        "AppName": "APP_02580_DEV",
        "Description": "Test share with nsc qiming",
        "AuthValidTime": "2023-06-17T03:41:53Z",
        "AppId": 110982419,
        "Extend": "extra info",
        "AuthorizedTime": "2016-07-21T06:17:20Z"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history