All Products
Search
Document Center

Security Center:DescribeRiskType

Last Updated:Nov 13, 2024

Queries baseline types.

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

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

192.168.X.X
LangstringNo

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

  • zh: Chinese
  • en: English
zh
SourcestringNo

The data source. Valid values:

  • default: host baseline
  • agentless: agentless baseline
agentless

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

F22037B5-FCE4-5178-A9E7-71798E1F9270
RiskTypesarray<object>

An array that consists of the information about baseline types.

RiskTypeobject

The information about the baseline type.

TypeNamestring

The name of the baseline type.

hc_exploit
Aliasstring

The alias of the baseline type.

Redis unauthorized access high exploit vulnerability risk
SubTypesarray<object>

An array that consists of the information about baseline subtypes.

SubTypeobject
TypeNamestring

The name of the baseline subtype.

hc_exploit_redis
Aliasstring

The alias of the baseline subtype.

Redis unauthorized access high exploit vulnerability risk
CheckDetailsarray<object>

An array that consists of the check details about the baseline subtype.

CheckDetailobject
CheckIdlong

The ID of the baseline.

1299
CheckItemstring

The baseline.

Ensure password expiration period is set.
CheckDescstring

The description of the baseline.

Set password expiration time, force regular modification of password, reduce password leakage and guess risk.Use non-password login (e.g. key pair) please ignore this item.
Rulesarray<object>

An array that consists of the rule details about the baseline.

Ruleobject
Optionalinteger

Indicates whether the baseline can be edited. Valid values:

  • 0: no
  • 1: yes
1
RuleDescstring

The description of the rule for the baseline.

Please customize the password expiration time detection standard as
RuleIdstring

The ID of the rule for the baseline.

audit.audit_policy.auditpolicychange.cus
ParamListarray<object>

An array that consists of the parameters in the rule for the baseline.

Paramobject
ParamDefaultValuestring

The default value of the parameter.

7
ParamNamestring

The name of the parameter.

range_val
MaxValueinteger

The maximum value of the parameter.

999
ParamTypeinteger

The configuration type of the parameter. Valid values:

  • 1: input
  • 2: selection
1
ParamDescstring

The description of the parameter.

The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure
MinValueinteger

The minimum value of the parameter.

1
EnumValuestring

If the value of paramType is 1, this parameter is empty. If the value of paramType is 2, this parameter provides the options that can be selected for paramType.

0,1,2,3
SupportedOsstring

The operating system type of the server. Valid values:

  • windows
  • linux
linux
AuthFlagboolean

The baseline subtype permission flag of the current user version. Valid values:

  • true: Have access
  • false: No permissions
true
AuthFlagboolean

The baseline type flag of the current user version. Valid values:

  • true: Have access
  • false: No permissions
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "F22037B5-FCE4-5178-A9E7-71798E1F9270",
  "RiskTypes": [
    {
      "TypeName": "hc_exploit",
      "Alias": "Redis unauthorized access high exploit vulnerability risk",
      "SubTypes": [
        {
          "TypeName": "hc_exploit_redis",
          "Alias": "Redis unauthorized access high exploit vulnerability risk",
          "CheckDetails": [
            {
              "CheckId": 1299,
              "CheckItem": "Ensure password expiration period is set.",
              "CheckDesc": "Set password expiration time, force regular modification of password, reduce password leakage and guess risk.Use non-password login (e.g. key pair) please ignore this item.",
              "Rules": [
                {
                  "Optional": 1,
                  "RuleDesc": "Please customize the password expiration time detection standard as",
                  "RuleId": "audit.audit_policy.auditpolicychange.cus",
                  "ParamList": [
                    {
                      "ParamDefaultValue": "7",
                      "ParamName": "range_val",
                      "MaxValue": 999,
                      "ParamType": 1,
                      "ParamDesc": "The setting value is 0 means no definition, 1 means success, 2 means failure, 3 means success and failure",
                      "MinValue": 1,
                      "EnumValue": "0,1,2,3"
                    }
                  ]
                }
              ]
            }
          ],
          "SupportedOs": "linux",
          "AuthFlag": true
        }
      ],
      "AuthFlag": true
    }
  ]
}

Error codes

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

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

Change history

Change timeSummary of changesOperation
2024-09-27The Error code has changedView Change Details
2023-11-21The Error code has changed. The response structure of the API has changedView Change Details
2023-08-18The Error code has changed. The request parameters of the API has changedView Change Details