GetWorkspace - 查询工作空间
根据工作空间 ID 查询工作空间详情,包括生命周期状态、CMS Workspace、AIRegistry Namespace 和当前网络策略。
接口说明
请求说明\n 根据工作空间 ID 查询工作空间详情,包括生命周期状态、CMS Workspace、AIRegistry Namespace 和当前网络策略。\n
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
agentcore:GetWorkspace |
get |
*Workspace
|
无 | 无 |
请求语法
GET /workspaces/{workspaceId} HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| workspaceId |
string |
是 |
工作空间 ID |
ws-123456 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
当前API无需请求参数
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
查询工作空间响应 |
||
| code |
string |
业务状态码 |
SUCCESS |
| data |
object |
工作空间详情 |
|
| authorizationStatus |
string |
OSS 存储授权状态 枚举值:
|
AUTHORIZED |
| bucketName |
string |
私有 OSS Bucket 名称 |
bucket-001 |
| createTime |
string |
创建时间 |
2026-08-06T03:56:56Z |
| name |
string |
工作空间名称 |
production-agents |
| networkConfiguration |
object |
工作空间网络配置 |
|
| privateIngressEnabled |
boolean |
工作空间的私网 Ingress 访问开关。true 表示已开启,false 表示已关闭;该开关与用户 VPC 网络配置中的 enabled 字段相互独立。 |
true |
| publicEgressEnabled |
boolean |
返回配置目标值;Updating 表示变更仍在执行,UpdateFailed 表示本轮变更失败。仅控制托管及自定义 Agent 最新版本使用平台公网出口;不控制固定历史版本、模型/MCP 代理出口和用户 VPC 自身公网出口。 |
true |
| publicEgressIp |
string |
工作空间公网出口 IP |
203.0.113.10 |
| 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、InitializationFailed、Initialized、Deleting、Deleted。 |
Initialized |
| statusReason |
string |
工作空间状态原因 |
InitializationFailed: VPC not found |
| 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",
"createTime": "2026-08-06T03:56:56Z",
"name": "production-agents",
"networkConfiguration": {
"privateIngressEnabled": true,
"publicEgressEnabled": true,
"publicEgressIp": "203.0.113.10",
"publicIngressEnabled": true,
"vpc": {
"enabled": true,
"vSwitchIds": [
"vsw-bp1234567890"
],
"vpcId": "vpc-bp1234567890"
}
},
"regionId": "cn-hangzhou",
"status": "Initialized",
"statusReason": "InitializationFailed: VPC not found",
"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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。