List Viewable Workspaces¶

GET /api/v1/wksp_share/granted_ws_list

Overview¶

Lists the granted workspaces that can be queried by the workspace to which the current API Key belongs.

Query Request Parameters¶

Parameter	Type	Description
namespace	commaArray	Filter viewable workspaces by authorized data type. Separate multiple namespaces with commas. Allow empty: False
regionCode	string	Filter by the authorizing site. The regionCode in the returned groups can be used as the query.targetRegion of query_data. Allow empty: False
filterWsUUIDs	commaArray	Filter by the authorizing workspace UUID. Separate multiple UUIDs with commas. Allow empty: False
search	string	Search by name. Allow empty: False
pageIndex	integer	Page number. Allow empty: False Example: 10 $minValue: 1
pageSize	integer	Number of items returned per page. Allow empty: False Example: 10 $minValue: 1 $maxValue: 100

Supplementary Notes on Parameters¶

This endpoint is the recommended way to obtain the target workspace UUID and query.targetRegion for query_data.

content[j].regionCode indicates the site to which the granted workspaces in that group belong, and can be used directly as query.targetRegion; data[k].regionCode within the group has the same meaning.
Find the target workspace by workspaceUUID within content[j].data, then use the regionCode of the same group. Do not treat toRegionCode as the target site; it indicates the grantee, that is, the site of the workspace to which the current API Key belongs.
You can filter the authorized data types by namespace, for example pass namespace=logging when querying logs.
The endpoint paginates independently for each regionCode group; pageInfo.count is only the count of the current page. On the first call, you can omit regionCode to discover the target site. Afterward, pass regionCode explicitly for each target site and paginate independently starting from pageIndex=1. Stop when reaching the pageInfo.totalCount of that site, or when pageIndex * pageSize >= totalCount; it is recommended to deduplicate by the authorized uuid and (regionCode, workspaceUUID).

For details on how to organize requests, see: OpenAPI Cross-Site Data Query.

1. Return Parameter Description:

Parameter	Description
regionCode	Authorizing site
regionName	Authorizing site name
workspaceName	Authorizing workspace name
workspaceUUID	Authorizing workspace UUID
toRegionCode	Authorized workspace site
toRegionName	Authorized workspace site name
toWorkspaceName	Authorized workspace name
toWorkspaceUUID	Authorized workspace UUID
type	Workspace authorization type: network, object, dialtest, billing, logging, tracing, metric, rum, keyevent, custom_object, security, profiling; * indicates authorization for all types
indexes	Authorized log index names; * indicates all

Note: The returned content is an array grouped by the authorizing site; each element's data contains the viewable workspace information for the current page of that site.

2. Example: The grantee can view the data authorized by the authorizing party. In the example below, workspace XX grants workspace YY view permission for the log index

"testing", meaning workspace YY can view the "testing" log index data of workspace XX. name="__codelineno-0-1"> { "createAt": 1749542060, "creator": "acnt_c956fd23a9c2427b96ee372c88ea9b60", "creatorInfo": { }, "delayDeleteAt": -1, "deleteAt": -1, "id": 442, "indexes": [ "testing" ], "regionCode": "daily", "regionName": "开发环境（daily）", "status": 0, "toRegionCode": "testing", "toRegionName": "测试环境（testing）", "toWorkspaceName": "YY", "toWorkspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d", "type": [ "logging" ], "updateAt": -1, "updator": "", "updatorInfo": { }, "uuid": "grant_02b04aec78c74f869151e3e8c3e54dae", "workspaceName": "XX", "workspaceUUID": "wksp_6e310e0c1cbd45b4a27a19bda0fd7582" }

Request Example¶

curl 'https://openapi.guance.com/api/v1/wksp_share/granted_ws_list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

Response¶

