Query container asset details by attribute using DescribeContainerTags - Security Center

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

yundun-sas:DescribeContainerTags

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FieldName	string	Yes	The name of the attribute that is used for the query. Valid values: namespace: the namespace appName: the application name image: the image tag: the tag	namespace
FieldValue	string	No	The value of the attribute that is used for the query.	demo4
CurrentPage	integer	Yes	The number of the page to return. Default value: 1.	1
PageSize	integer	Yes	The number of entries to return on each page. Default value: 200.	200
ClusterId	string	No	The ID of the cluster to which the container belongs. Note You can call the DescribeGroupedContainerInstances operation to query the IDs of clusters.	c22143730ab6e40b09ec7c1c51d4d****
Namespace	string	No	The namespace.	test-name-01
AppName	string	No	The name of the application.	node-exporter

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	028CF634-5268-5660-9575-48C9ED6BF880
TagValues	array	An array that consists of the attributes of container assets.
	string	The value of the attribute. If FieldName is set to namespace, the value of this parameter is the namespace. If FieldName is set to appName, the value of this parameter is the application name. If FieldName is set to image, the value of this parameter is the image. If FieldName is set to tag, the value of this parameter is the tag.	node-exporter

Examples

Success response

JSON format

{
  "RequestId": "028CF634-5268-5660-9575-48C9ED6BF880",
  "TagValues": [
    "node-exporter\n"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.