All Products
Search
Document Center

Security Center:GetCheckStructure

Last Updated:Nov 14, 2024

Obtains the structure information about check items provided by the configuration assessment feature.

Operation description

You must purchase the configuration assessment feature before you can use the feature.

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

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page.

20
LangstringNo

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

  • zh: Chinese
  • en: English
zh
RegionIdstringNo

The region ID of the asset. Valid values:

  • cn-hangzhou: China.
  • ap-southeast-1: outside China.
cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

LGetCheckStructureResponse

CheckStructureResponsearray<object>

The structure information about check items provided by the configuration assessment feature.

CheckStructureobject
StandardTypestring

The type of the check item.

  • RISK: security risk.
  • IDENTITY_PERMISSION: Cloud Infrastructure Entitlement Management (CIEM).
  • COMPLIANCE: security compliance.
RISK
Standardsarray<object>

The structure information about the check items of the business type.

Standardobject
Requirementsarray<object>

The standards of the check items.

Requirementobject
Idlong

The ID of the requirement item for the check item.

46
ShowNamestring

The display name of the requirement item for the check item.

Networking
TotalCheckCountinteger

The total number of check items for the requirement.

36
Sectionsarray<object>

The information about the sections of check items.

Sectionobject

The information about the section of the check item.

Idlong

The ID of the section for the check item.

177
ShowNamestring

The display name of the section for the check item.

Access Control
Idlong

The standard ID of the check item.

8
Typestring

The standard type of the check item. Valid values:

  • RISK: security risk.
  • IDENTITY_PERMISSION: CIEM.
  • COMPLIANCE: security compliance.
IDENTITY_PERMISSION
ShowNamestring

The display name of the standard for the check item.

Alibaba Cloud best security practices
RequestIdstring

The request ID.

379a9b8f-107b-4630-9e95-2299a1ea****

Examples

Sample success responses

JSONformat

{
  "CheckStructureResponse": [
    {
      "StandardType": "RISK",
      "Standards": [
        {
          "Requirements": [
            {
              "Id": 46,
              "ShowName": "Networking",
              "TotalCheckCount": 36,
              "Sections": [
                {
                  "Id": 177,
                  "ShowName": "Access Control"
                }
              ]
            }
          ],
          "Id": 8,
          "Type": "IDENTITY_PERMISSION",
          "ShowName": "Alibaba Cloud best security practices"
        }
      ]
    }
  ],
  "RequestId": "379a9b8f-107b-4630-9e95-2299a1ea****"
}

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.