Skip to content

List Sites¶

GET /api/v1/workspace/website/list

Overview¶

Get site information.

Parameter Notes¶

Returns the site information configured for the current environment. content[*].regionCode can be used as a candidate site code for query.targetRegion. However, the existence of a site does not mean that the current workspace has been granted data access authorization for that site.

When selecting a cross-site target workspace and targetRegion for query_data, you should first call /api/v1/wksp_share/granted_ws_list and use the regionCode that belongs to the same group as the target workspaceUUID.

Example Request¶

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

Response¶

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