UpdateWorkspace - 更新工作空间
更新工作空间名称或网络配置。只有状态为 Initialized 的工作空间允许更新。Status、TenantId 和 RegionId 由服务端维护,不允许通过本接口修改。
接口说明
请求说明\n 更新工作空间名称或网络配置。只有状态为 Initialized 的工作空间允许更新。Status、TenantId 和 RegionId 由服务端维护,不允许通过本接口修改。网络配置通过 Enabled 指定是否开启 VPC 网络,开启时必须同时提供 VpcId 和至少一个 VSwitchIds。\n
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
agentcore:UpdateWorkspace |
update |
*Workspace
|
无 | 无 |
请求语法
PUT /workspaces/{workspaceId} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
是 |
工作空间 ID |
ws-123456 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
更新工作空间请求体 |
|
| name |
string |
否 |
更新后的工作空间名称 |
production-agents-v2 |
| networkConfiguration |
object |
否 |
更新后的工作空间网络配置 |
|
| publicEgressEnabled |
boolean |
否 |
未传时保留原值。关闭将异步级联关闭 Agent 公网开关;重新开启不自动恢复 Agent 开关。仅控制托管及自定义 Agent 最新版本使用平台公网出口;不控制固定历史版本、模型/MCP 代理出口和用户 VPC 自身公网出口。 |
true |
| publicIngressEnabled |
boolean |
否 |
未传时保留原值。可与 PublicEgressEnabled 同次修改,通过统一任务异步生效。关闭后工作空间内所有 Agent Endpoint 的公网入口关闭,重新开启后恢复原公网入口;INNER_DIRECT 和用户 VPC 入口不受影响,协作及 Element Web 入口不在控制范围内。 |
true |
| vpc |
object |
是 |
用户 VPC 网络配置 |
|
| enabled |
boolean |
否 |
是否开启 VPC 网络 |
true |
| vSwitchIds |
array |
否 |
交换机 ID 列表,开启 VPC 网络时至少包含一个交换机,且所有交换机必须属于 VpcId 指定的 VPC。 |
|
|
string |
否 |
交换机 ID。 |
vsw-bp1234567890 |
|
| vpcId |
string |
否 |
用户专有网络 ID |
vpc-bp1234567890 |
| clientToken |
string |
否 |
客户端幂等标识 |
workspace-update-20260805-001 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
更新工作空间响应 |
||
| code |
string |
业务状态码 |
SUCCESS |
| data |
object |
更新后的工作空间详情 |
|
| authorizationStatus |
string |
OSS 存储授权状态 枚举值:
|
AUTHORIZED |
| bucketName |
string |
私有 OSS Bucket 名称 |
bucket-001 |
| name |
string |
工作空间名称 |
production-agents-v2 |
| networkConfiguration |
object |
工作空间网络配置 |
|
| publicEgressEnabled |
boolean |
返回配置目标值;Updating 表示变更仍在执行,UpdateFailed 表示本轮变更失败。仅控制托管及自定义 Agent 最新版本使用平台公网出口;不控制固定历史版本、模型/MCP 代理出口和用户 VPC 自身公网出口。 |
true |
| publicIngressEnabled |
boolean |
返回配置目标值;Updating 表示变更中,UpdateFailed 表示变更失败。关闭后工作空间内所有 Agent Endpoint 的公网入口关闭,重新开启后恢复原公网入口;INNER_DIRECT 和用户 VPC 入口不受影响,协作及 Element Web 入口不在控制范围内。 |
true |
| vpc |
object |
用户 VPC 网络配置 |
|
| enabled |
boolean |
是否开启 VPC 网络 |
true |
| vSwitchIds |
array |
交换机 ID 列表 |
|
|
string |
交换机 ID。 |
vsw-bp1234567890 |
|
| vpcId |
string |
用户专有网络 ID |
vpc-bp1234567890 |
| regionId |
string |
工作空间所在的地域 ID |
cn-hangzhou |
| status |
string |
工作空间状态。可选值:Initializing、Initialized、Deleting、Deleted。 |
Initialized |
| storageType |
string |
工作空间存储类型 枚举值:
|
PRIVATE |
| tenantId |
string |
所属租户 ID |
tenant-123456 |
| workspaceId |
string |
工作空间 ID |
ws-123456 |
| httpStatusCode |
integer |
HTTP 状态码 |
200 |
| message |
string |
响应消息 |
success |
| requestId |
string |
请求 ID |
request-123456 |
| success |
boolean |
请求是否成功 |
true |
示例
正常返回示例
JSON格式
{
"code": "SUCCESS",
"data": {
"authorizationStatus": "AUTHORIZED",
"bucketName": "bucket-001",
"name": "production-agents-v2",
"networkConfiguration": {
"publicEgressEnabled": true,
"publicIngressEnabled": true,
"vpc": {
"enabled": true,
"vSwitchIds": [
"vsw-bp1234567890"
],
"vpcId": "vpc-bp1234567890"
}
},
"regionId": "cn-hangzhou",
"status": "Initialized",
"storageType": "PRIVATE",
"tenantId": "tenant-123456",
"workspaceId": "ws-123456"
},
"httpStatusCode": 200,
"message": "success",
"requestId": "request-123456",
"success": true
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | The specified request parameter is invalid. | |
| 404 | Resource.NotFound | The specified AgentCore workspace does not exist. | |
| 409 | Resource.AlreadyExists | A workspace with the specified name already exists. | |
| 409 | Operation.Conflict | The workspace is not in a state that permits this operation. | |
| 409 | Idempotency.Conflict | The client token has already been used for another workspace operation. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。