华为云用户手册

  • 计费说明 分布式缓存服务的默认计费项为DCS实例,如果您在使用过程中单独升级了缓存实例带宽,会产生相应的带宽费用。具体内容如表1所示。 表1 分布式缓存服务计费项 计费项 计费项说明 适用的计费模式 计费公式 DCS实例 华为云DCS按照您选择的DCS实例规格进行计费。 包年/包月、按需计费 实例规格单价 * 购买时长 实例规格单价请参见分布式缓存服务价格详情。 升级带宽 当您的实例带宽带宽不足,并且进行了调整实例带宽,华为云DCS将按照您升级的DCS实例带宽规格进行计费。 按需计费 升级带宽单价 * 购买时长 升级带宽单价以调整实例带宽时控制台显示的价格为准。 在连接DCS缓存实例时,客户端如果通过ECS访问DCS实例,关于ECS计费详情,请参见弹性云服务器价格详情。
  • 配额限制 如果您需要修改默认限制值,请参考如何申请扩大配额。专享版更多参数配置,请参见配置参数。 新增或修改的APIG资源存在数据同步延迟,需要5-10秒才生效。 在高并发情况下会出现略超最大配额数限制的情况,不影响资源的正常使用。 表1 专享版配额管理明细 限制项 默认限制 能否修改 实例数量 每个用户最多创建5个实例。 √ API分组数量 每个实例最多创建1500个API分组。 √ API数量 每个实例: 基础版:250 专业版:800 企业版:2000 铂金版:8000 √ API数量 每个分组最多创建1000个API。 x 后端策略数量 每个实例最多创建5个后端策略。 √ 应用(凭据)数量 每个实例最多创建50个应用。应用配额包括用户自行创建的应用(凭据)。 √ 流控策略数量 每个实例最多创建300个流控策略。 用户流量限制不超过API流量限制。 应用(凭据)流量限制不超过用户流量限制。 源IP流量限制不超过API流量限制。 √ 环境数量 每个实例最多创建10个环境。 √ 签名密钥数量 每个实例最多创建200个签名密钥。 √ 访问控制策略数量 每个实例最多可以创建100个访问控制策略。 √ VPC通道(负载通道)数量 每个实例最多创建200个VPC通道(负载通道)。 √ 变量数量 每个分组在任意一个环境中,最多创建50个变量。 √ 独立域名数量 每个分组最多可以绑定5个独立域名。 √ 云服务器数量 每个VPC通道最多添加10个云服务器。 √ 参数数量 每个API最多创建50个参数。 √ 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 √ 每个API的访问频率 不超过6000次/秒。 √ 特殊应用 每个流控策略最多可创建30个特殊应用。 √ 特殊租户 每个流控策略最多可创建30个特殊租户。 √ 子域名(调试域名)访问次数 每个子域名(调试域名)每天最多可以访问1000次。 x 调用请求包的大小 API每次最大可以调用12M的请求包。 √ TLS协议 支持TLS1.1和TLS1.2,推荐使用TLS1.2。 √ 自定义认证数量 每个实例最多创建50个自定义认证。 x 插件数量 每个实例最多创建500个插件策略。 √ 表2 共享版配额管理明细 限制项 默认限制 能否修改 API分组数量 每个用户最多创建50个API分组。 √ API数量 每个用户最多创建200个API。 √ 后端策略数量 每个用户最多创建5个后端策略。 √ 应用数量 每个用户最多创建50个应用。应用配额包括用户自行创建的应用和API云商店购买API生成的应用。 √ 流控策略数量 每个用户最多创建30个流控策略。 用户流量限制不超过API流量限制。 应用流量限制不超过用户流量限制。 源IP流量限制不超过API流量限制。 √ 环境数量 每个用户最多创建10个环境。 √ 签名密钥数量 每个用户最多创建30个签名密钥。 √ 访问控制策略数量 每个用户最多可以创建100个访问控制策略。 √ VPC通道数量 每个用户最多创建30个VPC通道。 √ 变量数量 每个分组在任意一个环境中,最多创建50个变量。 √ 独立域名数量 每个分组最多可以绑定5个独立域名。 √ 云服务器数量 每个VPC通道最多添加200个云服务器。 √ 参数数量 每个API最多创建50个参数。 √ 发布历史数量 同一个API在每个环境中最多记录10条最新的发布历史。 √ 每个API的访问频率 不超过200次/秒。 √ 特殊应用 每个流控策略最多可创建30个特殊应用。 √ 特殊租户 每个流控策略最多可创建30个特殊租户。 √ 子域名访问次数 每个子域名每天最多可以访问1000次。 x 调用请求包的大小 API每次最大可以调用12M的请求包。 x 自定义认证数量 每个用户最多创建20个自定义认证。 √
  • 响应参数 状态码: 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/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 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 }
  • 响应示例 状态码: 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 }
  • 响应参数 状态码: 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 PROCESS 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 错误描述。
  • 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
  • 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
  • 响应示例 状态码: 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 }
  • 响应参数 状态码: 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 错误描述。
  • 概述 欢迎使用交换数据空间(Exchange Data Space,简称EDS),交换数据空间是面向数据要素流通场景,提供数据交换过程中的安全保护技术能力,如数据使用策略、日志审计、数据地图等。您可以选择相应的安全策略,让数据在提供方和消费方交换过程中,按照对应策略的约束使用数据,同时EDS提供相应的日志审计能力,帮助您了解数据在交换流转中的操作过程。 您可以使用本文档提供的API对交换数据空间进行相关操作,如查询用户连接器列表和点对点生成合约等。支持的全部操作请参见API概览。 在调用交换数据空间API之前,请确保已经充分了解交换数据空间相关概念,详细信息请参见交换数据空间的产品介绍。 父主题: 使用前必读
  • 响应示例 状态码: 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 }
  • 响应参数 状态码: 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
  • 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 审计日志列表。 { "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}/teams 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 team_name 否 String 团队名称。 参数校验规则:只能包含英文字母、数字、下划线、中文及-,并且只能以中文和英文开头,最小长度1,最大长度100。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of TeamInfo objects 团队详情。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 TeamInfo 参数 参数类型 描述 team_id String 团队ID team_name 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" : [ { "team_id": "40**********67bd9fc", "team_name": "测试3" }, { "team_id": "ffac5**********e54a1b78", "team_name": "测试2" } ], "total" : 2, "error_code" : null, "error_msg" : null }
  • 响应示例 状态码: 200 OK 合约数据包列表。 { "data" : [ { "data_packet_name" : "演示合约1", "data_packet_id" : "44d2f35e-0371-433f-b5b6-************", "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************", "creator" : "************", "create_time" : "2023-12-05T20:24:42Z", "updater" : "************", "update_time" : "2023-12-05T20:24:42Z", "shared_company_name" : null, "shared_company_id" : null, "shared_connector_name" : "连接器A", "shared_connector_id" : "b40b0d94-3201-4687-93aa-************" }, { "data_packet_name" : "演示合约2", "data_packet_id" : "448e88db-70c0-430b-a195-************", "contract_id" : "AGRTconnector-****b252e8d809754d6aaef7************", "creator" : "0574abfba400d2a91f5ec01111a89fcf", "create_time" : "2023-11-29T10:06:40Z", "updater" : "************", "update_time" : "2023-11-29T10:06:40Z", "shared_company_name" : null, "shared_company_id" : null, "shared_connector_name" : "连接器A", "shared_connector_id" : "b40b0d94-3201-4687-93aa-************" } ], "total" : 2, "error_code" : null, "error_msg" : null }
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/received-data-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 scope 是 String 查询范围: ALL:所有 READ:已读 UNREAD:未读 枚举值: ALL READ UNREAD offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of DataPackageResource objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 DataPackageResource 参数 参数类型 描述 data_packet_name String 数据包名称。 data_packet_id String 数据包ID。 contract_id String 合约ID。 creator String 创建人。 create_time String 创建时间。 updater String 更新人。 update_time String 更新时间。 shared_company_name String 数据包提供方所属的企业,即所属租户名。 shared_company_id String 数据包提供方所属的企业id,即所属租户id。 shared_connector_name String 数据包提供方所属的连接器,即所属连接器名。 shared_connector_id String 数据包提供方所属的连接器id,即所属连接器id。 状态码: 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/{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
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of ApplicationTemplate objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ApplicationTemplate 参数 参数类型 描述 id String 应用模板ID。 name String 应用模板名称。 description String 应用模板描述。 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 self Boolean 资源是否是自己的。 natives Boolean 是否内置应用, true内置,false自创。 operation Array of strings 限制使用的操作。 枚举值: VIEW PROCESS DOWNLOAD status String 状态: NORMAL:正常使用状态 DISABLE:停用状态,不再分配给新的eds实例 枚举值: NORMAL DISABLE icon String 应用图标。 create_time 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" : [ { "id" : "234ac118-d58e-4324-9d41-************", "name" : "PDF_JS", "description" : "用于预览PDF文件,仅供测试", "type" : "PDF_JS", "self" : null, "natives" : true, "operation" : [ "VIEW" ], "status" : "NORMAL", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "create_time" : "2023-05-23T21:37:02Z" }, { "id" : "234c118-758e-4324-9d41-************", "name" : "本地下载", "description" : "用于将文件下载到本地", "type" : "LOCAL_DOWN", "self" : null, "natives" : true, "operation" : [ "DOWNLOAD" ], "status" : "NORMAL", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "create_time" : "2023-05-23T21:37:02Z" } ], "total" : 2, "error_code" : null, "error_msg" : null }
  • 请求示例 查询数据资产统计列表。 GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs/artifact-usages?artifact_id=66f6bb97-c70a-43d9-aa73-************&offset=0&limit=100
  • 响应示例 状态码: 200 OK 资产使用情况列表。 { "data" : [ { "artifact_id" : "66f6bb97-c70a-43d9-aa73-************", "artifact_name" : "customers", "consumer_user_name" : "paas_roma_l00489135", "consumer_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "consumer_connector_name" : "连接器B", "action_count_list" : [ { "action" : "MODIFY", "count" : 1 }, { "action" : "DOWNLOAD", "count" : 1 }, { "action" : "VIEW", "count" : 2 } ] } ] }
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs/artifact-usages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 artifact_id 否 String 资产ID。 参数校验规则:最小长度1,最大长度50,匹配字母数字和符号-。 artifact_name 否 String 资产名称。 参数校验规则:只能包含英文字母、数字、下划线、中文及-,并且只能以中文和英文开头,最小长度1,最大长度200。 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 表4 响应Body参数 参数 参数类型 描述 data Array of ArtifactUsage objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ArtifactUsage 参数 参数类型 描述 artifact_id String 资产ID。 artifact_name String 资产名称。 consumer_user_name String 消费连接器用户名称。 consumer_connector_id String 消费连接器ID。 consumer_connector_name String 消费连接器名称。 action_count_list Array of ActionCount objects 使用次数。 表6 ActionCount 参数 参数类型 描述 action String 限制使用的操作: VIEW:查看 MODIFY:加工 DOWNLOAD:下载 枚举值: VIEW MODIFY DOWNLOAD count Integer 使用次数。 状态码: 400 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表8 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
共100000条