全部产品
Search
文档中心

API 网关:DescribeApiProductApis - 查询API产品绑定的API列表

更新时间:Apr 01, 2024

查询API产品绑定的API列表

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ApiProductIdstring

API 产品 ID

117b7a64a8b3f064eaa4a47ac62aac5e
PageNumberinteger

指定要查询的页码,默认是 1,起始是 1

1
PageSizeinteger

分页参数,每页显示条数,默认值 10

10

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

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

分页参数:当前页码

1
PageSizeinteger

分页参数:每页显示条数

10
TotalCountinteger

返回结果的总条数

4
ApiInfoListobject []

返回的 API 列表信息

ApiIdstring

API 的 ID

dd46297680014a7e8e318308f3345951
Descriptionstring

API 的描述信息

test
GroupNamestring

api 分组名称

testApiGroup
GroupIdstring

api 分组 ID

1e377f18142345dfb700cd8911c2463a
Pathstring

API 的请求路径

/test
Methodstring

API 的请求方法

POST
StageNamestring

API 的环境。

  • RELEASE: 线上
  • PRE: 预发
  • TEST: 测试
RELEASE
ApiNamestring

API 名称

testApi
RegionIdstring

所在的 region

cn-hangzhou

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。