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

创建增强型跨源连接

功能介绍

该API用于创建与其他服务的增强型跨源连接。

  • 如果需要了解Console界面的使用方法,可参考《数据湖探索用户指南》中的“增强型跨源连接”。
  • 系统default队列不支持创建跨源连接。

调试

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

URI

  • URI格式

    POST /v2.0/{project_id}/datasource/enhanced-connections

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

name

String

连接名称。

  • 名称只能包含数字、英文字母、下划线。不能为空。
  • 输入长度不能超过64个字符。

dest_vpc_id

String

对应服务的vpc的ID。具体请参考《虚拟私有云API参考》。

dest_network_id

String

对应服务的子网网络ID,即为需要建立连接的服务所在的子网。具体请参考《虚拟私有云API参考》。

queues

Array of Strings

需要使用跨源的队列列表。

说明:

只有包年包月队列和专属队列可以使用增强型跨源连接。

routetable_id

String

对应服务的子网关联的路由表。

hosts

Array of Objects

用户自定义主机信息,最大支持2万条记录,详细信息参见表 hosts请求参数

tags

Array of Objects

跨源连接的标签。具体请参考表4

表3 hosts请求参数

参数名称

是否必选

参数类型

说明

name

String

自定义主机名称。长度128,数字字母下划线("_")横杠("-")句点(".")组成,字母开头。

ip

String

主机对应的IPv4地址。

表4 tags参数

参数名称

是否必选

参数类型

说明

key

String

标签的键。

value

String

标签的值。

响应消息

表5 响应参数

参数名称

参数类型

说明

is_success

Boolean

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

message

String

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

connection_id

String

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

请求示例

{
  "name": "test",
  "dest_vpc_id": "22094d8f-c310-4621-913d-4c4d655d8495",
  "dest_network_id": "78f2562a-36e4-4b39-95b9-f5aab22e1281",
  "queues": [
    "q1",
    "q2"
  ],
  "hosts": [
    {
      "ip":"192.168.0.1",
      "name":"ecs-97f8-0001"
    },
    {
      "ip":"192.168.0.2", 
      "name":"ecs-97f8-0002"
    }
  ]
}

响应示例

{
  "is_success": true,
  "message": "Create peer connection for queues:{请求参数中的队列列表}",
  "connection_id": "2a620c33-5609-40c9-affd-2b6453071b0f"
}

状态码

状态码如表6所示。

表6 状态码

状态码

描述

201

创建成功。

400

请求错误。

500

内部服务器错误。

错误码

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

分享:

    相关文档

    相关产品