创建一个HTTP类型的API。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apig:CreateHttpApi | create | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/* |
| 无 |
请求语法
POST /v1/http-apis HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
body | object | 否 | 创建 API 相关参数。 | |
name | string | 是 | API 名称。 | test-api |
description | string | 否 | API 描述。 | 测试专用API。 |
protocols | array | 否 | API 访问协议列表。 | |
string | 否 | API 访问协议。 | HTTP | |
basePath | string | 否 | API 基础路径,需要以/开头。 | /v1 |
versionConfig | HttpApiVersionConfig | 否 | API 版本化配置。 | |
type | string | 否 | HTTP API 的类型。
| Http |
ingressConfig | object | 否 | HTTP Ingress API 配置信息。 | |
environmentId | string | 否 | 环境 ID。 | env-cq146allhtgk*** |
sourceId | string | 否 | 来源 ID。 | src-crdddallhtgtr*** |
ingressClass | string | 否 | 监听的 Ingress Class。 | mse |
watchNamespace | string | 否 | 监听的命名空间。 | default |
overrideIngressIp | boolean | 否 | 是否更新 Ingress Status 里的地址。 | false |
resourceGroupId | string | 否 | 资源组 ID。 | rg-xxx |
aiProtocols | array | 否 | AI API 协议,当前支持协议列表如下:
| |
string | 否 | AI API 协议。 | OpenAI/v1 | |
deployConfigs | array | 否 | API 部署配置,当前仅 AI API 支持部署配置,且仅支持传递单个部署配置。 | |
HttpApiDeployConfig | 否 | API 部署配置。 |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "A1994B10-C6A8-58FA-8347-6A08B0D4EFDE",
"code": "Ok",
"message": "success",
"data": {
"httpApiId": "api-xxx",
"name": "test-api"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-11-20 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-11-18 | API 内部配置变更,不影响调用 | 查看变更详情 |
2024-09-06 | API 内部配置变更,不影响调用 | 查看变更详情 |