DescribeOssStockStatus-AI Guardrails(AI Guardrails)-阿里云帮助中心

Retrieves the status of an OSS stock scan task.

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:DescribeOssStockStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	124.74.***.90
Lang	string	No	The language type.	zh
StockTaskId	integer	No	The ID of the stock scan task.	1664

Response elements

Element	Type	Description	Example
	object
VideoLiveCount	integer	The number of videos detected for inappropriate scene content.	1
ImageTotalCount	integer	The total number of images.	1
VideoPornCount	integer	The number of videos detected for pornographic content.	1
ImageLiveCount	integer	The number of images detected for inappropriate scene content.	1
AudioTotalCount	integer	The total number of audio files.	1
ImageAdCount	integer	The number of images detected for ad violations.	1
ImagePornCount	integer	The number of images detected for pornographic content.	1
VideoVoiceAntispamCount	integer	The number of videos detected for voice anti-spam content.	1
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
VideoTerrorismCount	integer	The number of videos detected for terrorism content.	1
AudioAntispamCount	integer	The number of audio files detected for anti-spam content.	1
StockStatus	integer	The status of the stock scan task.	1
FinishedTime	string	The time when the task was completed. Format: YYYY-MM-DDTHH:mm:ssZ.	2023-12-21T02:17Z
VideoAdCount	integer	The number of videos detected for ad content.	1
ImageTerrorismCount	integer	The number of images detected for terrorism content.	1
VideoTotalCount	integer	The total number of videos detected.	2
SceneList	array	The list of scene information.
	string	The list of scene information.	[]
ResouceTypeList	array	The list of resource types.
	string	The list of resource types.	[]
BucketList	array<object>	The list of OSS buckets.
	object	The list of OSS buckets.
Selected	boolean	Indicates whether the bucket is selected.	true
Bucket	string	The OSS bucket.	gj-bucket1
Prefixes	array	The prefixes.
	string	The prefixes.	["img/test_"]

Examples

Success response

JSON format

{
  "VideoLiveCount": 1,
  "ImageTotalCount": 1,
  "VideoPornCount": 1,
  "ImageLiveCount": 1,
  "AudioTotalCount": 1,
  "ImageAdCount": 1,
  "ImagePornCount": 1,
  "VideoVoiceAntispamCount": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "VideoTerrorismCount": 1,
  "AudioAntispamCount": 1,
  "StockStatus": 1,
  "FinishedTime": "2023-12-21T02:17Z",
  "VideoAdCount": 1,
  "ImageTerrorismCount": 1,
  "VideoTotalCount": 2,
  "SceneList": [
    "[]"
  ],
  "ResouceTypeList": [
    "[]"
  ],
  "BucketList": [
    {
      "Selected": true,
      "Bucket": "gj-bucket1",
      "Prefixes": [
        "[\"img/test_\"]\n"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.