DescribeOssResultItems-阿里云帮助中心

Queries OSS scan results.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-greenweb:DescribeOssResultItems

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address.	117.139.***.244
Lang	string	No	The language type.	zh
TotalCount	integer	No	The total number of entries.	1
PageSize	integer	No	The number of entries per page.	10
CurrentPage	integer	No	The current page number.	1
StartDate	string	No	The start time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00). Note: This parameter is required. If this parameter is not specified, the API returns a 400 error.	2023-07-12 10:06:20 +0800
EndDate	string	No	The end time. Format: YYYY-MM-DD HH:mm:ss ±HHMM (default time zone: UTC+08:00). Note: This parameter is required. If this parameter is not specified, the API returns a 400 error.	2023-08-27 10:07:52 +0800
Scene	string	No	The moderation scenario. Note: This parameter is required. If this parameter is not specified, the API returns a 400 error.	porn
Suggestion	string	No	The processing suggestion.	block
Stock	boolean	Yes	Specifies whether to query stock scan results.	true
MinScore	number	No	The minimum risk score of the results to query. This parameter applies only to image objects.	99.01
MaxScore	number	No	The maximum risk score of the results to query. This parameter applies only to image objects.	99.01
ResourceType	string	No	The resource type. Note: This parameter is required. If this parameter is not specified, the API returns a 400 error.	VIDEO
Bucket	string	No	The name of the OSS bucket to query.	123
QueryId	string	No	The ID of the detection request to query.	@guid
Object	string	No	The OSS object name.	post/image/eae1722368b6951ac05cfb68b1cdeb03.jpg
StockTaskId	integer	No	The ID of the stock scan task.	3482

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
TotalCount	integer	The total number of entries.	10
QueryId	string	The detection request ID.	@guid
ScanResultList	array<object>	The list of scan results.
	array<object>
Suggestion	string	The processing suggestion.	pass
CreateTime	string	The scan time. The value is a UNIX timestamp in milliseconds.	1527410977000
Score	string	The risk score of the resource. Valid values: 0 to 100. A higher score indicates a higher probability of violation.	90.9
DataId	string	The data ID.	4faded38970c41628f7dced832072af8
Object	string	The OSS object name.	post/image/eae1722368b6951ac05cfb68b1cdeb03.jpg
NewUrl	string	The URL of the original file.	https://example.com/bao/uploaded/LB1Q7lIoIbI8KJjy1zdXXbe1VXa.mp4
ScanFinishedTime	string	The time when the scan was completed. The value is a UNIX timestamp in milliseconds.	1527410977000
HandleStatus	integer	The processing status of the resource.	0
Content	string	The moderation content.	xxx
TaskId	string	The task ID.	xxx
Thumbnail	string	The thumbnail URL.	https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png
Id	integer	The primary key ID.	1739
ResourceStatus	integer	The status of the resource.	0
RequestTime	string	The request time. The value is a UNIX timestamp in milliseconds.	1527410977000
Bucket	string	The OSS bucket where the resource is stored.	uc-image
FrameResults	array<object>	The risky frames. This parameter applies only to video objects.
	object
Offset	integer	The position of the frame, which is the offset from the beginning of the video. Unit: seconds.	0
Url	string	The URL of the frame.	https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png
Thumbnail	string	The thumbnail URL of the frame.	https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png
VoiceSegmentAntispamResults	array<object>	The voice moderation results of the instance.
	object
EndTime	integer	The end time of the segment. Unit: seconds.	20
StartTime	integer	The start time of the segment. Unit: seconds.	10
Text	string	The text content.	xx
Label	string	The label.	politics

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "PageSize": 10,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****\n",
  "TotalCount": 10,
  "QueryId": "@guid\t\n",
  "ScanResultList": [
    {
      "Suggestion": "pass",
      "CreateTime": "1527410977000",
      "Score": "90.9\t",
      "DataId": "4faded38970c41628f7dced832072af8",
      "Object": "post/image/eae1722368b6951ac05cfb68b1cdeb03.jpg\t",
      "NewUrl": "https://example.com/bao/uploaded/LB1Q7lIoIbI8KJjy1zdXXbe1VXa.mp4\t",
      "ScanFinishedTime": "1527410977000\t",
      "HandleStatus": 0,
      "Content": "xxx",
      "TaskId": "xxx",
      "Thumbnail": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png\t",
      "Id": 1739,
      "ResourceStatus": 0,
      "RequestTime": "1527410977000",
      "Bucket": "uc-image\t",
      "FrameResults": [
        {
          "Offset": 0,
          "Url": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png\t",
          "Thumbnail": "https://example.com/tfs/TB1HPS9qb9YBuNjy0FgXXcxcXXa-200-200.png\t"
        }
      ],
      "VoiceSegmentAntispamResults": [
        {
          "EndTime": 20,
          "StartTime": 10,
          "Text": "xx",
          "Label": "politics"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	Missing required parameter.	Required parameter is missing.
400	InvalidParameter.Format	Parameter format invalid.	Parameter format error
400	InvalidParameter.Value	Parameter value not supported.	The parameter value is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.