DescribeApiProductApis Overview - API Gateway

Queries the attached APIs of an API product.

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

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. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	03442A3D-3B7D-434C-8A95-A5FEB989B519
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of returned entries.	4
ApiInfoList	object
ApiInfo	array<object>	The information about the returned APIs.
	object
ApiId	string	The API ID.	dd46297680014a7e8e318308f3345951
Description	string	The API description.	test
GroupName	string	The name of the API group to which the API belongs.	testApiGroup
GroupId	string	The ID of the API group.	1e377f18142345dfb700cd8911c2463a
Path	string	The request path of the API.	/test
Method	string	The request method of the API.	POST
StageName	string	The environment to which the API is published. Valid values: RELEASE: the production environment PRE: the staging environment TEST: the test environment	RELEASE
ApiName	string	The API name.	testApi
RegionId	string	The ID of the region where the API is deployed.	cn-hangzhou

Examples

Success response

JSON format

{
  "RequestId": "03442A3D-3B7D-434C-8A95-A5FEB989B519",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 4,
  "ApiInfoList": {
    "ApiInfo": [
      {
        "ApiId": "dd46297680014a7e8e318308f3345951",
        "Description": "test",
        "GroupName": "testApiGroup",
        "GroupId": "1e377f18142345dfb700cd8911c2463a",
        "Path": "/test",
        "Method": "POST",
        "StageName": "RELEASE",
        "ApiName": "testApi",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.