獲取接口列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| apig:ListHttpApiOperations | list | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId} |
| 無 |
請求語法
GET /v1/http-apis/{httpApiId}/operations HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| httpApiId | string | 是 | 目標 HTTP API ID。 | api-xxx |
| method | string | 否 | 按 Method 列舉接口。 枚舉值：
| GET |
| pathLike | string | 否 | 按路徑前綴匹配搜索接口。 | /v1 |
| nameLike | string | 否 | 按接口名稱前綴搜索接口。 | GetUser |
| pageNumber | integer | 否 | 分頁頁碼，從 1 開始，不填默認 1。 | 1 |
| pageSize | integer | 否 | 分頁大小，有效范圍[1, 100]，不填默認 10。 | 10 |
| name | string | 否 | 按照名稱精確搜索。 | getUserInfo |
| withConsumerInEnvironmentId | string | 否 | 響應中每個接口信息攜帶指定環境 ID 下的指定消費者的授權規則列表。需要額外指定 withConsumerInfoById 字段。 | env-xxx |
| withConsumerInfoById | string | 否 | 響應中每個接口信息攜帶指定環境 ID 下的指定消費者的授權規則列表。需要額外指定 withConsumerInEnvironmentId 字段。 | cs-xxx |
| consumerAuthorizationRuleId | string | 否 | 根據特定的消費者授權規則 ID 過濾接口列表，響應中的接口列表僅包含已授權的接口。 | cas-xxx |
| withPluginAttachmentByPluginId | string | 否 | 插件 ID，根據此插件 ID 獲取插件發布信息。 | pl-xxx |
返回參數
示例
正常返回示例
JSON格式
{
"requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 10,
"items": [
{
"operationId": "op-xxx",
"method": "GET",
"name": "GetUserInfo",
"path": "/user/123",
"description": "獲取用戶信息",
"response": {
"contentType": "application/json",
"items": [
{
"code": 200,
"example": "{\"result\": \"ok\"}",
"description": "正常接口響應",
"jsonSchema": "{\n \"type\": \"object\",\n \"required\": [\n \"result\"\n ],\n \"properties\": {\n \"result\": {\n \"type\": \"string\",\n \"description\": \"操作結果，'ok' 表示成功\"\n }\n }\n}"
}
]
},
"request": {
"headerParameters": [
{
"name": "userId",
"required": true,
"type": "String",
"defaultValue": "123",
"exampleValue": "123",
"description": "用戶ID"
}
],
"queryParameters": [
{
"name": "userId",
"required": true,
"type": "String",
"defaultValue": "123",
"exampleValue": "123",
"description": "用戶ID"
}
],
"pathParameters": [
{
"name": "userId",
"required": true,
"type": "String",
"defaultValue": "123",
"exampleValue": "123",
"description": "用戶ID"
}
],
"body": {
"description": "body參數描述",
"example": "{\"result\":\"ok\"}",
"contentType": "application/json",
"jsonSchema": "{\n \"type\": \"object\",\n \"required\": [\n \"result\"\n ],\n \"properties\": {\n \"result\": {\n \"type\": \"string\",\n \"description\": \"操作結果，'ok' 表示成功\"\n }\n }\n}\n"
}
},
"mock": {
"enable": false,
"responseCode": 200,
"responseContent": "Mock測試"
},
"createTimestamp": 1719386834548
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-28 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-10-24 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-08-05 | OpenAPI 入參發生變更 | 查看變更詳情 |