更新时间:2022-04-16 GMT+08:00
分享

查询经典型跨源连接列表

功能介绍

该API用于查询该用户已创建的经典型跨源连接列表。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式

    GET /v2.0/{project_id}/datasource-connection

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

请求消息

无请求参数。

响应消息

表2 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息可能为空。

connections

Array of Objects

跨源连接信息列表,详细信息请参考表3

count

Integer

跨源连接数量。

表3 connections参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

String

系统提示信息,执行成功时,信息为空。

connection_id

String

连接ID,用于标识跨源连接的UUID。

destination

String

创建连接时,用户填写的队列的访问地址。

state

String

连接状态,具体状态请参见表4

process

Double

正在创建的跨源连接进度,显示0.0至1.0代表0%至100%。

name

String

创建连接时,用户自定义的连接名称。

connection_url

String

用于建立跨源关联表时,需要使用到的连接url。

cluster_name

String

Serverless Spark队列名称。SQL队列模式下建立的跨源连接,该字段为空。

service

String

创建连接时,用户指定的对端服务(CloudTable/CloudTable.OpenTSDB/MRS.OpenTSDB/DWS/RDS/CSS)。

create_time

Long

创建连接的时间。为UTC的时间戳。

表4 连接状态

名称

含义

说明

CREATING

创建中

跨源连接正在创建中。

ACTIVE

已激活

跨源连接创建成功,与目的地址连接正常。

FAILED

已失败

跨源连接创建失败。

DELETED

已删除

跨源连接已被删除。

示例

  • 请求样例:
    None
  • 成功响应样例:
    {
        "is_success": true,
        "message": "",
        "connections": [
            {
                "is_success": true,
                "message": "",
                "connection_id": "75419c22-7a31-42e4-a3f3-102f6e6895c9",
                "destination": "cloudtable-c172-zk3-WBFt4fr2.mycloudtable.com:2181,cloudtable-c172-zk2-LHZEWNau.mycloudtable.com:2181,cloudtable-c172-zk1-cvwY6lMh.mycloudtable.com:2181",
                "state": "DELETED",
                "process": 0,
                "name": "test",
                "connection_url": "",
                "cluster_name": "",
                "service": "CloudTable",
                "create_time": 1549092947256
            }
          ]
        }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close