All Products
Search
Document Center

Security Center:DescribePluginSummary

Last Updated:Oct 24, 2025

Queries statistics on the client plug-in installation status.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:DescribePluginSummaryget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PluginNamestringNo

The name of the plug-in. Valid values:

  • alinet: AliNet.
  • alisecguard: client protection.
  • alihips: AliHips.
alihips
LangstringNo

The language of the content within the request and response.**** Valid values:

  • zh (default)
  • en
zh

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

1383B0DB-D5D6-4B0C-9E6B-75939C8E****
Dataobject

The details of the plug-in data.

OnlineCntinteger

The number of hosts on which the plug-in is online.

10
OfflineCntinteger

The number of hosts on which the plug-in is offline.

2
FailedCntinteger

The number of hosts on which the plug-in failed to be installed.

3
SwitchOffCntinteger

The number of hosts for which the plug-in is not enabled.

5
TotalCntinteger

The total number of hosts.

20
FailedReasonsarray<object>

The causes of installation failures.

failedReasonsobject
Reasonstring

The cause of the installation failure.

Other
Countinteger

The number of hosts on which the installation failed for this reason.

3
Codestring

The error code for the installation failure.

-1

Examples

Sample success responses

JSONformat

{
  "RequestId": "1383B0DB-D5D6-4B0C-9E6B-75939C8E****",
  "Data": {
    "OnlineCnt": 10,
    "OfflineCnt": 2,
    "FailedCnt": 3,
    "SwitchOffCnt": 5,
    "TotalCnt": 20,
    "FailedReasons": [
      {
        "Reason": "Other",
        "Count": 3,
        "Code": -1
      }
    ]
  }
}

Error codes

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