创建别名
更新时间 2026-04-15 18:18:26
最近更新时间: 2026-04-15 18:18:26
接口功能介绍
创建别名
接口约束
无
URI
POST /openapi/v1/functions/*/aliases
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| functionName | 是 | String | 函数名称，函数必须存在 | my-func |
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id，标识不同的地区，如：华东1、西南1 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| aliasName | 是 | String | 别名。只能包含字母、数字和中划线。只能字母开头，字母数字结尾。长度在 3~44之间。 | gray | |
| description | 否 | String | 关于别名的描述 | a gray alias | |
| versionId | 是 | String | 主版本ID | 1 | |
| gray | 否 | Object | 灰度版本的配置 | Gray |
表 Gray
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| versionId | 是 | String | 灰度版本ID | 2 | |
| type | 是 | Integer | 灰度类型，当前支持：1、按百分比随机灰度 | 1 | |
| config | 是 | Object | 对应类型的配置 | Config |
表 Config
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| weight | 是 | Integer | 切流的比例。假设值为 5%，函数计算会将 5% 的流量到打到灰度版本，95% 的流量打到主版本。范围是[0-100] | 50 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。0表示成功，非0表示不成功 | 0 | |
| error | String | 错误码。CF_0表示成功，其他值表示失败。 | CF_0 | |
| message | String | 错误描述信息 | ||
| returnObj | Object | 返回实体 | ReturnObj |
表 ReturnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| aliasName | String | 别名 | gray | |
| versionId | String | 主版本ID | 1 | |
| grayVersionId | String | 灰度版本ID | 2 | |
| description | String | 关于别名的描述 | a gray alias | |
| createTime | String | 创建时间 | 2024-06-06T14:01:02.616719195+08:00 | |
| updateTime | String | 更新时间 | 2024-06-06T14:01:02.616719195+08:00 | |
| grayType | Integer | 灰度类型，当前支持：1、按百分比随机灰度 | 1 | |
| aliasGrayConfig | Object | 灰度配置 | AliasGrayConfig |
表 AliasGrayConfig
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| weight | Integer | 切流的比例。假设值为 5%，函数计算会将 5% 的流量到打到灰度版本，95% 的流量打到主版本。范围是[0-100] |
枚举参数
无
请求示例
请求url
https://{host}/openapi/v1/functions/my-func/aliases
请求头header
regionId: bb9fdb42056f11eda1610242ac110002
请求体body
{
"aliasName": "gray",
"description": "a gray alias",
"versionId": "1"
}
响应示例
{
"statusCode": 0,
"error": "CF_0",
"message": "",
"returnObj": {
"createTime": "2024-06-06T14:01:02.616719195+08:00",
"updateTime": "2024-06-06T14:01:02.616719195+08:00",
"aliasName": "gray",
"versionId": "1",
"grayVersionId": "",
"grayType": 0,
"description": "a gray alias",
"aliasGrayConfig": {}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
