数据源操作

可创建、删除、查询通过OpenAPI创建的数据源。

创建数据源

创建BDP数据源,将出现在BDP数据源管理视图中;数据库内的数据表,默认归属在工作表视图中以数据库命名的文件夹内。

数据源的唯一标识是数据源ID,可通过数据源查看获取;数据源不可以重名。

请求URL:

https://open.bdp.cn/api/ds/create

请求方式:GET

请求参数说明:

参数名称 参数类型 是否必填 默认值 参数描述 最大长度
access_token string 必填 开发者中心获取token,用来作为用户的身份认证 无限制
name string 必填 数据源名称 64

请求示例:

curl --request GET --url 'https://open.bdp.cn/api/ds/create?access_token=19de5e0297bfd55097733dfbc87ad79e&name=ds_name'

请求成功时返回说明:

{
    "status": 0,
    "errstr": "",
    "result": {
        "ds_id": "DS_ID"    
    }
}

请求失败时返回说明:

{
    "status": 0,
    "errstr": ""
}

错误代码说明:

status errstr
101 数据源名已存在
101 内部错误(创建数据源)
601 内部错误(创建工作表文件夹)

查询数据源列表

查看账户下使用OpenAPI创建的数据源列表,结果将返回账户下全部数据源以及各数据源下全部数据表的ID和名称。

请求URL:

https://open.bdp.cn/api/ds/list

请求方式:GET

请求参数说明:

参数名称 参数类型 是否必填 默认值 参数描述 最大长度
access_token string 必填 开发者中心获取token,用来作为用户的身份认证 无限制

请求示例:

curl --request GET --url 'https://open.bdp.cn/api/ds/list?access_token=19de5e0297bfd55097733dfbc87ad79e'

请求成功时返回说明:

{
    "status": 0,
    "errstr": "",
    "result": {
        "data_source": [                //数据源列表
            {
                "tables": [                //某数据源中工作表列表
                    [
                        "TABLE_1_NAME",        //工作表1名称
                    "TABLE_1_ID"    //工作表1ID
                    ], 
                    [
                        "TABLE_2_NAME",    //工作表2名称
                        "TABLE_2_ID"    //工作表2ID
                    ]
                ], 
                "ds_id": "DS_1_ID",     //数据源1ID
                "name": "DS_1_NAME"        //数据源1名称
            }, 
            {
                "tables": [ 
                 [
                    "TABLE_3_NAME",        //工作表3名称 
                    "TABLE_3_ID"        //工作表3ID
                    ]
                ], 
                "ds_id": "DS_2_ID",        //数据源1ID
                "name": "DS_2_NAME"        //数据源1名称
            }
        ]
    }
}

请求错误时返回说明:

{
    "status": 0,
    "errstr": ""
}

错误代码说明:

status errstr
407 内部错误(查看数据源)

删除数据源

删除BDP数据源,需要先删除数据源中的所有工作表。

请求URL:

https://open.bdp.cn/api/ds/delete?access_token=ACCESS_TOKEN&ds_id=DS_ID

请求方式:GET

请求参数说明:

参数名称 参数类型 是否必填 默认值 参数描述 最大长度
access_token string 必填 开发者中心获取token,用来作为用户的身份认证 无限制
ds_id string 必填 数据源唯一标识,创建数据源的时候会生成

请求示例:

curl --request GET --url 'https://open.bdp.cn/api/ds/create?access_token=19de5e0297bfd55097733dfbc87ad79e&ds_id=ds_adf126f84a114d88bb6f6688b97b8053'

请求成功时返回说明:

{
    "status": 0,
    "errstr": "",
    "result": "success"
}

请求失败时返回说明:

{
    "status": 4,
    "errstr": "无权限删除这个数据源"
}

错误代码说明:

status errstr
4 无权限删除这个数据源
103 请先删除数据源内工作表
103 内部错误(删除数据源)

results matching ""

    No results matching ""