獲取HTTP API列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| apig:ListHttpApis | list | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/* |
| 無 |
請求語法
GET /v1/http-apis HTTP/1.1
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| keyword | string | 否 | 搜索關鍵詞，支持 API 名稱模糊搜索或 API ID 精確搜索。 | test- |
| pageNumber | integer | 否 | 分頁頁碼，從 1 開始，不填默認 1. | 1 |
| pageSize | integer | 否 | 分頁大小，有效范圍[1, 100]，不填默認 10。 | 10 |
| name | string | 否 | 按照名稱精確搜索。 | login |
| types | string | 否 | HTTP API 的類型。支持傳入多個類型，采用","分割。
| Http,Rest |
| gatewayId | string | 否 | 云原生 API 網關 ID。 | gw-cq2avtllh**** |
| withAuthPolicyInEnvironmentId | string | 否 | 響應中每個 API 信息攜帶指定環境 ID 下的消費者認證策略信息。 | env-xxx |
| withConsumerInfoById | string | 否 | 響應中每個 API 信息攜帶指定消費者 ID 的授權規則列表。 | cs-xxx |
返回參數
示例
正常返回示例
JSON格式
{
"requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
"code": "Ok",
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 10,
"items": [
{
"name": "test-api",
"versionEnabled": true,
"versionedHttpApis": [
{
"httpApiId": "api-xxx",
"name": "test",
"protocols": [
"HTTP"
],
"basePath": "/v1",
"description": "測試專用API",
"versionInfo": {
"enable": true,
"scheme": "Query",
"headerName": "my-version",
"queryName": "myVersion",
"version": "v1"
},
"environments": [
{
"environmentId": "env-xxx",
"backendScene": "SingleService",
"backendType": "Service",
"serviceConfigs": [
{
"gatewayServiceId": "gs-xxx",
"name": "demo-service",
"protocol": "HTTP",
"port": "8080",
"weight": 100,
"version": "v1",
"match": {
"default": true,
"conditions": [
{
"type": "Query",
"key": "color",
"value": "gray",
"operator": "equal"
}
]
},
"serviceId": "svc-xxx"
}
],
"customDomains": [
{
"domainId": "d-xxx",
"name": "www.example.com",
"protocol": "HTTP"
}
],
"name": "test",
"alias": "test",
"gatewayInfo": {
"gatewayId": "gw-xxx",
"name": "test"
},
"deployStatus": "Deployed",
"subDomains": [
{
"domainId": "d-xxx",
"name": "www.example.com",
"protocol": "HTTP",
"networkType": "Internet"
}
]
}
],
"ingressInfo": {
"sourceId": "src-xxx",
"ingressClass": "mse",
"watchNamespace": "default",
"environmentInfo": {
"environmentId": "env-xxx"
},
"k8sClusterInfo": {
"clusterId": "ca435c77cba1547cca9311957bcxxxxxx"
},
"overrideIngressIp": true
},
"type": "Rest",
"resourceGroupId": "rg-xxx",
"aiProtocols": [
"OpenAI/v1"
],
"deployConfigs": [
{
"customDomainIds": [
"d-xxx"
],
"environmentId": "env-xxx",
"backendScene": "SingleService",
"serviceConfigs": [
{
"serviceId": "svc-xxx",
"weight": 100,
"modelNamePattern": "qwen-*",
"modelName": "qwen-max"
}
],
"policyConfigs": [
{
"type": "AiFallback",
"enable": true,
"aiFallbackConfig": {
"serviceIds": [
"svc-xxx"
]
}
}
],
"autoDeploy": true
}
]
}
],
"type": "Http"
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-28 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-11-20 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-11-18 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-10-24 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-09-11 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-09-06 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-08-05 | OpenAPI 入參發生變更 | 查看變更詳情 |
| 2024-07-26 | OpenAPI 入參發生變更 | 查看變更詳情 |