云服务器内容精选

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data ConnectorDetail object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 ConnectorDetail 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 connector_description String 连接器描述。 create_time String 连接器创建时间。 connector_status String 连接器当前状态。 枚举值: ACTIVE INACTIVE create_user_id String 创建人id。 create_user_name String 创建人。 connector_owner_name String 连接器管理员名称。 connector_owner_Id String 连接器管理员ID。 protocol_signed Boolean 签署ids协议标识,true代表已经签署了协议,false表示没有签署。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。
  • 响应示例 状态码: 200 OK 连接器详情。 { "data" : { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B", "connector_description" : "测试连接器", "create_time" : "2023-10-09T11:15:48Z", "connector_status" : "ACTIVE", "create_user_name": "pa*******135", "create_user_id": "0574************", "connector_owner_name": "pa*******135", "connector_owner_Id": "0574************" "protocol_signed": "TRUE" }, "total" : 0, "error_code" : null, "error_msg" : null }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of ConnectorInfo objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ConnectorInfo 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 create_user_id String 创建人id。 create_user_name String 创建人。 connector_owner_name String 连接器管理员名称。 connector_owner_Id String 连接器管理员ID。 protocol_signed Boolean 签署ids协议标识,true代表已经签署了协议,false表示没有签署。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 是 String 查询类型。 枚举值: ADMIN offset 否 Integer 分页查询页码,表示从此页码开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 响应示例 状态码: 200 successful operation 连接器列表。 { "data" : [ { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B" }, { "connector_id" : "b40b0d94-3201-4687-93aa-************", "connector_name" : "连接器A", "create_user_name": "pa*******135", "create_user_id": "0574************", "connector_owner_name": "pa*******135", "connector_owner_Id": "0574************", "protocol_signed":true } ], "total" : 2, "error_code" : null, "error_msg" : null }
  • URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/retrieve 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data String 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 data Object 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 data Object 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • 操作步骤 参考如何登录AstroCanvas中操作,登录AstroCanvas界面。 在主菜单中,选择“数据中心”。 在左侧导航栏中,选择“连接器”。 在连接器管理页面,单击“新建连接器”。 设置基本信息。 图2 基本信息(无身份验证) 图3 基本信息(AK/SK) 图4 基本信息(API Key) 图5 API鉴权 连接器名称:输入新建连接器的名称,长度为1~32个字符,可包括中文、字母、数字及下划线。 类型:选择连接器类型,便于管理连接器。单击“新建类型”,可自定义连接器类型。 上传图标:单击,可设置连接器显示的图标。 描述:新建连接器的描述信息,可按需进行设置。 请求协议:设置连接器请求协议。 域名:请求的Host地址,不需要带上“http://”或“https://”协议头,同时也不需要“/”结尾。 域名参数:配置域名参数,包含字段名称、默认值和字段描述。 图6 配置域名参数 连接器配置中,当域名中配置“{字段名}”参数时,才会显示该参数。 接口鉴权方式:设置接口鉴权方式,支持API鉴权、AK/SK、API Key和无身份验证。 API鉴权:填写API鉴权信息后,可在连接器中选择其响应参数,作为连接器请求参数的值。 无身份验证:不需要任何验证信息,直接调用接口,通常用于访问一些公开的接口。 AK/SK:通过访问密钥进行接口鉴权。访问密钥即AK/SK(Access Key ID/Secret Access Key),是您访问系统的身份凭证,系统通过AK识别访问用户的身份,通过SK进行签名验证,通过加密签名验证可以确保请求的机密性、完整性和请求者身份的正确性。 API Key:使用API密钥进行授权,鉴权信息可以附加在Query或Header中。 鉴权信息:“接口鉴权方式”设置为“API鉴权”时,才会显示该参数。单击“新建鉴权信息”,设置鉴权信息。 图7 新建鉴权信息 API鉴权名称:设置API鉴权名称,长度为1~32个字符,可包括中文、字母、数字及下划线。 API鉴权描述:设置API鉴权描述信息。 API鉴权地址:设置API鉴权地址,通过输入字符“{xx}”可在请求参数Path列表中使用变量“xx”。 请求方式:设置接口请求方式,支持GET和POST。 请求参数:设置接口请求参数。 返回参数:设置接口返回参数。 参数位置:把鉴权信息附加在Query或Header中,请根据实际需求进行配置。“接口鉴权方式”设置为“API Key”时,才会显示该参数。 参数名称:API Key的名称,请根据实际需求进行配置。“接口鉴权方式”设置为“API Key”时,才会显示该参数。 设置执行动作。 图8 添加动作 动作信息 动作名称:设置新增动作的名称,长度为1~32个字符,可包括中文、字母、数字及下划线。 动作描述:新增动作的描述信息。 请求地址:设置请求地址,通过输入字符“{xx}”可在请求参数Path列表中使用变量“xx”。 请求方法:请根据接口类型,选择请求方法。 请求参数 Query:请求的参数,通常指的是URL中“?”后的附加参数。 Header:Header中需要的参数,目前是静态配置的。 Body:当请求类型为POST时,还需要设置Body,可以使用默认值也可以根据实际需求进行填写。 Path:URL中配置的带大括号的变量。例如{pathParam} ,其中pathParam会作为变量名。 返回参数:设置返回参数。在Body中,可以贴一段预期结果的json,使用时可以解析出字段格式。 认证信息设置完成后,单击“测试”,测试接口是否有效。 测试成功后,单击“保存”,完成连接器的创建。
  • 操作步骤 在“我的连接器”列表中,单击连接器名称,选择“执行动作”页签,单击“创建执行动作”。 设置执行动作基本信息,具体的参数说明如表1所示。 表1 参数说明 参数 说明 名称 填写执行动作的名称,根据规划自定义。建议您按照一定的命名规则填写执行动作的名称,方便您快速识别和查找。 类型 API:通过调用API的方式创建执行动作,请执行3~4。 函数:通过自定义函数的方式创建执行动作,请执行5。函数类型支持CDM集成。 流:通过编排流的方式创建执行动作,请执行6~8。 可见范围 可见:用户可见并可使用该执行动作。 隐藏:用户不可查看及使用该执行动作。 描述 执行动作的描述信息。 单击“下一步”,设置执行动作的请求信息,具体的参数说明如表2所示。 表2 参数说明 参数 说明 接口路径 被调用API的请求方式及请求路径。 输入参数 配置请求参数,如果被调用API没有请求参数可不填。 请求头(Header):HTTP请求消息的组成部分之一,请求头负责通知服务器有关于客户端请求的信息。 单击参数列表“操作”列的可以新增参数,参数配置说明请参见表3。 请求体(Body):HTTP请求消息的组成部分之一,请求体呈现发送给服务器的数据。 JSON(JSON Schema)/XML:JSON、XML格式的数据。 导入:可直接粘贴被调用API的JSON、JSON Schema或XML数据批量导入参数,减少逐个配置参数的工作量。 说明: 如果请求体使用XML格式,XML header参数必须配置。 复制:复制请求体参数的JSON或XML数据。 预览:可以预览参数的JSON或XML结构。 参数列表“操作”列的:可选择是否开启“是否支持根节点输入”参数,开启并发布对应连接器后,在创建流中添加该执行动作时可以自定义请求体参数的值。 参数列表“操作”列的:新增参数,参数配置说明请参见表3。 binary:文件格式数据。输入、输出仅支持配置一处,只支持数据流转,数据大小小于100MB。例如,输出入参数选择了“binary”,则输出不显示,反之亦成立。 查询参数(Query):查询参数会追加到URL。例如,在 /items?id=#### 中,查询参数为ID。 单击参数列表“操作”列的可以新增参数,参数配置说明请参见表3。 路径参数(Path):路径与路径模板一起使用,其中参数值实际上是操作URL的一部分。 表3 参数配置说明 参数 说明 参数名称 输入参数的名称。 显示字段 输入该参数的别名。 必填 勾选该参数是否是用户必填项。 参数类型 选择参数类型,支持string、number、boolean、integer类型。 说明 关于参数的介绍说明。 操作 单击:配置参数在界面的显示样式。配置完成并发布对应连接器后,在创建流中添加该执行动作时可以查看参数的界面显示效果。 参数类型:选择参数类型,支持string、number、boolean、integer类型。 格式:设置用户输入该参数时界面显示的样式,可选择文本框、密码、日期时间、富文本、下拉列表。不同的参数类型可选择的格式不同。 说明: 当格式选择为下拉列表时,需设置分隔符和下拉列表的值。其中,分隔符只能输入单个特殊字符,如“$”、“%”、“^”、“&”等,不设置时,默认为“,”;下拉列表的值不能和分隔符一致,支持设置多个值,单击“新增”可进行添加。 设置完成后,如果勾选了“支持多选”,则可在创建流中添加该执行动作时选择多个值,否则,只能选择一个值。 可见性:设置用户输入该参数时界面显示的可见性。无:在界面中正常显示;高级:默认隐藏在高级菜单里;隐藏:该参数向用户隐藏;重要:优先显示在界面的最开始。 默认值:设置该参数的预设值。 单击:新增节点。 单击:删除该节点。 单击“下一步”,添加响应信息,具体的参数说明如表4所示。添加完成后,执行9。 表4 参数说明 参数 说明 添加响应 根据被调用API的响应码信息添加响应码。 输出参数 配置响应参数,如被调用API没有响应参数可不填。 响应头:HTTP响应消息的组成部分之一,响应头负责通知服务器有关于客户端请求的信息。 单击参数列表“操作”列的可以新增参数,参数配置说明请参见表3。 响应体:HTTP响应消息的组成部分之一,响应体呈现发送给服务器的数据。 JSON(JSON Schema)/XML:JSON、XML格式的数据。 导入:可直接粘贴被调用API的JSON、JSON Schema或XML数据批量导入参数,减少逐个配置参数的工作量。 说明: 如果响应体使用XML格式,XML header参数必须配置。 复制:复制请求体参数的JSON或XML数据。 预览:可以预览参数的JSON或XML结构。 参数列表“操作”列的:新增参数,参数配置说明请参见表3。 binary:文件格式数据。输入、输出仅支持配置一处。例如,输出入参数选择了“binary”,则输出不显示,反之亦成立。 单击“下一步”,设置执行动作的函数信息,具体操作如下所示。 配置输入参数。选择已创建好的函数。 用户可以创建函数、编辑已创建的函数、复制函数以及刷新函数。创建函数的具体操作请参见创建函数。 单击“下一步”,配置输出参数。 单击“预览”可查看输入参数和输出参数。 单击“下一步”,设置执行动作的请求信息,具体的参数说明如表5所示。 表5 参数说明 参数 说明 输入参数 支持JSON、XML、CDM格式。 JSON:支持参数逐个增加,也支持导入JSON格式文件。 XML:支持参数逐个增加,也支持导入XML格式文件。 CDM:支持选择行业模板。 相关操作: 复制:复制请求体参数的JSON或XML数据。 预览:可以预览参数的JSON或XML结构。 “操作”列的:可选择是否开启“是否支持根节点输入”参数,开启并发布对应连接器后,在创建流中添加该执行动作时可以自定义请求体参数的值。 “操作”列的可以新增参数,参数配置说明请参见表3。 单击“下一步”,设置执行动作的输出信息,具体的参数说明如表5所示。 流编排,具体操作请参考3~6。 流编排时,触发事件为“流连接器”的“定义输入”,最后一个执行动作为“流连接器”的“定义输出”。 设置完成后,单击“保存”。 测试执行动作。测试执行动作前需要先发布连接器。 在界面右上方单击“发布”发布连接器,系统自动弹出发布的提示框,单击“确定”。 单击“操作”列的“测试”进入测试界面。 在“测试”界面中,配置连接以及输入参数,配置完成后单击“提交测试”。如果没有创建连接,请先创建连接。 如果该连接器采用“无验证”方式,则无需配置连接。 如果输入或输出为文件格式,则不支持测试。 测试完成后,可查看测试结果和测试历史。 如果测试通过,表示执行动作创建完成。 如果测试不通过,您可以单击“操作”列的“编辑”修改执行动作。修改完成后单击界面右上方“发布”重新发布连接器,再对该执行动作进行测试。
  • 如何进行连接器执行动作的测试? 未发布的连接器无法直接进行测试,需要发布后,在连接器执行动作页面进行测试。测试执行动作的具体操作如下: 在我的连接器列表中,单击连接器名称,选择“执行动作”页签,单击“创建执行动作”。 设置执行动作基本信息。 设置完成后,单击“保存”。 测试执行动作。测试执行动作前需要先发布连接器。 在界面右上方单击“发布”发布连接器。 在“测试”界面中,配置连接以及输入参数,配置完成后单击“提交测试”。如果没有创建连接,请先创建连接。 如果该连接器采用“无验证”方式,则无需配置连接。 如果输入或输出为文件格式,则不支持测试。 测试完成后,可查看测试结果和测试历史。 如果测试通过,表示执行动作创建完成。 如果测试不通过,您可以单击“操作”列的“编辑”修改执行动作。修改完成后单击界面右上方“发布”重新发布连接器,再对该执行动作进行测试。 父主题: 连接器管理
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of ConnectorInfo objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ConnectorInfo 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 OK 连接器列表。 { "data" : [ { "connector_id" : "b40b0d94-3201-4687-93aa-************", "connector_name" : "连接器A" }, { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B" } ], "total" : 2, "error_code" : null, "error_msg" : null }
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/user-connectors 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999 (当前华为云规范防止单页返回过大)。 最小值:0 最大值:999 缺省值:10
  • 删除offer 进入交换数据空间控制台界面,单击“我的空间”,在交换数据空间实例中,选择实例,单击实例卡片上的“连接器”。 单击实例下的连接器,选择界面左侧导航栏中的“数据offer”。 删除单个offer。 选择上架失败的数据offer,单击“操作”列的“删除”。 在弹出的确认框中,单击“确定”。 批量删除多个offer。 勾选上架失败的数据offer,单击页面左上角“删除”。 在弹出的确认框中,单击“确定”,多个数据offer删除。 当前仅支持对“上架失败”的offer进行删除操作。