GetImage - Platform For AI - Alibaba Cloud Documentation Center

Retrieves the details of an image.

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

paiimage:GetImage

get

*All Resource

*

None

Request syntax

GET /api/v1/images/{ImageId} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
ImageId	string	Yes	The ID of the image. For more information, see ListImages.	image-4c62******53uor

Request parameters

Parameter	Type	Required	Description	Example
Verbose	boolean	No	Specifies whether to display non-essential information. Non-essential information currently includes labels. Valid values: false (default): Does not display non-essential information. true: Displays non-essential information.	false

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	5A14FA81-DD4E-******-6343FE44B941
GmtCreateTime	string	The time when the image was created. The time is in UTC and the format is ISO 8601.	2021-01-21T17:12:35.232Z
GmtModifiedTime	string	The time when the image was last modified. The time is in UTC and the format is ISO 8601.	2021-01-21T17:12:35.232Z
Name	string	The name of the image.	nlp-compression
Description	string	The description of the image.	NLP模型压缩训练镜像
ImageUri	string	The URL of the image, including the version number.	registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu
UserId	string	The UID of the user who created the image.	15577******8921
ParentUserId	string	The Alibaba Cloud account of the creator.	15577******8921
Labels	array<object>	A list of image labels. This is an array. Each item in the array contains a Key and a Value field. Official images have the following label: the key is system.official and the value is true.
	object	The image label.
Key	string	The key of the label.	system.chipType
Value	string	The value of the label.	GPU
WorkspaceId	string	The ID of the workspace to which the image belongs.	15945
Accessibility	string	The visibility of the image. Valid values: PUBLIC: All members in the current workspace can perform operations on the image. PRIVATE: Only the creator can perform operations on the image.	PUBLIC
Size	integer	The size of the image in bytes.	10
SourceType	string	The type of the image source.
SourceId	string	The ID of the image source.

Examples

Success response

JSON format

{
  "RequestId": "5A14FA81-DD4E-******-6343FE44B941",
  "GmtCreateTime": "2021-01-21T17:12:35.232Z",
  "GmtModifiedTime": "2021-01-21T17:12:35.232Z",
  "Name": "nlp-compression\n",
  "Description": "NLP模型压缩训练镜像\n",
  "ImageUri": "registry.cn-hangzhou.aliyuncs.******ession/nlp:gpu\n",
  "UserId": "15577******8921",
  "ParentUserId": "15577******8921",
  "Labels": [
    {
      "Key": "system.chipType\n",
      "Value": "GPU"
    }
  ],
  "WorkspaceId": "15945",
  "Accessibility": "PUBLIC",
  "Size": 10,
  "SourceType": "",
  "SourceId": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.