云服务器内容精选

  • 响应参数 状态码: 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 OK 连接器列表。 { "data" : [ { "connector_id" : "b40b0d94-3201-4687-93aa-************", "connector_name" : "连接器A" }, { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B", "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 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(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 响应参数 状态码: 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 错误描述。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of AppInfo objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 AppInfo 参数 参数类型 描述 type String 实例化的应用类型: STRUCTURED:支持jdbc、csv下载 TRUSTED_ENV:支持可信环境下载 LOCAL_DOWN:支持本地下载 LUCKY_EXCEL:支持excel本地预览 UNSTRUCTURED:支持 obs sftp ftp下载 PDF_JS:支持pdf本地预览 STRUCTURED_VIEW:支持csv jdbc本地预览 WPS:wps应用 IMAGE_VIEWER:本地图片查看 枚举值: STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER name String 应用名称。 id String 应用ID。 temp_id String 应用模板ID。 temp_name String 应用模板名称。 natives Boolean 是否内置应用, true内置,false自创。 operation Array of strings 应用操作。 枚举值: VIEW PRO CES S DOWNLOAD description String 应用描述。 icon String 应用图标。 connection DataSourceConnect object 应用连接信息。 create_user_id String 创建人ID。 create_user_name String 创建人名称。 create_date String 创建时间。 表6 DataSourceConnect 参数 参数类型 描述 datasource_type String 数据源类型。 枚举值: MRS _HIVE ORACLE MYSQL DWS GAUSS_DB FTP SFTP OBS WPS API connection DataSourceConnection object 数据源连接信息。 表7 DataSourceConnection 参数 参数类型 描述 obs_connection ObsConnection object OBS数据源连接信息。 表8 ObsConnection 参数 参数类型 描述 endpoint String OBS访问地址。 bucket_name String OBS名称。 access_key String OBS永久访问密钥。 secret_key String OBS永久密钥。 path String OBS访问路径。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • 响应示例 状态码: 200 OK 查看实例化应用列表。 { "data" : [ { "type" : "UNSTRUCTURED", "name" : "OBS4", "id" : "70d5c8d0-fe76-4cf0-9d30-***********", "temp_id" : "335ac118-758e-4324-9d41-***********", "temp_name" : "文档下载", "natives" : false, "operation" : [ "DOWNLOAD" ], "description" : "abc", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "connection" : { "datasource_type" : "OBS", "connection" : null }, "create_user_id" : "test-***********", "create_user_name" : "test-***********", "create_date" : "2023-11-21T16:50:53Z" } ], "total" : 1, "error_code" : null, "error_msg" : null }
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10 app_name 否 String 实例化APP名称。 ids 否 Array 实例化APP ID。 operations 是 Array 执行动作过滤。 枚举值: VIEW PROCESS DOWNLOAD status 是 Array 状态: NORMAL:正常使用状态 DISABLE:停用状态,不再分配给新的eds实例 枚举值: NORMAL DISABLE
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of SubscriptionResponse objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 SubscriptionResponse 参数 参数类型 描述 offer_id String Offer ID。 offer_name String Offer名称。 subscription_id String 订阅返回ID。 subscription_reason String 订阅理由。 status String 订阅状态: WAIT_TO_DEAL:待处理 HAS_DEAL:已处理 CLOSED:已关闭 WAIT_TO_APPROVE:待审批 REJECTED:已驳回 PASSED:已通过 REVOKED:已撤销 WAIT_TO_OPEN:待开通 枚举值: WAIT_TO_DEAL HAS_DEAL CLOSED WAIT_TO_APPROVE REJECTED PASSED REVOKED WAIT_TO_OPEN create_time String 创建时间。 creator String 创建人。 状态码: 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 错误描述。
  • 响应示例 状态码: 200 OK 订阅待审批列表。 { "data" : [ { "offer_id" : "6e2ab6d7-5f19-4097-a074-************", "offer_name" : "offer-mysql-20231129AA", "subscription_id" : "7343b305-75f9-4979-ade0-************", "subscription_reason" : "Subscribe by OpenApi.", "status" : "WAIT_TO_APPROVE", "create_time" : "2023-12-01T17:47:23Z", "creator" : "************" } ], "total" : 1, "error_code" : null, "error_msg" : null }
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions/approvals 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 subscription_id 否 String 订阅ID。 参数校验规则:最小长度1,最大长度50,匹配字母数字和符号-。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 概述 欢迎使用 交换数据空间 (Exchange Data Space,简称EDS),交换数据空间是面向数据要素流通场景,提供数据交换过程中的安全保护技术能力,如数据使用策略、日志审计、数据地图等。您可以选择相应的安全策略,让数据在提供方和消费方交换过程中,按照对应策略的约束使用数据,同时EDS提供相应的日志审计能力,帮助您了解数据在交换流转中的操作过程。 您可以使用本文档提供的API对交换数据空间进行相关操作,如查询用户连接器列表和点对点生成合约等。支持的全部操作请参见API概览。 在调用交换数据空间API之前,请确保已经充分了解交换数据空间相关概念,详细信息请参见交换数据空间的产品介绍。 父主题: 使用前必读
  • 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 表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 错误描述。