查询插件绑定的API列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apigateway:DescribePluginApis | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PluginId | string | 是 | 指定要查询的 API 网关插件的 ID。 | bf6583efcef44c51adb00c4e******** |
| GroupId | string | 否 | 指定要查询的 API 所属分组 ID。 | 231a4bb81ee94da785733c29******** |
| ApiId | string | 否 | 指定要查询的 API 编号。 | c6b0dd188b0e4e408e12f926******** |
| ApiName | string | 否 | API 名称。 | API名称 |
| Path | string | 否 | API 请求路径。 | /sendVerifyCode |
| Method | string | 否 | API 的请求 HTTP Method。 | GET |
| Description | string | 否 | API 描述信息。 | API描述信息 |
| PageSize | integer | 否 | 分页参数，每页显示条数，默认值 10。 | 10 |
| PageNumber | integer | 否 | 指定要查询的页码，默认是 1，起始是 1。 | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"PageNumber": 1,
"RequestId": "F9C5C4A5-BC6C-57A3-839F-AB08********",
"PageSize": 10,
"TotalCount": 7,
"ApiSummarys": {
"ApiPluginSummary": [
{
"ApiId": "accc8c68b7294b1cb4928741********",
"Description": "API描述信息",
"GroupName": "myGroup2",
"GroupId": "5f51f89261854fd9ad5116be********",
"Path": "/mqTest",
"Method": "GET",
"StageName": "RELEASE",
"ApiName": "fhosQueryDayOfStock_V2",
"RegionId": "cn-shanghai",
"StageAlias": ""
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2024-03-21 | OpenAPI 返回结构发生变更 | 看变更集 | ||
|