ワークスペース一覧表示¶
GET /api/v1/wksp_share/granted_ws_list
概要¶
ワークスペース一覧を表示します。
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| namespace | commaArray | 指定された namespace の表示権限を持つワークスペースをフィルタリングします。 空を許可：False |
|
| regionCode | string | サイトフィルタ。指定されたサイトのどのワークスペースを表示できるかを指定します。 空を許可：False |
|
| filterWsUUIDs | commaArray | ワークスペース UUID。複数の UUID はカンマ（,）で区切ります。 空を許可：False |
|
| search | string | 名称検索 空を許可：False |
|
| pageIndex | integer | ページ番号 空を許可：False 例：10 $minValue: 1 |
|
| pageSize | integer | 1ページあたりの返却件数 空を許可：False 例：10 $minValue: 1 $maxValue: 100 |
パラメータ補足説明¶
1. レスポンスパラメータの説明:
| パラメータ名 | パラメータ説明 |
|---|---|
| regionCode | 権限付与元サイト |
| regionName | 権限付与元サイト名 |
| workspaceName | 権限付与元ワークスペース名 |
| workspaceUUID | 権限付与元ワークスペース UUID |
| toRegionCode | 権限付与先サイト |
| toRegionName | 権限付与先サイト名 |
| toWorkspaceName | 権限付与先ワークスペース名 |
| toWorkspaceUUID | 権限付与先ワークスペース UUID |
| type | ワークスペース権限タイプ。network、object、dialtest、billing、logging、tracing、metric、rum、keyevent、custom_object、security、profiling が指定可能。* は全タイプの権限付与を意味します。 |
| indexes | 権限付与されたログインデックス名。* は全てを意味します。 |
注意：レスポンスの content は配列です。配列の各要素は、単一サイトの全ての表示可能なワークスペース情報を格納します。
2. 例の説明: 権限付与先は、権限付与元から権限付与されたデータを表示できます。 以下の例では、XX ワークスペースが YY ワークスペースに対して、ログ testing インデックスの表示権限を付与しています。つまり、YY ワークスペースは XX ワークスペースのログ testing インデックスデータを表示できます。
{
"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"
}
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/wksp_share/granted_ws_list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed
レスポンス¶
{
"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"
}