DescribeApplicationImage-阿里云帮助中心

Retrieves information about an application 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

sae:DescribeApplicationImage

get

*All Resource

*

None

Request syntax

GET /pop/v1/sam/container/describeApplicationImage HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID.	d700e680-aa4d-4ec1-afc2-6566b5ff****
ImageUrl	string	Yes	The image URL.	registry-vpc.cn-hangzhou.aliyuncs.com/demo/demo:latest

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The returned message. success is returned if the request is successful. An error code is returned if the request fails.	success
TraceId	string	The trace ID that is used to query the details of a request.	0a98a02315955564772843261e****
Data	object	The application image information.
Logo	string	This parameter is reserved.
RepoOriginType	string	The image repository type. Currently, only Container Registry is supported.	ALI_HUB
CrUrl	string	This parameter is reserved.
RepoTag	string	The image tag.	latest
RepoType	string	A reserved field.
RepoName	string	The image repository name.	demo
RepoNamespace	string	The image namespace.	demo
RegionId	string	The region ID.	cn-beijing
ErrorCode	string	The error code. This parameter is left empty if the request is successful. This parameter returns an error code if the request fails. For more information, see the Error codes section of this topic.
Code	string	The HTTP status code. Valid values: 2xx: The request was successful. 3xx: The request was redirected. 4xx: A client-side error occurred. 5xx: A server-side error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Logo": "",
    "RepoOriginType": "ALI_HUB",
    "CrUrl": "",
    "RepoTag": "latest",
    "RepoType": "",
    "RepoName": "demo",
    "RepoNamespace": "demo",
    "RegionId": "cn-beijing"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.