tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Config
    Documentation
    Download PDF

    Data Types

    Last updated: 2024-12-02 15:06:14
    Download PDF

    Annotation

    Compliance details

    Used by actions: ListAggregateConfigRules, ListConfigRules, PutEvaluations.

    Name Type Required Description
    Configuration String Yes Current actual configuration of the resource. It can contain 0 to 256 characters, which is the non-compliant configuration of the resource.
    Note: This field may return null, indicating that no valid value is found.
    DesiredValue String Yes Desired configuration of the resource. It can contain 0 to 256 characters, which is the compliant configuration of the resource.
    Note: This field may return null, indicating that no valid value is found.
    Operator String No Comparison operator between current and desired configuration of the resource. Length is 0-16 characters. This field may be empty when custom rule reporting evaluation result.
    Property String No JSON path of current configuration in resource attribute structure. Length is 0-256 characters. This field may be empty when custom rule reporting evaluation result.

    ConfigRule

    Rule details

    Used by actions: ListAggregateConfigRules, ListConfigRules.

    Name Type Description
    Identifier String Rule identifier
    Note: This field may return null, indicating that no valid value is found.
    RuleName String Name of the rule

    Note: This field may return null, indicating that no valid value is found.
    InputParameter Array of InputParameter Rule parameters
    Note: This field may return null, indicating that no valid value is found.
    SourceCondition Array of SourceConditionForManage Rule trigger condition.

    Note: This field may return null, indicating that no valid value is found.
    ResourceType Array of String Resource types supported by rule. The rule only applies to specified resource types.
    Note: This field may return null, indicating that no valid value is found.
    Labels Array of String Rule ownership tag
    Note: This field may return null, indicating that no valid value is found.
    RiskLevel Integer Rule risk level
    1: Low risk
    2: Medium risk
    3: High risk
    Note: This field may return null, indicating that no valid value is found.
    ServiceFunction String Function corresponding to rule
    Note: This field may return null, indicating that no valid value is found.
    CreateTime String Creation time

    Format: YYYY-MM-DD h:i:s
    Note: This field may return null, indicating that no valid value is found.
    Description String Rule description

    Note: This field may return null, indicating that no valid value is found.
    Status String ACTIVE: Enabled
    NO_ACTIVE: Disabled
    Note: This field may return null, indicating that no valid value is found.
    ComplianceResult String Compliance: 'COMPLIANT'
    'NON_COMPLIANT'
    'NOT_APPLICABLE'
    Note: This field may return null, indicating that no valid value is found.
    Annotation Annotation ["",""]
    Note: This field may return null, indicating that no valid value is found.
    ConfigRuleInvokedTime String Rule evaluation time
    Format: YYYY-MM-DD h:i:s

    Note: This field may return null, indicating that no valid value is found.
    ConfigRuleId String Rule ID

    Note: This field may return null, indicating that no valid value is found.
    IdentifierType String CUSTOMIZE
    Managed rule
    Note: This field may return null, indicating that no valid value is found.
    CompliancePackId String Compliance package ID
    Note: This field may return null, indicating that no valid value is found.
    TriggerType Array of TriggerType Trigger Type

    Scheduled trigger
    Triggered by configuration change
    Note: This field may return null, indicating that no valid value is found.
    ManageInputParameter Array of InputParameterForManage Parameter details

    Note: This field may return null, indicating that no valid value is found.
    CompliancePackName String Rule name

    Note: This field may return null, indicating that no valid value is found.
    RegionsScope Array of String Associated region
    Note: This field may return null, indicating that no valid value is found.
    TagsScope Array of Tag Associate Tag

    Note: This field may return null, indicating that no valid value is found.
    ExcludeResourceIdsScope Array of String The rule is invalid for the specified resource ID, meaning it does not evaluate the resource.
    Note: This field may return null, indicating that no valid value is found.
    AccountGroupId String Account group ID

    Note: This field may return null, indicating that no valid value is found.
    AccountGroupName String Account group name
    Note: This field may return null, indicating that no valid value is found.
    RuleOwnerId Integer Rule owner user ID
    Note: This field may return null, indicating that no valid value is found.
    ManageTriggerType Array of String Trigger methods supported by preset rules
    Scheduled trigger
    Triggered by configuration change

    Evaluation

    Custom rule evaluation result

    Used by actions: PutEvaluations.

    Name Type Required Description
    ComplianceResourceId String Yes Evaluated resource id. It can contain 0 to 256 characters.
    ComplianceResourceType String Yes Evaluated resource type.
    Supported:
    QCS::CVM::Instance、 QCS::CBS::Disk、QCS::VPC::Vpc、QCS::VPC::Subnet、QCS::VPC::SecurityGroup、 QCS::CAM::User、QCS::CAM::Group、QCS::CAM::Policy、QCS::CAM::Role、QCS::COS::Bucket
    ComplianceRegion String Yes Evaluated resource region.
    It can contain 0 to 32 characters.
    ComplianceType String Yes Compliance type. Valid values:
    COMPLIANT: Compliant,
    NON_COMPLIANT: Non-compliant
    Annotation Annotation No Supplementary information for non-compliant resources.

    Filter

    Resource list filter

    Used by actions: ListDiscoveredResources.

    Name Type Required Description
    Name String No Query field name Resource name: resourceName Resource ID: resourceId Resource type: resourceType Resource region: resourceRegion Deletion status: resourceDelete 0 not deleted, 1 deleted resourceregionandzone region/az
    Values Array of String No Value of the field to query

    InputParameter

    Parameter value

    Used by actions: ListAggregateConfigRules, ListConfigRules.

    Name Type Required Description
    ParameterKey String Yes Parameter name
    Type String No Parameter type. Required type: Require, optional type: Optional.
    Value String No Parameter value

    Note: This field may return null, indicating that no valid value is found.

    InputParameterForManage

    Rule input parameters

    Used by actions: ListAggregateConfigRules, ListConfigRules.

    Name Type Required Description
    ValueType String No Value type. Integer: Integer, String: String.
    Note: This field may return null, indicating that no valid value is found.
    ParameterKey String No Parameter key
    Note: This field may return null, indicating that no valid value is found.
    Type String No Parameter type. Required type: Required, Optional type: Optional.
    Note: This field may return null, indicating that no valid value is found.
    DefaultValue String No Default value

    Note: This field may return null, indicating that no valid value is found.
    Description String No Description

    Note: This field may return null, indicating that no valid value is found.

    ResourceListInfo

    Resource list information response parameters structure

    Used by actions: ListDiscoveredResources.

    Name Type Description
    ResourceType String Resource type
    ResourceName String Resource name
    ResourceId String Resource ID
    ResourceRegion String Region

    Note: This field may return null, indicating that no valid value is found.
    ResourceStatus String Resource Status

    Note: This field may return null, indicating that no valid value is found.
    ResourceDelete Integer 1: Deleted. 2: Not deleted.
    Note: This field may return null, indicating that no valid value is found.
    ResourceCreateTime String Resource creation time

    Note: This field may return null, indicating that no valid value is found.
    Tags Array of Tag Tag information

    Note: This field may return null, indicating that no valid value is found.
    ResourceZone String Availability zone

    Note: This field may return null, indicating that no valid value is found.
    ComplianceResult String Compliance status.
    Note: This field may return null, indicating that no valid value is found.

    SourceConditionForManage

    Managing end rule conditions

    Used by actions: ListAggregateConfigRules, ListConfigRules.

    Name Type Required Description
    EmptyAs String No Condition is empty, Compliant: COMPLIANT, Non-compliant: NON_COMPLIANT, Not applicable: NOT_APPLICABLE.
    Note: This field may return null, indicating that no valid value is found.
    SelectPath String No Configuration path

    Note: This field may return null, indicating that no valid value is found.
    Operator String No Operators
    Note: This field may return null, indicating that no valid value is found.
    Required Boolean No Required or not.

    Note: This field may return null, indicating that no valid value is found.
    DesiredValue String No Expected value
    Note: This field may return null, indicating that no valid value is found.

    Tag

    Tag

    Used by actions: DescribeDiscoveredResource, ListAggregateConfigRules, ListConfigRules, ListDiscoveredResources.

    Name Type Required Description
    TagKey String No Tag key

    Note: This field may return null, indicating that no valid value is found.
    TagValue String No Tag value

    Note: This field may return null, indicating that no valid value is found.

    TriggerType

    Rule supports trigger type

    Used by actions: ListAggregateConfigRules, ListConfigRules.

    Name Type Required Description
    MessageType String Yes Trigger Type
    MaximumExecutionFrequency String No Trigger time period
    Note: This field may return null, indicating that no valid value is found.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy