This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.
Queries a list of HTTP APIs.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| apig:ListHttpApis | list | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/* |
| none |
Request syntax
GET /v1/http-apis HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| keyword | string | No | The consumer authentication policy in the specified environment in each returned API. | test- |
| pageNumber | integer | No | The environment information. | 1 |
| pageSize | integer | No | The resource group ID. | 10 |
| name | string | No | Specifies whether authentication is enabled. | login |
| types | string | No | The Ingress information. | Http,Rest |
| gatewayId | string | No | Specifies whether to include policy configurations. | gw-cq2avtllh**** |
| withAuthPolicyInEnvironmentId | string | No | The gateway type to filter. Valid values: AI and API. | env-xxx |
| withConsumerInfoById | string | No | The response body. | cs-xxx |
| withEnvironmentInfo | boolean | No | The request ID. | true |
| withPluginAttachmentByPluginId | string | No | The status code. | pl-ct9qn3um1hktue8dqol0 |
| resourceGroupId | string | No | The returned message. | rg-ahr5uil8raz0rq3b |
| withEnvironmentInfoById | string | No | The APIs. | env-ctovu5mm1hksb4q8ln40 |
| withAuthPolicyList | boolean | No | The page number of the returned page. | true |
| withIngressInfo | boolean | No | The number of entries per page. | false |
| withPolicyConfigs | boolean | No | The total number of entries returned. | false |
| withAPIsPublishedToEnvironment | boolean | No | Whether to return all APIs published to a specific environment | true |
| gatewayType | string | No | The API information. Enumeration Value:
| API |
Response parameters
Examples
Sample success responses
JSONformat
{
"requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
"code": 200,
"message": "success",
"data": {
"pageNumber": 1,
"pageSize": 10,
"totalSize": 10,
"items": [
{
"name": "test-api",
"versionEnabled": true,
"versionedHttpApis": [
{
"httpApiId": "api-xxx",
"name": "test",
"basePath": "/v1",
"description": "",
"versionInfo": {
"enable": true,
"scheme": "Query",
"headerName": "my-version",
"queryName": "myVersion",
"version": "v1"
},
"ingressInfo": {
"sourceId": "",
"ingressClass": "",
"watchNamespace": "",
"environmentInfo": {
"environmentId": ""
},
"k8sClusterInfo": {
"clusterId": ""
},
"overrideIngressIp": true
},
"type": "Rest",
"resourceGroupId": "rg-xxx",
"enabelAuth": true,
"authConfig": {
"authType": "",
"authMode": ""
},
"gatewayId": "",
"modelCategory": "",
"protocols": [
"HTTP"
],
"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"
}
]
}
],
"aiProtocols": [
""
],
"deployConfigs": [
{
"environmentId": "env-xxx",
"backendScene": "SingleService",
"autoDeploy": true,
"gatewayId": "gw-xx",
"routeBackend": {
"scene": "Single",
"services": [
{
"serviceId": "service-cq2bmmdlhtgj***",
"name": "item-service",
"protocol": "HTTP",
"port": 0,
"weight": 49,
"version": "v1"
}
]
},
"gatewayInfo": {
"gatewayId": "",
"name": "",
"vpcInfo": {
"vpcId": "",
"name": ""
},
"engineVersion": ""
},
"mock": {
"enable": false,
"responseCode": 200,
"responseContent": ""
},
"gatewayType": "API",
"customDomainIds": [
"d-xxx"
],
"serviceConfigs": [
{
"serviceId": "svc-xxx",
"weight": 100,
"modelNamePattern": "qwen-*",
"modelName": "qwen-max",
"intentCode": "",
"match": {
"default": true,
"conditions": [
{
"type": "Query",
"key": "color",
"value": "gray",
"operator": "equal"
}
]
}
}
],
"policyConfigs": [
{
"type": "AiFallback",
"enable": true,
"aiFallbackConfig": {
"serviceConfigs": [
{
"serviceId": "",
"targetModelName": ""
}
]
},
"aiSecurityGuardConfig": {
"serviceAddress": "",
"checkRequest": true,
"checkResponse": true,
"checkRequestImage": true,
"checkResponseImage": true,
"requestCheckService": "",
"responseCheckService": "",
"requestImageCheckService": "",
"responseImageCheckService": "",
"riskAlertLevel": "",
"riskConfig": [
{
"type": "",
"level": "",
"consumerRules": {
"pattern": "",
"matchType": ""
}
}
],
"bufferLimit": 0,
"consumerRequestCheckService": [
{
"name": "",
"requestCheckService": "",
"requestImageCheckService": "",
"matchType": "",
"modalityType": ""
}
],
"consumerResponseCheckService": [
{
"name": "",
"responseCheckService": "",
"responseImageCheckService": "",
"matchType": "",
"modalityType": ""
}
],
"consumerRiskLevel": [
{
"name": "",
"matchType": "",
"type": "",
"level": ""
}
]
},
"aiTokenRateLimitConfig": {
"rules": [
{
"limitType": "",
"matchKey": "",
"matchType": "",
"matchValue": "",
"limitMode": "",
"limitValue": 0
}
],
"globalRules": [
{
"limitType": "",
"matchKey": "",
"matchType": "",
"matchValue": "",
"limitMode": "",
"limitValue": 0
}
],
"enableGlobalRules": true
}
}
],
"customDomainInfos": [
{
"domainId": "",
"name": "",
"protocol": ""
}
],
"subDomains": [
{
"domainId": "",
"name": "",
"protocol": "",
"networkType": ""
}
]
}
],
"deployCntMap": {
"key": {
"deployedCnt": 0,
"Cnt": 0
}
},
"agentProtocols": [
""
]
}
],
"type": "Http",
"GatewayId": "gw-xx"
}
]
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-04-25 | The request parameters of the API has changed | View Change Details |
| 2025-03-31 | The request parameters of the API has changed | View Change Details |
| 2024-12-26 | The request parameters of the API has changed | View Change Details |
| 2024-11-28 | The request parameters of the API has changed | View Change Details |
| 2024-11-20 | The request parameters of the API has changed | View Change Details |
| 2024-11-18 | The request parameters of the API has changed | View Change Details |
| 2024-10-24 | The request parameters of the API has changed | View Change Details |
| 2024-09-11 | The request parameters of the API has changed | View Change Details |
| 2024-09-06 | The request parameters of the API has changed | View Change Details |
| 2024-08-05 | The request parameters of the API has changed | View Change Details |
| 2024-07-26 | The request parameters of the API has changed | View Change Details |