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

Queries the list of images in a custom image library.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The IP address of the access source.	114.84.0.***
TotalCount	integer	No	The total number of entries.	52
PageSize	integer	No	The number of entries per page.	10
CurrentPage	integer	No	The current page number.	1
ImageLibId	integer	Yes	The ID of the image library.	13776
Id	integer	No	The primary key ID.	1791
StartDate	string	No	The start time. Format: YYYY-MM-DD HH:mm:ss (default time zone: UTC+8).	2023-01-01 00:00:00 +0800
EndDate	string	No	The end time. Format: YYYY-MM-DD HH:mm:ss (default time zone: UTC+8).	2023-11-18 10:21:32 +0800
ModelId	integer	No	The model ID.	21981

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The current page number.	1
RequestId	string	The request ID.	AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries.	52
ImageFromLibList	array<object>	The list of image library information.
	object	The list of image library information.
ImageHitCount	integer	The number of image hits in the image library.	22
Image	string	The image URL.	https://xxxx.png
CreateTime	string	The creation time of the image library entry. Format: YYYY-MM-DD HH:mm:ss (default time zone: UTC+8).	2022-11-04 16:09:51 +0800
VideoHitCount	integer	The number of image hits in videos.	11
Thumbnail	string	The thumbnail URL.	https://xxxx.png
Id	integer	The primary key ID.	1697

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****\n",
  "PageSize": 10,
  "TotalCount": 52,
  "ImageFromLibList": [
    {
      "ImageHitCount": 22,
      "Image": "https://xxxx.png\n",
      "CreateTime": "2022-11-04 16:09:51 +0800",
      "VideoHitCount": 11,
      "Thumbnail": "https://xxxx.png",
      "Id": 1697
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.