Use DescribeImageLib to query custom image libraries - Content Moderation - Alibaba Cloud - AI Guardrails

Queries custom image libraries.

Description

Operation: DescribeImageLib

You can call this operation to query custom image libraries. For information about how to construct an HTTP request, see Request structure. You can also use a pre-constructed HTTP request. For more information, see SDK overview.

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

Parameter	Type	Required	Example	Description
ServiceModule	String	Yes	open_api	The name of the service module. Set the value to open_api.

Response parameters

Parameter	Type	Example	Description
Id	Integer	1279	The ID of the primary key.
ModifiedTime	String	2018-03-19 10:45:44 +0800	The last time when the image library was modified.
Name	String	Test	The name of the image library.
Code	String	808003055	The code of the image library. Note The code of the image library is displayed in the Alibaba Cloud Content Moderation console. The primary key ID is used to identify the image library in the operation.
ImageCount	String	191231231230	The number of images in the image library.
Category	String	BLACK	The category of the image library. Valid values: BLACK: a blacklist WHITE: a whitelist
Source	String	MANUAL	Indicates how the image library is created. Valid values: MANUAL: indicates that the image library is manually created. FEEDBACK: indicates that the image library is automatically created based on user feedback.
Scene	String	PORN	The moderation scenario to which the custom image library applies. Valid values: PORN: pornography detection AD: ad detection ILLEGAL: terrorist content detection
BizTypes	StringArray	["bizTypeA", "bizTypeB","bizTypeC"]	The business scenario. For more information, see CreateBizType.
Enable	Boolean	true	Indicates whether the image library was enabled. Valid values: true: The image library is enabled. This is the default value. false: The image library is disabled.

Examples

Sample request

http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeImageLib&ServiceModule=open_api
&<Common request parameters>
{
    "ServiceModule": "open_api"
}

Sample success responses

{
    "requestId": "6CF2815C-C8C7-4A01-B52E-FF6E24F53492",
    "data": {
        "TotalCount": 5,
        "ImageLibList": [
            {
                "Name": "Test a",
                "Source": "MANUAL",
                "ImageCount": 191231231230,
                "BizTypes": [
                             "bizTypeA", 
                             "bizTypeB",
                             "bizTypeC"
                 ],
                "Category": "BLACK",
                "ServiceModule": "open_api",
                "Scene": "PORN",
                "ModifiedTime": "2018-03-19 10:45:44 +0800",
                "Id": 1279,
                "Code": "808003055",
                "Enable": true
            },
            {
                "Name": "Hello aa",
                "Source": "MANUAL",
                "ImageCount": 0,
                "BizTypes": [
                             "bizTypea", 
                             "bizTypeb",
                             "bizTypec"
                 ],
                "Category": "BLACK",
                "ServiceModule": "open_api",
                "Scene": "PORN",
                "ModifiedTime": "2018-03-01 19:20:37 +0800",
                "Id": 1222,
                "Code": "808003043",
                "Enable": true
            }
        ]
    },
    "code": 200,
    "success": true
}