All Products
Search
Document Center

Serverless App Engine:DescribeApplicationImage

Last Updated:Jul 25, 2024

Queries the information about the image of an application.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sae:DescribeApplicationImageget
  • All Resources
    *
    none
none

Request syntax

GET /pop/v1/sam/container/describeApplicationImage

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

d700e680-aa4d-4ec1-afc2-6566b5ff****
ImageUrlstringYes

The URL of the image.

registry-vpc.cn-hangzhou.aliyuncs.com/demo/demo:latest

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

The returned message. Valid values:

  • success: If the call is successful, success is returned.
  • An error code: If the call fails, an error code is returned.
success
TraceIdstring

The trace ID that is used to query the details of the request.

0a98a02315955564772843261e****
Dataobject

The information about the image of the application.

RepoOriginTypestring

The type of the repository. Only Container Registry is supported.

ALI_HUB
CrUrlstring

This parameter is reserved.

RepoTagstring

The tag of the image.

latest
RepoTypestring

This parameter is reserved.

RepoNamestring

The name of the repository.

demo
RepoNamespacestring

The name of the namespace to which the image repository belongs.

demo
RegionIdstring

The region ID.

cn-beijing
ErrorCodestring

The error code. Valid values:

  • If the call is successful, the ErrorCode parameter is not returned.
  • If the call fails, the ErrorCode parameter is returned. For more information, see the Error codes section in this topic.
Codestring

The HTTP status code. Valid values:

  • 2xx: The call was successful.
  • 3xx: The call was redirected.
  • 4xx: The call failed.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the information about the image was obtained. Valid values:

  • true: The information was obtained.
  • false: The information failed to be obtained.
true

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history