跳转到内容
Local API环境分组

更新分组 ​

版本概览
PUT
/api/v1/groups/{group_id}

更新当前团队下的普通分组名称和备注;默认分组不允许通过 Local API 修改。

请求参数

Authorization Bearer Token

在请求头 Authorization 中使用 Bearer Token 传入 API Key。

Authorization: Bearer <api-key>

Path 参数

1
字段说明
string必填
环境分组唯一标识
示例值"group_01JABCDEF1234567890"
minLength: 1

Body 参数

必填application/jsonGroupMutationRequest
字段说明
string必填
分组名称,当前团队内唯一
minLength: 1maxLength: 64
string | null
分组备注
maxLength: 500
示例

根据数据模型生成,非实际请求结果。

{
  "name": "string"
}

请求示例代码

JavaScript / TypeScript 使用 Node.js 18+ 内置 fetch;PHP 需启用 cURL 扩展;Go 需 1.16+;Java 需 JDK 11+。运行前请替换 Token 和示例参数值。

curl -X PUT -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "name": "string"
}' 'http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890'

返回响应

成功时 code = 0,失败时 code > 0。选择状态码查看对应字段和示例,展开对象可查看嵌套字段;可选字段可能不返回。

更新后的分组详情

Body

application/jsonGroupDetailSuccessResponse
字段说明
number必填
业务状态码;成功固定为 0
枚举值
string必填
业务状态信息;成功固定为 success
枚举值
object必填
接口业务数据

不允许额外字段。

示例

根据数据模型生成,非实际请求结果。

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "group_01JABCDEF1234567890",
    "name": "string",
    "remark": "string",
    "is_default": true,
    "browser_count": 0,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "browsers": [
      {
        "env_id": "env_01JABCDEF1234567890",
        "env_sn": "string",
        "env_name": "string",
        "remark": "string"
      }
    ]
  }
}

查看全部业务错误码与 HTTP 状态码

中屹浏览器 Local API 文档