All Products
Search

This Product

    Cloud Config:PutEvaluations

    Document Center

    Cloud Config:PutEvaluations

    Last Updated:Jun 21, 2024

    Submits the evaluation results of a rule from Function Compute.

    Operation description

    For more information about the definition, use scenarios, and execution of custom function rules, see Definition and execution of custom function rules.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    EvaluationsstringNo

    The evaluation results.

    		[{"accountId":120886317861****,"annotation":"The flow log is not enabled.","complianceResourceId":"flowlog-o6wdfo1yvgo4i8****","complianceResourceType":"ACS::CEN::Flowlog","complianceRegionId":"cn-shanghai","complianceType":"NON_COMPLIANT","orderingTimestamp":1588907220408}]
    DeleteModebooleanNo

    Specifies whether to enable the delete mode. Valid values:

    • true: enables the delete mode
    • false (default): disables the delete mode
    Note This parameter is valid only when you manually trigger or periodically trigger custom rules to evaluate resources. If you enable the delete mode, the evaluation results that are not updated during the current evaluation are automatically deleted.
    		false
    ResultTokenstringYes

    The callback token. When Cloud Config triggers a custom rule to evaluate resources, the token information is sent to Function Compute as an input parameter. The token must be specified when you submit the evaluation results.

    		=lAUbfkWp7GL9AFoQEIStinqBMc4FC8sHvip/1F1npkWUDNS2GEm6xwL6Zl/fSr0bbkWY+aiCLjTJxnp4H/yp/8p/Q8VCAtqG5uhRii4sfnYRnTPnE****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		EDB324E2-A202-5FE4-A9BC-31E2C34F78A4
    Resultboolean

    Indicates whether the evaluation results of the custom rule are submitted. Valid values:

    • true: The evaluation results are submitted.
    • false: The evaluation results fail to be submitted.
    		true

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "EDB324E2-A202-5FE4-A9BC-31E2C34F78A4",
  "Result": true
}

    Error codes

    HTTP status codeError codeError messageDescription
    400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
    404AccountNotExistedYour account does not exist.The specified account does not exist.
    503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

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