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

Queries the list of custom image libraries.

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

get

*ImageLib

acs:yundun-greenweb:*:{#accountId}:imagelib/*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	125.121.36.***
ServiceModule	string	Yes	The service module to which the image library applies. Valid values: open_api: used for content moderation API website: used for website content analysis Valid values: website : website open_api : open_api	open_api

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of image libraries.	2
RequestId	string	The ID of the request.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
ImageLibList	array<object>	The list of image library information.
	object	The list of image library information.
ModifiedTime	string	The modification time in the format of YYYY-MM-DD HH:mm:ss (default time zone: UTC+08:00).	2018-03-19 10:45:44 +0800
Code	string	The code of the image library.	808003055
ImageCount	integer	The number of images in the image library.	2
Category	string	The purpose of the image library. Valid values: black: blacklist white: whitelist	BLACK
ServiceModule	string	The service module to which the image library applies. Valid values: open_api: used for content moderation API website: used for website content analysis	open_api
Source	string	The source of the image library. Valid values: manual: manually created feedback: automatic creation based on user feedback results	MANUAL
Name	string	The name of the image library.	测试a
Scene	string	The scenarios in which the image library is used. Valid values: PORN: pornography detection AD: ad detection ILLEGAL: terrorism and politically sensitive content detection	PORN
Id	integer	The primary key ID.	1279
Enable	string	Indicates whether the image library is enabled. Valid values: true: enabled false: disabled	true
BizTypes	array	The business types.
	string	The business type.	[\"default\",\"xinxifabu\"]

Examples

Success response

JSON format

{
  "TotalCount": 2,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****",
  "ImageLibList": [
    {
      "ModifiedTime": "2018-03-19 10:45:44 +0800",
      "Code": "808003055",
      "ImageCount": 2,
      "Category": "BLACK",
      "ServiceModule": "open_api",
      "Source": "MANUAL",
      "Name": "测试a",
      "Scene": "PORN",
      "Id": 1279,
      "Enable": "true",
      "BizTypes": [
        "[\\\"default\\\",\\\"xinxifabu\\\"]"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.