查询经典型跨源连接

功能介绍

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

调试

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

URI

URI格式
 GET /v2.0/{project_id}/datasource-connection/{connection_id}

参数说明

表1 URI参数
参数名称	是否必选	参数类型	说明
project_id	是	String	项目编号，用于资源隔离。获取方式请参考获取项目ID。
connection_id	是	String	连接ID，用于标识跨源连接的UUID。

请求消息

无请求参数。

响应消息

表2 响应参数
参数名称	是否必选	参数类型	说明
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的时间戳。
available_queue_info	否	Array of Objects	各个队列创建跨源连接的信息，详细信息请参考表3。

表3 available_queue_info参数说明
参数名称	是否必选	参数类型	说明
peer_id	否	String	跨源连接ID。
status	否	String	连接状态，状态码请参考表4。
name	否	String	队列名称。
err_msg	否	String	状态为失败时的详细报错信息。
update_time	否	Long	更新时间。

表4 连接状态
名称	含义	说明
CREATING	创建中	跨源连接正在创建中。
ACTIVE	已激活	跨源连接创建成功，与目的地址连接正常。
FAILED	已失败	跨源连接创建失败。
DELETED	已删除	跨源连接已被删除。

示例

请求样例：
```
None
```

成功响应样例:

{
      "is_success": true,
      "message": "",
      "connection_id":"378eb1e6-521d-41a4-a41c-bbb58f34a6d6",
      "destination":"cloudtable-cf82-zk3-pa6HnHpf.cloudtable.com:2181,cloudtable-cf82-zk2-weBkIrjI.cloudtable.com:2181,cloudtable-cf82-zk1-WY09px9l.cloudtable.com:2181",
      "state": "CREATING",
      "process": 0,
      "name": "op",
      "connection_url": "",
      "cluster_name": "",
      "service":"CloudTable.OPENTSDB",
      "create_time": 1566180327674,
      "count":1
    }

状态码

状态码如表5所示。

表5 状态码
状态码	描述
200	查询成功。
400	请求错误。
500	内部服务器错误。

错误码

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

父主题： 经典型跨源连接相关API

查询经典型跨源连接

功能介绍

调试

URI

请求消息

响应消息

示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

售前咨询热线