-
URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/user-protocol 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。
-
基本概念 账号 用户注册时的账号,账号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于账号是付费主体,为了确保账号安全,建议您不要直接使用账号进行日常管理工作,而是创建用户并使用新创建的用户进行日常管理工作。 用户 由账号在
IAM 中创建的用户,是云服务的使用人员,具有身份凭证(密码和访问密钥)。 在我的凭证下,用户可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中,用户需要用到账号、用户和密码信息。 区域(Region) 从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区(AZ,Availability Zone) 一个可用区是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目,这个项目由系统预置,用来隔离物理区域间的资源(计算资源、存储资源和网络资源),以默认项目为单位进行授权,用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制,可以在区域默认的项目中创建子项目,并在子项目中创建资源,然后以子项目为单位进行授权,使得用户仅能访问特定子项目中的资源,使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下,您可以查看项目ID。 企业项目 企业项目是项目的升级版,针对企业不同项目间的资源进行分组和管理,具有逻辑隔离能力。企业项目中可以包含多个区域的资源,且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。
-
URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications/templates 表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
-
请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 x-eds-proxy-userid 否 String 如果X-Auth-Token是租户ID,那么x-eds-proxy-userid填写实际被代理的真实用户ID。 最小长度:0 最大长度:100000
-
URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 sub_flag 是 Integer 提供/收到的合约标志: 0:我提供的合约 1:我收到的合约 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10 最小值:1 最大值:999 缺省值:10 transactional_mode 是 String 交换模式: PEER_TO_PEER: 点对点 SUBSCRIBE:订阅 枚举值: PEER_TO_PEER SUBSCRIBE name 否 String 合约名称。
-
响应示例 状态码: 200 OK 订阅列表。 {
"data" : [ {
"offer_id" : "6168c382-5184-4ec8-8a04-************",
"offer_name" : "offer-mysql-20231129AA",
"subscription_id" : "90bedec2-2efc-41d4-8223-************",
"subscription_reason" : "Subscribe by OpenApi.",
"status" : "WAIT_TO_APPROVE",
"create_time" : "2023-12-01T17:53:03Z",
"creator" : "************"
}, {
"offer_id" : "b74b4c6b-0c00-4a9d-86c3-************",
"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" : 2,
"error_code" : null,
"error_msg" : null
}
-
URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/subscriptions 表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,匹配字母、数字和符号-。 status 否 String 审批状态。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
-
响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of Offer objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 Offer 参数 参数类型 描述 offer_id String Offer ID。 offer_code String offer编码。 offer_name String offer名称。 offer_description String offer描述。 create_time String offer创建时间。 offer_status String offer状态: APPROVING: 审批中 APPROVE_REJECTED:审批拒绝 ON_BOARDING:上架中 ON_BOARD:已上架 ON_BOARD_FAILED:上架失败 OFF_BOARDING:下架中 OFF_BOARD:已下架 OFF_BOARD_FAILED:下架失败 枚举值: APPROVING APPROVE_REJECTED ON_BOARDING ON_BOARD ON_BOARD_FAILED OFF_BOARDING OFF_BOARD OFF_BOARD_FAILED 状态码: 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" : {
"user_name" : "test_user",
"user_id" : "f528b3337a724e0b9d7************",
"result_code" : "SUC
CES S",
"result_description" : "success"
},
"total" : 0,
"error_code" : null,
"error_msg" : null
}
-
响应示例 状态码: 200 OK 审计日志列表。 {
"data" : [ {
"audit_log_id" : "2a178fd057834c13a457************",
"resource_id" : "bdcfd032-fe52-448b-a673-************",
"resource_name" : "三清山.jpg",
"customer_user_id" : null,
"customer_user_name" : null,
"customer_connector_id" : "c1bf9bd7-52fc-435b-ae55-************",
"customer_connector_name" : "连接器B",
"happend_time" : "2023-12-01T16:10:28Z",
"action" : "VIEW",
"description" : null
}, {
"audit_log_id" : "74ae9d9af228437e89ad************",
"resource_id" : "7c9cafa2-0eb0-4dae-bd8d-************",
"resource_name" : "三清山.jpg",
"customer_user_id" : null,
"customer_user_name" : null,
"customer_connector_id" : "c1bf9bd7-52fc-435b-ae55-************",
"customer_connector_name" : "连接器B",
"happend_time" : "2023-12-01T15:09:36Z",
"action" : "VIEW",
"description" : null
} ]
}
-
URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 connector_keywords 否 String 连接器名称过滤关键字。 user_keywords 否 String 用户名称过滤关键字。 action 否 String 执行动作过滤: VIEW:查看 MODIFY:加工 DOWNLOAD:下载 枚举值: VIEW MODIFY DOWNLOAD start_time 否 String 发生时间。 end_time 否 String 结束时间。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
-
响应示例 状态码: 200 OK 审批操作结果。 {
"contract_id" : "AGRTconnector-****6b51ae804e0347c2b348************",
"contract_name" : "测试合约4",
"result_code" : "200",
"result_description" : "Approval succeeded."
}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用IAM服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 request_id 是 String 订阅请求id。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 approval_reason 否 String 审批理由。 参数校验规则:最小长度1,最大长度200,以字母数字中文开头,只含有字母数字汉字下划线和符号-。 approval_result 是 Boolean 审批是否通过。 contract_name 是 String 生成合约名称。 can_terminate 否 Boolean 是否允许提供方提前终止合约。
-
URI POST /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。
-
响应示例 状态码: 200 OK Offer详情。 {
"data" : {
"offer_id" : "fbf85846-3782-46dc-affb-************",
"offer_name" : "offer-mysql-20231129AA",
"offer_status" : "ON_BOARD",
"offer_resources" : [ {
"resource_id" : "25546208-0854-49a0-9023-************",
"resource_title" : "mysqlteset20231120184721",
"resource_type" : null,
"resource_category" : null
} ],
"need_approval" : false,
"can_terminate" : true,
"use_control_policies_template" : [ {
"action" : "VIEW",
"when" : {
"start_time" : "2023-11-29T10:19:03Z",
"end_time" : "2023-12-29T10:19:03Z"
},
"how_many" : null,
"where" : {
"device_ip" : [ ],
"device_mac" : [ ]
},
"who" : [ ],
"user_type" : null,
"application" : [ "22aac118-d58e-4324-9d41-************" ],
"additional_attributes" : {
"column" : "",
"rows" : [ ]
}
}, {
"action" : "DOWNLOAD",
"when" : {
"start_time" : "2023-11-29T10:19:03Z",
"end_time" : "2023-12-29T10:19:03Z"
},
"how_many" : null,
"where" : {
"device_ip" : [ ],
"device_mac" : [ ]
},
"who" : [ ],
"user_type" : null,
"application" : [ "dae4237f-9880-4fb9-a618-************" ],
"additional_attributes" : {
"column" : "",
"rows" : [ ]
}
} ],
"mask_sensitive" : null
},
"total" : 0,
"error_code" : null,
"error_msg" : null
}