接口功能介绍
修改别名
接口约束
无
URI
PUT /openapi/v1/functions//aliases/
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| functionName | 是 | String | 函数名称 | ||
| aliasName | 是 | String | 别名 |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池id | test |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| gray | 否 | Object | 启用灰度版本 | Gray | |
| versionId | 是 | String | 主版本 | ||
| description | 是 | String | 描述 |
表 Gray
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| type | 是 | Integer | 灰度类型 | ||
| config | 是 | Object | 该灰度类型配置 | Config | |
| versionId | 是 | String | 灰度版本 |
表 Config
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| weight | 是 | Integer | 切流的比例。假设值为 5%，函数计算会将 5% 的流量到打到灰度版本，95% 的流量打到主版本。范围是[0-100] | 50 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码,0表示成功，非0表示不成功 | 0 | |
| error | String | 错误码 | 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/gray
请求头header
无
请求体body
{
"gray": {
"versionId": "2",
"type": 1,
"config": {
"weight": 52
}
},
"versionId": "1",
"description": "a gray alias",
}
响应示例
{
"statusCode": 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": "2",
"grayType": 0,
"description": "a gray alias",
"aliasGrayConfig": {
"weight": 52
}
}
}
状态码
请参考 状态码
错误码
请参考 错误码
