Get OSS detection results
You can call the DescribeOssResultItems operation to paginate the results of an OSS content moderation scan.
Usage notes
Operation: DescribeOssResultItems
You can call this operation to paginate the results of an OSS content moderation scan. For more information about how to construct an HTTP request, see Request structure. You can also use a software development kit (SDK). For more information, see SDK overview.
Billing information: This operation is free of charge.
QPS limit
The queries per second (QPS) limit for this API is 10 per user. Exceeding this limit triggers throttling, which can impact your business. Plan your calls accordingly.
Request parameters
For more information about the common request parameters that must be included in a request, see Common parameters.
| Name | Type | Required | Example | Description |
| PageSize | Integer | No | 20 | The number of results to display on each page. |
| CurrentPage | Integer | No | 1 | The current page number. |
| StartDate | String | No | 2018-09-04 14:17:56 +0800 | The start time of the query. The format is yyyy-MM-dd HH:mm:ss Z. |
| EndDate | String | No | 2018-10-04 14:17:56 +0800 | The end time of the query. The format is yyyy-MM-dd HH:mm:ss Z. |
| Scene | String | Yes | porn | The detection scenario to query. Valid values:
|
| Suggestion | String | No | block | The suggested action for the results to query. Valid values:
Note This parameter is required when Stock is set to true. |
| Stock | Boolean | Yes | true | Specifies whether to query the results of a full scan.
|
| MinScore | Float | No | 90.01 | (For image objects only) The minimum risk score for the results to query. |
| MaxScore | Float | No | 99.01 | (For image objects only) The maximum risk score for the results to query. |
| ResourceType | String | Yes | VIDEO | The type of object to query. Valid values:
|
| Bucket | String | No | 123 | The name of the OSS bucket to query. |
| QueryId | String | No | @guid | The ID of the detection request to query. |
Return data
For more information about the response, see Response.
| Name | Type | Example | Description |
| TotalCount | Integer | 2 | The number of results. You can export up to 150 pages of data. |
| PageSize | Integer | 20 | The page size. |
| CurrentPage | Integer | 1 | The current page number. |
| ScanResultList | JSONArray | xxx | The list of scan results. For more information, see ScanResultList |
| Name | Type | Example | Description |
| Id | String | 1235789 | The unique identifier of the scan result. |
| TaskId | String | 222222 | The task ID. |
| DataId | String | srffdffdfd2 | The data ID. |
| SequestTime | String | 1527410977000 | The request time. |
| ScanFinishedTime | String | 1527410977000 | The time when the scan was completed. |
| RequestTime | String | 1527410977000 | The request time. |
| Suggestion | String | review | The suggested follow-up operation. Valid values:
|
| NewUrl | String | https://example.com/bao/uploaded/LB1Q7lIoIbI8KJjy1zdXXbe1VXa.mp4 | The URL of the original file. |
| Thumbnail | String | https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png | The URL of the thumbnail.
|
| CreateTime | String | 1527410977000 | The scan time. |
| Bucket | String | uc-image | The OSS bucket where the resource is stored. |
| Object | String | post/image/eae1722368b6951ac05cfb68b1cdeb03.jpg | The name of the OSS object. |
| Score | Float | 90.9 | The risk score of the resource. Value range: 0 to 100. A higher score indicates a higher probability of non-compliance. |
| HandleStatus | Integer | 0 | The processing status of the resource. Valid values:
|
| ResourceStatus | Integer | 1 | The status of the resource. Valid values:
|
| FrameResults | JSONArray | [{"Thumbnail":"https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png","Offset":0,"Url":"https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png"}] | (For video objects only) The at-risk frames in the video. For more information, see FrameResults |
| Name | Type | Example | Description |
| Thumbnail | String | https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png | The URL of the frame's thumbnail. |
| Offset | String | 0 | The position of the frame. This is the offset from the beginning of the video, in seconds. |
| Url | String | https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png | The URL of the frame. |
Examples
http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeOssResultItems&ServiceModule=open_api
&<Common request parameters>
{
"Scene": "porn",
"Suggestion": "block",
"Stock": true,
"ResourceType": "VIDEO"
}{
"code": "200",
"data": {
"TotalCount": 2,
"PageSize": 20,
"CurrentPage": 1,
"ScanResultList": [
{
"Id": 1235789,
"TaskId": "222222",
"DataId": "srffdffdfd2",
"SequestTime": "1527410977000",
"ScanFinishedTime": "1527410977000",
"RequestTime": "1527410977000",
"Suggestion": "review",
"NewUrl": "https://example.com/bao/uploaded/LB1Q7lIoIbI8KJjy1zdXXbe1VXa.mp4",
"Thumbnail": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png",
"CreateTime": "1527410977000",
"Bucket": "uc-image",
"Object": "post/image/eae1722368b6951ac05cfb68b1cdeb03.jpg",
"Score": 90.9,
"HandleStatus": 0,
"ResourceStatus": 1,
"FrameResults": [
{
"Thumbnail": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png",
"Offset": 0,
"Url": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png"
}
]
},
{
"Id": 123579,
"TaskId": "222222",
"DataId": "srffdffdfd2",
"SequestTime": "1527410977000",
"ScanFinishedTime": "1527410977000",
"RequestTime": "1527410977000",
"Suggestion": "review",
"NewUrl": "https://example.com/bao/uploaded/LB1Q7lIoIbI8KJjy1zdXXbe1VXa.mp4",
"Thumbnail": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png",
"CreateTime": "1527410977000",
"Bucket": "uc-image",
"Object": "post/image/eae1722368b6951ac05cfb68b1cdeb03.jpg",
"Score": 90.9,
"HandleStatus": 0,
"ResourceStatus": 1,
"FrameResults": [
{
"Thumbnail": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png",
"Offset": 0,
"Url": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png"
}
]
}
]
},
"requestId": "@guid",
"successResponse": true
}