DescribeAppsByApiProduct Overview - API Gateway - Alibaba Cloud - API Gateway

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ApiProductId	string	Yes	The ID of the API product.	117b7a64a8b3f064eaa4a47ac62aac5e
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 per page. Maximum value: 100. Default value: 10.	10
AppName	string	No	The application name.	testApp

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	AC866798-62D3-52F4-8AB5-CA149A53984F
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of returned entries.	4
AuthorizedApps	object
AuthorizedApp	array<object>	The information about authorized applications.
	object
AppName	string	The application name.	APP_02580_DEV
Description	string	The authorization description.	Authorization description
AuthValidTime	string	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
AppId	integer	The application ID.	110982419
Extend	string	The extended information.	extra info
AuthorizedTime	string	The time when the authorization was created. The time is in GMT.	2016-07-21T06:17:20Z

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.