All Products
Search
Document Center

Security Center:GetAuthSummary

Last Updated:Aug 20, 2026

Retrieves authorization statistics.

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:GetAuthSummary

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element

Type

Description

Example

object

RequestId

string

The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.

0B48AB3C-***-B9270EF46038

DefaultAuthToAll

integer

Indicates whether all assets are authorized by default. Valid values:

  • 0: No.

  • 1: Yes.

1

AllowPartialBuy

integer

Indicates whether on-demand authorization purchase is allowed during initial purchase. Valid values:

  • 0: Not allowed.

  • 1: Allowed.

1

AllowUpgradePartialBuy

integer

Indicates whether upgrading to on-demand authorization purchase is allowed during an upgrade. Valid values:

  • 0: Not allowed.

  • 1: Allowed.

1

HasPreBindSetting

boolean

Indicates whether a pre-bindingasset configuration exists. Pre-binding refers to the asset binding configuration selected in advance during purchase. Valid values:

  • 0: Does not exist.

  • 1: Exists.

1

IsMultiVersion

integer

Indicates whether multiple versions exist. Valid values:

  • 0: No.

  • 1: Yes.

1

AutoBind

integer

Indicates whether new subscription assets are automatically bound when the host and container security subscription service is activated. Valid values:

  • 0: Disabled.

  • 1: Enabled.

1

HighestVersion

integer

The highest purchased edition of Security Center. Valid values:

  • 1: Free Edition.

  • 3: Enterprise Edition.

  • 5: Premium Edition.

  • 6: Anti-virus Edition.

  • 7: Ultimate Edition.

  • 10: Value-added services only.

Note

If a single edition is purchased, this value indicates the corresponding edition. If multiple editions are purchased, this value indicates the highest sub-edition.

1

Machine

object

The asset authorization statistics information.

RiskCoreCount

integer

The number of cores of assets that have security risks.

10

BindCoreCount

integer

The number of cores of assets that are bound with authorization.

10

TotalEcsCount

integer

The total number of assets.

10

BindEcsCount

integer

The number of bound assets.

10

TotalCoreCount

integer

The total number of asset cores.

10

RiskEcsCount

integer

The number of assets that have security risks.

10

UnBindEcsCount

integer

The number of unbound assets.

10

UnBindCoreCount

integer

The number of cores of unbound assets.

10

PostPaidBindCoreCount

integer

The number of cores of assets bound with pay-as-you-go authorization.

10

PostPaidBindEcsCount

integer

The number of assets bound with pay-as-you-go authorization.

10

VersionSummary

array<object>

The authorization usage statistics information.

object

The authorization usage statistics information.

Index

integer

The index of the current edition. A larger value indicates a higher edition. This field is used for sorting. Valid values:

  • 1: Free Edition.

  • 2: Anti-virus Edition.

  • 3: Premium Edition.

  • 4: Enterprise Edition.

  • 5: Ultimate Edition.

1

Version

integer

The purchased edition of Security Center. Valid values:

  • 1: Free Edition.

  • 3: Enterprise Edition.

  • 5: Premium Edition.

  • 6: Anti-virus Edition.

  • 7: Ultimate Edition.

  • 8: Multi-version.

  • 10: Value-added services only.

3

UsedCoreCount

integer

The number of authorized cores that have been used.

Note

This parameter is valid only when AuthBindType is set to CORE or ASSET_AND_CORE.

10

UnUsedCount

integer

The number of unused authorized assets.

Note

This parameter is valid only when AuthBindType is set to ASSET or ASSET_AND_CORE.

10

UsedEcsCount

integer

The number of authorized assets that have been used.

Note

This parameter is valid only when AuthBindType is set to ASSET or ASSET_AND_CORE.

10

TotalCount

integer

The total number of authorized assets for the current edition.

Note

This parameter is valid only when AuthBindType is set to ASSET or ASSET_AND_CORE.

10

TotalEcsAuthCount

integer

The total number of authorized assets.

Note

This parameter is valid only when AuthBindType is set to ASSET or ASSET_AND_CORE.

10

TotalCoreAuthCount

integer

The total number of authorized cores.

Note

This parameter is valid only when AuthBindType is set to CORE or ASSET_AND_CORE.

10

UnusedEcsAuthCount

integer

The number of unused authorized assets.

Note

This parameter is valid only when AuthBindType is set to ASSET or ASSET_AND_CORE.

10

UnusedCoreAuthCount

integer

The number of unused authorized cores.

Note

This parameter is valid only when AuthBindType is set to CORE or ASSET_AND_CORE.

10

AuthBindType

string

The type of authorization consumed during binding. Valid values:

  • ASSET: consumes authorized asset count.

  • CORE: consumes authorized core count.

  • ASSET_AND_CORE: consumes both authorized asset count and authorized core count.

ASSET

AllowUserUnbind

integer

