Use GetOpaClusterLabelList to query container tags for proactive defense - 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:GetOpaClusterLabelList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TagName	string	No	The name of the tag.	test
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.	c556c8133b5ad4378b7fc533ddbda****
PageSize	integer	No	The number of entries per page. Default value: 200. If you leave the PageSize parameter empty, 200 entries are returned by default. Maximum value: 200. Note We recommend that you do not leave this parameter empty.	20
CurrentPage	integer	No	The page number.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	array<object>	The information about the tags that are added to containers.
	object
TagName	string	The name of the tag that is added to the container.	test
Count	integer	The number of entries returned on the current page.	2
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.	200
Message	string	The returned message.	successful
RequestId	string	The request ID.	95D35EB3-1F8E-5E07-A68E-BE018C9B80CB

Examples

Success response

JSON format

{
  "Data": [
    {
      "TagName": "test"
    }
  ],
  "Count": 2,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "95D35EB3-1F8E-5E07-A68E-BE018C9B80CB"
}

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.