All Products
Search
Document Center

API Gateway:DescribeApiProductApis

Last Updated:Jul 31, 2025

Queries the attached APIs of an 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:DescribeApiProductApisget
*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. Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

03442A3D-3B7D-434C-8A95-A5FEB989B519
PageNumberinteger

The page number.

1
PageSizeinteger

The number of entries per page.

10
TotalCountinteger

The total number of returned entries.

4
ApiInfoListarray<object>

The information about the returned APIs.

ApiInfoobject
ApiIdstring

The API ID.

dd46297680014a7e8e318308f3345951
Descriptionstring

The API description.

test
GroupNamestring

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

testApiGroup
GroupIdstring

The ID of the API group.

1e377f18142345dfb700cd8911c2463a
Pathstring

The request path of the API.

/test
Methodstring

The request method of the API.

POST
StageNamestring

The environment to which the API is published. Valid values:

  • RELEASE: the production environment
  • PRE: the staging environment
  • TEST: the test environment
RELEASE
ApiNamestring

The API name.

testApi
RegionIdstring

The ID of the region where the API is deployed.

cn-hangzhou

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
No change history