Query the workspace name¶

Query the name by the workspace ID in an existing data sharing relationship.

HTTP
POST $CLOUDSIGMA_API_BASE/data-share/workspace-names

Before you call this API¶

Configure the regional API endpoint and authentication, and select the target workspace.

Set the operation-specific values used in the request:

$TARGET_WORKSPACE_ID: The workspace ID whose name is to be queried.

Request¶

Input examples

Shell
curl -X POST "$CLOUDSIGMA_API_BASE/data-share/workspace-names" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": ["'"$TARGET_WORKSPACE_ID"'"]
  }'

Parameter reference

Request body

Parameter	Type	Required	Description
`ids`	string[]	Yes	A list of workspace IDs to query for names.

[] after a type means an array. For example, string[] is an array of strings.

Successful response¶

Returns 200 and the resolvable workspace name on success.

Response example

JSON
{
  "code": "OK",
  "msg": "OK",
  "data": {
    "workspaces": [
      {
        "id": "ws-02",
        "name": "分析工作区"
      }
    ]
  }
}

Field reference

The response fields are as follows.

Field	Type	Description
`data.workspaces`	array	A list of resolvable workspaces.
`data.workspaces[].id`	string	Workspace ID.
`data.workspaces[].name`	string	Workspace name.

In field paths, [] means each item in an array. For example, data.workspaces[].id is the id field of each item in data.workspaces.

Error response¶

Response example

JSON
{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

Field reference

Common HTTP errors¶

HTTP status code	error code	Common causes	Recommended actions
`400`	`ErrParamInvalid`	Invalid request body format or workspace ID list.	Check `ids`.
`403`	`ErrPermissionDenied`	The current identity is not a valid member of the current workspace.	Use credentials that have workspace access.
`500`	`ErrServer`	The server failed to resolve the workspace name.	Try again later.

Last updated on Sep 15, 2026