콘텐츠로 이동

작업 공간 생성¶

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"
}