DetectQRCodes - 二维码检测

更新时间:2024-11-26 08:14:56

二维码检测,建议换用DetectImageQRCodes。

接口说明

此接口已不再维护,建议使用新版(2020-09-30 版本)接口 DetectImageCodes 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
操作访问级别资源类型条件关键字关联操作
imm:DetectQRCodes
*全部资源
*

请求参数

名称类型必填描述示例值
名称类型必填描述示例值
Projectstring

项目名称。

immimagetest
SrcUrisstring

图片的 OSS URI,以 JSON 格式的字符串表示。当前仅支持 1 张图片。

OSS 地址规则为oss://bucket/object,其中 bucket 为和当前项目处于同一区域的 OSS Bucket 名称,object 为文件路径。

[“oss://imm-test/testcases/QRcodetest.jpg”]

返回参数

名称类型描述示例值
名称类型描述示例值
object
SuccessDetailsarray<object>

成功项目列表。

SuccessDetailsobject
SrcUristring

图片的 OSS URI。

oss://imm-test/testcases/QRcodetest.jpg
QRCodesarray<object>

识别出的二维码信息。

目前最多只能返回一个二维码。

QRCodesobject
QRCodesRectangleobject

二维码位置框信息。

Topstring

顶点 Y 坐标,距离顶端距离。单位为 px。

295
Widthstring

二维码位置框宽度。单位为 px。

741
Heightstring

二维码位置框高度。单位为 px。

706
Leftstring

顶点 X 坐标,距离左端距离。单位为 px。

460
Contentstring

二维码内容。

https://www.aliyun.com/product/imm
RequestIdstring

当次请求的 Request ID。

E6A558B8-87C1-45BE-90B9-26049B0BAB01
FailDetailsarray<object>

失败项目列表。

FailDetailsobject
ErrorMessagestring

错误信息。

The resource SrcUris is not valid. Please check.
SrcUristring

图片的 OSS URI。

oss://imm-test/testcases/QRcodetest.jpg
ErrorCodestring

错误码。

InvalidSrcUris

示例

正常返回示例

JSON格式

{
  "SuccessDetails": [
    {
      "SrcUri": "oss://imm-test/testcases/QRcodetest.jpg",
      "QRCodes": [
        {
          "QRCodesRectangle": {
            "Top": "295",
            "Width": "741",
            "Height": "706",
            "Left": "460"
          },
          "Content": "https://www.aliyun.com/product/imm"
        }
      ]
    }
  ],
  "RequestId": "E6A558B8-87C1-45BE-90B9-26049B0BAB01",
  "FailDetails": [
    {
      "ErrorMessage": "The resource SrcUris is not valid. Please check.",
      "SrcUri": "oss://imm-test/testcases/QRcodetest.jpg",
      "ErrorCode": "InvalidSrcUris"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

错误码

HTTP 状态码错误码错误信息描述
HTTP 状态码错误码错误信息描述
400InvalidSrcUrisThe resource SrcUris is not valid. Please check.图片资源无效、文件格式错误或文件不存在。
400InvalidParameter.SrcUris.NotSupportedThe input parameter SrcUris is not supported. Support valid OSS uri in same region.SrcUri 文件路径错误,需要使用正确的 OSS 格式的路径。
  • 本页导读 (1)
  • 接口说明
  • 调试
  • 授权信息
  • 请求参数
  • 返回参数
  • 示例
  • 错误码
  • 错误码