Skip to content

更新容器

POST
/v1/containers/update

以 containerId 定位目标容器,更新名称、描述、排序、类型、ACL 继承开关等自身属性。注意:请求体中的 metadataColumns 在 update 下为只读输出字段,写时忽略——容器元数据的修改请走 /v1/metadata/values/set。(与 create 不同:create 会写入 metadataColumns,update 只忽略)

授权

apiKey
类型
API Key (header: Authorization)

参数

请求头参数

X-Atk-User-Token

强通道:系统自签的不透明用户会话 token,用于 Client 代表用户调用。 与 X-Atk-Act-As-Source / X-Atk-Act-As-Source-Id 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string
X-Atk-Act-As-Source

弱通道:身份 source 主张(要求 Client 已开启 actAsAllowed)。 必须与 X-Atk-Act-As-Source-Id 成对携带,缺一服务端返回 400 INCOMPLETE_ACT_AS_HEADERS;与 X-Atk-User-Token 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string
X-Atk-Act-As-Source-Id

弱通道:身份 sourceId 主张(要求 Client 已开启 actAsAllowed)。 必须与 X-Atk-Act-As-Source 成对携带,缺一服务端返回 400 INCOMPLETE_ACT_AS_HEADERS;与 X-Atk-User-Token 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string

请求体

application/json
JSON
{
  
"id": 0,
  
"containerId": "string",
  
"parentId": "string",
  
"parentName": "string",
  
"containerTypeId": "string",
  
"containerTypeName": "string",
  
"name": "string",
  
"description": "string",
  
"sortOrder": 0,
  
"status": "string",
  
"createBy": "string",
  
"createByName": "string",
  
"createTime": "string",
  
"updateBy": "string",
  
"updateTime": "string",
  
"purgeAt": "string",
  
"metadataColumns": {
  
  
"additionalProperties": {
  
  
}
  
},
  
"aclInheritEnabled": true,
  
"effectivePermissions": {
  
  
"read": true,
  
  
"download": true,
  
  
"write": true,
  
  
"share": true,
  
  
"manage": true,
  
  
"effectiveRole": "string",
  
  
"delete": true
  
},
  
"hasChildren": true
}

响应

OK

*/*
JSON
{
  
"code": 0,
  
"data": {
  
  
"id": 0,
  
  
"containerId": "string",
  
  
"parentId": "string",
  
  
"parentName": "string",
  
  
"containerTypeId": "string",
  
  
"containerTypeName": "string",
  
  
"name": "string",
  
  
"description": "string",
  
  
"sortOrder": 0,
  
  
"status": "string",
  
  
"createBy": "string",
  
  
"createByName": "string",
  
  
"createTime": "string",
  
  
"updateBy": "string",
  
  
"updateTime": "string",
  
  
"purgeAt": "string",
  
  
"metadataColumns": {
  
  
  
"additionalProperties": {
  
  
  
}
  
  
},
  
  
"aclInheritEnabled": true,
  
  
"effectivePermissions": {
  
  
  
"read": true,
  
  
  
"download": true,
  
  
  
"write": true,
  
  
  
"share": true,
  
  
  
"manage": true,
  
  
  
"effectiveRole": "string",
  
  
  
"delete": true
  
  
},
  
  
"hasChildren": true
  
},
  
"ts": 0,
  
"rid": "string",
  
"msg": "string",
  
"success": true
}

试验场

服务器
授权
请求头
主体

示例

技术支持 VitePress OpenAPI