创建HttpApi的路由。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
apig:CreateHttpApiRoute | none | *HttpApi acs:apig:{#regionId}:{#accountId}:httpapi/{#HttpApiId} |
| 无 |
请求语法
POST /v1/http-apis/{httpApiId}/routes HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
httpApiId | string | 否 | 路由所属的 HTTP API ID。 | api-cqoob7llhtgq*** |
body | object | 否 | 请求 Body。 | |
environmentId | string | 否 | 环境 ID。 | env-cpqnr6tlhtgubcv*** |
name | string | 否 | 路由名称。 | login |
description | string | 否 | 路由描述。 | 用户登陆路由。 |
domainIds | array | 否 | 域名 ID。 | |
string | 否 | 域名 ID。 | d-cr62ts5lhtglnu*** | |
match | HttpRouteMatch | 否 | 路由 Match 规则。 | |
backendConfig | object | 否 | 路由的后端服务配置。 | |
scene | string | 否 | 后端服务场景。
| SingleService |
services | array<object> | 否 | 后端服务列表。 | |
object | 否 | 后端服务。 | ||
serviceId | string | 否 | 服务 ID。 | svc-crbgq0dlhtgr*** |
protocol | string | 否 | 服务协议:
| HTTP |
port | integer | 否 | 服务端口, 动态端口不传入。 | 8080 |
weight | integer | 否 | 流量比例的百分比值。 | 49 |
version | string | 否 | 服务版本,仅在按标签场景下有效 | v1 |
返回参数
示例
正常返回示例
JSON
格式
{
"requestId": "3ACFC7A7-45A9-58CF-B2D5-765B60254695",
"code": "Ok",
"message": "success",
"data": {
"routeId": "hr-cr82undlhtgrlej***"
}
}
错误码
访问错误中心查看更多错误码。