All Products
Search
Document Center

Security Center:GetCheckSale

Last Updated:Nov 14, 2024

Queries the sales information about the configuration assessment feature, including the purchased quota and the consumed 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:GetCheckSaleget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region in which the Security Center instance is deployed. Valid values:

  • cn-hangzhou: inside China
  • Global ap-southeast-1: outside China
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

F5CF78A7-30AA-59DB-847F-13EE3AE7****
CheckSaleobject

The sales information about the configuration assessment quota.

PurchaseCountlong

The purchased quota.

1000
ConsumeCountlong

The consumed quota.

500
LoyalUserboolean

Indicates whether the user is an existing user and whether the user uses the configuration assessment feature before the feature is released for sale on July 07, 2023. Valid values:

  • true: existing user
  • false: new user
true
SaleUserTypeinteger

The type of the user. Valid values:

  • 1: a user who can use all check items.
  • 2: an user who can only use the check items before the release of the feature on July 07, 2023. This type of users must upgrade Security Center before the users can use all check items.
  • 3: a new user who cannot use the configuration assessment feature. This type of users must make a purchase before the users can use the feature.
1

Examples

Sample success responses

JSONformat

{
  "RequestId": "F5CF78A7-30AA-59DB-847F-13EE3AE7****",
  "CheckSale": {
    "PurchaseCount": 1000,
    "ConsumeCount": 500,
    "LoyalUser": true,
    "SaleUserType": 1
  }
}

Error codes

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

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