华为云用户手册

  • 查询脱敏任务执行列表 输入参数 输入参数说明如表6所示。 表6 查询脱敏任务执行列表输入参数说明 参数 必填 说明 工作区ID 否 工作区ID。 页码 否 页码。 分页大小 否 分页大小。 模板ID 是 模板ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表7。 表7 查询脱敏任务执行列表输出参数说明 参数 说明 tasks 任务。 -db_type db_type -end_time 查询脱敏任务截止时间。 -execute_line execute_line -id ID -progress progress -run_status 查询脱敏任务的运行状态。 -start_time 查询脱敏任务的开始时间。 -task_template_id task_template_id -type type total total
  • 查询指定任务扫描结果 输入参数 输入参数说明如表8所示。 表8 查询指定任务扫描结果输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 资产类型 否 资产类型。 任务ID 是 指定任务的ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表9。 表9 查询指定任务扫描结果输出参数说明 参数 说明 job_id job_id job_name job_name type type db_scan_result db_scan_result -total total -db_scan_results db_scan_results --task_id task_id --db_name db_name --table_id table_id --table_name table_name --risk_level risk_level --sensitive_data_type sensitive_data_type --match_info match_info ---column_name column_name ---rule_name rule_name ---rule_id rule_id ---rule_risk_level rule_risk_level ---column_line column_line
  • 查询扫描规则组列表 输入参数 输入参数说明如表10所示。 表10 查询扫描规则组列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表11。 表11 查询扫描规则组列表输出参数说明 参数 说明 total total groups groups -id -ID -group_name group_name -group_desc group_desc -category category -rule_names rule_names -task_names task_names -delete_allowed delete_allowed -is_default is_default
  • 添加资产授权 添加数据资产扫描授权。 输入参数 输入参数说明如表4所示。 表4 添加资产授权输入参数说明 参数 必填 说明 资产类型 否 资产的类型。 OBS桶列表 否 支持输入框和数组两种模式。 输入框:请选择数组类型的节点输出。 数组:资产名称、桶位置、桶名称、桶策略等。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表5。 表5 添加资产授权输出参数说明 参数 说明 返回消息 返回消息。 返回状态 返回状态。
  • 发票验真 发票验真服务支持9种增值税发票的信息核验,包括增值税专用发票、增值税普通发票、增值税普通发票(卷式)、增值税电子专用发票、增值税电子普通发票、增值税电子普通发票(通行费)、二手车销售统一发票、机动车销售统一发票、 区块链 电子发票,支持返回票面的全部信息。 输入参数 用户配置发票验真执行动作,相关参数说明如表31所示。 表31 发票验真输入参数说明 参数 必须 说明 发票代码 是 发票代码。 发票号码 是 发票号码。 发票日期 是 发票日期格式:YYYY-MM-DD。 校验码后六位 否 校验码后六位发票种类为增值税普通发票、增值税电子普通发票、增值税普通发票(卷式)、增值税电子普通发票(通行费)、区块链电子发票时此项不可为空(区块链电子发票验真时,填写的是5位校验码)。 合计金额 否 合计金额(不含税) 发票种类为增值税专用发票、增值税电子专用发票、机动车销售统一发票、二手车销售统一发票、区块链电子发票时不可为空。 增值税专用发票、增值税电子专用发票、机动车销售统一发票、区块链电子发票填写发票合计金额(不含税),二手车发票填写发票车价合计。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表32。 表32 发票验真输出参数说明 参数 说明 调用成功时表示调用结果 调用成功时表示调用结果,调用失败时无此字段。
  • 网络图片识别 识别网络图片中的文字内容,并返回识别的结构化结果。 输入参数 用户配置网络图片识别执行动作,相关参数说明如表27所示。 表27 网络图片识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径,和图片文件二选一。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表28。 表28 网络图片识别输出参数说明 参数 说明 识别文字块列表 识别文字块列表,输出顺序从左到右,从上到下。 文字块识别结果 文字块识别结果。
  • 行驶证识别 识别用户上传的行驶证图片(或者用户提供的华为云上OBS的行驶证图片文件的URL)中主页和副页的文字内容,并将识别的结果返回给用户。 说明: 如果图片中包含多张卡证票据,请调用智能分类识别服务。 输入参数 用户配置行驶证执行动作,相关参数说明如表29所示。 表29 行驶证识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径,和图片文件二选一。 识别主页/副页 front:行驶证主页。 back:行驶证副页。 是否返回发证机关 true:返回发证机关。 false:不返回发证机关。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表30。 表30 行驶证识别输出参数说明 参数 说明 号牌号码 车辆号牌号码。 车辆类型 车辆类型。 所有人 车辆所有人。 住址 住址。 使用性质 车辆使用性质。 品牌型号 车辆品牌型号。 发动机号码 发动机号码。 车辆识别代号 车辆识别代号。 注册日期 车辆注册日期。 发证日期 车辆发证日期。 发证机关 发证机关。 档案编码 车辆档案编码。 核定载人数 核定载人数。 总质量 车辆总质量。 整备质量 车辆整备质量。 核定载质量 车辆核定载质量。 外廓尺寸 车辆外廓尺寸。 准牵引总质量 车辆准牵引总质量。 检验记录 车辆检验记录。 条码号 车辆条码号。
  • 增值税发票识别 识别用户上传的增值税发票图片(或者用户提供的华为云上OBS的增值税发票图片文件的URL)中的文字内容,并将识别的结果返回给用户。 说明: 该增值税发票仅限于中华人民共和国境内使用的增值税发票。 如果图片中包含多张卡证票据,请调用智能分类识别服务。 输入参数 用户配置增值税发票执行动作,相关参数说明如表25所示。 表25 增值税发票识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径,和图片文件二选一。 是否返回更多字段 如果传参为true,则返回更多字段。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表26。 表26 增值税发票识别输出参数说明 参数 说明 增值税发票类型 可选值包括:-special增值税专用发票;-normal增值税普通发票;-electronic增值税电子普通发票;-roll增值税普通发票(卷票)。 发票联次 发票联次。 发票归属地 发票归属地。 发票监制章 发票监制章。 发票代码 发票代码。 机器编号 机器编号。 机打号码 机打号码。 发票校验码 发票校验码。 发票号码 发票号码。 开票日期 开票日期。 密码区 密码区。 购买方名称 购买方名称。 购买方纳税人识别号 购买方纳税人识别号。 购买方地址、电话 购买方地址、电话。 购买方开户行及账号 购买方开户行及账号。 销售方名称 销售方名称。 销售方纳税人识别号 销售方纳税人识别号。 销售方地址、电话 销售方地址、电话。 销售方开户行及账号 销售方开户行及账号。 合计金额 合计金额。 合计税额 合计税额。 价税合计 价税合计。 价税合计(大写) 价税合计(大写)。 备注 备注。 收款人 收款人。 复核 复核。 开票人 开票人。 销售方发票专用章 销售方发票专用章。 货物或应税劳务列表 货物或应税劳务列表。 货物或应税劳务、服务名称 货物或应税劳务、服务名称。 规格型号 规格型号。 单位 单位。 数量 数量。 单价 单价。 车牌号码 车牌号码。 金额 金额。 税率 税率。 税额 税额。 通行日期止 通行日期止。 通行日期起 通行日期起。 车辆类型 车辆类型。 各个字段的置信度 各个字段的置信度。
  • 手写 文字识别 识别文档中的手写文字信息,并将识别的结构化结果返回给用户。 输入参数 用户配置手写文字票识别执行动作,相关参数说明如表17所示。 表17 手写文字识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径,和图片文件 。 是否校正图片的倾斜角度 -true:校正图片的倾斜角度;-false:不校正图片的倾斜角度。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表18。 表18 手写文字识别输出参数说明 参数 说明 识别文字块列表 识别文字块列表,输出顺序从左到右,从上到下。 文字块识别结果 文字块识别结果。
  • 名片识别 识别名片图片上的文字信息,并返回识别的结构化结果。支持对多种不同版式名片进行结构化信息提取。 输入参数 用户配置名片识别执行动作,相关参数说明如表23所示。 表23 名片识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 与图片文件Base64编码二选一。 图片朝向检测开关 true:检测图片朝向; false:不检测图片朝向。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表24。 表24 名片识别输出参数说明 参数 说明 姓名列表 姓名。 职位头衔列表 持有人职位头衔列表。 公司列表 持有人公司列表。 部门列表 持有人公司部门列表。 联系方式列表 持有人联系方式列表。 地址列表 公司地址列表。 邮箱列表 持有人邮箱列表。 传真列表 持有人传真列表。 邮编列表 持有人所在公司邮编列表。 公司网址列表 持有人网址列表。 返回矫正后的名片图像的BASE64编码 返回矫正后的名片图像的BASE64编码。
  • 车牌通行费发票识别 识别车辆通行费发票中的文字信息,并返回识别的结构化结果。 输入参数 用户配置车辆通行费发票识别执行动作,相关参数说明如表19所示。 表19 车辆通行费发票识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径,和图片文件二选一。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表20。 表20 车辆通行费发票识别输出参数说明 参数 说明 发票代码 发票代码。 发票号码 发票号码。 入口 该车通行入口。 出口 该车通行出口。 收费金额 该车通行收费金额。 收费员 收费员。 车辆类型 车辆类型。 日期 该车通行日期。 时间 该车通行时间。
  • 银行卡识别 识别银行卡上的关键文字信息,并返回识别的结构化结果。 输入参数 用户配置银行卡识别执行动作,相关参数说明如表21所示。 表21 银行卡识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 与图片文件Base64编码二选一。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表22。 表22 银行卡识别输出参数说明 参数 说明 发卡行 该卡发卡行。 银行卡号 该卡银行卡号。 有效期开始日期 该卡有效期开始日期。 有效期截止日期 该卡有效期截止日期。 银行卡类别 银行卡的类别,如:储蓄卡,信用卡。
  • 护照识别 识别用户上传的护照首页图片中的文字信息,并返回识别的结构化结果。当前版本支持中国护照的全字段识别。外国护照支持护照下方两行国际标准化的机读码识别,并可从中提取6-7个关键字段信息。 输入参数 用户配置护照识别执行动作,相关参数说明如表11所示。 表11 护照识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 与图片文件Base64编码二选一。 护照颁发国的国家码 -GENERAL,护照机器码识别。 -CHN,中国护照全字段识别。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表12。 表12 护照识别输出参数说明 参数 说明 护照类型 (P:普通因私护照、W:外交护照、G:公务护照)(英文)。 护照签发国的国家码(英文) 护照签发国的国家码(英文)。 护照号码(英文) 护照号码(英文)。 护照持有人国籍(英文) 护照持有人国籍(英文)。 姓(英文) 持有人姓(英文)。 名字(英文) 持有人名字(英文)。 性别(英文) 持有人性别(英文)。 出生日期(英文) 持有人出生日期(英文)。 护照有效期(英文) 该护照有效期(英文)。 护照签发日期 该护照签发日期(英文)。 出生地 持有人出生地(英文)。 签发地 持有人签发地(英文)。 签发机构 签发机构(英文),其中对中国的英文简写统一输出为P.R.China。
  • 车牌识别 识别输入图片中的车牌信息,并返回其坐标和内容。 输入参数 用户配置车牌识别执行动作,相关参数说明如表13所示。 表13 车牌识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径,和图片文件二选一。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表14。 表14 车牌识别输出参数说明 参数 说明 车牌内容 显示车牌号。 当前版本支持的车牌底色类型 -blue蓝色;green绿色;-black黑色;-white白色;-yellow黄色。
  • 文字识别 识别图片上的文字信息,返回识别的文字和坐标。支持扫描文件、电子文档、书籍、票据和表单等多种场景的文字识别。 输入参数 用户配置文字识别执行动作,相关参数说明如表15所示。 表15 文字识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径,和图片文件二选一。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表16。 表16 文字识别输出参数说明 参数 说明 识别文字块列表 识别文字块列表,输出顺序从左到右,先上后下。 文字块识别结果 文字块识别结果。
  • 身份证识别 识别身份证图片中的文字内容,并将识别的结果返回给用户。 输入参数 用户配置身份证识别执行动作,相关参数说明如表9所示。 表9 身份证识别输入参数说明 参数 说明 图片文件 上传图片所在位置。 图片的URL路径 图片的URL路径,和图片文件二选一。 识别正面/反面 front:身份证正面。 back:身份证背面。 是否返回校验信息 true:返回校验信息。 false:不反回校验信息。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表10。 表10 身份证识别输出参数说明 参数 说明 姓名 姓名。 性别 性别。 出生日期 出生日期。 民族 民族。 地址 地址。 身份证号 身份证号。 发证机关 身份证的发证机关。 有效起始日期 有效起始日期。 有效结束日期 有效结束日期。说明:身份证识别只支持中国大陆汉族身份证识别。 身份证号合法 根据校验规则判断身份证是否合法,如果身份证号合法,返回true,否则代表身份证号不合法,返回false。当身份证图片是背面时,默认是false。 身份证号与出生日期一致 判断出生日期和身份证号的第7位和第14位之间表示的出生日期是否一致。一致返回true,否则返回false。 当身份证图片是背面时,默认是false。 身份证号与性别一致 判断性别和身份证号的第17位表示的性别信息是否一致。身份证号的第17位如果为奇数表示男性,偶数表示女性。一致返回true,否则返回false。当身份证图片是背面时,默认是false。 当前日期在有效期内 当前日期在身份证有效期内返回true,否则返回false。 当身份证图片是正面时,默认是false。
  • 营业执照识别 识别营业执照首页图片中的文字信息,并返回识别的结构化结果。 输入参数 用户配置营业执照识别执行动作,相关参数说明如表7所示。 表7 营业执照识别输入参数说明 参数 说明 图片文件 上传图片文件。 图片的URL路径 图片的URL路径,和图片文件二选一。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表8。 表8 营业执照识别输出参数说明 参数 说明 2- 老版本营业执照对应注册号 老版本营业执照对应注册号。 企业名称 企业名称。 公司/企业类型/主体类型 显示公司/企业类型/主体类型。 住所/营业场所/企业住所 显示该企业住所/营业场所/企业住所。 法定代表人/负责人 该企业法定代表人/负责人。 注册资本 该企业注册资本。 成立日期 该企业成立日期。 营业期限 该企业营业期限。 经营范围 该企业经营范围。 发照日期 该企业发照日期。
  • 火车票识别 识别火车票中的文字信息,并返回识别的结构化结果。 输入参数 用户配置火车票识别执行动作,相关参数说明如表5所示。 表5 火车票识别输入参数说明 参数 说明 图片文件 上传图片文件。 图片的URL路径 与图片文件Base64编码二选一。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表6。 表6 火车票识别输出参数说明 参数 说明 火车票左上角的车票ID 火车票左上角的车票ID。 检票口信息 显示检票口信息。 车次 显示车辆车次。 始发站 该班次始发站。 终点站 该班次终点站。 开车时间 该班次开车时间。 座位号 该票座位号。 票价 该班次车票的票价。 售票方式 该车票售票方式。 座位类别 该座位的座位类别。 是否改签票 是否改签票,"Yes"表示改签票。 车票持有人的身份证号 车票持有人的身份证号。 车票持有人姓名 车票持有人姓名。 车票最下方的序列号 车票最下方的序列号。 车票售票地点 车票售票地点。
  • 机动车销售发票识别 识别机动车销售发票图片中的文字内容,并将识别的结果返回给用户。该增值税发票仅限于中华人民共和国境内使用的增值税发票。 输入参数 用户配置机动车销售发票识别执行动作,相关参数说明如表3所示。 表3 机动车销售发票识别输入参数说明 参数 说明 图片文件 上传图片文件。 图片的URL路径 图片的URL路径,和图片文件二选一。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表4。 表4 机动车销售发票识别输出参数说明 参数 说明 发票代码 显示发票代码。 发票号码 显示发票号码。 机打代码 显示发票机打代码。 机打号码 显示发票机打号码。 开票日期 显示发票开票日期。 机器编号 显示发票机器编号。 购买方名称 显示购买方名称。 购买方身份证号码/组织机构代码 显示购买方身份证号码/组织机构代码。 购买方纳税人识别号 显示购买方纳税人识别号。 销货单位名称 显示销货单位名称。 销售方电话 显示销售方电话。 销售方纳税人识别号 显示销售方纳税人识别号。 销售方账号 显示销售方账号。 销售方地址 显示销售方地址。 销售方开户行 显示销售方开户行。 车辆类型 显示车辆类型。 厂牌型号 显示厂牌型号。 产地 显示产地。 合格证号 显示合格证号。 进口证明书号 显示进口证明书号。 商检单号 显示商检单号。 发动机号码 显示发动机号码。 车辆识别代号/车架号码 显示车辆识别代号/车架号码。 吨位 显示吨位。 限乘人数 显示车辆限乘人数。 主管税务机关 显示相关主管税务机关。 主管税务机关代码 显示相关主管税务机关代码。 完税凭证号码 显示完税凭证号码。 增值税税率或征收率 显示增值税的税率或征收率。 增值税税额 显示增值税的税额。 不含税价 显示不含税价。 价税合计 显示价税合计。 价税合计大写 显示价税合计大写。 税控码 显示税控码。
  • City Location Info 城市地理位置信息。 输入参数 用户配置City Location Info执行动作,相关参数说明如表6所示。 表6 City Location Info输入参数说明 参数 必填 说明 示例值/默认值 City Name 是 用英文输入城市名称,有输入框和下拉框两种形式。 Beijing 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表7。 表7 City Location Info输出参数说明 参数 说明 示例值/默认值 所属城市 所属城市。 北京 所属行政区 所属行政区。 静安区 所属国家 所属国家。 中国 维度 查询地区的维度。 121.47187138 经度 查询地区的经度。 31.2327951763 时区 查询地区所属的时区。 GMT+8 当地时间 当地的时间。 2020-09-02 10:10:50
  • Astronomy Info 大气信息。 输入参数 用户配置Astronomy Info执行动作,相关参数说明如表4所示。 表4 Astronomy Info输入参数说明 参数 必填 说明 示例值/默认值 City Name 是 用英文输入城市名称,有输入框和下拉框两种形式。 Beijing Query Date 是 日期输入格式为:yyyy-MM-dd。 2022-02-20 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表5。 表5 Astronomy Info输出参数说明 参数 说明 日出时间 日出时间。 日落时间 日落时间。 月出时间 月出时间。 月落时间 月落时间。 月相 月相。 月照亮度 月照亮度。
  • Air Quality 空气质量。 输入参数 用户配置Air Quality执行动作,相关参数说明如表8所示。 表8 Air Quality输入参数说明 参数 必填 说明 示例值/默认值 City Name 是 用英文输入城市名称,有输入框和下拉框两种形式。 Beijing Whether to show air quality data 否 是否显示空气质量数据 show:yes not show:no 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表9。 表9 Air Quality输出参数说明 参数 说明 更新时间 更新时间。 温度 温度(摄氏度)。 天气状况 天气状况。 风速 风速(千米/小时)。 风向 风向。 气压 气压(mb)。 降水量 降水量(毫米)。 湿度 湿度(百分比)。 云量 云量(百分比)。 体感温度 体感温度(摄氏度)。 能见度 能见度(千米)。 紫外线指数 紫外线指数。 阵风 阵风(千米/小时)。
  • Forecast weather 天气预报。 输入参数 用户配置Forecast weather执行动作,相关参数说明如表2所示。 表2 Forecast weather输入参数说明 参数 必填 说明 示例值/默认值 City Name 是 用英文输入城市名称,有输入框和下拉框两种形式。 Beijing Forecast Days Range 是 需要预测的天数范围。 3 Whether to show air quality data 否 是否显示空气质量数据。 show:yes not show:no 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表1。 表3 Forecast weather输出参数说明 参数 说明 forecastday 预测天数信息列表。 预测日期 预测日期。 最高气温 最高气温(摄氏度)。 最低气温 最低气温(摄氏度)。 平均气温 平均气温(摄氏度)。 最大风速 最大风速(千米/小时)。 总降水量 总降水量(毫米)。 能见度 能见度(千米)。 湿度 湿度(百分比)。 是否下雨 是否下雨,0为否,1为是。 下雨概率 下雨概率(百分比)。 是否下雪 是否下雪,0为否,1为是。 下雪概率 下雪概率(百分比)。 紫外线指数 紫外线指数。 天气情况 天气情况。 日出时间 日出时间。 日落时间 日落时间。 月出时间 月出时间。 月落时间 月落时间。 月相 月相。 月照亮度 月照亮度。 逐小时预报 逐小时预报。 时间 时间。 温度 温度(摄氏度)。 天气情况 天气情况。 风速 风速(千米/小时)。 风向 风向。 气压 气压(mb)。 降水量 降水量(毫米)。 湿度 湿度(百分比)。 云量 云量(百分比)。 体感温度 体感温度(摄氏度)。 是否下雨 是否下雨,0为否,1为是。 下雨概率 下雨概率(百分比)。 是否下雪 是否下雪,0为否,1为是。 下雪概率 下雪概率(百分比)。 能见度 能见度(千米)。 阵风 阵风(千米/小时)。 紫外线指数 紫外线指数。
  • 删除图片 通过图片路径删除索引库中对应图片。 输入参数 用户配置删除图片执行动作,相关参数说明如表10所示。 表10 删除图片输入参数说明 参数 必填 说明 实例名称 是 要创建的实例名称。 图片ID 否 图片库中的图片索引ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表11。 表11 删除图片输出参数说明 参数 说明 调用结果 调用成功时表示调用结果。 调用失败时无此字段。 错误码 调用失败时的错误码,调用成功时无此字段。 错误信息 调用失败时的错误信息,调用成功时无此字段。
  • 查询用户实例信息 查看用户指定实例详细信息。 输入参数 用户配置查询用户实例信息执行动作,相关参数说明如表16所示。 表16 查询用户实例信息输入参数说明 参数 必填 说明 实例名称 是 要创建的实例名称。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表17。 表17 查询用户实例信息输出参数说明 参数 说明 模型名称 模型展示名或领 域名 称。 描述 描述。 注册时间 注册时间。 过期时间 过期时间,-1表示永不过期。 规格 实例的图片数量规格,默认为:30,000,000(单位:张)。 自定义标签 图片自定义标签。 实例状态 实例的状态,有以下状态信息: NORMAL:正常 ARREARAGE:欠费 CREATION:创建中 CREATION_FAILD:创建失败 DELETING:删除中 DELETING_FAILED:删除失败 ABNORMAL:异常 实例名称 实例名称。 错误码 调用失败时的错误码,调用成功时无此字段。 错误信息 调用失败时的错误信息,调用成功时无此字段。
  • 修改图片信息 修改图像索引库中已存在的图片信息。 输入参数 用户配置修改图片信息执行动作,相关参数说明如表12所示。 表12 修改图片信息输入参数说明 参数 必填 说明 实例名称 是 要创建的实例名称。 图片ID 是 图片库中的图片索引ID。 图片标签 否 自定义标签,格式为key:value对,其中:标签名(key值)须存在于实例中,标签内容(value值)为自定义标签值。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表13。 表13 修改图片信息输出参数说明 参数 说明 调用结果 调用成功时表示调用结果。 调用失败时无此字段。 错误码 调用失败时的错误码,调用成功时无此字段。 错误信息 调用失败时的错误信息,调用成功时无此字段
  • 删除实例 修改图像索引库中已存在的图片信息。 输入参数 用户配置删除实例执行动作,相关参数说明如表14所示。 表14 删除实例输入参数说明 参数 必填 说明 实例名称 是 要创建的实例名称。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表15。 表15 删除实例输出参数说明 参数 说明 调用结果 调用成功时表示调用结果, 调用失败时无此字段。 错误码 调用失败时的错误码,调用成功时无此字段。 错误信息 调用失败时的错误信息,调用成功时无此字段
  • 搜索图片 从图片索引库中搜索相似图片。 输入参数 用户配置搜索图片执行动作,相关参数说明如表6所示。 表6 搜索图片输入参数说明 参数 必填 说明 实例名称 是 要创建的实例名称。 上传图片 否 图片文件Base64编码字符串,仅支持JPEG/JPG/PNG/BMP格式,图片最小边不小于100px,最大边不超过2048px。该参数与path二选一,如果两个参数都存在,则以file为主。 图片ID 否 图片库中的图片索引ID。 检索图像的数量 否 返回被检索图像的数量,取值为1~100的整数,默认为10,缺省值:10。 起始索引 否 偏移量,指定搜索结果返回起始位置,取值为大于或等于0的整数,默认为0。 图片自定义标签 否 图片自定义标签,最多不超过10个,格式为key:value对。 指定区域搜索 否 是否用图片中指定区域(参数box)进行搜索。默认为false,该参数目前仅对某些特定模型有效,其他模型暂不支持目标检测。 - true:用图片中指定区域(参数box)进行搜索。 - false:用全图进行搜索。缺省值:false。 x坐标 否 区域中x坐标的最小值,单位:像素。 y坐标 否 区域中y坐标的最小值,单位:像素。 宽度 否 区域的宽度,单位:像素。 高度 否 区域的高度,单位:像素。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表7。 表7 搜索图片输出参数说明 参数 说明 结果总数 搜索结果总数。 结果详情 搜索结果详情。 图片路径 被搜索图片的路径。 图片相似度 查询图片和被搜索图片的相似度,值越接近1表示越相似。 标签名称和标签内容 自定义的标签名称和标签内容。 错误码 调用失败时的错误码,调用成功时无此字段。 错误信息 调用失败时的错误信息,调用成功时无此字段。
  • 查询图片 通过图片路径查询索引库中对应图片是否存在。 输入参数 用户配置查询图片执行动作,相关参数说明如表8所示。 表8 查询图片输入参数说明 参数 必填 说明 实例名称 是 要创建的实例名称。 图片ID 否 图片库中的图片索引ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表9。 表9 查询图片输出参数说明 参数 说明 调用结果 调用成功时表示调用结果。 调用失败时无此字段。 错误码 调用失败时的错误码,调用成功时无此字段。 错误信息 调用失败时的错误信息,调用成功时无此字段。
  • 近期赛程查询 根据NBA赛事,查询NBA赛事近期的赛程赛果。 输入参数 该执行动作无输入参数。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表3。 表3 近期赛程查询输出参数说明 参数 说明 返回说明 返回说明。 返回结果集 返回结果集。 -联赛名称 NBA联赛的名称。 -联赛赛季 NBA联赛的赛季。 -赛事清单 NBA联赛的赛事清单。 --比赛日期 NBA联赛的比赛日期。 --星期 NBA联赛的星期。 --赛事场次 NBA联赛的赛事场次。 ---比赛开始时间 NBA联赛赛事场次的比赛开始时间。 ---比赛状态 NBA联赛赛事场次的比赛状态。 ---比赛状态描述 NBA联赛赛事场次的比赛状态描述。 ---队伍1 NBA联赛每场比赛的队伍1 ---队伍2 NBA联赛每场比赛的队伍2 ---队伍1比分 NBA联赛每场比赛的队伍1比分 ---队伍2比分 NBA联赛每场比赛的队伍2比分 返回码 返回码。
共100000条