Indicates whether immediate unbinding of all bound assets is allowed. Valid values:

  • 0: No.

  • 1: Yes.

1

PostPaidVersionSummary

array<object>

The service authorization statistics for the host and container security pay-as-you-go service.

object

AuthBindType

string

The type of authorization consumed during binding. Valid values:

  • ASSET: consumes authorized asset count.

  • CORE: consumes authorized core count.

  • ASSET_AND_CORE: consumes both authorized asset count and authorized core count.

ASSET

Version

integer

The pay-as-you-go edition bound to host assets. Valid values:

  • 1: Free Edition.

  • 3: Enterprise Edition.

  • 5: Premium Edition.

  • 6: Anti-virus Edition.

  • 7: Ultimate Edition.

3

Index

integer

The index of the current edition. A larger value indicates a higher edition. This field is used for sorting. Valid values:

  • 1: Free Edition.

  • 2: Anti-virus Edition.

  • 3: Premium Edition.

  • 4: Enterprise Edition.

  • 5: Ultimate Edition.

1

UsedCoreCount

integer

The number of authorized cores that have been used.

Note

This parameter is valid only when AuthBindType is set to CORE or ASSET_AND_CORE.

10

UsedEcsCount

integer

The number of authorized assets that have been used.

Note

This parameter is valid only when AuthBindType is set to ASSET or ASSET_AND_CORE.

10

FreeType

string

FreeEcsCount

integer

FreeCoreCount

integer

PostPaidHostAutoBind

string

Indicates whether automatic binding of new hosts is enabled for the host and container security pay-as-you-go service. Valid values:

  • 0: Disabled.

  • 1: Enabled.

1

PostPaidHostAutoBindVersion

string

The edition to which new assets are automatically bound for the host and container security pay-as-you-go service. Valid values:

  • 1: Free Edition.

  • 3: Enterprise Edition.

  • 5: Premium Edition.

  • 6: Anti-virus Edition.

  • 7: Ultimate Edition.

7

PostPaidHighestVersion

string

The protection edition of the host and container security pay-as-you-go service. This is the highest protection edition among all bound hosts. Valid values:

  • 1: Free Edition.

  • 3: Enterprise Edition.

  • 5: Premium Edition.

  • 6: Anti-virus Edition.

  • 7: Ultimate Edition.

7

InvalidBindStatus

string

The binding validity status. Valid values:

  • NORMAL: Valid.

  • INVALID_NODE_VERSION: Invalid.

INVALID_NODE_VERSION

ClusterNodeCheck

integer

Indicates whether cluster nodes require agent version verification. Valid values:

  • 0: Not required.

  • 1: Required.

1

EdrSummary

object

BoundCount

string

PostPaidAutoBind

string

HybridPaidAutoBind

string

Examples

Success response

JSON format

{
  "RequestId": "0B48AB3C-***-B9270EF46038",
  "DefaultAuthToAll": 1,
  "AllowPartialBuy": 1,
  "AllowUpgradePartialBuy": 1,
  "HasPreBindSetting": true,
  "IsMultiVersion": 1,
  "AutoBind": 1,
  "HighestVersion": 1,
  "Machine": {
    "RiskCoreCount": 10,
    "BindCoreCount": 10,
    "TotalEcsCount": 10,
    "BindEcsCount": 10,
    "TotalCoreCount": 10,
    "RiskEcsCount": 10,
    "UnBindEcsCount": 10,
    "UnBindCoreCount": 10,
    "PostPaidBindCoreCount": 10,
    "PostPaidBindEcsCount": 10
  },
  "VersionSummary": [
    {
      "Index": 1,
      "Version": 3,
      "UsedCoreCount": 10,
      "UnUsedCount": 10,
      "UsedEcsCount": 10,
      "TotalCount": 10,
      "TotalEcsAuthCount": 10,
      "TotalCoreAuthCount": 10,
      "UnusedEcsAuthCount": 10,
      "UnusedCoreAuthCount": 10,
      "AuthBindType": "ASSET"
    }
  ],
  "AllowUserUnbind": 1,
  "PostPaidVersionSummary": [
    {
      "AuthBindType": "ASSET",
      "Version": 3,
      "Index": 1,
      "UsedCoreCount": 10,
      "UsedEcsCount": 10,
      "FreeType": "",
      "FreeEcsCount": 0,
      "FreeCoreCount": 0
    }
  ],
  "PostPaidHostAutoBind": "1",
  "PostPaidHostAutoBindVersion": "7",
  "PostPaidHighestVersion": "7",
  "InvalidBindStatus": "INVALID_NODE_VERSION",
  "ClusterNodeCheck": 1,
  "EdrSummary": {
    "BoundCount": "",
    "PostPaidAutoBind": "",
    "HybridPaidAutoBind": ""
  }
}

Error codes

HTTP status code

Error code

Error message

Description

500 ServerError ServerError
403 NoPermission caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.