GetArtifact - Compute Nest - Alibaba Cloud Documentation Center

Retrieves the details of an artifact.

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

computenestsupplier:GetArtifact

get

*Artifact

acs:computenestsupplier:*:{#accountId}:artifact/{#ArtifactId}

None

Request parameters

Parameter	Type	Required	Description	Example
ArtifactId	string	No	The ID of the artifact. Call ListArtifacts to obtain the artifact ID.	artifact-eea08d1e2d3a43aexxxx
ArtifactVersion	string	No	The version of the artifact. Call ListArtifacts to obtain the artifact version.	1
ArtifactName	string	No	The name of the artifact. Call ListArtifacts to obtain the artifact name.	gpu-test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	B1A0198B-F316-1B72-B8DD-28B6F6D6XXXX
ArtifactId	string	The ID of the artifact.	artifact-eea08d1e2d3a43aexxxx
ArtifactType	string	The type of the artifact.	EcsImage
Name	string	The name of the artifact.	Name
VersionName	string	The version name of the artifact.	v1
ArtifactVersion	string	The version of the artifact.	2
Description	string	The description of the artifact.	Description
GmtModified	string	The time when the artifact was last modified.	2022-10-20T02:19:55Z
Status	string	The status of the artifact.	Available
MaxVersion	integer	The latest version of the artifact.	2
ArtifactProperty	string	The properties of the artifact.	{\"CommodityCode\":\"cmjj0005xxxx\",\"CommodityVersion\":\"V2022xxxx\"}
SupportRegionIds	string	The IDs of the regions where the artifact is supported.	["cn-hangzhou","cn-beijing"]
Progress	string	The distribution progress of the artifact.	100
ResourceGroupId	string	The ID of the resource group.	rg-aekzkt5buxxxxxx
Tags	array<object>	The tags of the artifact.
	object	The tags of the artifact.
Key	string	The tag key of the artifact.	key1
Value	string	The tag value of the artifact.	value1
ArtifactBuildProperty	string	The content used to build the artifact. This parameter is used for managed artifact builds.	"{\"RegionId\":\"xxx\", \"SourceImageId\":\"xxx\", \"\":\"xxx\", \"CommandType\":\"xxx\", \"CommandContent\":\"xxx\"}"
StatusDetail	string	The description of the artifact status.	"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found"
ArtifactBuildType	string	The type of the artifact build.	Dockerfile
PermissionType	string	The permission type. This parameter is valid for artifacts of the ContainerImage and HelmChart types. Valid values: Public Automatic	Public

Examples

Success response

JSON format

{
  "RequestId": "B1A0198B-F316-1B72-B8DD-28B6F6D6XXXX",
  "ArtifactId": "artifact-eea08d1e2d3a43aexxxx",
  "ArtifactType": "EcsImage",
  "Name": "Name",
  "VersionName": "v1",
  "ArtifactVersion": "2",
  "Description": "Description",
  "GmtModified": "2022-10-20T02:19:55Z",
  "Status": "Available",
  "MaxVersion": 2,
  "ArtifactProperty": "{\\\"CommodityCode\\\":\\\"cmjj0005xxxx\\\",\\\"CommodityVersion\\\":\\\"V2022xxxx\\\"}",
  "SupportRegionIds": "[\"cn-hangzhou\",\"cn-beijing\"]",
  "Progress": "100",
  "ResourceGroupId": "rg-aekzkt5buxxxxxx",
  "Tags": [
    {
      "Key": "key1",
      "Value": "value1"
    }
  ],
  "ArtifactBuildProperty": "\"{\\\"RegionId\\\":\\\"xxx\\\", \\\"SourceImageId\\\":\\\"xxx\\\", \\\"\\\":\\\"xxx\\\", \\\"CommandType\\\":\\\"xxx\\\", \\\"CommandContent\\\":\\\"xxx\\\"}\"",
  "StatusDetail": "\"/usr/local/share/aliyun-assist/work/script/t-hz04zm90y6og0sg.sh: line 1: pip: command not found\"",
  "ArtifactBuildType": "Dockerfile",
  "PermissionType": "Public"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.