All Products
Search
Document Center

Security Center:GetAuthSummary

Last Updated:Nov 14, 2024

Queries the statistics of asset protection quota.

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

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

0B48AB3C-***-B9270EF46038
DefaultAuthToAllinteger

Indicates whether the protection quota is supported for all assets. Valid values:

  • 0: no
  • 1: yes
1
AllowPartialBuyinteger

Indicates whether you can purchase protection quota on demand when you purchase Security Center. Valid values:

  • 0: no
  • 1: yes
1
AllowUpgradePartialBuyinteger

Indicates whether you can purchase protection quota on demand after an upgrade. Valid values:

  • 0: no
  • 1: yes
1
HasPreBindSettingboolean

Indicates whether pre-bound assets exist. If you select assets to bind when you purchase Security Center, pre-bound assets exist. Valid values:

  • 0: no
  • 1: yes
1
IsMultiVersioninteger

Indicates whether Security Center Multi-edition is purchased. Valid values:

  • 0: no
  • 1: yes
1
AutoBindinteger

Indicates whether automatic binding is enabled. Valid values:

  • 0: disabled
  • 1: enabled
1
HighestVersioninteger

The most advanced edition that is used. Valid values:

  • 1: Basic edition
  • 3: Enterprise edition
  • 5: Advanced edition
  • 6: Anti-virus edition
  • 7: Ultimate edition
  • 10: Value-added Plan edition
Note If you purchase Security Center Multi-edition, the value indicates the most advanced edition that is used. Otherwise, the value indicates the specific edition that is purchased.
1
Machineobject

The statistics of the protection quota for assets.

RiskCoreCountinteger

The number of cores of the assets that are at risk.

10
BindCoreCountinteger

The number of cores of the assets that are bound to Security Center.

10
TotalEcsCountinteger

The total number of assets.

10
BindEcsCountinteger

The number of the assets that are bound to Security Center.

10
TotalCoreCountinteger

The total number of asset cores.

10
RiskEcsCountinteger

The number of the assets that are at risk.

10
UnBindEcsCountinteger

The number of unbound assets.

10
UnBindCoreCountinteger

The number of cores of unbound assets.

10
VersionSummaryarray<object>

The quota consumption statistics.

versionobject

The quota consumption statistics

Indexinteger

The index of the current edition. The smaller the value, the higher the edition. The index is used for sorting.

1
Versioninteger

The edition of purchased Security Center. Valid values:

  • 1: Basic edition
  • 3: Enterprise edition
  • 5: Advanced edition
  • 6: Anti-virus edition
  • 7: Ultimate edition
  • 8: Multi-edition
  • 10: Value-added Plan edition
3
UsedCoreCountinteger

The consumed quota of server cores.

Note This parameter takes effect only if AuthBindType is set to CORE or ASSET_AND_CORE.
10
UnUsedCountinteger

The remaining quota of servers.

Note This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.
10
UsedEcsCountinteger

The used quota of servers.

Note This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.
10
TotalCountinteger

The total quota of servers in the current edition.

Note This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.
10
TotalEcsAuthCountinteger

The total quota of servers.

Note This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.
10
TotalCoreAuthCountinteger

The total quota of server cores.

Note This parameter takes effect only if AuthBindType is set to CORE or ASSET_AND_CORE.
10
UnusedEcsAuthCountinteger

The remaining quota of servers.

Note This parameter takes effect only if AuthBindType is set to ASSET or ASSET_AND_CORE.
10
UnusedCoreAuthCountinteger

The remaining quota of server cores.

Note This parameter takes effect only if AuthBindType is set to CORE or ASSET_AND_CORE.
10
AuthBindTypestring

The type of the quota that is consumed. Valid values:

  • ASSET: quota of servers.
  • CORE: quota of server cores.
  • ASSET_AND_CORE: both.
ASSET
AllowUserUnbindinteger

Indicates whether all bound assets can be immediately unbound. Valid values:

  • 0: no
  • 1: yes
1

Examples

Sample success responses

JSONformat

{
  "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
  },
  "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
}

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.