コンテンツにスキップ

サイト一覧¶

GET /api/v1/workspace/website/list

概要¶

サイト情報を取得します。

パラメータ補足説明¶

現在の環境に設定されているサイト情報を返します。content[*].regionCode は query.targetRegion の候補サイトコードとして使用できますが、サイトが存在しても、現在のワークスペースがそのサイトのデータアクセス権限を取得しているとは限りません。

query_data でクロスサイトのターゲットワークスペースと targetRegion を選択する場合は、優先的に /api/v1/wksp_share/granted_ws_list を呼び出し、ターゲットの workspaceUUID と同じグループの regionCode を使用してください。

リクエスト例¶

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

レスポンス¶

{
    "code": 200,
    "content": [
        {
            "declaration": {
                "asd": "aa,bb,cc,1,True",
                "asdasd": "dawdawd",
                "business": "aaa",
                "dd": "dd",
                "fawf": "afawf",
                "organization": "64fe7b4062f74d0007b46676"
            },
            "endpoint": "http://testing-ft2x-saas.dataflux.cn",
            "isCurSite": true,
            "regionCode": "testing",
            "regionName": "Test Environment（testing）"
        },
        {
            "declaration": {
                "asd": "aa,bb,cc,1,True",
                "asdasd": "dawdawd",
                "business": "aaa",
                "dd": "dd",
                "fawf": "afawf",
                "organization": "64fe7b4062f74d0007b46676"
            },
            "endpoint": "http://daily-ft2x.dataflux.cn",
            "isCurSite": false,
            "regionCode": "daily",
            "regionName": "Development Environment（daily）"
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B9CDF96A-34FB-4F48-8217-256BC3AFC5EF"
}