作成¶
POST /api/v1/workspace/create
概要¶
ワークスペースを作成します。
既存のワークスペースの API Key を使用して、新しいワークスペースを作成します。 新しいワークスペースの所有者は、デフォルトでこのリクエストの API Key が属するワークスペースの所有者になります。
有料版のワークスペースを作成する場合、デフォルトでこのリクエストの API Key が属するワークスペースの請求センターアカウントがバインドされます。
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | Y | 名前 例: supper_workspace 空値許可: False 最大長: 256 |
| desc | string | 説明 例: ワークスペースの説明 空値許可: True 空文字列許可: True |
|
| menuStyle | string | ワークスペースのメニューバースタイル。運用/テスト/研究開発 (廃止済み) 例: 運用 空値許可: False 空文字列許可: True |
|
| needCreateAk | boolean | ワークスペースの AK を作成するかどうか 例: True 空値許可: False |
|
| createPayWsVersion | boolean | 有料ワークスペースバージョンを作成するかどうか（デフォルトは false。無料プランのワークスペースを作成）。デプロイメントプランの場合は自動的に無効になります。 例: True 空値許可: False |
|
| akName | string | ワークスペース AK の名前 例: My_WS_AK 空値許可: False |
|
| language | string | ワークスペースの言語 例: zh 空値許可: True 空文字列許可: True 選択可能な値: ['zh', 'en', 'zh-hant', 'id', 'ja', 'ko'] |
パラメータ補足説明¶
データ説明.*
- リクエストパラメータの説明
| パラメータ名 | type | 説明 |
|---|---|---|
| name | string | 新しいワークスペースの名前 |
| desc | string | 新しいワークスペースの説明 |
| needCreateAk | boolean | 新しいワークスペースに API KEY を作成する必要があるかどうか |
| akName | string | API KEY の名前 |
| createPayWsVersion | boolean | 有料ワークスペースバージョンを作成するかどうか（デフォルトは false。無料プランのワークスペースを作成） |
- レスポンスパラメータの説明
| パラメータ名 | type | 説明 |
|---|---|---|
| akInfo | dict | 新しいワークスペースの API KEY 情報 |
| ownerInfo | dict | 新しいワークスペースの所有者情報 |
| wsInfo | dict | ワークスペース関連情報 |
| versionType | string | ワークスペースのバージョンタイプ |
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/workspace/create' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"name":"ws_create_test","desc":"test","needCreateAk":true,"akName":"test_ak"}' \
--compressed
--insecure
レスポンス¶
{
"code": 200,
"content": {
"accountInfo": [
"acnt_xxxxxx"
],
"akInfo": {
"keyId": "wsak_xxxxxx",
"keySk": "xxxxxxxxxxx",
"name": "test_ak"
},
"makeResourceExceptionCode": "",
"ownerInfo": {
"accountUUID": "acnt_xxxxxxxxxx",
"email": "xxx@guance.com",
"name": "Test"
},
"wsInfo": {
"billingState": "free",
"createAt": 1672802266,
"creator": "wsak_xxxxx",
"dashboardUUID": null,
"datastore": {
"backup_log": "es",
"custom_object": "es",
"keyevent": "es",
"logging": "es",
"metric": "influxdb",
"network": "es",
"object": "es",
"object_history": "es",
"rum": "es",
"security": "es",
"tracing": "es"
},
"dbUUID": "ifdb_xxxx32",
"deleteAt": -1,
"desc": "test",
"durationSet": {
"apm": "7d",
"backup_log": "7d",
"keyevent": "7d",
"logging": "7d",
"network": "1d",
"rp": "7d"
},
"enablePublicDataway": 1,
"esIndexMerged": 1,
"esIndexSettings": {},
"esInstanceUUID": "es_xxxx32",
"exterId": "",
"id": null,
"isLocked": 0,
"isOpenLogMultipleIndex": false,
"lockAt": -1,
"loggingCutSize": 10240,
"makeResourceExceptionCode": "",
"name": "ws_create_test",
"rpName": "rp1",
"status": 0,
"supportJsonMessage": 1,
"updateAt": 1672802266,
"updator": "wsak_xxxxx",
"uuid": "wksp_xxxx32",
"versionType": "free"
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-89835D3F-C614-46AD-A1B8-83CC686DDA7F"
}