云服务器内容精选

  • 约束与限制 对于数据服务共享版 IAM 认证方式的API,系统已默认记录了当前账号的白名单,不支持删除,因此共享版IAM认证方式的API无需进行授权即可进行调用。而专享版中使用IAM认证方式的API则必须先通过应用或白名单授权才能调用。 申请API授权时,仅支持通过应用授权的方式,暂不支持白名单授权方式。 APP认证方式的API只能授权给APP类型的应用。 IAM认证方式的API只能授权给IAM类型的应用。
  • 操作场景 DataArts Studio 数据服务的API流量控制基于指定规则对API的访问流量进行调节控制的限流策略,能够提供多种维度的后端服务保护功能。当前API流控支持通过用户、应用和时间段等不同维度限制API的调用次数。 为了提供持续稳定的服务,您需要通过创建并选择流控策略,针对部分API进行流量控制。流控策略和API本身是相互独立的,只有将流控策略绑定API后,流控策略才对绑定的API生效。 同一个环境中一个API只能被一个流控策略绑定,一个流控策略可以绑定多个API。
  • API开放方使用流程 您作为API提供者,需要实现一个或一组API的开放,那么您需要先后完成以下工作: 购买并管理专享版集群 如果您需要使用数据服务专享版,需要先购买专享版集群。 新建数据服务审核人 在创建API前,需要新建数据服务审核人。 创建API 创建API即生成API和注册API。其中,生成API支持两种方式(配置方式生成API和脚本/MyBatis方式生成API)。 调试API API创建后需要验证服务是否正常,管理控制台提供了调试功能。 发布API 只有将API发布后,API才支持被调用。 管理API 您可以根据您的需要,对已创建发布的API进行管理。 编排API 编排API是将已经开发好的服务API接口,在无需编写复杂代码的情况下,根据特定的业务逻辑和流程进行可视化的重组和重构,从而实现在不影响原生接口的前提下进行简便的二次开发。 (可选)配置流控策略 为了保护后端服务的稳定的考虑,您可以对API进行流量控制。 (可选)主动授权API 应用定义了一个API调用者的身份。对于使用APP或IAM认证方式的API,必须在API授权后,才能获得认证信息以用于API调用。
  • 总览页面说明 在总览页用户可以看到丰富的监控数据视图。数据服务总览页面分别从API开放方和API调用方的视角,统计了API的相关度量数据。 图1 API总览 表1 API开放方数据统计 界面 说明 发布趋势 从每天、每周、每月、每年的维度统计了API开放方发布的API数量。 调用趋势 从半天、每天、每周、每月的维度统计了API开放方发布的API,被调用的次数。 调用比率TOP5 统计API开放方所开放的API,被调用的比率,包含成功率、失败率、合法率和非法率。 调用时间TOP5 统计API开放方所开放的API,被调用时长,支持统计的维度包含时长平均总值、成功时长平均总值,失败时长平均总值。 调用次数TOP5 统计API开放方所开放的API,被调用次数排名TOP5的,支持统计的维度包含调用总次数、成功次数、失败次数、合法次数和非法次数。 已发布 统计API开放方已成功发布的API数量。 开发中 统计API开放方开发中的API数量。 申请者 统计API开放方已成功发布的API,被申请调用的应用数量。 调用成功 统计API开放方已成功发布的API,被应用成功调用的次数。 调用失败 统计API开放方已成功发布的API,被应用调用失败的次数。 总调用次数 统计API开放方已成功发布的API,被应用调用的总次数。 图2 调用总览 表2 API调用方数据统计 界面 说明 调用趋势 从每天、每周、每月、每年的维度统计了API调用方调用的API数量。 调用比率 统计调用方最近7天内调用API的成功和失败比例。 已申请 统计API调用方,在数据服务平台申请调用的API数量。 调用成功 统计API调用方在数据服务平台成功调用API的次数。 总调用次数 统计API调用方在数据服务平台调用API的总次数。
  • 使用API时,每个子 域名 每天可以访问多少次? 每个子域名的访问次数限制与API发布到的目标有关。 共享版默认发布到API网关共享版。发布成功后,您可以在API网关服务共享版控制台上查看所发布的API。 系统为API网关共享版的默认分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,此调试域名每天最多可以访问1000次。如果您不希望与其他API共享此规格,可以在APIG共享版控制台新建一个API分组(详情请参考创建API分组),然后在数据服务发布时选择对应API分组,独享每天最多访问1000次的规格。另外,您还可以为API分组绑定一个或多个独立域名(详情请参考绑定域名),API调用者通过访问独立域名来调用您开放的API,这样即可不受每天最多访问1000次的规格限制。 专享版默认发布到数据服务专享版集群上,发布成功后API调用者可以通过内网调用该API。值得一提的是,只有将API发布到专享版集群上,才不存在每天最多可以访问1000次的限制,可自由调用API。 您也可以选择“更多”,将API发布到APIG专享版或ROMA Connect实例上。 APIG专享版:如果您需要将API发布到APIG专享版上,则您需要提前在API网关服务上购买一个APIG实例。实例创建后,有一个默认API分组,系统为分组自动分配一个内部测试用的调试域名,此调试域名唯一且不可更改,每天最多可以访问1000次。如果您不希望与其他API共享此规格,可以在APIG控制台新建一个API分组(详情请参考创建API分组),然后在数据服务发布时选择对应API分组,独享每天最多访问1000次的规格。另外,您还可以为API分组绑定一个或多个独立域名(详情请参考绑定域名),API调用者通过访问独立域名来调用您开放的API,这样即可不受每天最多访问1000次的规格限制。 ROMA Connect实例:如果您需要将API发布到ROMA Connect实例上,则您需要提前在ROMA Connect服务上购买一个ROMA实例,并创建API分组(详情请参考创建API分组)。API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。为了不受此规格限制,您可以为API分组绑定独立域名(详情请参考绑定域名),API调用者通过访问独立域名来调用您开放的API。 详细内容请参见发布API。 父主题: 数据服务
  • SDK调用常见错误码/错误信息 表1 常见错误码/错误信息 错误码 错误信息 错误原因 解决方案 DLM.0 null 表示API调用成功。 表示调用成功,无需处理。 APIG.0101 The API does not exist or has not been published in the environment API未发布 url错误 发布API 确认请求的url和实际url是否相同 APIG.0106 Orchestration error: Invalid header parameter: x-Authorization, required SDK未添加x-Authorization。 SDK使用前准备步骤3。 APIG.0106 Orchestration error: Invalid ___ parameter: ___, required 未传指定参数。 调用时上传此参数。 APIG.0201 Backend timeout 后端超时(API网关请求维持50秒后未收到返回结果,会返回此错误信息。) 请先确认数据服务访问日志,如果访问日志中有数据(数据略有延迟),则说明数据源取数时间过长,请尽量优化取数sql逻辑。 如果访问日志中无数据,请确认(共享版:数据服务gateway/专享版:数据服务集群)是否运行中。 APIG.0303 Incorrect app authentication information: app not found 应用不存在。 确认请求的key和secret是否准确。 APIG.0304 The app is not authorized to access the API 应用无权访问当前API。 确认API已授权给应用。 确认请求的key和secret是否准确。 APIG.0308 The throttling threshold has been reached: policy domain over ratelimit, limit:1000, time:1 day 域名的请求次数达到了给定的上限:1天1000次。 建议:去API网关,为分组绑定域名。 临时规避:切换分组。域名以分组为单位,每个分组限制独立计算。 DLM.4018 Api is not exist API不存在。 20200630版本前发布的API: 请确认调用时参数x-api-id的值,是否正确(该值为所访问API的ID,请向此API的提供者获取) 20200630版本后发布的API: 确认请求的url和实际url是否相同。 若为专享版刚发布的API,请稍作等待,API下发至集群存在短暂的延时。 其他(数据同步异常): 停用/下线对应API,然后恢复/发布。 尝试重启集群(逐个节点重启可避免业务影响)。 DLM.4094 Call api failed. 调用API失败。 确认调用所执行的SQL正确,可以正常使用(所执行SQL详见访问日志,仅API方可见)。 CDM 中代理异常,错误原因详见返回的DLG错误信息。 调用超时,若为DWS数据库,建议API采用自定义分页。 调用超时,请优化查询语句,确保数据库中能短时间内完成执行。 DLM.4211 Token invalid token校验不通过。 确认token是否正确。 确认token所属租户,是否已授权或已位于白名单中。 DLM.4312 Missing parameters: ___ 缺少指定参数。 调用时上传此参数。 400 App does not have permission to access API. 应用无权访问当前API。 确认API已授权给应用。 确认请求的key和secret是否准确。 确认API和APP的授权关系仍在有效期内。 401 Authorization not found. 签名信息未找到。 应用认证:SDK使用前准备步骤3。 发布到网关的专享版IAM认证:IAM认证的API发布到网关后,不支持直接访问集群的token认证形式。 401 Authorization format incorrect. 签名格式错误。 建议使用SDK生成签名。 401 Signing key not found. 签名密钥未找到。 确认请求的key和secret是否准确。 401 Signed header ___ not found. 签名头未找到。 请确认用于签名的header头参数在调用时上传了。 401 Header x-sdk-date not found. 签名头x-sdk-date未找到。 此参数为签名时自动生成,若通过其他方式调用,请将SDK签名后的此参数在调用时也进行上传。 401 Signature expired. 签名过期。 签名具有一定的有效期,当前签名已过期,请重新生成签名。 请确认本地时间和实际时间是否一致。 如果本地时间是准确的,请联系相关人员确认集群节点时间,可能节点时间存在异常。 401 Verify authroization failed. 签名校验失败。 请确认进行签名的所有参数,均已上传且和签名时相同,包括且不限于url、path、header、query、body等。 说明: 如果自行对接了第三方网关等,请求地址和数据服务展示的地址不一致,需要在请求头中补充参数x-forwarded-host,值为签名时使用的请求地址。 如果使用get请求,不要定义body体。 DLG.0902 Fail to call the agent. For details about No matching constant for [-1], see the CDM logs. CDM上的代理拒绝服务。 SQL执行时间过长 CDM资源不足了 确认SQL执行时长,如果时间过长,建议优化SQL(默认分页的话则建议使用自定义分页)。 如果SQL执行时间较短,当前没有其他服务正在作业的话,重启CDM。 DAYU.1088 Failed to process the request sent by the agent. CDM无响应。 尝试重启CDM。 可能是CDM升级引起,考虑新买一个CDM。 父主题: 数据服务SDK参考
  • 新建审核人 如果数据服务模块当前还未添加审核人,请先添加审核人,因为创建API需要提交审核人审核。 只有工作空间管理员角色的用户才具有添加审核人的权限。 单击工作空间“XXX”的“数据服务”,单击左侧的“专享版”。 单击左侧导航栏中的“审核中心”,进入相应页面后,选择“审核人管理”页 签,然后单击“新建”按钮。 图1 新建审核人1 选择审核人(此处的账户列表来自于工作空间成员), 单击“确认”完成审核人的添加。根据需要,可以添加多个审核人。 图2 新建审核人2 父主题: 数据服务
  • 操作步骤 登录MapDS控制台。 在左侧导航栏选中“卫星遥感数据”,进入订单列表页面。 单击右上角“购买卫星遥感数据”,进入购买页面。 根据界面提示选择购买区域。 在购买区域上用户可根据“行政区域选择”或者“自定义SharpFile”。 自定义sharpFile场景说明: 上传的shp文件要求文件包含4个文件,后缀分别为.shp,.shx,.dbf,.prj,缺一不可。 自定义sharpFile场景,要求上传的shp文件是WGS84坐标系,MapDS把shp文件从WGS84坐标系转换成EPSG:4527坐标系完成面积统计计算。 图1 选择区域 单击“下一步”,根据界面提示进行属性配置,配置信息表1所示。 表1 配置属性 参数名称 参数说明 购买类型 影像:数字正射影像图,带有公里格网、图廓(内、外)整饰和注记的平面图。 地形:数字高程模型,即对地面地形的数字化模拟。 交付类型 光学 多光谱 时效 现势(90天以内):直接获取所需空间范围内的90天内的影像数据 一年存档 两年存档 三年存档 预约拍摄:可自行选择预约时间进行数据拍摄 预约时间 当时效选择“预约拍摄”时,需要选择预约时间。 分辨率 购买类型为“影像”时需要设置分辨率。 精度越高,能观察到的地面物体越清晰。 高程精度 购买类型为“地形”时需要设置高程精度。 网格大小 购买类型为“地形”时需要设置网格大小。 坐标系(可选) 当勾选“高级选项”时,需要设置该项。 WGS-84坐标系:2000.0历元的瞬时坐标,用于生产活动,强调统一性、规范性、自洽性和稳定性。 2000国家大地坐标系:观测历元的动态坐标,用于导航,强调实时性、动态性。 单击“下一步”,填写用户联系方式:用户名和电话号码。 单击“下一步”,进行配置信息确认。 确认无误后,单击“支付”。
  • 响应 响应样例 {"success": true,"returnData": {"isBuyD CS ervice": true,"buyStatus": "SUC CES S"}} 要素说明 参数名 参数类型 备注 success boolean 请求是否成功。 returnData object 返回值。 isBuyDCService boolean 是否订购。 true:已订购。 false:未订购。 buyStatus String 具体的订购状态。
  • 数据库有数据,但是接口返回0是什么原因? 可能原因如下: “rdmextentiontype”参数值有误。请检查“rdmextentiontype”是否有值。如果有,该值是否正确。“rdmextentiontype”参数值为模型项英文名称。 “rdmdeleteflag”参数值为0或空。“rdmdeleteflag”表示软删除标识,工业数字模型驱动引擎-数据建模引擎(xDM Foundation,简称xDM-F)提供的所有原子接口均不查询和返回软删除的数据。 查询条件不对。 父主题: 全量数据服务API相关问题
  • 操作场景 当您发布数据模型和发布应用后,系统会在全量数据服务中预生成与其相应的API,您可以在应用设计态预览各类API的详细信息。 支持通过如下方式进行查看: 离线方式:将应用设计态的全量数据服务API导出至本地计算机进行查看(推荐),具体操作请参见导出API。 在线方式:在应用设计态上在线查看。 如需查看应用完整的全量数据服务API,需将应用部署至数据建模引擎后,前往应用运行态查看,具体操作请参见部署应用和全量数据服务。
  • 使用流程 进入“生成器配置”页签,创建ID标识器,即建立一个满足业务需求的编码发生器。 创建ID标识器前,需要添加生成器分类和生成器标签,生成器名称及代码系统自动生成。 生成器分类:支持创建一种业务分类,例如生成的编码是文档编码、零件编号或生产批次等。 生成器标签:为生成器建立编码标签,例如上文中的文档,是属于工程文档、测试说明,还是财经报告、法律条文等,添加一个可辨识、搜索的标签。 ID标识器任务创建完成后,通过拖拉拽在画布中添加“构件”,并设置构件的运行属性,设置完成后发布生效。 编码生成器由4个部分构件组成,固定字符+对象编码+日期代码+流水序列。其中流水序列是必选部分,没有该部分,无法对外生成编码。 添加构件时,若添加“对象编码”构件,则需要设置业务对象属性。例如部件编码组成包含对内型号、小类代码等属性,此时就需要在“业务对象属性”中单独添加属性,并设置“业务对象类属性代码”(属性值、唯一值)。编码生成时就会包含自定义添加的属性值。 通过接口调用使用,应用于系统或程序中,生成业务编码。
  • 创建ID标识器 创建任务 进入“生成器配置”页签,单击。 在弹出的界面中设置如下信息: 生成器代码:由系统自动生成,系统唯一值。 生成器名称:生成器的名称,系统默认填充“生成器代码”的取值。 生成器分类:数据来源于生成器分类。 生成器标签:数据来源于生成器标签。 填写完成后,单击“确定”。 添加构件 将需要的“构件”从顶部的构件列表中拖入中间的画布区域。 图1 添加构件 “流水序列”构件为必选,没有流水序列,无法对外生成编码。 单击构件,设置构件属性。 表3 构件属性 构件 说明 ID生成器 生成器代码:系统自动生成,系统唯一值 生成器名称:生成器的名称,系统默认填充“生成器代码”的取值 生成器分类:自定义分类,数据来源于生成器分类 总目标长度:生成器条码总长度 流水分组规则:系统自动生成 格式预览:生成器条码内容 备注:填写自定义备注信息 固定字符 构件代码:由系统自动生成,系统唯一值 构件名称:默认为固定字符串,支持修改 固定值:编码中自定义的固定值,如ABC、001等 目标长度:固定值的长度 是否属于流水分组标识:是否开启编码生成的预览效果,默认开启 是否作为组装元素输出:是否使用该规则,默认开启 对象编码 业务属性取值 业务属性:数据来源于业务对象属性 属性初始值:数据来源于“业务对象属性”中的“默认值” 目标长度:根据预览值计算的长度 预览值:“属性初始值”经过数据处理后的最终数值 数据处理逻辑 数据处理方法:支持大小写转换、长度填补、顺序反转、字符串截取、增加前缀、增加后缀。(例如大小写转换,支持设置为“全转大写”,即编码中的小写字母全部转换成大写) 构件显示属性 构件名称:默认为对象编码,支持修改 构件代码:由系统自动生成,系统唯一值 是否属于流水分组标识:是否开启编码生成的预览效果,默认开启 是否作为组装元素输出:是否使用该规则,默认开启 日期代码 时间代码属性:设置日期样式,选项如下 时间年月日时分秒yyyMddHHmmss 时间年月日yyyyMdd 时间年月yyyyMM 时间时分秒HHmmss 自选定组合 日期格式:设置年份显示样式,显示为2位数字或4位数字,例如24或2024 预览值:选定日期后,自动生成预览值 目标长度:预览值长度 初始值:根据“时间代码属性”生成的值,例如202406 构件代码:由系统自动生成,系统唯一值 构件名称:默认为日期代码,支持修改 是否属于流水分组标识:是否开启编码生成的预览效果,默认开启 是否作为组装元素输出:是否使用该规则,默认开启 流水序列 流水码类别:当前仅支持数字流水 目标长度:数字流水值的长度,取值范围1-10 最小值:根据目标长度和进制规则确认最小值 最大值:根据目标长度和进制规则确认最大值 增减方式:目前仅支持增量 间隔量(十进制):默认为1 进制规则:十进制、可配置字符进制,其中34进制字符集不勾选O和I 周期重置模式:可选值从不、每日、每周、每月、每年 预览值:最小值经过进制转换后的最终数值 构件代码:由系统自动生成,系统唯一值 构件名称:默认为流水序号,支持修改 是否作为组装元素输出:是否使用该规则,默认开启 说明: 流水序列递增规则: 如果纯数字,会从最小值递增到最大值,例如:最小值是1最大值是9999,则初始的第一个流水序列码是0001,然后往上递增加1,变为0002,0003。 如果是数字加字母形式,会从最小值递增到最大值,例如,最小值是1,最大值是ZZZZ,在同一个位数上,先是数字递增,然后再到字母递增。则初始的第一个流水序列码是0001,然后往上递增加1,变为0002,0003,到了0009的时候再递增是000A,000B,000C,到了000Z后再递增是0010。 设置完成后单击“操作”列表中的“发布”。 操作过程中您也可以进行重置、还原、复制等操作。
  • 业务对象属性 添加编码构件后,需要创建业务对象,并设置业务对象属性。业务对象添加后可应用于编码当中,作为编码的组成部分。 添加业务对象 进入“业务对象属性”页签。 单击“添加”。 在弹出的“添加业务对象”窗口中,设置如下信息: 应用名称:业务对象的应用名称。 应用类名称:业务对象的应用类名称。 应用类代码:业务对象的应用类代码,默认为“应用类名称”取值。 应用类描述:业务对象的应用类描述。 参考对象表:业务对象参考对象表。 参考的数据源名称:业务对象参考的数据源名称。 设置完成后,单击“保存”。 添加业务对象属性 选择已添加的业务对象,单击“操作”列中的“添加”。 在弹出的“添加业务对象属性”窗口中,设置如下信息: 业务对象:数据来源于业务对象。 业务对象类属性代码:业务对象属性的代码,系统唯一值。 业务对象类属性名称:业务对象属性的名称。 数据类型:业务对象属性的数据类型。 取值范围:varchar(字符);number(数字);date(日期)。 默认值:业务对象属性的默认值。 业务对象类属性描述:业务对象属性的描述。 备注:业务对象属性的备注。 设置完成后,单击“保存”。
  • 功能简介 编码发生器是一种用于生成一定长度的随机编码的工具。这些编码通常由数字、字母或符号组成,具有一定的随机性和唯一性,可以用于各种需要标识唯一性的场合,如订单号、会员号、优惠券码等。 编码发生器可以根据不同的需求和规则生成不同类型的编码,如固定长度、可变长度、指定字符集、不重复等。同时,编码发生器还可以支持批量生成和自定义前缀、后缀等功能,方便快捷地生成大量的编码。 在实际应用中,编码发生器通常与数据库或缓存系统结合使用,用于生成唯一的标识符,以便于管理和查询。