更新时间:2023-06-15 GMT+08:00

修改主机信息

功能介绍

该API用于在跨源中修改数据源主机信息,仅支持全量覆盖。

URI

  • URI格式

    PUT /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}

  • 参数说明
    表1 URI参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    connection_id

    String

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

请求消息

表2 请求参数

参数名称

是否必选

参数类型

说明

hosts

Array of objects

用户自定义主机信息,最大支持2万条记录,详细信息参见表 hosts请求参数。内容填空表示清除所有已配置的主机信息。

表3 hosts请求参数

参数名称

是否必选

参数类型

说明

name

String

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

ip

String

主机对应的IPv4地址。

响应消息

表4 响应参数

参数名称

参数类型

说明

is_success

Boolean

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

message

String

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

请求示例

修改增强型跨源连接的主机信息。

{
  "hosts": [
    {
      "ip":"192.168.0.1",
      "name":"ecs-97f8-0001"
    },
    {
      "ip":"192.168.0.2", 
      "name":"ecs-97f8-0002"
    }
  ]
}

响应示例

{
  "is_success": true,
  "message": ""
}

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

修改成功。

400

请求错误。

500

内部服务器错误。

错误码

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