All Products
Search
Document Center

Security Center:GetOpaClusterLabelList

Last Updated:Nov 25, 2024

Queries information about the tags that are added to containers based on the feature of proactive defense for containers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
yundun-sas:GetOpaClusterLabelListget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TagNamestringNo

The name of the tag.

test
ClusterIdstringNo

The ID of the cluster to which the container belongs.

Note You can call the DescribeGroupedContainerInstances operation to query the IDs of clusters.
c556c8133b5ad4378b7fc533ddbda****
PageSizeintegerNo

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
CurrentPageintegerNo

The page number.

1

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataarray<object>

The information about the tags that are added to containers.

Dataobject
TagNamestring

The name of the tag that is added to the container.

test
Countinteger

The number of entries returned on the current page.

2
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Codestring

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
Messagestring

The returned message.

successful
RequestIdstring

The request ID.

95D35EB3-1F8E-5E07-A68E-BE018C9B80CB

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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