{
    "code": 200,
    "content": [
        {
            "data": [
                {
                    "authorizationCode": "4248e561808c42868397a7a695a2d654",
                    "createAt": 1749542060,
                    "creator": "acnt_c956fd23a9c2427b96ee372c88ea9b60",
                    "delayDeleteAt": -1,
                    "deleteAt": -1,
                    "id": 442,
                    "indexes": [
                        "mysql",
                        "*"
                    ],
                    "regionCode": "daily",
                    "regionName": "Development Environment（daily）",
                    "status": 0,
                    "toRegionCode": "testing",
                    "toRegionName": "Test Environment（testing）",
                    "toWorkspaceName": "【Doris】for Developer",
                    "toWorkspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d",
                    "type": [
                        "logging"
                    ],
                    "updateAt": -1,
                    "updator": "",
                    "uuid": "grant_02b04aec78c74f869151e3e8c3e54dae",
                    "workspaceName": "daily for testing",
                    "workspaceUUID": "wksp_6e310e0c1cbd45b4a27a19bda0fd7582"
                },
                {
                    "authorizationCode": "52f146179ec54f4b920f28c800ae9b3e",
                    "createAt": 1749541984,
                    "creator": "acnt_c956fd23a9c2427b96ee372c88ea9b60",
                    "delayDeleteAt": -1,
                    "deleteAt": -1,
                    "id": 441,
                    "indexes": [
                        "*"
                    ],
                    "regionCode": "daily",
                    "regionName": "Development Environment（daily）",
                    "status": 0,
                    "toRegionCode": "testing",
                    "toRegionName": "Test Environment（testing）",
                    "toWorkspaceName": "【Doris】for Developer",
                    "toWorkspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d",
                    "type": [
                        "logging",
                        "billing",
                        "dialtest",
                        "tracing"
                    ],
                    "updateAt": -1,
                    "updator": "",
                    "uuid": "grant_5eab9ac478614c64a5ac5cdc9f363921",
                    "workspaceName": "Guance Cloud(Test Environment)Monitoring",
                    "workspaceUUID": "wksp_dbfb60524bf44dfea84a4e1d73484e41"
                }
            ],
            "declaration": {
                "asd": "aa,bb,cc,1,True",
                "asdasd": "dawdawd",
                "business": "aaa",
                "dd": "dd",
                "fawf": "afawf",
                "organization": "64fe7b4062f74d0007b46676"
            },
            "pageInfo": {
                "count": 2,
                "pageIndex": 1,
                "pageSize": 100,
                "totalCount": 2
            },
            "regionCode": "daily",
            "regionName": "Development Environment（daily）"
        },
        {
            "data": [
                {
                    "authorizationCode": "b081a0bec4c34bc899b05ee99b64ea04",
                    "createAt": 1748240284,
                    "creator": "acnt_06d1380440d54f2d845cb1dd3c896e45",
                    "delayDeleteAt": -1,
                    "deleteAt": -1,
                    "id": 434,
                    "indexes": [],
                    "regionCode": "testing",
                    "regionName": "Test Environment（testing）",
                    "status": 0,
                    "toRegionCode": "testing",
                    "toRegionName": "Test Environment（testing）",
                    "toWorkspaceName": "【Doris】for Developer",
                    "toWorkspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d",
                    "type": [
                        "custom_object"
                    ],
                    "updateAt": -1,
                    "updator": "",
                    "uuid": "grant_7419f57582664a2e8755ea63cab11491",
                    "workspaceName": "WayneTest Workspace",
                    "workspaceUUID": "wksp_dc1b82a836ba4f71a4c136c99f119a11"
                },
                {
                    "authorizationCode": null,
                    "createAt": 1747139040,
                    "creator": "acnt_154f255afd8644779c78d28411454772",
                    "delayDeleteAt": -1,
                    "deleteAt": -1,
                    "id": 426,
                    "indexes": [
                        "*"
                    ],
                    "regionCode": "testing",
                    "regionName": "Test Environment（testing）",
                    "status": 0,
                    "toRegionCode": "testing",
                    "toRegionName": "Test Environment（testing）",
                    "toWorkspaceName": "【Doris】for Developer",
                    "toWorkspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d",
                    "type": [
                        "*"
                    ],
                    "updateAt": -1,
                    "updator": "",
                    "uuid": "grant_14ea52f7b22c483785db5f783610dab2",
                    "workspaceName": "huangdong testing",
                    "workspaceUUID": "wksp_aef7103dc5a44397a9f4d0442517a15e"
                }
            ],
            "declaration": {
                "asd": "aa,bb,cc,1,True",
                "asdasd": "dawdawd",
                "business": "aaa",
                "dd": "dd",
                "fawf": "afawf",
                "organization": "64fe7b4062f74d0007b46676"
            },
            "pageInfo": {
                "count": 100,
                "pageIndex": 1,
                "pageSize": 100,
                "totalCount": 107
            },
            "regionCode": "testing",
            "regionName": "Test Environment（testing）"
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-900225FA-E0C1-44D4-BA1A-5C8F39F9D108"
}