Detects barcodes and QR codes in an image.
Operation description
- For information about the image encoding formats supported by this operation, see Limits on images.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
imm:DetectImageCodes | none | *Project acs:imm:{#regionId}:{#accountId}:project/{#ProjectName} |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
ProjectName | string | Yes | The name of the project. You can obtain the name of the project from the response of the CreateProject operation. | immtest |
SourceURI | string | Yes | The URI of the Object Storage Service (OSS) bucket in which the image file is stored. Specify the value in the oss://${Bucket}/${Object} format. | oss://bucketname/objectname |
CredentialConfig | CredentialConfig | No | If you do not have special requirements, leave this parameter empty. The authorization chain. This parameter is optional. For more information, see Use authorization chains to access resources of other entities. |
Response parameters
Examples
Sample success responses
JSON
format
{
"Codes": [
{
"Content": "https://www.example.com",
"Confidence": 0.9,
"Boundary": {
"Width": 200,
"Height": 300,
"Left": 10,
"Top": 30,
"Polygon": [
{
"X": 10,
"Y": 10
}
]
},
"Type": "qrcode"
}
],
"RequestId": "6E93D6C9-5AC0-49F9-914D-E02678D3****"
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
Change time | Summary of changes | Operation |
---|