Documentation
¶
Index ¶
- Constants
- type AggregateResourceInfo
- type Annotation
- type Client
- func (c *Client) DescribeDiscoveredResource(request *DescribeDiscoveredResourceRequest) (response *DescribeDiscoveredResourceResponse, err error)
- func (c *Client) DescribeDiscoveredResourceWithContext(ctx context.Context, request *DescribeDiscoveredResourceRequest) (response *DescribeDiscoveredResourceResponse, err error)
- func (c *Client) ListAggregateConfigRules(request *ListAggregateConfigRulesRequest) (response *ListAggregateConfigRulesResponse, err error)
- func (c *Client) ListAggregateConfigRulesWithContext(ctx context.Context, request *ListAggregateConfigRulesRequest) (response *ListAggregateConfigRulesResponse, err error)
- func (c *Client) ListAggregateDiscoveredResources(request *ListAggregateDiscoveredResourcesRequest) (response *ListAggregateDiscoveredResourcesResponse, err error)
- func (c *Client) ListAggregateDiscoveredResourcesWithContext(ctx context.Context, request *ListAggregateDiscoveredResourcesRequest) (response *ListAggregateDiscoveredResourcesResponse, err error)
- func (c *Client) ListConfigRules(request *ListConfigRulesRequest) (response *ListConfigRulesResponse, err error)
- func (c *Client) ListConfigRulesWithContext(ctx context.Context, request *ListConfigRulesRequest) (response *ListConfigRulesResponse, err error)
- func (c *Client) ListDiscoveredResources(request *ListDiscoveredResourcesRequest) (response *ListDiscoveredResourcesResponse, err error)
- func (c *Client) ListDiscoveredResourcesWithContext(ctx context.Context, request *ListDiscoveredResourcesRequest) (response *ListDiscoveredResourcesResponse, err error)
- func (c *Client) PutEvaluations(request *PutEvaluationsRequest) (response *PutEvaluationsResponse, err error)
- func (c *Client) PutEvaluationsWithContext(ctx context.Context, request *PutEvaluationsRequest) (response *PutEvaluationsResponse, err error)
- type ConfigRule
- type DescribeDiscoveredResourceRequest
- type DescribeDiscoveredResourceRequestParams
- type DescribeDiscoveredResourceResponse
- type DescribeDiscoveredResourceResponseParams
- type Evaluation
- type Filter
- type InputParameter
- type InputParameterForManage
- type ListAggregateConfigRulesRequest
- type ListAggregateConfigRulesRequestParams
- type ListAggregateConfigRulesResponse
- type ListAggregateConfigRulesResponseParams
- type ListAggregateDiscoveredResourcesRequest
- type ListAggregateDiscoveredResourcesRequestParams
- type ListAggregateDiscoveredResourcesResponse
- type ListAggregateDiscoveredResourcesResponseParams
- type ListConfigRulesRequest
- type ListConfigRulesRequestParams
- type ListConfigRulesResponse
- type ListConfigRulesResponseParams
- type ListDiscoveredResourcesRequest
- type ListDiscoveredResourcesRequestParams
- type ListDiscoveredResourcesResponse
- type ListDiscoveredResourcesResponseParams
- type PutEvaluationsRequest
- type PutEvaluationsRequestParams
- type PutEvaluationsResponse
- type PutEvaluationsResponseParams
- type ResourceListInfo
- type SourceConditionForManage
- type Tag
- type TriggerType
Constants ¶
const ( // Internal error. INTERNALERROR = "InternalError" // Parameter error. INVALIDPARAMETER = "InvalidParameter" // Account group does not exist. RESOURCENOTFOUND_ACCOUNTGROUPISNOTEXIST = "ResourceNotFound.AccountGroupIsNotExist" // The resource does not exist. RESOURCENOTFOUND_RESOURCENOTEXIST = "ResourceNotFound.ResourceNotExist" // The rule does not exist. RESOURCENOTFOUND_RULEISNOTEXIST = "ResourceNotFound.RuleIsNotExist" )
const APIVersion = "2022-08-02"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AggregateResourceInfo ¶
type AggregateResourceInfo struct {
// Resource type
ResourceType *string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`
// Resource name
ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`
// Resource ID
ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
// Region
//
// Note: This field may return null, indicating that no valid value is found.
ResourceRegion *string `json:"ResourceRegion,omitnil,omitempty" name:"ResourceRegion"`
// Resource Status
//
// Note: This field may return null, indicating that no valid value is found.
ResourceStatus *string `json:"ResourceStatus,omitnil,omitempty" name:"ResourceStatus"`
// Whether to delete. 1: Deleted; 0: Not deleted.
// Note: This field may return null, indicating that no valid value is found.
ResourceDelete *uint64 `json:"ResourceDelete,omitnil,omitempty" name:"ResourceDelete"`
// Resource creation time
//
// Note: This field may return null, indicating that no valid value is found.
ResourceCreateTime *string `json:"ResourceCreateTime,omitnil,omitempty" name:"ResourceCreateTime"`
// Tag information
//
// Note: This field may return null, indicating that no valid value is found.
Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
// Availability zone
//
// Note: This field may return null, indicating that no valid value is found.
ResourceZone *string `json:"ResourceZone,omitnil,omitempty" name:"ResourceZone"`
// Compliance status
// Note: This field may return null, indicating that no valid value is found.
ComplianceResult *string `json:"ComplianceResult,omitnil,omitempty" name:"ComplianceResult"`
// Resource owner uid
ResourceOwnerId *uint64 `json:"ResourceOwnerId,omitnil,omitempty" name:"ResourceOwnerId"`
// User nickname
// Note: This field may return null, indicating that no valid value is found.
ResourceOwnerName *string `json:"ResourceOwnerName,omitnil,omitempty" name:"ResourceOwnerName"`
}
type Annotation ¶
type Annotation struct {
// 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.
Configuration *string `json:"Configuration,omitnil,omitempty" name:"Configuration"`
// 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.
DesiredValue *string `json:"DesiredValue,omitnil,omitempty" name:"DesiredValue"`
// 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.
Operator *string `json:"Operator,omitnil,omitempty" name:"Operator"`
// 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.
Property *string `json:"Property,omitnil,omitempty" name:"Property"`
}
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) DescribeDiscoveredResource ¶
func (c *Client) DescribeDiscoveredResource(request *DescribeDiscoveredResourceRequest) (response *DescribeDiscoveredResourceResponse, err error)
DescribeDiscoveredResource Resource details.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND_RESOURCENOTEXIST = "ResourceNotFound.ResourceNotExist"
func (*Client) DescribeDiscoveredResourceWithContext ¶
func (c *Client) DescribeDiscoveredResourceWithContext(ctx context.Context, request *DescribeDiscoveredResourceRequest) (response *DescribeDiscoveredResourceResponse, err error)
DescribeDiscoveredResource Resource details.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND_RESOURCENOTEXIST = "ResourceNotFound.ResourceNotExist"
func (*Client) ListAggregateConfigRules ¶
func (c *Client) ListAggregateConfigRules(request *ListAggregateConfigRulesRequest) (response *ListAggregateConfigRulesResponse, err error)
ListAggregateConfigRules This API is used to get the account group rule list.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND_ACCOUNTGROUPISNOTEXIST = "ResourceNotFound.AccountGroupIsNotExist"
func (*Client) ListAggregateConfigRulesWithContext ¶
func (c *Client) ListAggregateConfigRulesWithContext(ctx context.Context, request *ListAggregateConfigRulesRequest) (response *ListAggregateConfigRulesResponse, err error)
ListAggregateConfigRules This API is used to get the account group rule list.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND_ACCOUNTGROUPISNOTEXIST = "ResourceNotFound.AccountGroupIsNotExist"
func (*Client) ListAggregateDiscoveredResources ¶
func (c *Client) ListAggregateDiscoveredResources(request *ListAggregateDiscoveredResourcesRequest) (response *ListAggregateDiscoveredResourcesResponse, err error)
ListAggregateDiscoveredResources Account Group access the list of resources.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND_ACCOUNTGROUPISNOTEXIST = "ResourceNotFound.AccountGroupIsNotExist"
func (*Client) ListAggregateDiscoveredResourcesWithContext ¶
func (c *Client) ListAggregateDiscoveredResourcesWithContext(ctx context.Context, request *ListAggregateDiscoveredResourcesRequest) (response *ListAggregateDiscoveredResourcesResponse, err error)
ListAggregateDiscoveredResources Account Group access the list of resources.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND_ACCOUNTGROUPISNOTEXIST = "ResourceNotFound.AccountGroupIsNotExist"
func (*Client) ListConfigRules ¶
func (c *Client) ListConfigRules(request *ListConfigRulesRequest) (response *ListConfigRulesResponse, err error)
ListConfigRules This API is used to get the rule list.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter"
func (*Client) ListConfigRulesWithContext ¶
func (c *Client) ListConfigRulesWithContext(ctx context.Context, request *ListConfigRulesRequest) (response *ListConfigRulesResponse, err error)
ListConfigRules This API is used to get the rule list.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter"
func (*Client) ListDiscoveredResources ¶
func (c *Client) ListDiscoveredResources(request *ListDiscoveredResourcesRequest) (response *ListDiscoveredResourcesResponse, err error)
ListDiscoveredResources This API is used to get the resource list.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter"
func (*Client) ListDiscoveredResourcesWithContext ¶
func (c *Client) ListDiscoveredResourcesWithContext(ctx context.Context, request *ListDiscoveredResourcesRequest) (response *ListDiscoveredResourcesResponse, err error)
ListDiscoveredResources This API is used to get the resource list.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter"
func (*Client) PutEvaluations ¶
func (c *Client) PutEvaluations(request *PutEvaluationsRequest) (response *PutEvaluationsResponse, err error)
PutEvaluations This API is used to report custom rule evaluation results.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND_ACCOUNTGROUPISNOTEXIST = "ResourceNotFound.AccountGroupIsNotExist" RESOURCENOTFOUND_RESOURCENOTEXIST = "ResourceNotFound.ResourceNotExist" RESOURCENOTFOUND_RULEISNOTEXIST = "ResourceNotFound.RuleIsNotExist"
func (*Client) PutEvaluationsWithContext ¶
func (c *Client) PutEvaluationsWithContext(ctx context.Context, request *PutEvaluationsRequest) (response *PutEvaluationsResponse, err error)
PutEvaluations This API is used to report custom rule evaluation results.
error code that may be returned:
INVALIDPARAMETER = "InvalidParameter" RESOURCENOTFOUND_ACCOUNTGROUPISNOTEXIST = "ResourceNotFound.AccountGroupIsNotExist" RESOURCENOTFOUND_RESOURCENOTEXIST = "ResourceNotFound.ResourceNotExist" RESOURCENOTFOUND_RULEISNOTEXIST = "ResourceNotFound.RuleIsNotExist"
type ConfigRule ¶
type ConfigRule struct {
// Rule identifier
// Note: This field may return null, indicating that no valid value is found.
Identifier *string `json:"Identifier,omitnil,omitempty" name:"Identifier"`
// Name of the rule
//
// Note: This field may return null, indicating that no valid value is found.
RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`
// Rule parameters
// Note: This field may return null, indicating that no valid value is found.
InputParameter []*InputParameter `json:"InputParameter,omitnil,omitempty" name:"InputParameter"`
// Rule trigger condition.
//
// Note: This field may return null, indicating that no valid value is found.
SourceCondition []*SourceConditionForManage `json:"SourceCondition,omitnil,omitempty" name:"SourceCondition"`
// 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.
ResourceType []*string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`
// Rule ownership tag
// Note: This field may return null, indicating that no valid value is found.
Labels []*string `json:"Labels,omitnil,omitempty" name:"Labels"`
// 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.
RiskLevel *int64 `json:"RiskLevel,omitnil,omitempty" name:"RiskLevel"`
// Function corresponding to rule
// Note: This field may return null, indicating that no valid value is found.
ServiceFunction *string `json:"ServiceFunction,omitnil,omitempty" name:"ServiceFunction"`
// Creation time
//
// Format: YYYY-MM-DD h:i:s
// Note: This field may return null, indicating that no valid value is found.
CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`
// Rule description
//
// Note: This field may return null, indicating that no valid value is found.
Description *string `json:"Description,omitnil,omitempty" name:"Description"`
// ACTIVE: Enabled
// NO_ACTIVE: Disabled
// Note: This field may return null, indicating that no valid value is found.
Status *string `json:"Status,omitnil,omitempty" name:"Status"`
// Compliance: 'COMPLIANT'
// 'NON_COMPLIANT'
// 'NOT_APPLICABLE'
// Note: This field may return null, indicating that no valid value is found.
ComplianceResult *string `json:"ComplianceResult,omitnil,omitempty" name:"ComplianceResult"`
// ["",""]
// Note: This field may return null, indicating that no valid value is found.
Annotation *Annotation `json:"Annotation,omitnil,omitempty" name:"Annotation"`
// Rule evaluation time
// Format: YYYY-MM-DD h:i:s
//
// Note: This field may return null, indicating that no valid value is found.
ConfigRuleInvokedTime *string `json:"ConfigRuleInvokedTime,omitnil,omitempty" name:"ConfigRuleInvokedTime"`
// Rule ID
//
// Note: This field may return null, indicating that no valid value is found.
ConfigRuleId *string `json:"ConfigRuleId,omitnil,omitempty" name:"ConfigRuleId"`
// CUSTOMIZE
// Managed rule
// Note: This field may return null, indicating that no valid value is found.
IdentifierType *string `json:"IdentifierType,omitnil,omitempty" name:"IdentifierType"`
// Compliance package ID
// Note: This field may return null, indicating that no valid value is found.
CompliancePackId *string `json:"CompliancePackId,omitnil,omitempty" name:"CompliancePackId"`
// Trigger Type
//
// Scheduled trigger
// Triggered by configuration change
// Note: This field may return null, indicating that no valid value is found.
TriggerType []*TriggerType `json:"TriggerType,omitnil,omitempty" name:"TriggerType"`
// Parameter details
//
// Note: This field may return null, indicating that no valid value is found.
ManageInputParameter []*InputParameterForManage `json:"ManageInputParameter,omitnil,omitempty" name:"ManageInputParameter"`
// Rule name
//
// Note: This field may return null, indicating that no valid value is found.
CompliancePackName *string `json:"CompliancePackName,omitnil,omitempty" name:"CompliancePackName"`
// Associated region
// Note: This field may return null, indicating that no valid value is found.
RegionsScope []*string `json:"RegionsScope,omitnil,omitempty" name:"RegionsScope"`
// Associate Tag
//
// Note: This field may return null, indicating that no valid value is found.
TagsScope []*Tag `json:"TagsScope,omitnil,omitempty" name:"TagsScope"`
// 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.
ExcludeResourceIdsScope []*string `json:"ExcludeResourceIdsScope,omitnil,omitempty" name:"ExcludeResourceIdsScope"`
// Account group ID
//
// Note: This field may return null, indicating that no valid value is found.
AccountGroupId *string `json:"AccountGroupId,omitnil,omitempty" name:"AccountGroupId"`
// Account group name
// Note: This field may return null, indicating that no valid value is found.
AccountGroupName *string `json:"AccountGroupName,omitnil,omitempty" name:"AccountGroupName"`
// Rule owner user ID
// Note: This field may return null, indicating that no valid value is found.
RuleOwnerId *uint64 `json:"RuleOwnerId,omitnil,omitempty" name:"RuleOwnerId"`
// Trigger methods supported by preset rules
// Scheduled trigger
// Triggered by configuration change
ManageTriggerType []*string `json:"ManageTriggerType,omitnil,omitempty" name:"ManageTriggerType"`
}
type DescribeDiscoveredResourceRequest ¶
type DescribeDiscoveredResourceRequest struct {
*tchttp.BaseRequest
// Resource ID
ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
// Resource type
ResourceType *string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`
// Resource region
ResourceRegion *string `json:"ResourceRegion,omitnil,omitempty" name:"ResourceRegion"`
}
func NewDescribeDiscoveredResourceRequest ¶
func NewDescribeDiscoveredResourceRequest() (request *DescribeDiscoveredResourceRequest)
func (*DescribeDiscoveredResourceRequest) FromJsonString ¶
func (r *DescribeDiscoveredResourceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDiscoveredResourceRequest) ToJsonString ¶
func (r *DescribeDiscoveredResourceRequest) ToJsonString() string
type DescribeDiscoveredResourceRequestParams ¶
type DescribeDiscoveredResourceRequestParams struct {
// Resource ID
ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
// Resource type
ResourceType *string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`
// Resource region
ResourceRegion *string `json:"ResourceRegion,omitnil,omitempty" name:"ResourceRegion"`
}
Predefined struct for user
type DescribeDiscoveredResourceResponse ¶
type DescribeDiscoveredResourceResponse struct {
*tchttp.BaseResponse
Response *DescribeDiscoveredResourceResponseParams `json:"Response"`
}
func NewDescribeDiscoveredResourceResponse ¶
func NewDescribeDiscoveredResourceResponse() (response *DescribeDiscoveredResourceResponse)
func (*DescribeDiscoveredResourceResponse) FromJsonString ¶
func (r *DescribeDiscoveredResourceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDiscoveredResourceResponse) ToJsonString ¶
func (r *DescribeDiscoveredResourceResponse) ToJsonString() string
type DescribeDiscoveredResourceResponseParams ¶
type DescribeDiscoveredResourceResponseParams struct {
// Resource ID
//
// Note: This field may return null, indicating that no valid value is found.
ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
// Resource type
//
// Note: This field may return null, indicating that no valid value is found.
ResourceType *string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`
// Resource Name
//
// Note: This field may return null, indicating that no valid value is found.
ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`
// Resource region
//
// Note: This field may return null, indicating that no valid value is found.
ResourceRegion *string `json:"ResourceRegion,omitnil,omitempty" name:"ResourceRegion"`
// Resource availability zone
// Note: This field may return null, indicating that no valid value is found.
ResourceZone *string `json:"ResourceZone,omitnil,omitempty" name:"ResourceZone"`
// Resource configuration
//
// Note: This field may return null, indicating that no valid value is found.
Configuration *string `json:"Configuration,omitnil,omitempty" name:"Configuration"`
// Resource creation time
//
// Note: This field may return null, indicating that no valid value is found.
ResourceCreateTime *string `json:"ResourceCreateTime,omitnil,omitempty" name:"ResourceCreateTime"`
// Resource tag
//
// Note: This field may return null, indicating that no valid value is found.
Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
// Resource update time
// Note: This field may return null, indicating that no valid value is found.
UpdateTime *string `json:"UpdateTime,omitnil,omitempty" name:"UpdateTime"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type Evaluation ¶
type Evaluation struct {
// Evaluated resource id. It can contain 0 to 256 characters.
ComplianceResourceId *string `json:"ComplianceResourceId,omitnil,omitempty" name:"ComplianceResourceId"`
// 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
ComplianceResourceType *string `json:"ComplianceResourceType,omitnil,omitempty" name:"ComplianceResourceType"`
// Evaluated resource region.
// It can contain 0 to 32 characters.
ComplianceRegion *string `json:"ComplianceRegion,omitnil,omitempty" name:"ComplianceRegion"`
// Compliance type. Valid values:
// COMPLIANT: Compliant,
// NON_COMPLIANT: Non-compliant
ComplianceType *string `json:"ComplianceType,omitnil,omitempty" name:"ComplianceType"`
// Supplementary information for non-compliant resources.
Annotation *Annotation `json:"Annotation,omitnil,omitempty" name:"Annotation"`
}
type Filter ¶
type Filter struct {
// 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
Name *string `json:"Name,omitnil,omitempty" name:"Name"`
// Value of the field to query
Values []*string `json:"Values,omitnil,omitempty" name:"Values"`
}
type InputParameter ¶
type InputParameter struct {
// Parameter name
ParameterKey *string `json:"ParameterKey,omitnil,omitempty" name:"ParameterKey"`
// Parameter type. Required type: Require, optional type: Optional.
Type *string `json:"Type,omitnil,omitempty" name:"Type"`
// Parameter value
//
// Note: This field may return null, indicating that no valid value is found.
Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}
type InputParameterForManage ¶
type InputParameterForManage struct {
// Value type. Integer: Integer, String: String.
// Note: This field may return null, indicating that no valid value is found.
ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"`
// Parameter key
// Note: This field may return null, indicating that no valid value is found.
ParameterKey *string `json:"ParameterKey,omitnil,omitempty" name:"ParameterKey"`
// Parameter type. Required type: Required, Optional type: Optional.
// Note: This field may return null, indicating that no valid value is found.
Type *string `json:"Type,omitnil,omitempty" name:"Type"`
// Default value
//
// Note: This field may return null, indicating that no valid value is found.
DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`
// Description
//
// Note: This field may return null, indicating that no valid value is found.
Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}
type ListAggregateConfigRulesRequest ¶
type ListAggregateConfigRulesRequest struct {
*tchttp.BaseRequest
// Specifies the limit per page.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Offset.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Account group ID
AccountGroupId *string `json:"AccountGroupId,omitnil,omitempty" name:"AccountGroupId"`
// Sort type, descending: desc, ascending: asc.
OrderType *string `json:"OrderType,omitnil,omitempty" name:"OrderType"`
// Risk level
//
// 1: High risk.
// 2: Medium risk.
// 3: Low risk.
RiskLevel []*uint64 `json:"RiskLevel,omitnil,omitempty" name:"RiskLevel"`
// Rule status
State *string `json:"State,omitnil,omitempty" name:"State"`
// Evaluation result
ComplianceResult []*string `json:"ComplianceResult,omitnil,omitempty" name:"ComplianceResult"`
// Name of the rule
RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`
// Rule ownership account ID
RuleOwnerId *uint64 `json:"RuleOwnerId,omitnil,omitempty" name:"RuleOwnerId"`
}
func NewListAggregateConfigRulesRequest ¶
func NewListAggregateConfigRulesRequest() (request *ListAggregateConfigRulesRequest)
func (*ListAggregateConfigRulesRequest) FromJsonString ¶
func (r *ListAggregateConfigRulesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListAggregateConfigRulesRequest) ToJsonString ¶
func (r *ListAggregateConfigRulesRequest) ToJsonString() string
type ListAggregateConfigRulesRequestParams ¶
type ListAggregateConfigRulesRequestParams struct {
// Specifies the limit per page.
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Offset.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Account group ID
AccountGroupId *string `json:"AccountGroupId,omitnil,omitempty" name:"AccountGroupId"`
// Sort type, descending: desc, ascending: asc.
OrderType *string `json:"OrderType,omitnil,omitempty" name:"OrderType"`
// Risk level
//
// 1: High risk.
// 2: Medium risk.
// 3: Low risk.
RiskLevel []*uint64 `json:"RiskLevel,omitnil,omitempty" name:"RiskLevel"`
// Rule status
State *string `json:"State,omitnil,omitempty" name:"State"`
// Evaluation result
ComplianceResult []*string `json:"ComplianceResult,omitnil,omitempty" name:"ComplianceResult"`
// Name of the rule
RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`
// Rule ownership account ID
RuleOwnerId *uint64 `json:"RuleOwnerId,omitnil,omitempty" name:"RuleOwnerId"`
}
Predefined struct for user
type ListAggregateConfigRulesResponse ¶
type ListAggregateConfigRulesResponse struct {
*tchttp.BaseResponse
Response *ListAggregateConfigRulesResponseParams `json:"Response"`
}
func NewListAggregateConfigRulesResponse ¶
func NewListAggregateConfigRulesResponse() (response *ListAggregateConfigRulesResponse)
func (*ListAggregateConfigRulesResponse) FromJsonString ¶
func (r *ListAggregateConfigRulesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListAggregateConfigRulesResponse) ToJsonString ¶
func (r *ListAggregateConfigRulesResponse) ToJsonString() string
type ListAggregateConfigRulesResponseParams ¶
type ListAggregateConfigRulesResponseParams struct {
// Total number
Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`
// Details
Items []*ConfigRule `json:"Items,omitnil,omitempty" name:"Items"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ListAggregateDiscoveredResourcesRequest ¶
type ListAggregateDiscoveredResourcesRequest struct {
*tchttp.BaseRequest
// Items per Page
MaxResults *uint64 `json:"MaxResults,omitnil,omitempty" name:"MaxResults"`
// Account group ID
AccountGroupId *string `json:"AccountGroupId,omitnil,omitempty" name:"AccountGroupId"`
// resourceName: Resource name; resourceId: Resource ID; resourceType: Resource type
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// <Tag>
Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
// Next page token.
NextToken *string `json:"NextToken,omitnil,omitempty" name:"NextToken"`
// Sorting method asc, desc
OrderType *string `json:"OrderType,omitnil,omitempty" name:"OrderType"`
}
func NewListAggregateDiscoveredResourcesRequest ¶
func NewListAggregateDiscoveredResourcesRequest() (request *ListAggregateDiscoveredResourcesRequest)
func (*ListAggregateDiscoveredResourcesRequest) FromJsonString ¶
func (r *ListAggregateDiscoveredResourcesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListAggregateDiscoveredResourcesRequest) ToJsonString ¶
func (r *ListAggregateDiscoveredResourcesRequest) ToJsonString() string
type ListAggregateDiscoveredResourcesRequestParams ¶
type ListAggregateDiscoveredResourcesRequestParams struct {
// Items per Page
MaxResults *uint64 `json:"MaxResults,omitnil,omitempty" name:"MaxResults"`
// Account group ID
AccountGroupId *string `json:"AccountGroupId,omitnil,omitempty" name:"AccountGroupId"`
// resourceName: Resource name; resourceId: Resource ID; resourceType: Resource type
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// <Tag>
Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
// Next page token.
NextToken *string `json:"NextToken,omitnil,omitempty" name:"NextToken"`
// Sorting method asc, desc
OrderType *string `json:"OrderType,omitnil,omitempty" name:"OrderType"`
}
Predefined struct for user
type ListAggregateDiscoveredResourcesResponse ¶
type ListAggregateDiscoveredResourcesResponse struct {
*tchttp.BaseResponse
Response *ListAggregateDiscoveredResourcesResponseParams `json:"Response"`
}
func NewListAggregateDiscoveredResourcesResponse ¶
func NewListAggregateDiscoveredResourcesResponse() (response *ListAggregateDiscoveredResourcesResponse)
func (*ListAggregateDiscoveredResourcesResponse) FromJsonString ¶
func (r *ListAggregateDiscoveredResourcesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListAggregateDiscoveredResourcesResponse) ToJsonString ¶
func (r *ListAggregateDiscoveredResourcesResponse) ToJsonString() string
type ListAggregateDiscoveredResourcesResponseParams ¶
type ListAggregateDiscoveredResourcesResponseParams struct {
// Details.
Items []*AggregateResourceInfo `json:"Items,omitnil,omitempty" name:"Items"`
// next page
// Note: This field may return null, indicating that no valid value is found.
NextToken *string `json:"NextToken,omitnil,omitempty" name:"NextToken"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ListConfigRulesRequest ¶
type ListConfigRulesRequest struct {
*tchttp.BaseRequest
// Page limit
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Offset.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Sort type. Descending: desc, Ascending: asc.
OrderType *string `json:"OrderType,omitnil,omitempty" name:"OrderType"`
// Risk level
//
// 1: High risk.
// 2: Medium risk.
// 3: Low risk.
RiskLevel []*uint64 `json:"RiskLevel,omitnil,omitempty" name:"RiskLevel"`
// Rule status
State *string `json:"State,omitnil,omitempty" name:"State"`
// Evaluation result
ComplianceResult []*string `json:"ComplianceResult,omitnil,omitempty" name:"ComplianceResult"`
// Name of the rule
RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`
}
func NewListConfigRulesRequest ¶
func NewListConfigRulesRequest() (request *ListConfigRulesRequest)
func (*ListConfigRulesRequest) FromJsonString ¶
func (r *ListConfigRulesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListConfigRulesRequest) ToJsonString ¶
func (r *ListConfigRulesRequest) ToJsonString() string
type ListConfigRulesRequestParams ¶
type ListConfigRulesRequestParams struct {
// Page limit
Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
// Offset.
Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`
// Sort type. Descending: desc, Ascending: asc.
OrderType *string `json:"OrderType,omitnil,omitempty" name:"OrderType"`
// Risk level
//
// 1: High risk.
// 2: Medium risk.
// 3: Low risk.
RiskLevel []*uint64 `json:"RiskLevel,omitnil,omitempty" name:"RiskLevel"`
// Rule status
State *string `json:"State,omitnil,omitempty" name:"State"`
// Evaluation result
ComplianceResult []*string `json:"ComplianceResult,omitnil,omitempty" name:"ComplianceResult"`
// Name of the rule
RuleName *string `json:"RuleName,omitnil,omitempty" name:"RuleName"`
}
Predefined struct for user
type ListConfigRulesResponse ¶
type ListConfigRulesResponse struct {
*tchttp.BaseResponse
Response *ListConfigRulesResponseParams `json:"Response"`
}
func NewListConfigRulesResponse ¶
func NewListConfigRulesResponse() (response *ListConfigRulesResponse)
func (*ListConfigRulesResponse) FromJsonString ¶
func (r *ListConfigRulesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListConfigRulesResponse) ToJsonString ¶
func (r *ListConfigRulesResponse) ToJsonString() string
type ListConfigRulesResponseParams ¶
type ListConfigRulesResponseParams struct {
// Total number
Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`
// Details
Items []*ConfigRule `json:"Items,omitnil,omitempty" name:"Items"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ListDiscoveredResourcesRequest ¶
type ListDiscoveredResourcesRequest struct {
*tchttp.BaseRequest
// Items per Page
MaxResults *uint64 `json:"MaxResults,omitnil,omitempty" name:"MaxResults"`
// resourceName: Resource name resourceId: Resource ID
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Tag
Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
// Next page token.
NextToken *string `json:"NextToken,omitnil,omitempty" name:"NextToken"`
// Sorting method asc, desc
OrderType *string `json:"OrderType,omitnil,omitempty" name:"OrderType"`
}
func NewListDiscoveredResourcesRequest ¶
func NewListDiscoveredResourcesRequest() (request *ListDiscoveredResourcesRequest)
func (*ListDiscoveredResourcesRequest) FromJsonString ¶
func (r *ListDiscoveredResourcesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListDiscoveredResourcesRequest) ToJsonString ¶
func (r *ListDiscoveredResourcesRequest) ToJsonString() string
type ListDiscoveredResourcesRequestParams ¶
type ListDiscoveredResourcesRequestParams struct {
// Items per Page
MaxResults *uint64 `json:"MaxResults,omitnil,omitempty" name:"MaxResults"`
// resourceName: Resource name resourceId: Resource ID
Filters []*Filter `json:"Filters,omitnil,omitempty" name:"Filters"`
// Tag
Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
// Next page token.
NextToken *string `json:"NextToken,omitnil,omitempty" name:"NextToken"`
// Sorting method asc, desc
OrderType *string `json:"OrderType,omitnil,omitempty" name:"OrderType"`
}
Predefined struct for user
type ListDiscoveredResourcesResponse ¶
type ListDiscoveredResourcesResponse struct {
*tchttp.BaseResponse
Response *ListDiscoveredResourcesResponseParams `json:"Response"`
}
func NewListDiscoveredResourcesResponse ¶
func NewListDiscoveredResourcesResponse() (response *ListDiscoveredResourcesResponse)
func (*ListDiscoveredResourcesResponse) FromJsonString ¶
func (r *ListDiscoveredResourcesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListDiscoveredResourcesResponse) ToJsonString ¶
func (r *ListDiscoveredResourcesResponse) ToJsonString() string
type ListDiscoveredResourcesResponseParams ¶
type ListDiscoveredResourcesResponseParams struct {
// Details
Items []*ResourceListInfo `json:"Items,omitnil,omitempty" name:"Items"`
// Next page
// Note: This field may return null, indicating that no valid value is found.
NextToken *string `json:"NextToken,omitnil,omitempty" name:"NextToken"`
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type PutEvaluationsRequest ¶
type PutEvaluationsRequest struct {
*tchttp.BaseRequest
// Callback token. Obtained from the ResultToken value in the Context of the selected Serverless Cloud Function (SCF) for the custom rule.
ResultToken *string `json:"ResultToken,omitnil,omitempty" name:"ResultToken"`
// Custom rule evaluation result information.
Evaluations []*Evaluation `json:"Evaluations,omitnil,omitempty" name:"Evaluations"`
}
func NewPutEvaluationsRequest ¶
func NewPutEvaluationsRequest() (request *PutEvaluationsRequest)
func (*PutEvaluationsRequest) FromJsonString ¶
func (r *PutEvaluationsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PutEvaluationsRequest) ToJsonString ¶
func (r *PutEvaluationsRequest) ToJsonString() string
type PutEvaluationsRequestParams ¶
type PutEvaluationsRequestParams struct {
// Callback token. Obtained from the ResultToken value in the Context of the selected Serverless Cloud Function (SCF) for the custom rule.
ResultToken *string `json:"ResultToken,omitnil,omitempty" name:"ResultToken"`
// Custom rule evaluation result information.
Evaluations []*Evaluation `json:"Evaluations,omitnil,omitempty" name:"Evaluations"`
}
Predefined struct for user
type PutEvaluationsResponse ¶
type PutEvaluationsResponse struct {
*tchttp.BaseResponse
Response *PutEvaluationsResponseParams `json:"Response"`
}
func NewPutEvaluationsResponse ¶
func NewPutEvaluationsResponse() (response *PutEvaluationsResponse)
func (*PutEvaluationsResponse) FromJsonString ¶
func (r *PutEvaluationsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*PutEvaluationsResponse) ToJsonString ¶
func (r *PutEvaluationsResponse) ToJsonString() string
type PutEvaluationsResponseParams ¶
type PutEvaluationsResponseParams struct {
// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}
Predefined struct for user
type ResourceListInfo ¶
type ResourceListInfo struct {
// Resource type
ResourceType *string `json:"ResourceType,omitnil,omitempty" name:"ResourceType"`
// Resource name
ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`
// Resource ID
ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
// Region
//
// Note: This field may return null, indicating that no valid value is found.
ResourceRegion *string `json:"ResourceRegion,omitnil,omitempty" name:"ResourceRegion"`
// Resource Status
//
// Note: This field may return null, indicating that no valid value is found.
ResourceStatus *string `json:"ResourceStatus,omitnil,omitempty" name:"ResourceStatus"`
// 1: Deleted. 2: Not deleted.
// Note: This field may return null, indicating that no valid value is found.
ResourceDelete *uint64 `json:"ResourceDelete,omitnil,omitempty" name:"ResourceDelete"`
// Resource creation time
//
// Note: This field may return null, indicating that no valid value is found.
ResourceCreateTime *string `json:"ResourceCreateTime,omitnil,omitempty" name:"ResourceCreateTime"`
// Tag information
//
// Note: This field may return null, indicating that no valid value is found.
Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
// Availability zone
//
// Note: This field may return null, indicating that no valid value is found.
ResourceZone *string `json:"ResourceZone,omitnil,omitempty" name:"ResourceZone"`
// Compliance status.
// Note: This field may return null, indicating that no valid value is found.
ComplianceResult *string `json:"ComplianceResult,omitnil,omitempty" name:"ComplianceResult"`
}
type SourceConditionForManage ¶
type SourceConditionForManage struct {
// 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.
EmptyAs *string `json:"EmptyAs,omitnil,omitempty" name:"EmptyAs"`
// Configuration path
//
// Note: This field may return null, indicating that no valid value is found.
SelectPath *string `json:"SelectPath,omitnil,omitempty" name:"SelectPath"`
// Operators
// Note: This field may return null, indicating that no valid value is found.
Operator *string `json:"Operator,omitnil,omitempty" name:"Operator"`
// Required or not.
//
// Note: This field may return null, indicating that no valid value is found.
Required *bool `json:"Required,omitnil,omitempty" name:"Required"`
// Expected value
// Note: This field may return null, indicating that no valid value is found.
DesiredValue *string `json:"DesiredValue,omitnil,omitempty" name:"DesiredValue"`
}
type Tag ¶
type Tag struct {
// Tag key
//
// Note: This field may return null, indicating that no valid value is found.
TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`
// Tag value
//
// Note: This field may return null, indicating that no valid value is found.
TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}
type TriggerType ¶
type TriggerType struct {
// Trigger Type
MessageType *string `json:"MessageType,omitnil,omitempty" name:"MessageType"`
// Trigger time period
// Note: This field may return null, indicating that no valid value is found.
MaximumExecutionFrequency *string `json:"MaximumExecutionFrequency,omitnil,omitempty" name:"MaximumExecutionFrequency"`
}