All Products
Search
Document Center

Security Center:ListClusterPluginInfo

Last Updated:Nov 14, 2024

Queries the status of plug-ins on clusters.

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:ListClusterPluginInfolist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
PluginNamestringNo

The name of the plug-in.

alihips
ClusterIdsarrayYes

The IDs of the clusters.

stringYes

The ID of the cluster.

902e428f6cc6679685d65fc81803****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0B48AB3C-84FC-424D-A01D-B9270EF46038
Dataarray<object>

The information about the plug-in.

clusterPluginInfoResponseobject
ClusterStatusstring

The status of the cluster. Valid values:

  • 1: normal
  • 2: abnormal
  • 3: offline
ABNORMAL
ClusterIdstring

The ID of the cluster.

c8ca91e0907d94efaba7fb0827eb9****
ClusterNamestring

The name of the cluster.

lmftest
NodePluginInfoListarray<object>

The plug-ins.

nodePluginInfoListobject
PluginVersionstring

The version of the plug-in.

1.3.1
Installedboolean

Indicates whether the plug-in is installed. Valid values:

  • true
  • false
true
MachineTypelong

The type of the instance. Valid values include:

  • ecs: Elastic Compute Service (ECS) instance
  • slb: Server Load Balancer (SLB) instance
ECS
Uuidstring

The UUID of the server.

bc563d2b-2a3d-411b-8bbe-d75b8d3c****
MachineIntranetIpstring

The private IP address of the server.

10.XXX.XXX.XX
Onlineboolean

Indicates whether the Security Center agent is online. Valid values:

  • true
  • false
Note If the Security Center agent of the server is offline, Security Center does not protect the server.
true
MachineInternetIpstring

The public IP address of the server.

100.100.XXX.XX
PluginNamestring

The name of the plug-in.

alihips
MachineNamestring

The name of the server.

npznas05
instanceIdstring

The instance ID of the server.

tpp-cn-2r42njq4y001
ErrorCodestring

The error code returned.

kenerl not support
ErrorMsgstring

The error message returned.

kenerl not support

Examples

Sample success responses

JSONformat

{
  "RequestId": "0B48AB3C-84FC-424D-A01D-B9270EF46038",
  "Data": [
    {
      "ClusterStatus": "ABNORMAL",
      "ClusterId": "c8ca91e0907d94efaba7fb0827eb9****",
      "ClusterName": "lmftest",
      "NodePluginInfoList": [
        {
          "PluginVersion": "1.3.1",
          "Installed": true,
          "MachineType": 0,
          "Uuid": "bc563d2b-2a3d-411b-8bbe-d75b8d3c****",
          "MachineIntranetIp": "10.XXX.XXX.XX",
          "Online": true,
          "MachineInternetIp": "100.100.XXX.XX",
          "PluginName": "alihips",
          "MachineName": "npznas05",
          "instanceId": "tpp-cn-2r42njq4y001",
          "ErrorCode": "kenerl not support",
          "ErrorMsg": "kenerl not support"
        }
      ]
    }
  ]
}

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.