ListArtifacts - Compute Nest - Alibaba Cloud Documentation Center

Queries a list of artifacts.

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

list

*Artifact

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

None

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The number of entries to return on each page. The maximum value is 100. The default value is 20.	20
NextToken	string	No	The query token. Set it to the NextToken value returned from the previous API call.	AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hRQzE=
Filter	array<object>	No	The filter.
	object	No	The filter.
Name	string	No	The name of the filter. You can specify one or more filter names to query artifacts. Valid values: Name: Performs a fuzzy query by artifact name. ArtifactId: The artifact ID. ArtifactType: The artifact type.	ArtifactType
Values	array	No	A list of filter values.
	string	No	The list of filter values. You can specify from 1 to 10 values.	value1
ResourceGroupId	string	No	The resource group ID.	rg-aek25yfxxxxxxxx
Tag	array<object>	No	The tag.
	object	No	The tag.
Key	string	No	The tag key.	key1
Value	string	No	The tag value.	value1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	46577928-3162-15A6-9084-69820EB9xxxx
NextToken	string	The query token. Set it to the NextToken value returned from the previous API call.	AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hRQzE=
MaxResults	integer	The number of entries returned per page. The maximum value is 100. The default value is 20.	20
TotalCount	integer	The total number of entries that meet the filter criteria.	2
Artifacts	array<object>	The information about the artifacts.
	array<object>	The information about the artifacts.
ArtifactId	string	The artifact ID.	artifact-eea08d1e2d3a43aexxxx
ArtifactType	string	The artifact type.	EcsImage
Name	string	The artifact name.	Name
MaxVersion	string	The latest version.	2
Description	string	The description of the artifact.	Description
GmtModified	string	The time when the artifact was modified.	2022-10-20T02:19:55Z
Status	string	The status of the artifact. Valid values: Created: The artifact is created. Scanning: The artifact is being scanned. ScanFailed: The artifact failed to be scanned. Delivering: The artifact is being distributed. Available: The artifact is available. Deleted: The artifact is deleted.	Created
ResourceGroupId	string	The resource group ID.	rg-aek25rexxxxxxxx
Tags	array<object>	The tags.
	object	The tag.
Key	string	The tag key.	key1
Value	string	The tag value.	value1
ArtifactBuildProperty	string	The content used to build the artifact. This parameter is used for hosted artifact builds.	{\"CodeRepo\":{\"Owner\":\"wenle\",\"Platform\":\"github\",\"Branch\":\"main\",\"RepoName\":\"aliyun-computenest/java-springboot-demo\"}}
PermissionType	string	The permission field. This parameter is valid for artifacts of the container image, Helm chart, and file types. For other types of artifacts, you can only change the permission from Automatic to Public. Valid values: Public Automatic	Public

Examples

Success response

JSON format

{
  "RequestId": "46577928-3162-15A6-9084-69820EB9xxxx",
  "NextToken": "AAAAAc3HCuYhJi/wvpk4xOr0VLbfVwapgMwCN1wYzPVzLbItEdB0uWSY7AGnM3qCgm/YnjuEfwSnMwiMkcUoI0hRQzE=",
  "MaxResults": 20,
  "TotalCount": 2,
  "Artifacts": [
    {
      "ArtifactId": "artifact-eea08d1e2d3a43aexxxx",
      "ArtifactType": "EcsImage",
      "Name": "Name",
      "MaxVersion": "2",
      "Description": "Description",
      "GmtModified": "2022-10-20T02:19:55Z",
      "Status": "Created",
      "ResourceGroupId": "rg-aek25rexxxxxxxx",
      "Tags": [
        {
          "Key": "key1",
          "Value": "value1"
        }
      ],
      "ArtifactBuildProperty": "{\\\"CodeRepo\\\":{\\\"Owner\\\":\\\"wenle\\\",\\\"Platform\\\":\\\"github\\\",\\\"Branch\\\":\\\"main\\\",\\\"RepoName\\\":\\\"aliyun-computenest/java-springboot-demo\\\"}}",
      "PermissionType": "Public"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.