获取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": "",
"ingressClass": "",
"watchNamespace": "",
"environmentInfo": {
"environmentId": ""
},
"k8sClusterInfo": {
"clusterId": ""
},
"overrideIngressIp": true
},
"type": "Rest",
"resourceGroupId": "rg-xxx",
"aiProtocols": [
""
],
"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-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 入参发生变更 | 查看变更详情 |