Documentation ¶
Index ¶
- Constants
- type AlarmInfo
- type AlarmNotice
- type AlarmTarget
- type AlarmTargetInfo
- type AnalysisDimensional
- type ApplyConfigToMachineGroupRequest
- type ApplyConfigToMachineGroupResponse
- type CallBackInfo
- type Ckafka
- type Client
- func (c *Client) ApplyConfigToMachineGroup(request *ApplyConfigToMachineGroupRequest) (response *ApplyConfigToMachineGroupResponse, err error)
- func (c *Client) ApplyConfigToMachineGroupWithContext(ctx context.Context, request *ApplyConfigToMachineGroupRequest) (response *ApplyConfigToMachineGroupResponse, err error)
- func (c *Client) CloseKafkaConsumer(request *CloseKafkaConsumerRequest) (response *CloseKafkaConsumerResponse, err error)
- func (c *Client) CloseKafkaConsumerWithContext(ctx context.Context, request *CloseKafkaConsumerRequest) (response *CloseKafkaConsumerResponse, err error)
- func (c *Client) CreateAlarm(request *CreateAlarmRequest) (response *CreateAlarmResponse, err error)
- func (c *Client) CreateAlarmNotice(request *CreateAlarmNoticeRequest) (response *CreateAlarmNoticeResponse, err error)
- func (c *Client) CreateAlarmNoticeWithContext(ctx context.Context, request *CreateAlarmNoticeRequest) (response *CreateAlarmNoticeResponse, err error)
- func (c *Client) CreateAlarmWithContext(ctx context.Context, request *CreateAlarmRequest) (response *CreateAlarmResponse, err error)
- func (c *Client) CreateConfig(request *CreateConfigRequest) (response *CreateConfigResponse, err error)
- func (c *Client) CreateConfigWithContext(ctx context.Context, request *CreateConfigRequest) (response *CreateConfigResponse, err error)
- func (c *Client) CreateConsumer(request *CreateConsumerRequest) (response *CreateConsumerResponse, err error)
- func (c *Client) CreateConsumerWithContext(ctx context.Context, request *CreateConsumerRequest) (response *CreateConsumerResponse, err error)
- func (c *Client) CreateExport(request *CreateExportRequest) (response *CreateExportResponse, err error)
- func (c *Client) CreateExportWithContext(ctx context.Context, request *CreateExportRequest) (response *CreateExportResponse, err error)
- func (c *Client) CreateIndex(request *CreateIndexRequest) (response *CreateIndexResponse, err error)
- func (c *Client) CreateIndexWithContext(ctx context.Context, request *CreateIndexRequest) (response *CreateIndexResponse, err error)
- func (c *Client) CreateLogset(request *CreateLogsetRequest) (response *CreateLogsetResponse, err error)
- func (c *Client) CreateLogsetWithContext(ctx context.Context, request *CreateLogsetRequest) (response *CreateLogsetResponse, err error)
- func (c *Client) CreateMachineGroup(request *CreateMachineGroupRequest) (response *CreateMachineGroupResponse, err error)
- func (c *Client) CreateMachineGroupWithContext(ctx context.Context, request *CreateMachineGroupRequest) (response *CreateMachineGroupResponse, err error)
- func (c *Client) CreateShipper(request *CreateShipperRequest) (response *CreateShipperResponse, err error)
- func (c *Client) CreateShipperWithContext(ctx context.Context, request *CreateShipperRequest) (response *CreateShipperResponse, err error)
- func (c *Client) CreateTopic(request *CreateTopicRequest) (response *CreateTopicResponse, err error)
- func (c *Client) CreateTopicWithContext(ctx context.Context, request *CreateTopicRequest) (response *CreateTopicResponse, err error)
- func (c *Client) DeleteAlarm(request *DeleteAlarmRequest) (response *DeleteAlarmResponse, err error)
- func (c *Client) DeleteAlarmNotice(request *DeleteAlarmNoticeRequest) (response *DeleteAlarmNoticeResponse, err error)
- func (c *Client) DeleteAlarmNoticeWithContext(ctx context.Context, request *DeleteAlarmNoticeRequest) (response *DeleteAlarmNoticeResponse, err error)
- func (c *Client) DeleteAlarmWithContext(ctx context.Context, request *DeleteAlarmRequest) (response *DeleteAlarmResponse, err error)
- func (c *Client) DeleteConfig(request *DeleteConfigRequest) (response *DeleteConfigResponse, err error)
- func (c *Client) DeleteConfigFromMachineGroup(request *DeleteConfigFromMachineGroupRequest) (response *DeleteConfigFromMachineGroupResponse, err error)
- func (c *Client) DeleteConfigFromMachineGroupWithContext(ctx context.Context, request *DeleteConfigFromMachineGroupRequest) (response *DeleteConfigFromMachineGroupResponse, err error)
- func (c *Client) DeleteConfigWithContext(ctx context.Context, request *DeleteConfigRequest) (response *DeleteConfigResponse, err error)
- func (c *Client) DeleteConsumer(request *DeleteConsumerRequest) (response *DeleteConsumerResponse, err error)
- func (c *Client) DeleteConsumerWithContext(ctx context.Context, request *DeleteConsumerRequest) (response *DeleteConsumerResponse, err error)
- func (c *Client) DeleteExport(request *DeleteExportRequest) (response *DeleteExportResponse, err error)
- func (c *Client) DeleteExportWithContext(ctx context.Context, request *DeleteExportRequest) (response *DeleteExportResponse, err error)
- func (c *Client) DeleteIndex(request *DeleteIndexRequest) (response *DeleteIndexResponse, err error)
- func (c *Client) DeleteIndexWithContext(ctx context.Context, request *DeleteIndexRequest) (response *DeleteIndexResponse, err error)
- func (c *Client) DeleteLogset(request *DeleteLogsetRequest) (response *DeleteLogsetResponse, err error)
- func (c *Client) DeleteLogsetWithContext(ctx context.Context, request *DeleteLogsetRequest) (response *DeleteLogsetResponse, err error)
- func (c *Client) DeleteMachineGroup(request *DeleteMachineGroupRequest) (response *DeleteMachineGroupResponse, err error)
- func (c *Client) DeleteMachineGroupWithContext(ctx context.Context, request *DeleteMachineGroupRequest) (response *DeleteMachineGroupResponse, err error)
- func (c *Client) DeleteShipper(request *DeleteShipperRequest) (response *DeleteShipperResponse, err error)
- func (c *Client) DeleteShipperWithContext(ctx context.Context, request *DeleteShipperRequest) (response *DeleteShipperResponse, err error)
- func (c *Client) DeleteTopic(request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
- func (c *Client) DeleteTopicWithContext(ctx context.Context, request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
- func (c *Client) DescribeAlarmNotices(request *DescribeAlarmNoticesRequest) (response *DescribeAlarmNoticesResponse, err error)
- func (c *Client) DescribeAlarmNoticesWithContext(ctx context.Context, request *DescribeAlarmNoticesRequest) (response *DescribeAlarmNoticesResponse, err error)
- func (c *Client) DescribeAlarms(request *DescribeAlarmsRequest) (response *DescribeAlarmsResponse, err error)
- func (c *Client) DescribeAlarmsWithContext(ctx context.Context, request *DescribeAlarmsRequest) (response *DescribeAlarmsResponse, err error)
- func (c *Client) DescribeConfigMachineGroups(request *DescribeConfigMachineGroupsRequest) (response *DescribeConfigMachineGroupsResponse, err error)
- func (c *Client) DescribeConfigMachineGroupsWithContext(ctx context.Context, request *DescribeConfigMachineGroupsRequest) (response *DescribeConfigMachineGroupsResponse, err error)
- func (c *Client) DescribeConfigs(request *DescribeConfigsRequest) (response *DescribeConfigsResponse, err error)
- func (c *Client) DescribeConfigsWithContext(ctx context.Context, request *DescribeConfigsRequest) (response *DescribeConfigsResponse, err error)
- func (c *Client) DescribeConsumer(request *DescribeConsumerRequest) (response *DescribeConsumerResponse, err error)
- func (c *Client) DescribeConsumerWithContext(ctx context.Context, request *DescribeConsumerRequest) (response *DescribeConsumerResponse, err error)
- func (c *Client) DescribeExports(request *DescribeExportsRequest) (response *DescribeExportsResponse, err error)
- func (c *Client) DescribeExportsWithContext(ctx context.Context, request *DescribeExportsRequest) (response *DescribeExportsResponse, err error)
- func (c *Client) DescribeIndex(request *DescribeIndexRequest) (response *DescribeIndexResponse, err error)
- func (c *Client) DescribeIndexWithContext(ctx context.Context, request *DescribeIndexRequest) (response *DescribeIndexResponse, err error)
- func (c *Client) DescribeLogContext(request *DescribeLogContextRequest) (response *DescribeLogContextResponse, err error)
- func (c *Client) DescribeLogContextWithContext(ctx context.Context, request *DescribeLogContextRequest) (response *DescribeLogContextResponse, err error)
- func (c *Client) DescribeLogHistogram(request *DescribeLogHistogramRequest) (response *DescribeLogHistogramResponse, err error)
- func (c *Client) DescribeLogHistogramWithContext(ctx context.Context, request *DescribeLogHistogramRequest) (response *DescribeLogHistogramResponse, err error)
- func (c *Client) DescribeLogsets(request *DescribeLogsetsRequest) (response *DescribeLogsetsResponse, err error)
- func (c *Client) DescribeLogsetsWithContext(ctx context.Context, request *DescribeLogsetsRequest) (response *DescribeLogsetsResponse, err error)
- func (c *Client) DescribeMachineGroupConfigs(request *DescribeMachineGroupConfigsRequest) (response *DescribeMachineGroupConfigsResponse, err error)
- func (c *Client) DescribeMachineGroupConfigsWithContext(ctx context.Context, request *DescribeMachineGroupConfigsRequest) (response *DescribeMachineGroupConfigsResponse, err error)
- func (c *Client) DescribeMachineGroups(request *DescribeMachineGroupsRequest) (response *DescribeMachineGroupsResponse, err error)
- func (c *Client) DescribeMachineGroupsWithContext(ctx context.Context, request *DescribeMachineGroupsRequest) (response *DescribeMachineGroupsResponse, err error)
- func (c *Client) DescribeMachines(request *DescribeMachinesRequest) (response *DescribeMachinesResponse, err error)
- func (c *Client) DescribeMachinesWithContext(ctx context.Context, request *DescribeMachinesRequest) (response *DescribeMachinesResponse, err error)
- func (c *Client) DescribePartitions(request *DescribePartitionsRequest) (response *DescribePartitionsResponse, err error)
- func (c *Client) DescribePartitionsWithContext(ctx context.Context, request *DescribePartitionsRequest) (response *DescribePartitionsResponse, err error)
- func (c *Client) DescribeShipperTasks(request *DescribeShipperTasksRequest) (response *DescribeShipperTasksResponse, err error)
- func (c *Client) DescribeShipperTasksWithContext(ctx context.Context, request *DescribeShipperTasksRequest) (response *DescribeShipperTasksResponse, err error)
- func (c *Client) DescribeShippers(request *DescribeShippersRequest) (response *DescribeShippersResponse, err error)
- func (c *Client) DescribeShippersWithContext(ctx context.Context, request *DescribeShippersRequest) (response *DescribeShippersResponse, err error)
- func (c *Client) DescribeTopics(request *DescribeTopicsRequest) (response *DescribeTopicsResponse, err error)
- func (c *Client) DescribeTopicsWithContext(ctx context.Context, request *DescribeTopicsRequest) (response *DescribeTopicsResponse, err error)
- func (c *Client) GetAlarmLog(request *GetAlarmLogRequest) (response *GetAlarmLogResponse, err error)
- func (c *Client) GetAlarmLogWithContext(ctx context.Context, request *GetAlarmLogRequest) (response *GetAlarmLogResponse, err error)
- func (c *Client) MergePartition(request *MergePartitionRequest) (response *MergePartitionResponse, err error)
- func (c *Client) MergePartitionWithContext(ctx context.Context, request *MergePartitionRequest) (response *MergePartitionResponse, err error)
- func (c *Client) ModifyAlarm(request *ModifyAlarmRequest) (response *ModifyAlarmResponse, err error)
- func (c *Client) ModifyAlarmNotice(request *ModifyAlarmNoticeRequest) (response *ModifyAlarmNoticeResponse, err error)
- func (c *Client) ModifyAlarmNoticeWithContext(ctx context.Context, request *ModifyAlarmNoticeRequest) (response *ModifyAlarmNoticeResponse, err error)
- func (c *Client) ModifyAlarmWithContext(ctx context.Context, request *ModifyAlarmRequest) (response *ModifyAlarmResponse, err error)
- func (c *Client) ModifyConfig(request *ModifyConfigRequest) (response *ModifyConfigResponse, err error)
- func (c *Client) ModifyConfigWithContext(ctx context.Context, request *ModifyConfigRequest) (response *ModifyConfigResponse, err error)
- func (c *Client) ModifyConsumer(request *ModifyConsumerRequest) (response *ModifyConsumerResponse, err error)
- func (c *Client) ModifyConsumerWithContext(ctx context.Context, request *ModifyConsumerRequest) (response *ModifyConsumerResponse, err error)
- func (c *Client) ModifyIndex(request *ModifyIndexRequest) (response *ModifyIndexResponse, err error)
- func (c *Client) ModifyIndexWithContext(ctx context.Context, request *ModifyIndexRequest) (response *ModifyIndexResponse, err error)
- func (c *Client) ModifyLogset(request *ModifyLogsetRequest) (response *ModifyLogsetResponse, err error)
- func (c *Client) ModifyLogsetWithContext(ctx context.Context, request *ModifyLogsetRequest) (response *ModifyLogsetResponse, err error)
- func (c *Client) ModifyMachineGroup(request *ModifyMachineGroupRequest) (response *ModifyMachineGroupResponse, err error)
- func (c *Client) ModifyMachineGroupWithContext(ctx context.Context, request *ModifyMachineGroupRequest) (response *ModifyMachineGroupResponse, err error)
- func (c *Client) ModifyShipper(request *ModifyShipperRequest) (response *ModifyShipperResponse, err error)
- func (c *Client) ModifyShipperWithContext(ctx context.Context, request *ModifyShipperRequest) (response *ModifyShipperResponse, err error)
- func (c *Client) ModifyTopic(request *ModifyTopicRequest) (response *ModifyTopicResponse, err error)
- func (c *Client) ModifyTopicWithContext(ctx context.Context, request *ModifyTopicRequest) (response *ModifyTopicResponse, err error)
- func (c *Client) OpenKafkaConsumer(request *OpenKafkaConsumerRequest) (response *OpenKafkaConsumerResponse, err error)
- func (c *Client) OpenKafkaConsumerWithContext(ctx context.Context, request *OpenKafkaConsumerRequest) (response *OpenKafkaConsumerResponse, err error)
- func (c *Client) RetryShipperTask(request *RetryShipperTaskRequest) (response *RetryShipperTaskResponse, err error)
- func (c *Client) RetryShipperTaskWithContext(ctx context.Context, request *RetryShipperTaskRequest) (response *RetryShipperTaskResponse, err error)
- func (c *Client) SearchLog(request *SearchLogRequest) (response *SearchLogResponse, err error)
- func (c *Client) SearchLogWithContext(ctx context.Context, request *SearchLogRequest) (response *SearchLogResponse, err error)
- func (c *Client) SplitPartition(request *SplitPartitionRequest) (response *SplitPartitionResponse, err error)
- func (c *Client) SplitPartitionWithContext(ctx context.Context, request *SplitPartitionRequest) (response *SplitPartitionResponse, err error)
- func (c *Client) UploadLog(request *UploadLogRequest, data []byte) (response *UploadLogResponse, err error)
- func (c *Client) UploadLogWithContext(ctx context.Context, request *UploadLogRequest, data []byte) (response *UploadLogResponse, err error)
- type CloseKafkaConsumerRequest
- type CloseKafkaConsumerResponse
- type Column
- type CompressInfo
- type ConfigInfo
- type ConsumerContent
- type ContentInfo
- type CreateAlarmNoticeRequest
- type CreateAlarmNoticeResponse
- type CreateAlarmRequest
- type CreateAlarmResponse
- type CreateConfigRequest
- type CreateConfigResponse
- type CreateConsumerRequest
- type CreateConsumerResponse
- type CreateExportRequest
- type CreateExportResponse
- type CreateIndexRequest
- type CreateIndexResponse
- type CreateLogsetRequest
- type CreateLogsetResponse
- type CreateMachineGroupRequest
- type CreateMachineGroupResponse
- type CreateShipperRequest
- type CreateShipperResponse
- type CreateTopicRequest
- type CreateTopicResponse
- type CsvInfo
- type DeleteAlarmNoticeRequest
- type DeleteAlarmNoticeResponse
- type DeleteAlarmRequest
- type DeleteAlarmResponse
- type DeleteConfigFromMachineGroupRequest
- type DeleteConfigFromMachineGroupResponse
- type DeleteConfigRequest
- type DeleteConfigResponse
- type DeleteConsumerRequest
- type DeleteConsumerResponse
- type DeleteExportRequest
- type DeleteExportResponse
- type DeleteIndexRequest
- type DeleteIndexResponse
- type DeleteLogsetRequest
- type DeleteLogsetResponse
- type DeleteMachineGroupRequest
- type DeleteMachineGroupResponse
- type DeleteShipperRequest
- type DeleteShipperResponse
- type DeleteTopicRequest
- type DeleteTopicResponse
- type DescribeAlarmNoticesRequest
- type DescribeAlarmNoticesResponse
- type DescribeAlarmsRequest
- type DescribeAlarmsResponse
- type DescribeConfigMachineGroupsRequest
- type DescribeConfigMachineGroupsResponse
- type DescribeConfigsRequest
- type DescribeConfigsResponse
- type DescribeConsumerRequest
- type DescribeConsumerResponse
- type DescribeExportsRequest
- type DescribeExportsResponse
- type DescribeIndexRequest
- type DescribeIndexResponse
- type DescribeLogContextRequest
- type DescribeLogContextResponse
- type DescribeLogHistogramRequest
- type DescribeLogHistogramResponse
- type DescribeLogsetsRequest
- type DescribeLogsetsResponse
- type DescribeMachineGroupConfigsRequest
- type DescribeMachineGroupConfigsResponse
- type DescribeMachineGroupsRequest
- type DescribeMachineGroupsResponse
- type DescribeMachinesRequest
- type DescribeMachinesResponse
- type DescribePartitionsRequest
- type DescribePartitionsResponse
- type DescribeShipperTasksRequest
- type DescribeShipperTasksResponse
- type DescribeShippersRequest
- type DescribeShippersResponse
- type DescribeTopicsRequest
- type DescribeTopicsResponse
- type ExcludePathInfo
- type ExportInfo
- type ExtractRuleInfo
- type Filter
- type FilterRuleInfo
- type FullTextInfo
- type GetAlarmLogRequest
- type GetAlarmLogResponse
- type HistogramInfo
- type JsonInfo
- type KeyRegexInfo
- type KeyValueInfo
- type LogContextInfo
- type LogInfo
- type LogItem
- type LogItems
- type LogsetInfo
- type MachineGroupInfo
- type MachineGroupTypeInfo
- type MachineInfo
- type MergePartitionRequest
- type MergePartitionResponse
- type ModifyAlarmNoticeRequest
- type ModifyAlarmNoticeResponse
- type ModifyAlarmRequest
- type ModifyAlarmResponse
- type ModifyConfigRequest
- type ModifyConfigResponse
- type ModifyConsumerRequest
- type ModifyConsumerResponse
- type ModifyIndexRequest
- type ModifyIndexResponse
- type ModifyLogsetRequest
- type ModifyLogsetResponse
- type ModifyMachineGroupRequest
- type ModifyMachineGroupResponse
- type ModifyShipperRequest
- type ModifyShipperResponse
- type ModifyTopicRequest
- type ModifyTopicResponse
- type MonitorTime
- type NoticeReceiver
- type OpenKafkaConsumerRequest
- type OpenKafkaConsumerResponse
- type ParquetInfo
- type ParquetKeyInfo
- type PartitionInfo
- type RetryShipperTaskRequest
- type RetryShipperTaskResponse
- type RuleInfo
- type RuleKeyValueInfo
- type RuleTagInfo
- type SearchLogRequest
- type SearchLogResponse
- type ShipperInfo
- type ShipperTaskInfo
- type SplitPartitionRequest
- type SplitPartitionResponse
- type Tag
- type TopicInfo
- type UploadLogRequest
- type UploadLogResponse
- type ValueInfo
- type WebCallback
Constants ¶
const ( // CAM signature/authentication error. AUTHFAILURE = "AuthFailure" // Operation failed. FAILEDOPERATION = "FailedOperation" // The alarm notification template has already been bound to an alarm policy. FAILEDOPERATION_BINDEDALARM = "FailedOperation.BindedAlarm" // The number of searched logs has reached the upper limit. FAILEDOPERATION_GETLOGREACHLIMIT = "FailedOperation.GetlogReachLimit" // IA storage does not support key-value or tag index configuration. FAILEDOPERATION_INVALIDINDEXRULEFORSEARCHLOW = "FailedOperation.InValidIndexRuleForSearchLow" // The alarm policy is exceptional. Please check whether all the log topic IDs exist. FAILEDOPERATION_INVALIDALARM = "FailedOperation.InvalidAlarm" // The search cursor is invalid or does not exist. FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" // The offline storage period cannot be less than 7 days. FAILEDOPERATION_INVALIDPERIOD = "FailedOperation.InvalidPeriod" // The same logset already exists. FAILEDOPERATION_LOGSETCONFLICT = "FailedOperation.LogsetConflict" // There are log topics under the logset. FAILEDOPERATION_LOGSETNOTEMPTY = "FailedOperation.LogsetNotEmpty" // Invalid `Content`. FAILEDOPERATION_MISSINGCONTENT = "FailedOperation.MissingContent" // The modified lifecycle is prohibited. FAILEDOPERATION_PERIODMODIFYFORBIDDEN = "FailedOperation.PeriodModifyForbidden" // The query statement failed to run. FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" // The read QPS exceeds the limit. FAILEDOPERATION_READQPSLIMIT = "FailedOperation.ReadQpsLimit" // The query timed out. FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" // Shipping task retry is not allowed. FAILEDOPERATION_SHIPPERTASKNOTTORETRY = "FailedOperation.ShipperTaskNotToRetry" // An error occurred while parsing the query statement. FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" // The frequency of tag service requests is limited. FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" // The log topic has been disabled. FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" // The log topic has been isolated. FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" // The write QPS exceeds the limit. FAILEDOPERATION_WRITEQPSLIMIT = "FailedOperation.WriteQpsLimit" // The write traffic exceeds the limit. FAILEDOPERATION_WRITETRAFFICLIMIT = "FailedOperation.WriteTrafficLimit" // Internal error. INTERNALERROR = "InternalError" // Incorrect parameter. INVALIDPARAMETER = "InvalidParameter" // The alarm policy already exists. INVALIDPARAMETER_ALARMCONFLICT = "InvalidParameter.AlarmConflict" // The alarm notification template already exists. INVALIDPARAMETER_ALARMNOTICECONFLICT = "InvalidParameter.AlarmNoticeConflict" // The same collection configuration rule already exists. INVALIDPARAMETER_CONFIGCONFLICT = "InvalidParameter.ConfigConflict" // Invalid `Content`. INVALIDPARAMETER_CONTENT = "InvalidParameter.Content" // IA storage does not support key-value or tag index configuration. INVALIDPARAMETER_INVALIDINDEXRULEFORSEARCHLOW = "InvalidParameter.InValidIndexRuleForSearchLow" // An index rule already exists for the specified log topic. INVALIDPARAMETER_INDEXCONFLICT = "InvalidParameter.IndexConflict" // The same logset already exists. INVALIDPARAMETER_LOGSETCONFLICT = "InvalidParameter.LogsetConflict" // The same machine group already exists. INVALIDPARAMETER_MACHINEGROUPCONFLICT = "InvalidParameter.MachineGroupConflict" // Shipping rule naming conflict. INVALIDPARAMETER_SHIPPERCONFLICT = "InvalidParameter.ShipperConflict" // There is already a log topic with the same name in the specified logset. INVALIDPARAMETER_TOPICCONFLICT = "InvalidParameter.TopicConflict" // Incorrect parameter value. INVALIDPARAMETERVALUE = "InvalidParameterValue" // The quota limit has been reached. LIMITEXCEEDED = "LimitExceeded" // The collection rule configuration exceeds the maximum value limit. LIMITEXCEEDED_CONFIG = "LimitExceeded.Config" // The number of exported logs exceeds the limit. LIMITEXCEEDED_EXPORT = "LimitExceeded.Export" // The number of concurrent queries exceeds the limit, which is 15 per topic. LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" // The log size exceeds the limit. LIMITEXCEEDED_LOGSIZE = "LimitExceeded.LogSize" // The number of logsets exceeds the limit. LIMITEXCEEDED_LOGSET = "LimitExceeded.Logset" // The number of machine groups exceeds the limit. LIMITEXCEEDED_MACHINEGROUP = "LimitExceeded.MachineGroup" // The number of machine group IPs exceeds the limit. LIMITEXCEEDED_MACHINEGROUPIP = "LimitExceeded.MachineGroupIp" // The number of machine group labels exceeds the limit. LIMITEXCEEDED_MACHINEGROUPLABELS = "LimitExceeded.MachineGroupLabels" // The number of partitions exceeds the limit. LIMITEXCEEDED_PARTITION = "LimitExceeded.Partition" // The number of logs returned by the search API exceeds the upper limit (20 MB). LIMITEXCEEDED_SEARCHRESULTTOOLARGE = "LimitExceeded.SearchResultTooLarge" // The number of shipping rules exceeds the limit. LIMITEXCEEDED_SHIPPER = "LimitExceeded.Shipper" // The number of tags exceeds the limit. LIMITEXCEEDED_TAG = "LimitExceeded.Tag" // The number of log topics exceeds the limit. LIMITEXCEEDED_TOPIC = "LimitExceeded.Topic" // Missing parameter. MISSINGPARAMETER = "MissingParameter" // Operation denied. OPERATIONDENIED = "OperationDenied" // ACL verification failed. OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" // The account has been terminated. OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" // The account has overdue payments. OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" // The account does not exist. OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" // IA storage does not support alarms. OPERATIONDENIED_ALARMNOTSUPPORTFORSEARCHLOW = "OperationDenied.AlarmNotSupportForSearchLow" // The analysis feature is not enabled for the field. OPERATIONDENIED_ANALYSISSWITCHCLOSE = "OperationDenied.AnalysisSwitchClose" // The notification template is bound to an alarm and cannot be deleted. OPERATIONDENIED_NOTICEHASALARM = "OperationDenied.NoticeHasAlarm" // The operation is not supported in IA storage. OPERATIONDENIED_OPERATIONNOTSUPPORTINSEARCHLOW = "OperationDenied.OperationNotSupportInSearchLow" // A data processing task is bound to this topic. OPERATIONDENIED_TOPICHASDATAFORMTASK = "OperationDenied.TopicHasDataFormTask" // The topic is bound to a function for shipping. OPERATIONDENIED_TOPICHASDELIVERFUNCTION = "OperationDenied.TopicHasDeliverFunction" // The resource does not exist. RESOURCENOTFOUND = "ResourceNotFound" // The agent version does not exist. RESOURCENOTFOUND_AGENTVERSIONNOTEXIST = "ResourceNotFound.AgentVersionNotExist" // The alarm policy does not exist. RESOURCENOTFOUND_ALARMNOTEXIST = "ResourceNotFound.AlarmNotExist" // The alarm notification template does not exist. RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist" // The specified collection rule configuration does not exist. RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist" // The log export does not exist. RESOURCENOTFOUND_EXPORTNOTEXIST = "ResourceNotFound.ExportNotExist" // The index does not exist. RESOURCENOTFOUND_INDEXNOTEXIST = "ResourceNotFound.IndexNotExist" // The specified logset does not exist. RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist" // The machine group does not exist. RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist" // The partition does not exist. RESOURCENOTFOUND_PARTITIONNOTEXIST = "ResourceNotFound.PartitionNotExist" // The shipping rule does not exist. RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist" // The shipping task does not exist. RESOURCENOTFOUND_SHIPPERTASKNOTEXIST = "ResourceNotFound.ShipperTaskNotExist" // The log topic does not exist. RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist" // Unsupported operation. UNSUPPORTEDOPERATION = "UnsupportedOperation" )
const APIVersion = "2020-10-16"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlarmInfo ¶
type AlarmInfo struct { // Alarm policy name Name *string `json:"Name,omitempty" name:"Name"` // Monitoring object list AlarmTargets []*AlarmTargetInfo `json:"AlarmTargets,omitempty" name:"AlarmTargets"` // Monitoring task running time point MonitorTime *MonitorTime `json:"MonitorTime,omitempty" name:"MonitorTime"` // Trigger condition Condition *string `json:"Condition,omitempty" name:"Condition"` // Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1–10. TriggerCount *int64 `json:"TriggerCount,omitempty" name:"TriggerCount"` // Repeated alarm interval in minutes. Value range: 0–1440. AlarmPeriod *int64 `json:"AlarmPeriod,omitempty" name:"AlarmPeriod"` // List of associated alarm notification templates AlarmNoticeIds []*string `json:"AlarmNoticeIds,omitempty" name:"AlarmNoticeIds"` // Enablement status Status *bool `json:"Status,omitempty" name:"Status"` // Alarm policy ID AlarmId *string `json:"AlarmId,omitempty" name:"AlarmId"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Last update time UpdateTime *string `json:"UpdateTime,omitempty" name:"UpdateTime"` // Custom notification template // Note: this field may return `null`, indicating that no valid values can be obtained. MessageTemplate *string `json:"MessageTemplate,omitempty" name:"MessageTemplate"` // Custom callback template // Note: this field may return `null`, indicating that no valid values can be obtained. CallBack *CallBackInfo `json:"CallBack,omitempty" name:"CallBack"` // Multi-Dimensional analysis settings // Note: this field may return `null`, indicating that no valid values can be obtained. Analysis []*AnalysisDimensional `json:"Analysis,omitempty" name:"Analysis"` }
type AlarmNotice ¶
type AlarmNotice struct { // Alarm notification template name Name *string `json:"Name,omitempty" name:"Name"` // Alarm template type. Valid values: // <br><li> `Trigger`: alarm triggered // <br><li> `Recovery`: alarm cleared // <br><li> `All`: alarm triggered and alarm cleared Type *string `json:"Type,omitempty" name:"Type"` // Information of the recipient in alarm notification template // Note: this field may return `null`, indicating that no valid values can be obtained. NoticeReceivers []*NoticeReceiver `json:"NoticeReceivers,omitempty" name:"NoticeReceivers"` // Callback information of alarm notification template // Note: this field may return `null`, indicating that no valid values can be obtained. WebCallbacks []*WebCallback `json:"WebCallbacks,omitempty" name:"WebCallbacks"` // Alarm notification template ID // Note: this field may return `null`, indicating that no valid values can be obtained. AlarmNoticeId *string `json:"AlarmNoticeId,omitempty" name:"AlarmNoticeId"` // Creation time // Note: this field may return `null`, indicating that no valid values can be obtained. CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Last update time // Note: this field may return `null`, indicating that no valid values can be obtained. UpdateTime *string `json:"UpdateTime,omitempty" name:"UpdateTime"` }
type AlarmTarget ¶
type AlarmTarget struct { // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Query statement Query *string `json:"Query,omitempty" name:"Query"` // Monitoring object number, which is incremental from 1. Number *int64 `json:"Number,omitempty" name:"Number"` // Offset of the query start time from the alarm execution time in minutes. The value cannot be positive. Value range: -1440–0. StartTimeOffset *int64 `json:"StartTimeOffset,omitempty" name:"StartTimeOffset"` // Offset of the query end time from the alarm execution time in minutes. The value cannot be positive and must be greater than `StartTimeOffset`. Value range: -1440–0. EndTimeOffset *int64 `json:"EndTimeOffset,omitempty" name:"EndTimeOffset"` // Logset ID LogsetId *string `json:"LogsetId,omitempty" name:"LogsetId"` }
type AlarmTargetInfo ¶
type AlarmTargetInfo struct { // Logset ID LogsetId *string `json:"LogsetId,omitempty" name:"LogsetId"` // Logset name LogsetName *string `json:"LogsetName,omitempty" name:"LogsetName"` // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Log topic name TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Query statement Query *string `json:"Query,omitempty" name:"Query"` // Monitoring object number Number *int64 `json:"Number,omitempty" name:"Number"` // Offset of the query start time from the alarm execution time in minutes. The value cannot be positive. Value range: -1440–0. StartTimeOffset *int64 `json:"StartTimeOffset,omitempty" name:"StartTimeOffset"` // Offset of the query end time from the alarm execution time in minutes. The value cannot be positive and must be greater than `StartTimeOffset`. Value range: -1440–0. EndTimeOffset *int64 `json:"EndTimeOffset,omitempty" name:"EndTimeOffset"` }
type AnalysisDimensional ¶
type ApplyConfigToMachineGroupRequest ¶
type ApplyConfigToMachineGroupRequest struct { *tchttp.BaseRequest // Collection configuration ID ConfigId *string `json:"ConfigId,omitempty" name:"ConfigId"` // Machine group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` }
func NewApplyConfigToMachineGroupRequest ¶
func NewApplyConfigToMachineGroupRequest() (request *ApplyConfigToMachineGroupRequest)
func (*ApplyConfigToMachineGroupRequest) FromJsonString ¶
func (r *ApplyConfigToMachineGroupRequest) 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 (*ApplyConfigToMachineGroupRequest) ToJsonString ¶
func (r *ApplyConfigToMachineGroupRequest) ToJsonString() string
type ApplyConfigToMachineGroupResponse ¶
type ApplyConfigToMachineGroupResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewApplyConfigToMachineGroupResponse ¶
func NewApplyConfigToMachineGroupResponse() (response *ApplyConfigToMachineGroupResponse)
func (*ApplyConfigToMachineGroupResponse) FromJsonString ¶
func (r *ApplyConfigToMachineGroupResponse) 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 (*ApplyConfigToMachineGroupResponse) ToJsonString ¶
func (r *ApplyConfigToMachineGroupResponse) ToJsonString() string
type CallBackInfo ¶
type Ckafka ¶
type Ckafka struct { // CKafka VIP Vip *string `json:"Vip,omitempty" name:"Vip"` // CKafka Vport Vport *string `json:"Vport,omitempty" name:"Vport"` // CKafka instance ID InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"` // CKafka instance name InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"` // CKafka topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // CKafka topic name TopicName *string `json:"TopicName,omitempty" name:"TopicName"` }
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) ApplyConfigToMachineGroup ¶
func (c *Client) ApplyConfigToMachineGroup(request *ApplyConfigToMachineGroupRequest) (response *ApplyConfigToMachineGroupResponse, err error)
ApplyConfigToMachineGroup This API is used to apply the collection configuration to the specified machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) ApplyConfigToMachineGroupWithContext ¶
func (c *Client) ApplyConfigToMachineGroupWithContext(ctx context.Context, request *ApplyConfigToMachineGroupRequest) (response *ApplyConfigToMachineGroupResponse, err error)
ApplyConfigToMachineGroup This API is used to apply the collection configuration to the specified machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) CloseKafkaConsumer ¶
func (c *Client) CloseKafkaConsumer(request *CloseKafkaConsumerRequest) (response *CloseKafkaConsumerResponse, err error)
CloseKafkaConsumer This API is used to disable Kafka consumption.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CloseKafkaConsumerWithContext ¶
func (c *Client) CloseKafkaConsumerWithContext(ctx context.Context, request *CloseKafkaConsumerRequest) (response *CloseKafkaConsumerResponse, err error)
CloseKafkaConsumer This API is used to disable Kafka consumption.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateAlarm ¶
func (c *Client) CreateAlarm(request *CreateAlarmRequest) (response *CreateAlarmResponse, err error)
CreateAlarm This API is used to create an alarm policy.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_ALARMCONFLICT = "InvalidParameter.AlarmConflict" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_ALARMNOTSUPPORTFORSEARCHLOW = "OperationDenied.AlarmNotSupportForSearchLow" RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateAlarmNotice ¶
func (c *Client) CreateAlarmNotice(request *CreateAlarmNoticeRequest) (response *CreateAlarmNoticeResponse, err error)
CreateAlarmNotice This API is used to create a notification group.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_ALARMNOTICECONFLICT = "InvalidParameter.AlarmNoticeConflict" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) CreateAlarmNoticeWithContext ¶
func (c *Client) CreateAlarmNoticeWithContext(ctx context.Context, request *CreateAlarmNoticeRequest) (response *CreateAlarmNoticeResponse, err error)
CreateAlarmNotice This API is used to create a notification group.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_ALARMNOTICECONFLICT = "InvalidParameter.AlarmNoticeConflict" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) CreateAlarmWithContext ¶
func (c *Client) CreateAlarmWithContext(ctx context.Context, request *CreateAlarmRequest) (response *CreateAlarmResponse, err error)
CreateAlarm This API is used to create an alarm policy.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_ALARMCONFLICT = "InvalidParameter.AlarmConflict" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_ALARMNOTSUPPORTFORSEARCHLOW = "OperationDenied.AlarmNotSupportForSearchLow" RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateConfig ¶
func (c *Client) CreateConfig(request *CreateConfigRequest) (response *CreateConfigResponse, err error)
CreateConfig This API is used to create a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_CONFIGCONFLICT = "InvalidParameter.ConfigConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED_CONFIG = "LimitExceeded.Config" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateConfigWithContext ¶
func (c *Client) CreateConfigWithContext(ctx context.Context, request *CreateConfigRequest) (response *CreateConfigResponse, err error)
CreateConfig This API is used to create a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_CONFIGCONFLICT = "InvalidParameter.ConfigConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED_CONFIG = "LimitExceeded.Config" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateConsumer ¶
func (c *Client) CreateConsumer(request *CreateConsumerRequest) (response *CreateConsumerResponse, err error)
CreateConsumer This API is used to create a shipping task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) CreateConsumerWithContext ¶
func (c *Client) CreateConsumerWithContext(ctx context.Context, request *CreateConsumerRequest) (response *CreateConsumerResponse, err error)
CreateConsumer This API is used to create a shipping task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) CreateExport ¶
func (c *Client) CreateExport(request *CreateExportRequest) (response *CreateExportResponse, err error)
CreateExport This API is used to create a download task. To get the returned download address, call `DescribeExports` to view the task list. The `CosPath` parameter is also included for download address. For more information, visit https://intl.cloud.tencent.com/document/product/614/56449.?from_cn_redirect=1
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_EXPORT = "LimitExceeded.Export" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateExportWithContext ¶
func (c *Client) CreateExportWithContext(ctx context.Context, request *CreateExportRequest) (response *CreateExportResponse, err error)
CreateExport This API is used to create a download task. To get the returned download address, call `DescribeExports` to view the task list. The `CosPath` parameter is also included for download address. For more information, visit https://intl.cloud.tencent.com/document/product/614/56449.?from_cn_redirect=1
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_EXPORT = "LimitExceeded.Export" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateIndex ¶
func (c *Client) CreateIndex(request *CreateIndexRequest) (response *CreateIndexResponse, err error)
CreateIndex This API is used to create an index.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDINDEXRULEFORSEARCHLOW = "FailedOperation.InValidIndexRuleForSearchLow" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_INVALIDINDEXRULEFORSEARCHLOW = "InvalidParameter.InValidIndexRuleForSearchLow" INVALIDPARAMETER_INDEXCONFLICT = "InvalidParameter.IndexConflict" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateIndexWithContext ¶
func (c *Client) CreateIndexWithContext(ctx context.Context, request *CreateIndexRequest) (response *CreateIndexResponse, err error)
CreateIndex This API is used to create an index.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDINDEXRULEFORSEARCHLOW = "FailedOperation.InValidIndexRuleForSearchLow" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_INVALIDINDEXRULEFORSEARCHLOW = "InvalidParameter.InValidIndexRuleForSearchLow" INVALIDPARAMETER_INDEXCONFLICT = "InvalidParameter.IndexConflict" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateLogset ¶
func (c *Client) CreateLogset(request *CreateLogsetRequest) (response *CreateLogsetResponse, err error)
CreateLogset This API is used to create a logset. The ID of the created logset is returned.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_LOGSETCONFLICT = "FailedOperation.LogsetConflict" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_LOGSETCONFLICT = "InvalidParameter.LogsetConflict" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_LOGSET = "LimitExceeded.Logset" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) CreateLogsetWithContext ¶
func (c *Client) CreateLogsetWithContext(ctx context.Context, request *CreateLogsetRequest) (response *CreateLogsetResponse, err error)
CreateLogset This API is used to create a logset. The ID of the created logset is returned.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_LOGSETCONFLICT = "FailedOperation.LogsetConflict" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_LOGSETCONFLICT = "InvalidParameter.LogsetConflict" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_LOGSET = "LimitExceeded.Logset" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) CreateMachineGroup ¶
func (c *Client) CreateMachineGroup(request *CreateMachineGroupRequest) (response *CreateMachineGroupResponse, err error)
CreateMachineGroup This API is used to create a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_MACHINEGROUPCONFLICT = "InvalidParameter.MachineGroupConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_MACHINEGROUP = "LimitExceeded.MachineGroup" LIMITEXCEEDED_MACHINEGROUPIP = "LimitExceeded.MachineGroupIp" LIMITEXCEEDED_MACHINEGROUPLABELS = "LimitExceeded.MachineGroupLabels" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) CreateMachineGroupWithContext ¶
func (c *Client) CreateMachineGroupWithContext(ctx context.Context, request *CreateMachineGroupRequest) (response *CreateMachineGroupResponse, err error)
CreateMachineGroup This API is used to create a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_MACHINEGROUPCONFLICT = "InvalidParameter.MachineGroupConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_MACHINEGROUP = "LimitExceeded.MachineGroup" LIMITEXCEEDED_MACHINEGROUPIP = "LimitExceeded.MachineGroupIp" LIMITEXCEEDED_MACHINEGROUPLABELS = "LimitExceeded.MachineGroupLabels" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) CreateShipper ¶
func (c *Client) CreateShipper(request *CreateShipperRequest) (response *CreateShipperResponse, err error)
CreateShipper This API is used to create a shipping rule. Note: To use this API, you need to check whether you have configured the role and permission for COS shipping tasks. If not, see **Viewing and Configuring Shipping Authorization** at https://intl.cloud.tencent.com/document/product/614/71623.?from_cn_redirect=1
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_SHIPPERCONFLICT = "InvalidParameter.ShipperConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED_SHIPPER = "LimitExceeded.Shipper" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateShipperWithContext ¶
func (c *Client) CreateShipperWithContext(ctx context.Context, request *CreateShipperRequest) (response *CreateShipperResponse, err error)
CreateShipper This API is used to create a shipping rule. Note: To use this API, you need to check whether you have configured the role and permission for COS shipping tasks. If not, see **Viewing and Configuring Shipping Authorization** at https://intl.cloud.tencent.com/document/product/614/71623.?from_cn_redirect=1
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_SHIPPERCONFLICT = "InvalidParameter.ShipperConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED_SHIPPER = "LimitExceeded.Shipper" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) CreateTopic ¶
func (c *Client) CreateTopic(request *CreateTopicRequest) (response *CreateTopicResponse, err error)
CreateTopic This API is used to create a log topic.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDPERIOD = "FailedOperation.InvalidPeriod" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_TOPICCONFLICT = "InvalidParameter.TopicConflict" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_LOGSET = "LimitExceeded.Logset" LIMITEXCEEDED_TOPIC = "LimitExceeded.Topic" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist"
func (*Client) CreateTopicWithContext ¶
func (c *Client) CreateTopicWithContext(ctx context.Context, request *CreateTopicRequest) (response *CreateTopicResponse, err error)
CreateTopic This API is used to create a log topic.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDPERIOD = "FailedOperation.InvalidPeriod" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_TOPICCONFLICT = "InvalidParameter.TopicConflict" LIMITEXCEEDED = "LimitExceeded" LIMITEXCEEDED_LOGSET = "LimitExceeded.Logset" LIMITEXCEEDED_TOPIC = "LimitExceeded.Topic" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist"
func (*Client) DeleteAlarm ¶
func (c *Client) DeleteAlarm(request *DeleteAlarmRequest) (response *DeleteAlarmResponse, err error)
DeleteAlarm This API is used to delete an alarm policy.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_ALARMNOTEXIST = "ResourceNotFound.AlarmNotExist"
func (*Client) DeleteAlarmNotice ¶
func (c *Client) DeleteAlarmNotice(request *DeleteAlarmNoticeRequest) (response *DeleteAlarmNoticeResponse, err error)
DeleteAlarmNotice This API is used to delete a notification group.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_BINDEDALARM = "FailedOperation.BindedAlarm" INTERNALERROR = "InternalError" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_NOTICEHASALARM = "OperationDenied.NoticeHasAlarm" RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist"
func (*Client) DeleteAlarmNoticeWithContext ¶
func (c *Client) DeleteAlarmNoticeWithContext(ctx context.Context, request *DeleteAlarmNoticeRequest) (response *DeleteAlarmNoticeResponse, err error)
DeleteAlarmNotice This API is used to delete a notification group.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_BINDEDALARM = "FailedOperation.BindedAlarm" INTERNALERROR = "InternalError" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_NOTICEHASALARM = "OperationDenied.NoticeHasAlarm" RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist"
func (*Client) DeleteAlarmWithContext ¶
func (c *Client) DeleteAlarmWithContext(ctx context.Context, request *DeleteAlarmRequest) (response *DeleteAlarmResponse, err error)
DeleteAlarm This API is used to delete an alarm policy.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_ALARMNOTEXIST = "ResourceNotFound.AlarmNotExist"
func (*Client) DeleteConfig ¶
func (c *Client) DeleteConfig(request *DeleteConfigRequest) (response *DeleteConfigResponse, err error)
DeleteConfig This API is used to delete a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist"
func (*Client) DeleteConfigFromMachineGroup ¶
func (c *Client) DeleteConfigFromMachineGroup(request *DeleteConfigFromMachineGroupRequest) (response *DeleteConfigFromMachineGroupResponse, err error)
DeleteConfigFromMachineGroup This API is used to delete the collection configuration applied to a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) DeleteConfigFromMachineGroupWithContext ¶
func (c *Client) DeleteConfigFromMachineGroupWithContext(ctx context.Context, request *DeleteConfigFromMachineGroupRequest) (response *DeleteConfigFromMachineGroupResponse, err error)
DeleteConfigFromMachineGroup This API is used to delete the collection configuration applied to a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) DeleteConfigWithContext ¶
func (c *Client) DeleteConfigWithContext(ctx context.Context, request *DeleteConfigRequest) (response *DeleteConfigResponse, err error)
DeleteConfig This API is used to delete a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist"
func (*Client) DeleteConsumer ¶
func (c *Client) DeleteConsumer(request *DeleteConsumerRequest) (response *DeleteConsumerResponse, err error)
DeleteConsumer This API is used to delete a shipping task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DeleteConsumerWithContext ¶
func (c *Client) DeleteConsumerWithContext(ctx context.Context, request *DeleteConsumerRequest) (response *DeleteConsumerResponse, err error)
DeleteConsumer This API is used to delete a shipping task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DeleteExport ¶
func (c *Client) DeleteExport(request *DeleteExportRequest) (response *DeleteExportResponse, err error)
DeleteExport This API is used to delete a log download task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_EXPORTNOTEXIST = "ResourceNotFound.ExportNotExist"
func (*Client) DeleteExportWithContext ¶
func (c *Client) DeleteExportWithContext(ctx context.Context, request *DeleteExportRequest) (response *DeleteExportResponse, err error)
DeleteExport This API is used to delete a log download task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_EXPORTNOTEXIST = "ResourceNotFound.ExportNotExist"
func (*Client) DeleteIndex ¶
func (c *Client) DeleteIndex(request *DeleteIndexRequest) (response *DeleteIndexResponse, err error)
DeleteIndex This API is used to delete the index configuration of a log topic. After deleting, you cannot retrieve or query the collected logs.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_INDEXNOTEXIST = "ResourceNotFound.IndexNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DeleteIndexWithContext ¶
func (c *Client) DeleteIndexWithContext(ctx context.Context, request *DeleteIndexRequest) (response *DeleteIndexResponse, err error)
DeleteIndex This API is used to delete the index configuration of a log topic. After deleting, you cannot retrieve or query the collected logs.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_INDEXNOTEXIST = "ResourceNotFound.IndexNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DeleteLogset ¶
func (c *Client) DeleteLogset(request *DeleteLogsetRequest) (response *DeleteLogsetResponse, err error)
DeleteLogset This API is used to delete a logset.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_LOGSETNOTEMPTY = "FailedOperation.LogsetNotEmpty" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist"
func (*Client) DeleteLogsetWithContext ¶
func (c *Client) DeleteLogsetWithContext(ctx context.Context, request *DeleteLogsetRequest) (response *DeleteLogsetResponse, err error)
DeleteLogset This API is used to delete a logset.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_LOGSETNOTEMPTY = "FailedOperation.LogsetNotEmpty" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist"
func (*Client) DeleteMachineGroup ¶
func (c *Client) DeleteMachineGroup(request *DeleteMachineGroupRequest) (response *DeleteMachineGroupResponse, err error)
DeleteMachineGroup This API is used to delete a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) DeleteMachineGroupWithContext ¶
func (c *Client) DeleteMachineGroupWithContext(ctx context.Context, request *DeleteMachineGroupRequest) (response *DeleteMachineGroupResponse, err error)
DeleteMachineGroup This API is used to delete a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) DeleteShipper ¶
func (c *Client) DeleteShipper(request *DeleteShipperRequest) (response *DeleteShipperResponse, err error)
DeleteShipper This API is used to delete a shipping rule.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist"
func (*Client) DeleteShipperWithContext ¶
func (c *Client) DeleteShipperWithContext(ctx context.Context, request *DeleteShipperRequest) (response *DeleteShipperResponse, err error)
DeleteShipper This API is used to delete a shipping rule.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist"
func (*Client) DeleteTopic ¶
func (c *Client) DeleteTopic(request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
DeleteTopic This API is used to delete a log topic.
error code that may be returned:
FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_TOPICHASDATAFORMTASK = "OperationDenied.TopicHasDataFormTask" OPERATIONDENIED_TOPICHASDELIVERFUNCTION = "OperationDenied.TopicHasDeliverFunction" RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DeleteTopicWithContext ¶
func (c *Client) DeleteTopicWithContext(ctx context.Context, request *DeleteTopicRequest) (response *DeleteTopicResponse, err error)
DeleteTopic This API is used to delete a log topic.
error code that may be returned:
FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_TOPICHASDATAFORMTASK = "OperationDenied.TopicHasDataFormTask" OPERATIONDENIED_TOPICHASDELIVERFUNCTION = "OperationDenied.TopicHasDeliverFunction" RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeAlarmNotices ¶
func (c *Client) DescribeAlarmNotices(request *DescribeAlarmNoticesRequest) (response *DescribeAlarmNoticesResponse, err error)
DescribeAlarmNotices This API is used to get the notification group list.
error code that may be returned:
FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeAlarmNoticesWithContext ¶
func (c *Client) DescribeAlarmNoticesWithContext(ctx context.Context, request *DescribeAlarmNoticesRequest) (response *DescribeAlarmNoticesResponse, err error)
DescribeAlarmNotices This API is used to get the notification group list.
error code that may be returned:
FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeAlarms ¶
func (c *Client) DescribeAlarms(request *DescribeAlarmsRequest) (response *DescribeAlarmsResponse, err error)
DescribeAlarms This API is used to get the alarm policy list.
error code that may be returned:
FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeAlarmsWithContext ¶
func (c *Client) DescribeAlarmsWithContext(ctx context.Context, request *DescribeAlarmsRequest) (response *DescribeAlarmsResponse, err error)
DescribeAlarms This API is used to get the alarm policy list.
error code that may be returned:
FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeConfigMachineGroups ¶
func (c *Client) DescribeConfigMachineGroups(request *DescribeConfigMachineGroupsRequest) (response *DescribeConfigMachineGroupsResponse, err error)
DescribeConfigMachineGroups This API is used to get the machine group bound to a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist"
func (*Client) DescribeConfigMachineGroupsWithContext ¶
func (c *Client) DescribeConfigMachineGroupsWithContext(ctx context.Context, request *DescribeConfigMachineGroupsRequest) (response *DescribeConfigMachineGroupsResponse, err error)
DescribeConfigMachineGroups This API is used to get the machine group bound to a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist"
func (*Client) DescribeConfigs ¶
func (c *Client) DescribeConfigs(request *DescribeConfigsRequest) (response *DescribeConfigsResponse, err error)
DescribeConfigs This API is used to get a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeConfigsWithContext ¶
func (c *Client) DescribeConfigsWithContext(ctx context.Context, request *DescribeConfigsRequest) (response *DescribeConfigsResponse, err error)
DescribeConfigs This API is used to get a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeConsumer ¶
func (c *Client) DescribeConsumer(request *DescribeConsumerRequest) (response *DescribeConsumerResponse, err error)
DescribeConsumer This API is used to query a shipping task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeConsumerWithContext ¶
func (c *Client) DescribeConsumerWithContext(ctx context.Context, request *DescribeConsumerRequest) (response *DescribeConsumerResponse, err error)
DescribeConsumer This API is used to query a shipping task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeExports ¶
func (c *Client) DescribeExports(request *DescribeExportsRequest) (response *DescribeExportsResponse, err error)
DescribeExports This API is used to get the list of log download tasks.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_EXPORTNOTEXIST = "ResourceNotFound.ExportNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeExportsWithContext ¶
func (c *Client) DescribeExportsWithContext(ctx context.Context, request *DescribeExportsRequest) (response *DescribeExportsResponse, err error)
DescribeExports This API is used to get the list of log download tasks.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_EXPORTNOTEXIST = "ResourceNotFound.ExportNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeIndex ¶
func (c *Client) DescribeIndex(request *DescribeIndexRequest) (response *DescribeIndexResponse, err error)
DescribeIndex This API is used to get the index configuration information.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_INDEXNOTEXIST = "ResourceNotFound.IndexNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeIndexWithContext ¶
func (c *Client) DescribeIndexWithContext(ctx context.Context, request *DescribeIndexRequest) (response *DescribeIndexResponse, err error)
DescribeIndex This API is used to get the index configuration information.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_INDEXNOTEXIST = "ResourceNotFound.IndexNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeLogContext ¶
func (c *Client) DescribeLogContext(request *DescribeLogContextRequest) (response *DescribeLogContextResponse, err error)
DescribeLogContext This API is used to search for content in the log context.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeLogContextWithContext ¶
func (c *Client) DescribeLogContextWithContext(ctx context.Context, request *DescribeLogContextRequest) (response *DescribeLogContextResponse, err error)
DescribeLogContext This API is used to search for content in the log context.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeLogHistogram ¶
func (c *Client) DescribeLogHistogram(request *DescribeLogHistogramRequest) (response *DescribeLogHistogramResponse, err error)
DescribeLogHistogram This API is used to build a histogram.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeLogHistogramWithContext ¶
func (c *Client) DescribeLogHistogramWithContext(ctx context.Context, request *DescribeLogHistogramRequest) (response *DescribeLogHistogramResponse, err error)
DescribeLogHistogram This API is used to build a histogram.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeLogsets ¶
func (c *Client) DescribeLogsets(request *DescribeLogsetsRequest) (response *DescribeLogsetsResponse, err error)
DescribeLogsets This API is used to get the list of logsets.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) DescribeLogsetsWithContext ¶
func (c *Client) DescribeLogsetsWithContext(ctx context.Context, request *DescribeLogsetsRequest) (response *DescribeLogsetsResponse, err error)
DescribeLogsets This API is used to get the list of logsets.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound"
func (*Client) DescribeMachineGroupConfigs ¶
func (c *Client) DescribeMachineGroupConfigs(request *DescribeMachineGroupConfigsRequest) (response *DescribeMachineGroupConfigsResponse, err error)
DescribeMachineGroupConfigs This API is used to get the collection rule configuration bound to a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) DescribeMachineGroupConfigsWithContext ¶
func (c *Client) DescribeMachineGroupConfigsWithContext(ctx context.Context, request *DescribeMachineGroupConfigsRequest) (response *DescribeMachineGroupConfigsResponse, err error)
DescribeMachineGroupConfigs This API is used to get the collection rule configuration bound to a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) DescribeMachineGroups ¶
func (c *Client) DescribeMachineGroups(request *DescribeMachineGroupsRequest) (response *DescribeMachineGroupsResponse, err error)
DescribeMachineGroups This API is used to get the list of machine groups.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeMachineGroupsWithContext ¶
func (c *Client) DescribeMachineGroupsWithContext(ctx context.Context, request *DescribeMachineGroupsRequest) (response *DescribeMachineGroupsResponse, err error)
DescribeMachineGroups This API is used to get the list of machine groups.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeMachines ¶
func (c *Client) DescribeMachines(request *DescribeMachinesRequest) (response *DescribeMachinesResponse, err error)
DescribeMachines This API is used to get the machine status in the specified machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_AGENTVERSIONNOTEXIST = "ResourceNotFound.AgentVersionNotExist" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) DescribeMachinesWithContext ¶
func (c *Client) DescribeMachinesWithContext(ctx context.Context, request *DescribeMachinesRequest) (response *DescribeMachinesResponse, err error)
DescribeMachines This API is used to get the machine status in the specified machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_AGENTVERSIONNOTEXIST = "ResourceNotFound.AgentVersionNotExist" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) DescribePartitions ¶
func (c *Client) DescribePartitions(request *DescribePartitionsRequest) (response *DescribePartitionsResponse, err error)
DescribePartitions This API is used to get the list of topic partitions.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribePartitionsWithContext ¶
func (c *Client) DescribePartitionsWithContext(ctx context.Context, request *DescribePartitionsRequest) (response *DescribePartitionsResponse, err error)
DescribePartitions This API is used to get the list of topic partitions.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) DescribeShipperTasks ¶
func (c *Client) DescribeShipperTasks(request *DescribeShipperTasksRequest) (response *DescribeShipperTasksResponse, err error)
DescribeShipperTasks This API is used to get the list of shipping tasks.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist"
func (*Client) DescribeShipperTasksWithContext ¶
func (c *Client) DescribeShipperTasksWithContext(ctx context.Context, request *DescribeShipperTasksRequest) (response *DescribeShipperTasksResponse, err error)
DescribeShipperTasks This API is used to get the list of shipping tasks.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist"
func (*Client) DescribeShippers ¶
func (c *Client) DescribeShippers(request *DescribeShippersRequest) (response *DescribeShippersResponse, err error)
DescribeShippers This API is used to get the list of shipping rules.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeShippersWithContext ¶
func (c *Client) DescribeShippersWithContext(ctx context.Context, request *DescribeShippersRequest) (response *DescribeShippersResponse, err error)
DescribeShippers This API is used to get the list of shipping rules.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) DescribeTopics ¶
func (c *Client) DescribeTopics(request *DescribeTopicsRequest) (response *DescribeTopicsResponse, err error)
DescribeTopics
This API is used to get the list of log topics and supports pagination.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_ANALYSISSWITCHCLOSE = "OperationDenied.AnalysisSwitchClose"
func (*Client) DescribeTopicsWithContext ¶
func (c *Client) DescribeTopicsWithContext(ctx context.Context, request *DescribeTopicsRequest) (response *DescribeTopicsResponse, err error)
DescribeTopics
This API is used to get the list of log topics and supports pagination.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_ANALYSISSWITCHCLOSE = "OperationDenied.AnalysisSwitchClose"
func (*Client) GetAlarmLog ¶
func (c *Client) GetAlarmLog(request *GetAlarmLogRequest) (response *GetAlarmLogResponse, err error)
GetAlarmLog This API is used to get the records of alarm tasks.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_GETLOGREACHLIMIT = "FailedOperation.GetlogReachLimit" FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) GetAlarmLogWithContext ¶
func (c *Client) GetAlarmLogWithContext(ctx context.Context, request *GetAlarmLogRequest) (response *GetAlarmLogResponse, err error)
GetAlarmLog This API is used to get the records of alarm tasks.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_GETLOGREACHLIMIT = "FailedOperation.GetlogReachLimit" FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) MergePartition ¶
func (c *Client) MergePartition(request *MergePartitionRequest) (response *MergePartitionResponse, err error)
MergePartition This API is used to merge a topic partition in read/write state. During merge, a topic partition ID can be specified, and CLS will automatically merge the partition adjacent to the right of the range.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_PARTITION = "LimitExceeded.Partition" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_PARTITIONNOTEXIST = "ResourceNotFound.PartitionNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) MergePartitionWithContext ¶
func (c *Client) MergePartitionWithContext(ctx context.Context, request *MergePartitionRequest) (response *MergePartitionResponse, err error)
MergePartition This API is used to merge a topic partition in read/write state. During merge, a topic partition ID can be specified, and CLS will automatically merge the partition adjacent to the right of the range.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_PARTITION = "LimitExceeded.Partition" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_PARTITIONNOTEXIST = "ResourceNotFound.PartitionNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) ModifyAlarm ¶
func (c *Client) ModifyAlarm(request *ModifyAlarmRequest) (response *ModifyAlarmResponse, err error)
ModifyAlarm This API is used to modify an alarm policy. At least one valid configuration item needs to be modified.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDALARM = "FailedOperation.InvalidAlarm" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_ALARMCONFLICT = "InvalidParameter.AlarmConflict" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_ALARMNOTSUPPORTFORSEARCHLOW = "OperationDenied.AlarmNotSupportForSearchLow" RESOURCENOTFOUND_ALARMNOTEXIST = "ResourceNotFound.AlarmNotExist" RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) ModifyAlarmNotice ¶
func (c *Client) ModifyAlarmNotice(request *ModifyAlarmNoticeRequest) (response *ModifyAlarmNoticeResponse, err error)
ModifyAlarmNotice This API is used to modify a notification group.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_ALARMNOTICECONFLICT = "InvalidParameter.AlarmNoticeConflict" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist"
func (*Client) ModifyAlarmNoticeWithContext ¶
func (c *Client) ModifyAlarmNoticeWithContext(ctx context.Context, request *ModifyAlarmNoticeRequest) (response *ModifyAlarmNoticeResponse, err error)
ModifyAlarmNotice This API is used to modify a notification group.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_ALARMNOTICECONFLICT = "InvalidParameter.AlarmNoticeConflict" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist"
func (*Client) ModifyAlarmWithContext ¶
func (c *Client) ModifyAlarmWithContext(ctx context.Context, request *ModifyAlarmRequest) (response *ModifyAlarmResponse, err error)
ModifyAlarm This API is used to modify an alarm policy. At least one valid configuration item needs to be modified.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDALARM = "FailedOperation.InvalidAlarm" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_ALARMCONFLICT = "InvalidParameter.AlarmConflict" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_ALARMNOTSUPPORTFORSEARCHLOW = "OperationDenied.AlarmNotSupportForSearchLow" RESOURCENOTFOUND_ALARMNOTEXIST = "ResourceNotFound.AlarmNotExist" RESOURCENOTFOUND_ALARMNOTICENOTEXIST = "ResourceNotFound.AlarmNoticeNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) ModifyConfig ¶
func (c *Client) ModifyConfig(request *ModifyConfigRequest) (response *ModifyConfigResponse, err error)
ModifyConfig This API is used to modify a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_CONFIGCONFLICT = "InvalidParameter.ConfigConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist"
func (*Client) ModifyConfigWithContext ¶
func (c *Client) ModifyConfigWithContext(ctx context.Context, request *ModifyConfigRequest) (response *ModifyConfigResponse, err error)
ModifyConfig This API is used to modify a collection rule configuration.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_CONFIGCONFLICT = "InvalidParameter.ConfigConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_CONFIGNOTEXIST = "ResourceNotFound.ConfigNotExist"
func (*Client) ModifyConsumer ¶
func (c *Client) ModifyConsumer(request *ModifyConsumerRequest) (response *ModifyConsumerResponse, err error)
ModifyConsumer This API is used to modify a shipping task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) ModifyConsumerWithContext ¶
func (c *Client) ModifyConsumerWithContext(ctx context.Context, request *ModifyConsumerRequest) (response *ModifyConsumerResponse, err error)
ModifyConsumer This API is used to modify a shipping task.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists"
func (*Client) ModifyIndex ¶
func (c *Client) ModifyIndex(request *ModifyIndexRequest) (response *ModifyIndexResponse, err error)
ModifyIndex This API is used to modify the index configuration.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDINDEXRULEFORSEARCHLOW = "FailedOperation.InValidIndexRuleForSearchLow" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_INVALIDINDEXRULEFORSEARCHLOW = "InvalidParameter.InValidIndexRuleForSearchLow" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_INDEXNOTEXIST = "ResourceNotFound.IndexNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) ModifyIndexWithContext ¶
func (c *Client) ModifyIndexWithContext(ctx context.Context, request *ModifyIndexRequest) (response *ModifyIndexResponse, err error)
ModifyIndex This API is used to modify the index configuration.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDINDEXRULEFORSEARCHLOW = "FailedOperation.InValidIndexRuleForSearchLow" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_INVALIDINDEXRULEFORSEARCHLOW = "InvalidParameter.InValidIndexRuleForSearchLow" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_INDEXNOTEXIST = "ResourceNotFound.IndexNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) ModifyLogset ¶
func (c *Client) ModifyLogset(request *ModifyLogsetRequest) (response *ModifyLogsetResponse, err error)
ModifyLogset This API is used to modify a logset.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_PERIODMODIFYFORBIDDEN = "FailedOperation.PeriodModifyForbidden" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_LOGSETCONFLICT = "InvalidParameter.LogsetConflict" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist"
func (*Client) ModifyLogsetWithContext ¶
func (c *Client) ModifyLogsetWithContext(ctx context.Context, request *ModifyLogsetRequest) (response *ModifyLogsetResponse, err error)
ModifyLogset This API is used to modify a logset.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_PERIODMODIFYFORBIDDEN = "FailedOperation.PeriodModifyForbidden" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_LOGSETCONFLICT = "InvalidParameter.LogsetConflict" LIMITEXCEEDED = "LimitExceeded" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_LOGSETNOTEXIST = "ResourceNotFound.LogsetNotExist"
func (*Client) ModifyMachineGroup ¶
func (c *Client) ModifyMachineGroup(request *ModifyMachineGroupRequest) (response *ModifyMachineGroupResponse, err error)
ModifyMachineGroup This API is used to modify a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_MACHINEGROUPCONFLICT = "InvalidParameter.MachineGroupConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED_MACHINEGROUPIP = "LimitExceeded.MachineGroupIp" LIMITEXCEEDED_MACHINEGROUPLABELS = "LimitExceeded.MachineGroupLabels" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) ModifyMachineGroupWithContext ¶
func (c *Client) ModifyMachineGroupWithContext(ctx context.Context, request *ModifyMachineGroupRequest) (response *ModifyMachineGroupResponse, err error)
ModifyMachineGroup This API is used to modify a machine group.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_MACHINEGROUPCONFLICT = "InvalidParameter.MachineGroupConflict" INVALIDPARAMETERVALUE = "InvalidParameterValue" LIMITEXCEEDED_MACHINEGROUPIP = "LimitExceeded.MachineGroupIp" LIMITEXCEEDED_MACHINEGROUPLABELS = "LimitExceeded.MachineGroupLabels" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_MACHINEGROUPNOTEXIST = "ResourceNotFound.MachineGroupNotExist"
func (*Client) ModifyShipper ¶
func (c *Client) ModifyShipper(request *ModifyShipperRequest) (response *ModifyShipperResponse, err error)
ModifyShipper This API is used to modify an existing shipping rule. To use this API, you need to grant CLS the write permission of the specified bucket.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist"
func (*Client) ModifyShipperWithContext ¶
func (c *Client) ModifyShipperWithContext(ctx context.Context, request *ModifyShipperRequest) (response *ModifyShipperResponse, err error)
ModifyShipper This API is used to modify an existing shipping rule. To use this API, you need to grant CLS the write permission of the specified bucket.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist"
func (*Client) ModifyTopic ¶
func (c *Client) ModifyTopic(request *ModifyTopicRequest) (response *ModifyTopicResponse, err error)
ModifyTopic This API is used to modify a log topic.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDPERIOD = "FailedOperation.InvalidPeriod" FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_TOPICCONFLICT = "InvalidParameter.TopicConflict" LIMITEXCEEDED = "LimitExceeded" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) ModifyTopicWithContext ¶
func (c *Client) ModifyTopicWithContext(ctx context.Context, request *ModifyTopicRequest) (response *ModifyTopicResponse, err error)
ModifyTopic This API is used to modify a log topic.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDPERIOD = "FailedOperation.InvalidPeriod" FAILEDOPERATION_TAGQPSLIMIT = "FailedOperation.TagQpsLimit" FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_TOPICCONFLICT = "InvalidParameter.TopicConflict" LIMITEXCEEDED = "LimitExceeded" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) OpenKafkaConsumer ¶
func (c *Client) OpenKafkaConsumer(request *OpenKafkaConsumerRequest) (response *OpenKafkaConsumerResponse, err error)
OpenKafkaConsumer This API is used to enable the Kafka consumption feature.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) OpenKafkaConsumerWithContext ¶
func (c *Client) OpenKafkaConsumerWithContext(ctx context.Context, request *OpenKafkaConsumerRequest) (response *OpenKafkaConsumerResponse, err error)
OpenKafkaConsumer This API is used to enable the Kafka consumption feature.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) RetryShipperTask ¶
func (c *Client) RetryShipperTask(request *RetryShipperTaskRequest) (response *RetryShipperTaskResponse, err error)
RetryShipperTask This API is used to retry a failed shipping task.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_SHIPPERTASKNOTTORETRY = "FailedOperation.ShipperTaskNotToRetry" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist" RESOURCENOTFOUND_SHIPPERTASKNOTEXIST = "ResourceNotFound.ShipperTaskNotExist"
func (*Client) RetryShipperTaskWithContext ¶
func (c *Client) RetryShipperTaskWithContext(ctx context.Context, request *RetryShipperTaskRequest) (response *RetryShipperTaskResponse, err error)
RetryShipperTask This API is used to retry a failed shipping task.
error code that may be returned:
AUTHFAILURE = "AuthFailure" FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_SHIPPERTASKNOTTORETRY = "FailedOperation.ShipperTaskNotToRetry" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_SHIPPERNOTEXIST = "ResourceNotFound.ShipperNotExist" RESOURCENOTFOUND_SHIPPERTASKNOTEXIST = "ResourceNotFound.ShipperTaskNotExist"
func (*Client) SearchLog ¶
func (c *Client) SearchLog(request *SearchLogRequest) (response *SearchLogResponse, err error)
SearchLog This API is used to search logs. It is subject to the default API rate limit, and the number of concurrent queries to the same log topic cannot exceed 15.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" LIMITEXCEEDED_SEARCHRESULTTOOLARGE = "LimitExceeded.SearchResultTooLarge" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_OPERATIONNOTSUPPORTINSEARCHLOW = "OperationDenied.OperationNotSupportInSearchLow" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) SearchLogWithContext ¶
func (c *Client) SearchLogWithContext(ctx context.Context, request *SearchLogRequest) (response *SearchLogResponse, err error)
SearchLog This API is used to search logs. It is subject to the default API rate limit, and the number of concurrent queries to the same log topic cannot exceed 15.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_INVALIDCONTEXT = "FailedOperation.InvalidContext" FAILEDOPERATION_QUERYERROR = "FailedOperation.QueryError" FAILEDOPERATION_SEARCHTIMEOUT = "FailedOperation.SearchTimeout" FAILEDOPERATION_SYNTAXERROR = "FailedOperation.SyntaxError" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_LOGSEARCH = "LimitExceeded.LogSearch" LIMITEXCEEDED_SEARCHRESULTTOOLARGE = "LimitExceeded.SearchResultTooLarge" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" OPERATIONDENIED_OPERATIONNOTSUPPORTINSEARCHLOW = "OperationDenied.OperationNotSupportInSearchLow" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) SplitPartition ¶
func (c *Client) SplitPartition(request *SplitPartitionRequest) (response *SplitPartitionResponse, err error)
SplitPartition This API is used to split a topic partition.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_PARTITION = "LimitExceeded.Partition" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_PARTITIONNOTEXIST = "ResourceNotFound.PartitionNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) SplitPartitionWithContext ¶
func (c *Client) SplitPartitionWithContext(ctx context.Context, request *SplitPartitionRequest) (response *SplitPartitionResponse, err error)
SplitPartition This API is used to split a topic partition.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" LIMITEXCEEDED_PARTITION = "LimitExceeded.Partition" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND = "ResourceNotFound" RESOURCENOTFOUND_PARTITIONNOTEXIST = "ResourceNotFound.PartitionNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) UploadLog ¶
func (c *Client) UploadLog(request *UploadLogRequest, data []byte) (response *UploadLogResponse, err error)
UploadLog ## Note
To ensure log data reliability and help you use CLS more efficiently, you are advised to use the optimized API [Uploading Structured Logs](https://intl.cloud.tencent.com/document/api/614/16873) to upload logs.
For the optimized API, we have developed an SDK (available in multiple languages) that provides features including async sending, resource control, automatic retry, graceful shutdown, and detection-based reporting. For details, see [Collection via SDK](https://intl.cloud.tencent.com/document/product/614/67157?from_cn_redirect=1).
`UploadLog` allows you to synchronously upload log data. If you still want to continue to use this API instead of the optimized one, read this document.
## Feature Description
This API is used to write logs to a specified log topic.
CLS provides the following two modes:
#### Load balancing mode
In this mode, logs will be automatically written to a target partition among all readable/writable partitions under the current log topic based on the load balancing principle. This mode is suitable for scenarios where sequential consumption is not needed.
#### Hash routing mode
In this mode, data will be written to a target partition that meets the range requirements based on the carried hash value (`X-CLS-HashKey`). For example, a log source can be bound to a topic partition through `HashKey`, strictly guaranteeing the sequence of the data written to and consumed in this partition.
In addition, CLS allows you to upload logs in the following two modes:
#### Input parameters (pb binary streams in `body`)
| Parameter | Type | Location | Required | Description |
| ------------ | ------- | ---- | ---- | ------------------------------------------------------------ |
| logGroupList | message | pb | Yes | The `logGroup` list, which describes the encapsulated log groups. We recommend you enter up to 5 `logGroup` values. |
`LogGroup` description:
| Parameter | Required | Description |
| ----------- | -------- | ------------------------------------------------------------ |
| logs | Yes | Log array consisting of multiple `Log` values. The `Log` indicates a log, and a `LogGroup` can contain up to 10,000 `Log` values. |
| contextFlow | No | Unique `LogGroup` ID, which should be passed in if the context feature needs to be used. Format: "{context ID}-{LogGroupID}". <br>Context ID: Uniquely identifies the context (a series of log files that are continuously scrolling or a series of logs that need to be sequenced), which is a 64-bit integer hex string. <br>LogGroupID: A 64-bit integer hex string that continuously increases, such as `102700A66102516A-59F59`. |
| filename | No | Log filename |
| source | No | Log source, which is generally the machine IP |
| logTags | No | Tag list of logs |
`Log` description:
| Parameter | Required | Description |
| -------- | -------- | ------------------------------------------------------------ |
| time | Yes | Unix timestamp of log time in seconds or milliseconds (recommended) |
| contents | No | Log content in key-value format. A log can contain multiple key-value pairs. |
`Content` description:
| Parameter | Required | Description |
| ------ | -------- | ------------------------------------------------------------ |
| key | Yes | Key of a field group in one log, which cannot start with `_`. |
| value | Yes | Value of a field group. The `value` of one log cannot exceed 1 MB and the total `value` in `LogGroup` cannot exceed 5 MB. |
`LogTag` description:
| Parameter | Required | Description |
| ------ | -------- | -------------------------------- |
| key | Yes | Key of a custom tag |
| value | Yes | Value corresponding to the custom tag key |
## pb Compilation Sample
This sample describes how to use the protoc compiler to compile the pb description file into a log upload API in C++.
> ?Currently, protoc supports compilation in multiple programming languages such as Java, C++, and Python. For more information, see [protoc](https://github.com/protocolbuffers/protobuf).
#### 1. Install Protocol Buffers
Download [Protocol Buffers](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz), decompress the package, and install the tool. The version used in the sample is protobuf 2.6.1 running on CentOS 7.3. Run the following command to decompress the `protobuf-2.6.1.tar.gz` package to the `/usr/local` directory and go to the directory:
```
tar -zxvf protobuf-2.6.1.tar.gz -C /usr/local/ && cd /usr/local/protobuf-2.6.1
```
Run the following commands to start compilation and installation, and configure the environment variables:
```
[root@VM_0_8_centos protobuf-2.6.1]# ./configure
[root@VM_0_8_centos protobuf-2.6.1]# make && make install
[root@VM_0_8_centos protobuf-2.6.1]# export PATH=$PATH:/usr/local/protobuf-2.6.1/bin
```
After the compilation succeeds, run the following command to check the version:
```
[root@VM_0_8_centos protobuf-2.6.1]# protoc --version
liprotoc 2.6.1
```
#### 2. Create a pb description file
A pb description file is an agreed-on data interchange format for communication. To upload logs, compile the specified protocol format to an API in the target programming language and add the API to the project code. For more information, see [protoc](https://github.com/protocolbuffers/protobuf).
Create a pb message description file `cls.proto` based on the pb data format content specified by CLS.
> !The pb description file content cannot be modified, and the filename must end with `.proto`.
The content of `cls.proto` (pb description file) is as follows:
```
package cls;
message Log
{
message Content { required string key = 1; // Key of each field group required string value = 2; // Value of each field group } required int64 time = 1; // Unix timestamp repeated Content contents = 2; // Multiple key-value pairs in one log
}
message LogTag
{
required string key = 1; required string value = 2;
}
message LogGroup
{
repeated Log logs = 1; // Log array consisting of multiple logs optional string contextFlow = 2; // This parameter does not take effect currently optional string filename = 3; // Log filename optional string source = 4; // Log source, which is generally the machine IP repeated LogTag logTags = 5;
}
message LogGroupList
{
repeated LogGroup logGroupList = 1; // Log group list
}
```
#### 3. Compile and generate the API
This sample uses the proto compiler to generate a C++ file in the same directory as the `cls.proto` file. Run the following compilation command:
```
protoc --cpp_out=./ ./cls.proto
```
> ?`--cpp_out=./ ` indicates that the file will be compiled in cpp format and output to the current directory. `./cls.proto` indicates the `cls.proto` description file in the current directory.
After the compilation succeeds, the code file in the corresponding programming language will be generated. This sample generates the `cls.pb.h` header file and [cls.pb.cc](http://cls.pb.cc) code implementation file as shown below:
```
[root@VM_0_8_centos protobuf-2.6.1]# protoc --cpp_out=./ ./cls.proto
[root@VM_0_8_centos protobuf-2.6.1]# ls
cls.pb.cc cls.pb.h cls.proto
```
#### 4. Call the API
Import the generated `cls.pb.h` header file into the code and call the API for data encapsulation.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_MISSINGCONTENT = "FailedOperation.MissingContent" FAILEDOPERATION_READQPSLIMIT = "FailedOperation.ReadQpsLimit" FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" FAILEDOPERATION_WRITEQPSLIMIT = "FailedOperation.WriteQpsLimit" FAILEDOPERATION_WRITETRAFFICLIMIT = "FailedOperation.WriteTrafficLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_CONTENT = "InvalidParameter.Content" LIMITEXCEEDED_LOGSIZE = "LimitExceeded.LogSize" LIMITEXCEEDED_TAG = "LimitExceeded.Tag" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_PARTITIONNOTEXIST = "ResourceNotFound.PartitionNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
func (*Client) UploadLogWithContext ¶
func (c *Client) UploadLogWithContext(ctx context.Context, request *UploadLogRequest, data []byte) (response *UploadLogResponse, err error)
UploadLog ## Note
To ensure log data reliability and help you use CLS more efficiently, you are advised to use the optimized API [Uploading Structured Logs](https://intl.cloud.tencent.com/document/api/614/16873) to upload logs.
For the optimized API, we have developed an SDK (available in multiple languages) that provides features including async sending, resource control, automatic retry, graceful shutdown, and detection-based reporting. For details, see [Collection via SDK](https://intl.cloud.tencent.com/document/product/614/67157?from_cn_redirect=1).
`UploadLog` allows you to synchronously upload log data. If you still want to continue to use this API instead of the optimized one, read this document.
## Feature Description
This API is used to write logs to a specified log topic.
CLS provides the following two modes:
#### Load balancing mode
In this mode, logs will be automatically written to a target partition among all readable/writable partitions under the current log topic based on the load balancing principle. This mode is suitable for scenarios where sequential consumption is not needed.
#### Hash routing mode
In this mode, data will be written to a target partition that meets the range requirements based on the carried hash value (`X-CLS-HashKey`). For example, a log source can be bound to a topic partition through `HashKey`, strictly guaranteeing the sequence of the data written to and consumed in this partition.
In addition, CLS allows you to upload logs in the following two modes:
#### Input parameters (pb binary streams in `body`)
| Parameter | Type | Location | Required | Description |
| ------------ | ------- | ---- | ---- | ------------------------------------------------------------ |
| logGroupList | message | pb | Yes | The `logGroup` list, which describes the encapsulated log groups. We recommend you enter up to 5 `logGroup` values. |
`LogGroup` description:
| Parameter | Required | Description |
| ----------- | -------- | ------------------------------------------------------------ |
| logs | Yes | Log array consisting of multiple `Log` values. The `Log` indicates a log, and a `LogGroup` can contain up to 10,000 `Log` values. |
| contextFlow | No | Unique `LogGroup` ID, which should be passed in if the context feature needs to be used. Format: "{context ID}-{LogGroupID}". <br>Context ID: Uniquely identifies the context (a series of log files that are continuously scrolling or a series of logs that need to be sequenced), which is a 64-bit integer hex string. <br>LogGroupID: A 64-bit integer hex string that continuously increases, such as `102700A66102516A-59F59`. |
| filename | No | Log filename |
| source | No | Log source, which is generally the machine IP |
| logTags | No | Tag list of logs |
`Log` description:
| Parameter | Required | Description |
| -------- | -------- | ------------------------------------------------------------ |
| time | Yes | Unix timestamp of log time in seconds or milliseconds (recommended) |
| contents | No | Log content in key-value format. A log can contain multiple key-value pairs. |
`Content` description:
| Parameter | Required | Description |
| ------ | -------- | ------------------------------------------------------------ |
| key | Yes | Key of a field group in one log, which cannot start with `_`. |
| value | Yes | Value of a field group. The `value` of one log cannot exceed 1 MB and the total `value` in `LogGroup` cannot exceed 5 MB. |
`LogTag` description:
| Parameter | Required | Description |
| ------ | -------- | -------------------------------- |
| key | Yes | Key of a custom tag |
| value | Yes | Value corresponding to the custom tag key |
## pb Compilation Sample
This sample describes how to use the protoc compiler to compile the pb description file into a log upload API in C++.
> ?Currently, protoc supports compilation in multiple programming languages such as Java, C++, and Python. For more information, see [protoc](https://github.com/protocolbuffers/protobuf).
#### 1. Install Protocol Buffers
Download [Protocol Buffers](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz), decompress the package, and install the tool. The version used in the sample is protobuf 2.6.1 running on CentOS 7.3. Run the following command to decompress the `protobuf-2.6.1.tar.gz` package to the `/usr/local` directory and go to the directory:
```
tar -zxvf protobuf-2.6.1.tar.gz -C /usr/local/ && cd /usr/local/protobuf-2.6.1
```
Run the following commands to start compilation and installation, and configure the environment variables:
```
[root@VM_0_8_centos protobuf-2.6.1]# ./configure
[root@VM_0_8_centos protobuf-2.6.1]# make && make install
[root@VM_0_8_centos protobuf-2.6.1]# export PATH=$PATH:/usr/local/protobuf-2.6.1/bin
```
After the compilation succeeds, run the following command to check the version:
```
[root@VM_0_8_centos protobuf-2.6.1]# protoc --version
liprotoc 2.6.1
```
#### 2. Create a pb description file
A pb description file is an agreed-on data interchange format for communication. To upload logs, compile the specified protocol format to an API in the target programming language and add the API to the project code. For more information, see [protoc](https://github.com/protocolbuffers/protobuf).
Create a pb message description file `cls.proto` based on the pb data format content specified by CLS.
> !The pb description file content cannot be modified, and the filename must end with `.proto`.
The content of `cls.proto` (pb description file) is as follows:
```
package cls;
message Log
{
message Content { required string key = 1; // Key of each field group required string value = 2; // Value of each field group } required int64 time = 1; // Unix timestamp repeated Content contents = 2; // Multiple key-value pairs in one log
}
message LogTag
{
required string key = 1; required string value = 2;
}
message LogGroup
{
repeated Log logs = 1; // Log array consisting of multiple logs optional string contextFlow = 2; // This parameter does not take effect currently optional string filename = 3; // Log filename optional string source = 4; // Log source, which is generally the machine IP repeated LogTag logTags = 5;
}
message LogGroupList
{
repeated LogGroup logGroupList = 1; // Log group list
}
```
#### 3. Compile and generate the API
This sample uses the proto compiler to generate a C++ file in the same directory as the `cls.proto` file. Run the following compilation command:
```
protoc --cpp_out=./ ./cls.proto
```
> ?`--cpp_out=./ ` indicates that the file will be compiled in cpp format and output to the current directory. `./cls.proto` indicates the `cls.proto` description file in the current directory.
After the compilation succeeds, the code file in the corresponding programming language will be generated. This sample generates the `cls.pb.h` header file and [cls.pb.cc](http://cls.pb.cc) code implementation file as shown below:
```
[root@VM_0_8_centos protobuf-2.6.1]# protoc --cpp_out=./ ./cls.proto
[root@VM_0_8_centos protobuf-2.6.1]# ls
cls.pb.cc cls.pb.h cls.proto
```
#### 4. Call the API
Import the generated `cls.pb.h` header file into the code and call the API for data encapsulation.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" FAILEDOPERATION_MISSINGCONTENT = "FailedOperation.MissingContent" FAILEDOPERATION_READQPSLIMIT = "FailedOperation.ReadQpsLimit" FAILEDOPERATION_TOPICCLOSED = "FailedOperation.TopicClosed" FAILEDOPERATION_TOPICISOLATED = "FailedOperation.TopicIsolated" FAILEDOPERATION_WRITEQPSLIMIT = "FailedOperation.WriteQpsLimit" FAILEDOPERATION_WRITETRAFFICLIMIT = "FailedOperation.WriteTrafficLimit" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_CONTENT = "InvalidParameter.Content" LIMITEXCEEDED_LOGSIZE = "LimitExceeded.LogSize" LIMITEXCEEDED_TAG = "LimitExceeded.Tag" MISSINGPARAMETER = "MissingParameter" OPERATIONDENIED = "OperationDenied" OPERATIONDENIED_ACLFAILED = "OperationDenied.ACLFailed" OPERATIONDENIED_ACCOUNTDESTROY = "OperationDenied.AccountDestroy" OPERATIONDENIED_ACCOUNTISOLATE = "OperationDenied.AccountIsolate" OPERATIONDENIED_ACCOUNTNOTEXISTS = "OperationDenied.AccountNotExists" RESOURCENOTFOUND_PARTITIONNOTEXIST = "ResourceNotFound.PartitionNotExist" RESOURCENOTFOUND_TOPICNOTEXIST = "ResourceNotFound.TopicNotExist"
type CloseKafkaConsumerRequest ¶
type CloseKafkaConsumerRequest struct { *tchttp.BaseRequest // CLS topic identifier FromTopicId *string `json:"FromTopicId,omitempty" name:"FromTopicId"` }
func NewCloseKafkaConsumerRequest ¶
func NewCloseKafkaConsumerRequest() (request *CloseKafkaConsumerRequest)
func (*CloseKafkaConsumerRequest) FromJsonString ¶
func (r *CloseKafkaConsumerRequest) 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 (*CloseKafkaConsumerRequest) ToJsonString ¶
func (r *CloseKafkaConsumerRequest) ToJsonString() string
type CloseKafkaConsumerResponse ¶
type CloseKafkaConsumerResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCloseKafkaConsumerResponse ¶
func NewCloseKafkaConsumerResponse() (response *CloseKafkaConsumerResponse)
func (*CloseKafkaConsumerResponse) FromJsonString ¶
func (r *CloseKafkaConsumerResponse) 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 (*CloseKafkaConsumerResponse) ToJsonString ¶
func (r *CloseKafkaConsumerResponse) ToJsonString() string
type CompressInfo ¶
type CompressInfo struct { // Compression format. Valid values: `gzip`, `lzop`, `none` (no compression) Format *string `json:"Format,omitempty" name:"Format"` }
type ConfigInfo ¶
type ConfigInfo struct { // Collection rule configuration ID ConfigId *string `json:"ConfigId,omitempty" name:"ConfigId"` // Log formatting method // Note: this field may return `null`, indicating that no valid values can be obtained. LogFormat *string `json:"LogFormat,omitempty" name:"LogFormat"` // Log collection path // Note: this field may return `null`, indicating that no valid values can be obtained. Path *string `json:"Path,omitempty" name:"Path"` // Type of the log to be collected. Valid values: `json_log`: log in JSON format; `delimiter_log`: log in delimited format; `minimalist_log`: minimalist log; `multiline_log`: log in multi-line format; `fullregex_log`: log in full regex format. Default value: `minimalist_log` // Note: this field may return `null`, indicating that no valid values can be obtained. LogType *string `json:"LogType,omitempty" name:"LogType"` // Extraction rule. If `ExtractRule` is set, `LogType` must be set // Note: this field may return `null`, indicating that no valid values can be obtained. ExtractRule *ExtractRuleInfo `json:"ExtractRule,omitempty" name:"ExtractRule"` // Collection path blocklist // Note: this field may return `null`, indicating that no valid values can be obtained. ExcludePaths []*ExcludePathInfo `json:"ExcludePaths,omitempty" name:"ExcludePaths"` // Log topic ID (TopicId) of collection configuration Output *string `json:"Output,omitempty" name:"Output"` // Update time // Note: this field may return `null`, indicating that no valid values can be obtained. UpdateTime *string `json:"UpdateTime,omitempty" name:"UpdateTime"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Custom parsing string // Note: this field may return `null`, indicating that no valid values can be obtained. UserDefineRule *string `json:"UserDefineRule,omitempty" name:"UserDefineRule"` }
type ConsumerContent ¶
type ConsumerContent struct { // Whether to ship tag information // Note: This field may return `null`, indicating that no valid value was found. EnableTag *bool `json:"EnableTag,omitempty" name:"EnableTag"` // List of metadata to ship. Currently, only __SOURCE__, __FILENAME__, and __TIMESTAMP__ are supported. // Note: This field may return `null`, indicating that no valid value was found. MetaFields []*string `json:"MetaFields,omitempty" name:"MetaFields"` // This parameter is required if `EnableTag` is `true`, and is used to specify whether the tag information is JSON tiled. Valid values: `true` (not tiled); `false` (tiled) // Note: This field may return `null`, indicating that no valid value was found. TagJsonNotTiled *bool `json:"TagJsonNotTiled,omitempty" name:"TagJsonNotTiled"` }
type ContentInfo ¶
type ContentInfo struct { // Content format. Valid values: `json`, `csv` Format *string `json:"Format,omitempty" name:"Format"` // CSV format content description // Note: this field may return `null`, indicating that no valid values can be obtained. Csv *CsvInfo `json:"Csv,omitempty" name:"Csv"` // JSON format content description // Note: this field may return `null`, indicating that no valid values can be obtained. Json *JsonInfo `json:"Json,omitempty" name:"Json"` // `Parquet` format description // Note: This field may return `null`, indicating that no valid value can be obtained. Parquet *ParquetInfo `json:"Parquet,omitempty" name:"Parquet"` }
type CreateAlarmNoticeRequest ¶
type CreateAlarmNoticeRequest struct { *tchttp.BaseRequest // Notification group name Name *string `json:"Name,omitempty" name:"Name"` // Notification type. Valid values: // <li> `Trigger`: alarm triggered // <li> `Recovery`: alarm cleared // <li> `All`: alarm triggered and alarm cleared Type *string `json:"Type,omitempty" name:"Type"` // Notification recipient NoticeReceivers []*NoticeReceiver `json:"NoticeReceivers,omitempty" name:"NoticeReceivers"` // API callback information (including WeCom) WebCallbacks []*WebCallback `json:"WebCallbacks,omitempty" name:"WebCallbacks"` }
func NewCreateAlarmNoticeRequest ¶
func NewCreateAlarmNoticeRequest() (request *CreateAlarmNoticeRequest)
func (*CreateAlarmNoticeRequest) FromJsonString ¶
func (r *CreateAlarmNoticeRequest) 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 (*CreateAlarmNoticeRequest) ToJsonString ¶
func (r *CreateAlarmNoticeRequest) ToJsonString() string
type CreateAlarmNoticeResponse ¶
type CreateAlarmNoticeResponse struct { *tchttp.BaseResponse Response *struct { // Alarm template ID AlarmNoticeId *string `json:"AlarmNoticeId,omitempty" name:"AlarmNoticeId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateAlarmNoticeResponse ¶
func NewCreateAlarmNoticeResponse() (response *CreateAlarmNoticeResponse)
func (*CreateAlarmNoticeResponse) FromJsonString ¶
func (r *CreateAlarmNoticeResponse) 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 (*CreateAlarmNoticeResponse) ToJsonString ¶
func (r *CreateAlarmNoticeResponse) ToJsonString() string
type CreateAlarmRequest ¶
type CreateAlarmRequest struct { *tchttp.BaseRequest // Alarm policy name Name *string `json:"Name,omitempty" name:"Name"` // Monitoring object list AlarmTargets []*AlarmTarget `json:"AlarmTargets,omitempty" name:"AlarmTargets"` // Monitoring task running time point MonitorTime *MonitorTime `json:"MonitorTime,omitempty" name:"MonitorTime"` // Trigger condition Condition *string `json:"Condition,omitempty" name:"Condition"` // Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1–10. TriggerCount *int64 `json:"TriggerCount,omitempty" name:"TriggerCount"` // Repeated alarm interval in minutes. Value range: 0–1440. AlarmPeriod *int64 `json:"AlarmPeriod,omitempty" name:"AlarmPeriod"` // List of associated alarm notification templates AlarmNoticeIds []*string `json:"AlarmNoticeIds,omitempty" name:"AlarmNoticeIds"` // Whether to enable the alarm policy. Default value: true Status *bool `json:"Status,omitempty" name:"Status"` // Custom alarm content MessageTemplate *string `json:"MessageTemplate,omitempty" name:"MessageTemplate"` // Custom callback CallBack *CallBackInfo `json:"CallBack,omitempty" name:"CallBack"` // Multi-Dimensional analysis Analysis []*AnalysisDimensional `json:"Analysis,omitempty" name:"Analysis"` }
func NewCreateAlarmRequest ¶
func NewCreateAlarmRequest() (request *CreateAlarmRequest)
func (*CreateAlarmRequest) FromJsonString ¶
func (r *CreateAlarmRequest) 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 (*CreateAlarmRequest) ToJsonString ¶
func (r *CreateAlarmRequest) ToJsonString() string
type CreateAlarmResponse ¶
type CreateAlarmResponse struct { *tchttp.BaseResponse Response *struct { // Alarm policy ID. AlarmId *string `json:"AlarmId,omitempty" name:"AlarmId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateAlarmResponse ¶
func NewCreateAlarmResponse() (response *CreateAlarmResponse)
func (*CreateAlarmResponse) FromJsonString ¶
func (r *CreateAlarmResponse) 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 (*CreateAlarmResponse) ToJsonString ¶
func (r *CreateAlarmResponse) ToJsonString() string
type CreateConfigRequest ¶
type CreateConfigRequest struct { *tchttp.BaseRequest // Collection configuration name Name *string `json:"Name,omitempty" name:"Name"` // Log topic ID (TopicId) of collection configuration Output *string `json:"Output,omitempty" name:"Output"` // Log collection path containing the filename Path *string `json:"Path,omitempty" name:"Path"` // Type of the log to be collected. Valid values: `json_log`: log in JSON format; `delimiter_log`: log in delimited format; `minimalist_log`: minimalist log; `multiline_log`: log in multi-line format; `fullregex_log`: log in full regex format. Default value: `minimalist_log` LogType *string `json:"LogType,omitempty" name:"LogType"` // Extraction rule. If `ExtractRule` is set, `LogType` must be set. ExtractRule *ExtractRuleInfo `json:"ExtractRule,omitempty" name:"ExtractRule"` // Collection path blocklist ExcludePaths []*ExcludePathInfo `json:"ExcludePaths,omitempty" name:"ExcludePaths"` // Custom collection rule, which is a serialized JSON string UserDefineRule *string `json:"UserDefineRule,omitempty" name:"UserDefineRule"` }
func NewCreateConfigRequest ¶
func NewCreateConfigRequest() (request *CreateConfigRequest)
func (*CreateConfigRequest) FromJsonString ¶
func (r *CreateConfigRequest) 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 (*CreateConfigRequest) ToJsonString ¶
func (r *CreateConfigRequest) ToJsonString() string
type CreateConfigResponse ¶
type CreateConfigResponse struct { *tchttp.BaseResponse Response *struct { // Collection configuration ID ConfigId *string `json:"ConfigId,omitempty" name:"ConfigId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateConfigResponse ¶
func NewCreateConfigResponse() (response *CreateConfigResponse)
func (*CreateConfigResponse) FromJsonString ¶
func (r *CreateConfigResponse) 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 (*CreateConfigResponse) ToJsonString ¶
func (r *CreateConfigResponse) ToJsonString() string
type CreateConsumerRequest ¶
type CreateConsumerRequest struct { *tchttp.BaseRequest // Log topic ID to bind TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Whether to ship log metadata. Default value: `true` NeedContent *bool `json:"NeedContent,omitempty" name:"NeedContent"` // Metadata to ship if `NeedContent` is `true` Content *ConsumerContent `json:"Content,omitempty" name:"Content"` // CKafka information Ckafka *Ckafka `json:"Ckafka,omitempty" name:"Ckafka"` }
func NewCreateConsumerRequest ¶
func NewCreateConsumerRequest() (request *CreateConsumerRequest)
func (*CreateConsumerRequest) FromJsonString ¶
func (r *CreateConsumerRequest) 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 (*CreateConsumerRequest) ToJsonString ¶
func (r *CreateConsumerRequest) ToJsonString() string
type CreateConsumerResponse ¶
type CreateConsumerResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateConsumerResponse ¶
func NewCreateConsumerResponse() (response *CreateConsumerResponse)
func (*CreateConsumerResponse) FromJsonString ¶
func (r *CreateConsumerResponse) 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 (*CreateConsumerResponse) ToJsonString ¶
func (r *CreateConsumerResponse) ToJsonString() string
type CreateExportRequest ¶
type CreateExportRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Number of logs to be exported. Maximum value: 50 million Count *uint64 `json:"Count,omitempty" name:"Count"` // Search statements for log export. <a href="https://intl.cloud.tencent.com/document/product/614/44061?from_cn_redirect=1" target="_blank">[SQL statements]</a> are not supported. Query *string `json:"Query,omitempty" name:"Query"` // Start time of the log to be exported, which is a timestamp in milliseconds From *int64 `json:"From,omitempty" name:"From"` // End time of the log to be exported, which is a timestamp in milliseconds To *int64 `json:"To,omitempty" name:"To"` // Exported log sorting order by time. Valid values: `asc`: ascending; `desc`: descending. Default value: `desc` Order *string `json:"Order,omitempty" name:"Order"` // Exported log data format. Valid values: `json`, `csv`. Default value: `json` Format *string `json:"Format,omitempty" name:"Format"` }
func NewCreateExportRequest ¶
func NewCreateExportRequest() (request *CreateExportRequest)
func (*CreateExportRequest) FromJsonString ¶
func (r *CreateExportRequest) 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 (*CreateExportRequest) ToJsonString ¶
func (r *CreateExportRequest) ToJsonString() string
type CreateExportResponse ¶
type CreateExportResponse struct { *tchttp.BaseResponse Response *struct { // Log export ID. ExportId *string `json:"ExportId,omitempty" name:"ExportId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateExportResponse ¶
func NewCreateExportResponse() (response *CreateExportResponse)
func (*CreateExportResponse) FromJsonString ¶
func (r *CreateExportResponse) 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 (*CreateExportResponse) ToJsonString ¶
func (r *CreateExportResponse) ToJsonString() string
type CreateIndexRequest ¶
type CreateIndexRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Index rule Rule *RuleInfo `json:"Rule,omitempty" name:"Rule"` // Whether to take effect. Default value: true Status *bool `json:"Status,omitempty" name:"Status"` // Internal field marker of full-text index. Default value: `false`. Valid value: `false`: excluding internal fields; `true`: including internal fields IncludeInternalFields *bool `json:"IncludeInternalFields,omitempty" name:"IncludeInternalFields"` // Metadata flag. Default value: `0`. Valid value: `0`: full-text index (including the metadata field with key-value index enabled); `1`: full-text index (including all metadata fields); `2`: full-text index (excluding metadata fields). MetadataFlag *uint64 `json:"MetadataFlag,omitempty" name:"MetadataFlag"` }
func NewCreateIndexRequest ¶
func NewCreateIndexRequest() (request *CreateIndexRequest)
func (*CreateIndexRequest) FromJsonString ¶
func (r *CreateIndexRequest) 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 (*CreateIndexRequest) ToJsonString ¶
func (r *CreateIndexRequest) ToJsonString() string
type CreateIndexResponse ¶
type CreateIndexResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateIndexResponse ¶
func NewCreateIndexResponse() (response *CreateIndexResponse)
func (*CreateIndexResponse) FromJsonString ¶
func (r *CreateIndexResponse) 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 (*CreateIndexResponse) ToJsonString ¶
func (r *CreateIndexResponse) ToJsonString() string
type CreateLogsetRequest ¶
type CreateLogsetRequest struct { *tchttp.BaseRequest // Logset name, which must be unique LogsetName *string `json:"LogsetName,omitempty" name:"LogsetName"` // Tag description list. Up to 10 tag key-value pairs are supported and must be unique. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
func NewCreateLogsetRequest ¶
func NewCreateLogsetRequest() (request *CreateLogsetRequest)
func (*CreateLogsetRequest) FromJsonString ¶
func (r *CreateLogsetRequest) 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 (*CreateLogsetRequest) ToJsonString ¶
func (r *CreateLogsetRequest) ToJsonString() string
type CreateLogsetResponse ¶
type CreateLogsetResponse struct { *tchttp.BaseResponse Response *struct { // Logset ID LogsetId *string `json:"LogsetId,omitempty" name:"LogsetId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateLogsetResponse ¶
func NewCreateLogsetResponse() (response *CreateLogsetResponse)
func (*CreateLogsetResponse) FromJsonString ¶
func (r *CreateLogsetResponse) 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 (*CreateLogsetResponse) ToJsonString ¶
func (r *CreateLogsetResponse) ToJsonString() string
type CreateMachineGroupRequest ¶
type CreateMachineGroupRequest struct { *tchttp.BaseRequest // Machine group name, which must be unique GroupName *string `json:"GroupName,omitempty" name:"GroupName"` // Type of the machine group to be created. Valid values: `ip`: use the IP string list in `Values` to create a machine group; `label`: use the tag string list in `Values` to create a machine group MachineGroupType *MachineGroupTypeInfo `json:"MachineGroupType,omitempty" name:"MachineGroupType"` // Tag description list. This parameter is used to bind a tag to a machine group. Up to 10 tag key-value pairs are supported, and a resource can be bound to only one tag key. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Whether to enable automatic update for the machine group AutoUpdate *bool `json:"AutoUpdate,omitempty" name:"AutoUpdate"` // Update start time. We recommend you update LogListener during off-peak hours. UpdateStartTime *string `json:"UpdateStartTime,omitempty" name:"UpdateStartTime"` // Update end time. We recommend you update LogListener during off-peak hours. UpdateEndTime *string `json:"UpdateEndTime,omitempty" name:"UpdateEndTime"` // Whether to enable the service log to record the logs generated by the LogListener service itself. After it is enabled, the internal logset `cls_service_logging` and the `loglistener_status`, `loglistener_alarm`, and `loglistener_business` log topics will be created, which will not incur fees ServiceLogging *bool `json:"ServiceLogging,omitempty" name:"ServiceLogging"` }
func NewCreateMachineGroupRequest ¶
func NewCreateMachineGroupRequest() (request *CreateMachineGroupRequest)
func (*CreateMachineGroupRequest) FromJsonString ¶
func (r *CreateMachineGroupRequest) 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 (*CreateMachineGroupRequest) ToJsonString ¶
func (r *CreateMachineGroupRequest) ToJsonString() string
type CreateMachineGroupResponse ¶
type CreateMachineGroupResponse struct { *tchttp.BaseResponse Response *struct { // Machine group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateMachineGroupResponse ¶
func NewCreateMachineGroupResponse() (response *CreateMachineGroupResponse)
func (*CreateMachineGroupResponse) FromJsonString ¶
func (r *CreateMachineGroupResponse) 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 (*CreateMachineGroupResponse) ToJsonString ¶
func (r *CreateMachineGroupResponse) ToJsonString() string
type CreateShipperRequest ¶
type CreateShipperRequest struct { *tchttp.BaseRequest // ID of the log topic to which the shipping rule to be created belongs TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Destination bucket in the shipping rule to be created Bucket *string `json:"Bucket,omitempty" name:"Bucket"` // Prefix of the shipping directory in the shipping rule to be created Prefix *string `json:"Prefix,omitempty" name:"Prefix"` // Shipping rule name ShipperName *string `json:"ShipperName,omitempty" name:"ShipperName"` // Interval between shipping tasks (in sec). Default value: 300. Value range: 300-900 Interval *uint64 `json:"Interval,omitempty" name:"Interval"` // Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100-256 MaxSize *uint64 `json:"MaxSize,omitempty" name:"MaxSize"` // Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped. FilterRules []*FilterRuleInfo `json:"FilterRules,omitempty" name:"FilterRules"` // Rules for partitioning logs to be shipped. `strftime` can be used to define the presentation of time format. Partition *string `json:"Partition,omitempty" name:"Partition"` // Compression configuration of shipped log Compress *CompressInfo `json:"Compress,omitempty" name:"Compress"` // Format configuration of shipped log content Content *ContentInfo `json:"Content,omitempty" name:"Content"` }
func NewCreateShipperRequest ¶
func NewCreateShipperRequest() (request *CreateShipperRequest)
func (*CreateShipperRequest) FromJsonString ¶
func (r *CreateShipperRequest) 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 (*CreateShipperRequest) ToJsonString ¶
func (r *CreateShipperRequest) ToJsonString() string
type CreateShipperResponse ¶
type CreateShipperResponse struct { *tchttp.BaseResponse Response *struct { // Shipping rule ID ShipperId *string `json:"ShipperId,omitempty" name:"ShipperId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateShipperResponse ¶
func NewCreateShipperResponse() (response *CreateShipperResponse)
func (*CreateShipperResponse) FromJsonString ¶
func (r *CreateShipperResponse) 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 (*CreateShipperResponse) ToJsonString ¶
func (r *CreateShipperResponse) ToJsonString() string
type CreateTopicRequest ¶
type CreateTopicRequest struct { *tchttp.BaseRequest // Logset ID LogsetId *string `json:"LogsetId,omitempty" name:"LogsetId"` // Log topic name TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Number of log topic partitions. Default value: 1. Maximum value: 10 PartitionCount *int64 `json:"PartitionCount,omitempty" name:"PartitionCount"` // Tag description list. This parameter is used to bind a tag to a log topic. Up to 10 tag key-value pairs are supported, and a resource can be bound to only one tag key. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Whether to enable automatic split. Default value: true AutoSplit *bool `json:"AutoSplit,omitempty" name:"AutoSplit"` // Maximum number of partitions to split into for this topic if automatic split is enabled. Default value: 50 MaxSplitPartitions *int64 `json:"MaxSplitPartitions,omitempty" name:"MaxSplitPartitions"` // Log topic storage type. Valid values: `hot` (STANDARD storage); `cold` (IA storage). Default value: `hot`. StorageType *string `json:"StorageType,omitempty" name:"StorageType"` // Lifecycle in days. Value range: 1-3600 (3640 indicates permanent retention) Period *int64 `json:"Period,omitempty" name:"Period"` }
func NewCreateTopicRequest ¶
func NewCreateTopicRequest() (request *CreateTopicRequest)
func (*CreateTopicRequest) FromJsonString ¶
func (r *CreateTopicRequest) 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 (*CreateTopicRequest) ToJsonString ¶
func (r *CreateTopicRequest) ToJsonString() string
type CreateTopicResponse ¶
type CreateTopicResponse struct { *tchttp.BaseResponse Response *struct { // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateTopicResponse ¶
func NewCreateTopicResponse() (response *CreateTopicResponse)
func (*CreateTopicResponse) FromJsonString ¶
func (r *CreateTopicResponse) 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 (*CreateTopicResponse) ToJsonString ¶
func (r *CreateTopicResponse) ToJsonString() string
type CsvInfo ¶
type CsvInfo struct { // Whether to print `key` on the first row of the CSV file PrintKey *bool `json:"PrintKey,omitempty" name:"PrintKey"` // Names of keys // Note: this field may return `null`, indicating that no valid values can be obtained. Keys []*string `json:"Keys,omitempty" name:"Keys"` // Field delimiter Delimiter *string `json:"Delimiter,omitempty" name:"Delimiter"` // Escape character used to enclose any field delimiter in field content. You can enter only a single quotation mark, double quotation mark, or an empty string. EscapeChar *string `json:"EscapeChar,omitempty" name:"EscapeChar"` // Content used to populate non-existing fields NonExistingField *string `json:"NonExistingField,omitempty" name:"NonExistingField"` }
type DeleteAlarmNoticeRequest ¶
type DeleteAlarmNoticeRequest struct { *tchttp.BaseRequest // Notification group ID AlarmNoticeId *string `json:"AlarmNoticeId,omitempty" name:"AlarmNoticeId"` }
func NewDeleteAlarmNoticeRequest ¶
func NewDeleteAlarmNoticeRequest() (request *DeleteAlarmNoticeRequest)
func (*DeleteAlarmNoticeRequest) FromJsonString ¶
func (r *DeleteAlarmNoticeRequest) 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 (*DeleteAlarmNoticeRequest) ToJsonString ¶
func (r *DeleteAlarmNoticeRequest) ToJsonString() string
type DeleteAlarmNoticeResponse ¶
type DeleteAlarmNoticeResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteAlarmNoticeResponse ¶
func NewDeleteAlarmNoticeResponse() (response *DeleteAlarmNoticeResponse)
func (*DeleteAlarmNoticeResponse) FromJsonString ¶
func (r *DeleteAlarmNoticeResponse) 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 (*DeleteAlarmNoticeResponse) ToJsonString ¶
func (r *DeleteAlarmNoticeResponse) ToJsonString() string
type DeleteAlarmRequest ¶
type DeleteAlarmRequest struct { *tchttp.BaseRequest // Alarm policy ID. AlarmId *string `json:"AlarmId,omitempty" name:"AlarmId"` }
func NewDeleteAlarmRequest ¶
func NewDeleteAlarmRequest() (request *DeleteAlarmRequest)
func (*DeleteAlarmRequest) FromJsonString ¶
func (r *DeleteAlarmRequest) 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 (*DeleteAlarmRequest) ToJsonString ¶
func (r *DeleteAlarmRequest) ToJsonString() string
type DeleteAlarmResponse ¶
type DeleteAlarmResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteAlarmResponse ¶
func NewDeleteAlarmResponse() (response *DeleteAlarmResponse)
func (*DeleteAlarmResponse) FromJsonString ¶
func (r *DeleteAlarmResponse) 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 (*DeleteAlarmResponse) ToJsonString ¶
func (r *DeleteAlarmResponse) ToJsonString() string
type DeleteConfigFromMachineGroupRequest ¶
type DeleteConfigFromMachineGroupRequest struct { *tchttp.BaseRequest // Machine group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Collection configuration ID ConfigId *string `json:"ConfigId,omitempty" name:"ConfigId"` }
func NewDeleteConfigFromMachineGroupRequest ¶
func NewDeleteConfigFromMachineGroupRequest() (request *DeleteConfigFromMachineGroupRequest)
func (*DeleteConfigFromMachineGroupRequest) FromJsonString ¶
func (r *DeleteConfigFromMachineGroupRequest) 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 (*DeleteConfigFromMachineGroupRequest) ToJsonString ¶
func (r *DeleteConfigFromMachineGroupRequest) ToJsonString() string
type DeleteConfigFromMachineGroupResponse ¶
type DeleteConfigFromMachineGroupResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteConfigFromMachineGroupResponse ¶
func NewDeleteConfigFromMachineGroupResponse() (response *DeleteConfigFromMachineGroupResponse)
func (*DeleteConfigFromMachineGroupResponse) FromJsonString ¶
func (r *DeleteConfigFromMachineGroupResponse) 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 (*DeleteConfigFromMachineGroupResponse) ToJsonString ¶
func (r *DeleteConfigFromMachineGroupResponse) ToJsonString() string
type DeleteConfigRequest ¶
type DeleteConfigRequest struct { *tchttp.BaseRequest // Collection rule configuration ID ConfigId *string `json:"ConfigId,omitempty" name:"ConfigId"` }
func NewDeleteConfigRequest ¶
func NewDeleteConfigRequest() (request *DeleteConfigRequest)
func (*DeleteConfigRequest) FromJsonString ¶
func (r *DeleteConfigRequest) 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 (*DeleteConfigRequest) ToJsonString ¶
func (r *DeleteConfigRequest) ToJsonString() string
type DeleteConfigResponse ¶
type DeleteConfigResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteConfigResponse ¶
func NewDeleteConfigResponse() (response *DeleteConfigResponse)
func (*DeleteConfigResponse) FromJsonString ¶
func (r *DeleteConfigResponse) 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 (*DeleteConfigResponse) ToJsonString ¶
func (r *DeleteConfigResponse) ToJsonString() string
type DeleteConsumerRequest ¶
type DeleteConsumerRequest struct { *tchttp.BaseRequest // Log topic ID bound to the task TopicId *string `json:"TopicId,omitempty" name:"TopicId"` }
func NewDeleteConsumerRequest ¶
func NewDeleteConsumerRequest() (request *DeleteConsumerRequest)
func (*DeleteConsumerRequest) FromJsonString ¶
func (r *DeleteConsumerRequest) 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 (*DeleteConsumerRequest) ToJsonString ¶
func (r *DeleteConsumerRequest) ToJsonString() string
type DeleteConsumerResponse ¶
type DeleteConsumerResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteConsumerResponse ¶
func NewDeleteConsumerResponse() (response *DeleteConsumerResponse)
func (*DeleteConsumerResponse) FromJsonString ¶
func (r *DeleteConsumerResponse) 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 (*DeleteConsumerResponse) ToJsonString ¶
func (r *DeleteConsumerResponse) ToJsonString() string
type DeleteExportRequest ¶
type DeleteExportRequest struct { *tchttp.BaseRequest // Log export ID ExportId *string `json:"ExportId,omitempty" name:"ExportId"` }
func NewDeleteExportRequest ¶
func NewDeleteExportRequest() (request *DeleteExportRequest)
func (*DeleteExportRequest) FromJsonString ¶
func (r *DeleteExportRequest) 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 (*DeleteExportRequest) ToJsonString ¶
func (r *DeleteExportRequest) ToJsonString() string
type DeleteExportResponse ¶
type DeleteExportResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteExportResponse ¶
func NewDeleteExportResponse() (response *DeleteExportResponse)
func (*DeleteExportResponse) FromJsonString ¶
func (r *DeleteExportResponse) 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 (*DeleteExportResponse) ToJsonString ¶
func (r *DeleteExportResponse) ToJsonString() string
type DeleteIndexRequest ¶
type DeleteIndexRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` }
func NewDeleteIndexRequest ¶
func NewDeleteIndexRequest() (request *DeleteIndexRequest)
func (*DeleteIndexRequest) FromJsonString ¶
func (r *DeleteIndexRequest) 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 (*DeleteIndexRequest) ToJsonString ¶
func (r *DeleteIndexRequest) ToJsonString() string
type DeleteIndexResponse ¶
type DeleteIndexResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteIndexResponse ¶
func NewDeleteIndexResponse() (response *DeleteIndexResponse)
func (*DeleteIndexResponse) FromJsonString ¶
func (r *DeleteIndexResponse) 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 (*DeleteIndexResponse) ToJsonString ¶
func (r *DeleteIndexResponse) ToJsonString() string
type DeleteLogsetRequest ¶
type DeleteLogsetRequest struct { *tchttp.BaseRequest // Logset ID LogsetId *string `json:"LogsetId,omitempty" name:"LogsetId"` }
func NewDeleteLogsetRequest ¶
func NewDeleteLogsetRequest() (request *DeleteLogsetRequest)
func (*DeleteLogsetRequest) FromJsonString ¶
func (r *DeleteLogsetRequest) 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 (*DeleteLogsetRequest) ToJsonString ¶
func (r *DeleteLogsetRequest) ToJsonString() string
type DeleteLogsetResponse ¶
type DeleteLogsetResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteLogsetResponse ¶
func NewDeleteLogsetResponse() (response *DeleteLogsetResponse)
func (*DeleteLogsetResponse) FromJsonString ¶
func (r *DeleteLogsetResponse) 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 (*DeleteLogsetResponse) ToJsonString ¶
func (r *DeleteLogsetResponse) ToJsonString() string
type DeleteMachineGroupRequest ¶
type DeleteMachineGroupRequest struct { *tchttp.BaseRequest // Machine group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` }
func NewDeleteMachineGroupRequest ¶
func NewDeleteMachineGroupRequest() (request *DeleteMachineGroupRequest)
func (*DeleteMachineGroupRequest) FromJsonString ¶
func (r *DeleteMachineGroupRequest) 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 (*DeleteMachineGroupRequest) ToJsonString ¶
func (r *DeleteMachineGroupRequest) ToJsonString() string
type DeleteMachineGroupResponse ¶
type DeleteMachineGroupResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteMachineGroupResponse ¶
func NewDeleteMachineGroupResponse() (response *DeleteMachineGroupResponse)
func (*DeleteMachineGroupResponse) FromJsonString ¶
func (r *DeleteMachineGroupResponse) 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 (*DeleteMachineGroupResponse) ToJsonString ¶
func (r *DeleteMachineGroupResponse) ToJsonString() string
type DeleteShipperRequest ¶
type DeleteShipperRequest struct { *tchttp.BaseRequest // Shipping rule ID ShipperId *string `json:"ShipperId,omitempty" name:"ShipperId"` }
func NewDeleteShipperRequest ¶
func NewDeleteShipperRequest() (request *DeleteShipperRequest)
func (*DeleteShipperRequest) FromJsonString ¶
func (r *DeleteShipperRequest) 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 (*DeleteShipperRequest) ToJsonString ¶
func (r *DeleteShipperRequest) ToJsonString() string
type DeleteShipperResponse ¶
type DeleteShipperResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteShipperResponse ¶
func NewDeleteShipperResponse() (response *DeleteShipperResponse)
func (*DeleteShipperResponse) FromJsonString ¶
func (r *DeleteShipperResponse) 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 (*DeleteShipperResponse) ToJsonString ¶
func (r *DeleteShipperResponse) ToJsonString() string
type DeleteTopicRequest ¶
type DeleteTopicRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` }
func NewDeleteTopicRequest ¶
func NewDeleteTopicRequest() (request *DeleteTopicRequest)
func (*DeleteTopicRequest) FromJsonString ¶
func (r *DeleteTopicRequest) 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 (*DeleteTopicRequest) ToJsonString ¶
func (r *DeleteTopicRequest) ToJsonString() string
type DeleteTopicResponse ¶
type DeleteTopicResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteTopicResponse ¶
func NewDeleteTopicResponse() (response *DeleteTopicResponse)
func (*DeleteTopicResponse) FromJsonString ¶
func (r *DeleteTopicResponse) 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 (*DeleteTopicResponse) ToJsonString ¶
func (r *DeleteTopicResponse) ToJsonString() string
type DescribeAlarmNoticesRequest ¶
type DescribeAlarmNoticesRequest struct { *tchttp.BaseRequest // <li> name // Filter by **notification group name**. // Type: String // Required: No // <li> alarmNoticeId // Filter by **notification group ID**. // Type: String // Required: No // <li> uid // Filter by **recipient ID**. // Type: String // Required: No // <li> groupId // Filter by **recipient ID**. // Type: String // Required: No // // Each request can have up to 10 `Filters` and 5 `Filter.Values`. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Page offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of entries per page. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeAlarmNoticesRequest ¶
func NewDescribeAlarmNoticesRequest() (request *DescribeAlarmNoticesRequest)
func (*DescribeAlarmNoticesRequest) FromJsonString ¶
func (r *DescribeAlarmNoticesRequest) 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 (*DescribeAlarmNoticesRequest) ToJsonString ¶
func (r *DescribeAlarmNoticesRequest) ToJsonString() string
type DescribeAlarmNoticesResponse ¶
type DescribeAlarmNoticesResponse struct { *tchttp.BaseResponse Response *struct { // Alarm notification template list // Note: this field may return `null`, indicating that no valid values can be obtained. AlarmNotices []*AlarmNotice `json:"AlarmNotices,omitempty" name:"AlarmNotices"` // Total number of eligible alarm notification templates TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeAlarmNoticesResponse ¶
func NewDescribeAlarmNoticesResponse() (response *DescribeAlarmNoticesResponse)
func (*DescribeAlarmNoticesResponse) FromJsonString ¶
func (r *DescribeAlarmNoticesResponse) 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 (*DescribeAlarmNoticesResponse) ToJsonString ¶
func (r *DescribeAlarmNoticesResponse) ToJsonString() string
type DescribeAlarmsRequest ¶
type DescribeAlarmsRequest struct { *tchttp.BaseRequest // <br><li> name // // Filter by **alarm policy name** // Type: string // // Required: no // // <br><li> alarmId // // Filter by **alarm policy ID** // Type: string // // Required: no // // <br><li> topicId // // Filter by **log topic ID** // // Type: string // // Required: no // // <br><li> enable // // Filter by **enablement status** // // Type: string // // Note: The valid values of `enable` include `1`, `t`, `T`, `TRUE`, `true`, `True`, `0`, `f`, `F`, `FALSE`, `false`, and `False`. If other values are entered, an “invalid parameter” error will be returned. // // Required: no // // Each request can have up to 10 `Filters` and 5 `Filter.Values`. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Page offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of entries per page. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeAlarmsRequest ¶
func NewDescribeAlarmsRequest() (request *DescribeAlarmsRequest)
func (*DescribeAlarmsRequest) FromJsonString ¶
func (r *DescribeAlarmsRequest) 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 (*DescribeAlarmsRequest) ToJsonString ¶
func (r *DescribeAlarmsRequest) ToJsonString() string
type DescribeAlarmsResponse ¶
type DescribeAlarmsResponse struct { *tchttp.BaseResponse Response *struct { // Alarm policy list Alarms []*AlarmInfo `json:"Alarms,omitempty" name:"Alarms"` // Number of eligible alarm policies TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeAlarmsResponse ¶
func NewDescribeAlarmsResponse() (response *DescribeAlarmsResponse)
func (*DescribeAlarmsResponse) FromJsonString ¶
func (r *DescribeAlarmsResponse) 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 (*DescribeAlarmsResponse) ToJsonString ¶
func (r *DescribeAlarmsResponse) ToJsonString() string
type DescribeConfigMachineGroupsRequest ¶
type DescribeConfigMachineGroupsRequest struct { *tchttp.BaseRequest // Collection configuration ID ConfigId *string `json:"ConfigId,omitempty" name:"ConfigId"` }
func NewDescribeConfigMachineGroupsRequest ¶
func NewDescribeConfigMachineGroupsRequest() (request *DescribeConfigMachineGroupsRequest)
func (*DescribeConfigMachineGroupsRequest) FromJsonString ¶
func (r *DescribeConfigMachineGroupsRequest) 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 (*DescribeConfigMachineGroupsRequest) ToJsonString ¶
func (r *DescribeConfigMachineGroupsRequest) ToJsonString() string
type DescribeConfigMachineGroupsResponse ¶
type DescribeConfigMachineGroupsResponse struct { *tchttp.BaseResponse Response *struct { // List of machine groups bound to the collection rule configuration // Note: this field may return `null`, indicating that no valid values can be obtained. MachineGroups []*MachineGroupInfo `json:"MachineGroups,omitempty" name:"MachineGroups"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeConfigMachineGroupsResponse ¶
func NewDescribeConfigMachineGroupsResponse() (response *DescribeConfigMachineGroupsResponse)
func (*DescribeConfigMachineGroupsResponse) FromJsonString ¶
func (r *DescribeConfigMachineGroupsResponse) 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 (*DescribeConfigMachineGroupsResponse) ToJsonString ¶
func (r *DescribeConfigMachineGroupsResponse) ToJsonString() string
type DescribeConfigsRequest ¶
type DescribeConfigsRequest struct { *tchttp.BaseRequest // <br><li> configName // // Filter by fuzzy match of **collection configuration name** // Type: String // // Required: no // // <br><li> configId // // Filter by **collection configuration ID**. // Type: String // // Required: no // // <br><li> topicId // // Filter by **log topic**. // // Type: String // // Required: no // // Each request can contain up to 10 `Filters` and 5 `Filter.Values`. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Page offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of entries per page. Default value: 20. Maximum value: 100 Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeConfigsRequest ¶
func NewDescribeConfigsRequest() (request *DescribeConfigsRequest)
func (*DescribeConfigsRequest) FromJsonString ¶
func (r *DescribeConfigsRequest) 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 (*DescribeConfigsRequest) ToJsonString ¶
func (r *DescribeConfigsRequest) ToJsonString() string
type DescribeConfigsResponse ¶
type DescribeConfigsResponse struct { *tchttp.BaseResponse Response *struct { // Collection configuration list // Note: this field may return `null`, indicating that no valid values can be obtained. Configs []*ConfigInfo `json:"Configs,omitempty" name:"Configs"` // Total number of filtered items TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeConfigsResponse ¶
func NewDescribeConfigsResponse() (response *DescribeConfigsResponse)
func (*DescribeConfigsResponse) FromJsonString ¶
func (r *DescribeConfigsResponse) 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 (*DescribeConfigsResponse) ToJsonString ¶
func (r *DescribeConfigsResponse) ToJsonString() string
type DescribeConsumerRequest ¶
type DescribeConsumerRequest struct { *tchttp.BaseRequest // Log topic ID bound to the task TopicId *string `json:"TopicId,omitempty" name:"TopicId"` }
func NewDescribeConsumerRequest ¶
func NewDescribeConsumerRequest() (request *DescribeConsumerRequest)
func (*DescribeConsumerRequest) FromJsonString ¶
func (r *DescribeConsumerRequest) 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 (*DescribeConsumerRequest) ToJsonString ¶
func (r *DescribeConsumerRequest) ToJsonString() string
type DescribeConsumerResponse ¶
type DescribeConsumerResponse struct { *tchttp.BaseResponse Response *struct { // Whether the shipping task is effective Effective *bool `json:"Effective,omitempty" name:"Effective"` // Whether log metadata is shipped NeedContent *bool `json:"NeedContent,omitempty" name:"NeedContent"` // Metadata shipped if `NeedContent` is `true` // Note: This field may return `null`, indicating that no valid value was found. Content *ConsumerContent `json:"Content,omitempty" name:"Content"` // CKafka information Ckafka *Ckafka `json:"Ckafka,omitempty" name:"Ckafka"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeConsumerResponse ¶
func NewDescribeConsumerResponse() (response *DescribeConsumerResponse)
func (*DescribeConsumerResponse) FromJsonString ¶
func (r *DescribeConsumerResponse) 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 (*DescribeConsumerResponse) ToJsonString ¶
func (r *DescribeConsumerResponse) ToJsonString() string
type DescribeExportsRequest ¶
type DescribeExportsRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Page offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of entries per page. Default value: 20. Maximum value: 100 Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeExportsRequest ¶
func NewDescribeExportsRequest() (request *DescribeExportsRequest)
func (*DescribeExportsRequest) FromJsonString ¶
func (r *DescribeExportsRequest) 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 (*DescribeExportsRequest) ToJsonString ¶
func (r *DescribeExportsRequest) ToJsonString() string
type DescribeExportsResponse ¶
type DescribeExportsResponse struct { *tchttp.BaseResponse Response *struct { // List of exported logs Exports []*ExportInfo `json:"Exports,omitempty" name:"Exports"` // Total number TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeExportsResponse ¶
func NewDescribeExportsResponse() (response *DescribeExportsResponse)
func (*DescribeExportsResponse) FromJsonString ¶
func (r *DescribeExportsResponse) 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 (*DescribeExportsResponse) ToJsonString ¶
func (r *DescribeExportsResponse) ToJsonString() string
type DescribeIndexRequest ¶
type DescribeIndexRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` }
func NewDescribeIndexRequest ¶
func NewDescribeIndexRequest() (request *DescribeIndexRequest)
func (*DescribeIndexRequest) FromJsonString ¶
func (r *DescribeIndexRequest) 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 (*DescribeIndexRequest) ToJsonString ¶
func (r *DescribeIndexRequest) ToJsonString() string
type DescribeIndexResponse ¶
type DescribeIndexResponse struct { *tchttp.BaseResponse Response *struct { // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Whether it takes effect Status *bool `json:"Status,omitempty" name:"Status"` // Index configuration information // Note: this field may return `null`, indicating that no valid values can be obtained. Rule *RuleInfo `json:"Rule,omitempty" name:"Rule"` // Index modification time. The default value is the index creation time. ModifyTime *string `json:"ModifyTime,omitempty" name:"ModifyTime"` // Internal field marker of full-text index. Default value: `false`. Valid value: `false`: excluding internal fields; `true`: including internal fields // Note: This field may return `null`, indicating that no valid value was found. IncludeInternalFields *bool `json:"IncludeInternalFields,omitempty" name:"IncludeInternalFields"` // Metadata flag. Default value: `0`. Valid value: `0`: full-text index (including the metadata field with key-value index enabled); `1`: full-text index (including all metadata fields); `2`: full-text index (excluding metadata fields). // Note: This field may return `null`, indicating that no valid value was found. MetadataFlag *uint64 `json:"MetadataFlag,omitempty" name:"MetadataFlag"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeIndexResponse ¶
func NewDescribeIndexResponse() (response *DescribeIndexResponse)
func (*DescribeIndexResponse) FromJsonString ¶
func (r *DescribeIndexResponse) 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 (*DescribeIndexResponse) ToJsonString ¶
func (r *DescribeIndexResponse) ToJsonString() string
type DescribeLogContextRequest ¶
type DescribeLogContextRequest struct { *tchttp.BaseRequest // Log topic ID to be queried TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Log time in the format of YYYY-mm-dd HH:MM:SS.FFF BTime *string `json:"BTime,omitempty" name:"BTime"` // Log package number PkgId *string `json:"PkgId,omitempty" name:"PkgId"` // Log number in log package PkgLogId *int64 `json:"PkgLogId,omitempty" name:"PkgLogId"` // Number of previous logs. Default value: 10 PrevLogs *int64 `json:"PrevLogs,omitempty" name:"PrevLogs"` // Number of next logs. Default value: 10 NextLogs *int64 `json:"NextLogs,omitempty" name:"NextLogs"` }
func NewDescribeLogContextRequest ¶
func NewDescribeLogContextRequest() (request *DescribeLogContextRequest)
func (*DescribeLogContextRequest) FromJsonString ¶
func (r *DescribeLogContextRequest) 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 (*DescribeLogContextRequest) ToJsonString ¶
func (r *DescribeLogContextRequest) ToJsonString() string
type DescribeLogContextResponse ¶
type DescribeLogContextResponse struct { *tchttp.BaseResponse Response *struct { // Log context information set LogContextInfos []*LogContextInfo `json:"LogContextInfos,omitempty" name:"LogContextInfos"` // Whether the previous logs have been returned PrevOver *bool `json:"PrevOver,omitempty" name:"PrevOver"` // Whether the next logs have been returned NextOver *bool `json:"NextOver,omitempty" name:"NextOver"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeLogContextResponse ¶
func NewDescribeLogContextResponse() (response *DescribeLogContextResponse)
func (*DescribeLogContextResponse) FromJsonString ¶
func (r *DescribeLogContextResponse) 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 (*DescribeLogContextResponse) ToJsonString ¶
func (r *DescribeLogContextResponse) ToJsonString() string
type DescribeLogHistogramRequest ¶
type DescribeLogHistogramRequest struct { *tchttp.BaseRequest // ID of the log topic to be queried TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Start time of the log to be queried, which is a Unix timestamp in milliseconds From *int64 `json:"From,omitempty" name:"From"` // End time of the log to be queried, which is a Unix timestamp in milliseconds To *int64 `json:"To,omitempty" name:"To"` // Query statement Query *string `json:"Query,omitempty" name:"Query"` // Time interval in milliseconds Interval *int64 `json:"Interval,omitempty" name:"Interval"` }
func NewDescribeLogHistogramRequest ¶
func NewDescribeLogHistogramRequest() (request *DescribeLogHistogramRequest)
func (*DescribeLogHistogramRequest) FromJsonString ¶
func (r *DescribeLogHistogramRequest) 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 (*DescribeLogHistogramRequest) ToJsonString ¶
func (r *DescribeLogHistogramRequest) ToJsonString() string
type DescribeLogHistogramResponse ¶
type DescribeLogHistogramResponse struct { *tchttp.BaseResponse Response *struct { // Statistical period in milliseconds Interval *int64 `json:"Interval,omitempty" name:"Interval"` // The number of logs that hit the keywords TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Statistical result details within the period HistogramInfos []*HistogramInfo `json:"HistogramInfos,omitempty" name:"HistogramInfos"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeLogHistogramResponse ¶
func NewDescribeLogHistogramResponse() (response *DescribeLogHistogramResponse)
func (*DescribeLogHistogramResponse) FromJsonString ¶
func (r *DescribeLogHistogramResponse) 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 (*DescribeLogHistogramResponse) ToJsonString ¶
func (r *DescribeLogHistogramResponse) ToJsonString() string
type DescribeLogsetsRequest ¶
type DescribeLogsetsRequest struct { *tchttp.BaseRequest // <br><li> logsetName // // Filter by **logset name**. // Type: String // // Required: no // // <br><li> logsetId // // Filter by **logset ID**. // Type: String // // Required: no // // <br><li> tagKey // // Filter by **tag key**. // // Type: String // // Required: no // // <br><li> tag:tagKey // // Filter by **tag key-value pair**. The `tagKey` should be replaced with a specified tag key. // Type: String // // Required: no // // // Each request can contain up to 10 `Filters` and 5 `Filter.Values`. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Page offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of entries per page. Default value: 20. Maximum value: 100 Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeLogsetsRequest ¶
func NewDescribeLogsetsRequest() (request *DescribeLogsetsRequest)
func (*DescribeLogsetsRequest) FromJsonString ¶
func (r *DescribeLogsetsRequest) 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 (*DescribeLogsetsRequest) ToJsonString ¶
func (r *DescribeLogsetsRequest) ToJsonString() string
type DescribeLogsetsResponse ¶
type DescribeLogsetsResponse struct { *tchttp.BaseResponse Response *struct { // Total number of pages TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // Logset list Logsets []*LogsetInfo `json:"Logsets,omitempty" name:"Logsets"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeLogsetsResponse ¶
func NewDescribeLogsetsResponse() (response *DescribeLogsetsResponse)
func (*DescribeLogsetsResponse) FromJsonString ¶
func (r *DescribeLogsetsResponse) 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 (*DescribeLogsetsResponse) ToJsonString ¶
func (r *DescribeLogsetsResponse) ToJsonString() string
type DescribeMachineGroupConfigsRequest ¶
type DescribeMachineGroupConfigsRequest struct { *tchttp.BaseRequest // Machine group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` }
func NewDescribeMachineGroupConfigsRequest ¶
func NewDescribeMachineGroupConfigsRequest() (request *DescribeMachineGroupConfigsRequest)
func (*DescribeMachineGroupConfigsRequest) FromJsonString ¶
func (r *DescribeMachineGroupConfigsRequest) 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 (*DescribeMachineGroupConfigsRequest) ToJsonString ¶
func (r *DescribeMachineGroupConfigsRequest) ToJsonString() string
type DescribeMachineGroupConfigsResponse ¶
type DescribeMachineGroupConfigsResponse struct { *tchttp.BaseResponse Response *struct { // Collection rule configuration list // Note: this field may return `null`, indicating that no valid values can be obtained. Configs []*ConfigInfo `json:"Configs,omitempty" name:"Configs"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeMachineGroupConfigsResponse ¶
func NewDescribeMachineGroupConfigsResponse() (response *DescribeMachineGroupConfigsResponse)
func (*DescribeMachineGroupConfigsResponse) FromJsonString ¶
func (r *DescribeMachineGroupConfigsResponse) 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 (*DescribeMachineGroupConfigsResponse) ToJsonString ¶
func (r *DescribeMachineGroupConfigsResponse) ToJsonString() string
type DescribeMachineGroupsRequest ¶
type DescribeMachineGroupsRequest struct { *tchttp.BaseRequest // <br><li> machineGroupName // // Filter by **machine group name**. // Type: String // // Required: no // // <br><li> machineGroupId // // Filter by **machine group ID**. // Type: String // // Required: no // // <br><li> tagKey // // Filter by **tag key**. // // Type: String // // Required: no // // <br><li> tag:tagKey // // Filter by **tag key-value pair**. The `tagKey` should be replaced with a specified tag key. // Type: String // // Required: no // // // Each request can contain up to 10 `Filters` and 5 `Filter.Values`. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Page offset. Default value: 0 Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of entries per page. Default value: 20. Maximum value: 100 Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeMachineGroupsRequest ¶
func NewDescribeMachineGroupsRequest() (request *DescribeMachineGroupsRequest)
func (*DescribeMachineGroupsRequest) FromJsonString ¶
func (r *DescribeMachineGroupsRequest) 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 (*DescribeMachineGroupsRequest) ToJsonString ¶
func (r *DescribeMachineGroupsRequest) ToJsonString() string
type DescribeMachineGroupsResponse ¶
type DescribeMachineGroupsResponse struct { *tchttp.BaseResponse Response *struct { // Machine group information list // Note: this field may return `null`, indicating that no valid values can be obtained. MachineGroups []*MachineGroupInfo `json:"MachineGroups,omitempty" name:"MachineGroups"` // Total number of pages TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeMachineGroupsResponse ¶
func NewDescribeMachineGroupsResponse() (response *DescribeMachineGroupsResponse)
func (*DescribeMachineGroupsResponse) FromJsonString ¶
func (r *DescribeMachineGroupsResponse) 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 (*DescribeMachineGroupsResponse) ToJsonString ¶
func (r *DescribeMachineGroupsResponse) ToJsonString() string
type DescribeMachinesRequest ¶
type DescribeMachinesRequest struct { *tchttp.BaseRequest // ID of the machine group to be queried GroupId *string `json:"GroupId,omitempty" name:"GroupId"` }
func NewDescribeMachinesRequest ¶
func NewDescribeMachinesRequest() (request *DescribeMachinesRequest)
func (*DescribeMachinesRequest) FromJsonString ¶
func (r *DescribeMachinesRequest) 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 (*DescribeMachinesRequest) ToJsonString ¶
func (r *DescribeMachinesRequest) ToJsonString() string
type DescribeMachinesResponse ¶
type DescribeMachinesResponse struct { *tchttp.BaseResponse Response *struct { // Group of machine status information Machines []*MachineInfo `json:"Machines,omitempty" name:"Machines"` // Whether to enable the automatic update feature for the machine group AutoUpdate *int64 `json:"AutoUpdate,omitempty" name:"AutoUpdate"` // Preset start time of automatic update of machine group UpdateStartTime *string `json:"UpdateStartTime,omitempty" name:"UpdateStartTime"` // Preset end time of automatic update of machine group UpdateEndTime *string `json:"UpdateEndTime,omitempty" name:"UpdateEndTime"` // Latest LogListener version available to the current user LatestAgentVersion *string `json:"LatestAgentVersion,omitempty" name:"LatestAgentVersion"` // Whether to enable the service log ServiceLogging *bool `json:"ServiceLogging,omitempty" name:"ServiceLogging"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeMachinesResponse ¶
func NewDescribeMachinesResponse() (response *DescribeMachinesResponse)
func (*DescribeMachinesResponse) FromJsonString ¶
func (r *DescribeMachinesResponse) 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 (*DescribeMachinesResponse) ToJsonString ¶
func (r *DescribeMachinesResponse) ToJsonString() string
type DescribePartitionsRequest ¶
type DescribePartitionsRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` }
func NewDescribePartitionsRequest ¶
func NewDescribePartitionsRequest() (request *DescribePartitionsRequest)
func (*DescribePartitionsRequest) FromJsonString ¶
func (r *DescribePartitionsRequest) 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 (*DescribePartitionsRequest) ToJsonString ¶
func (r *DescribePartitionsRequest) ToJsonString() string
type DescribePartitionsResponse ¶
type DescribePartitionsResponse struct { *tchttp.BaseResponse Response *struct { // Partition list Partitions []*PartitionInfo `json:"Partitions,omitempty" name:"Partitions"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribePartitionsResponse ¶
func NewDescribePartitionsResponse() (response *DescribePartitionsResponse)
func (*DescribePartitionsResponse) FromJsonString ¶
func (r *DescribePartitionsResponse) 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 (*DescribePartitionsResponse) ToJsonString ¶
func (r *DescribePartitionsResponse) ToJsonString() string
type DescribeShipperTasksRequest ¶
type DescribeShipperTasksRequest struct { *tchttp.BaseRequest // Shipping rule ID ShipperId *string `json:"ShipperId,omitempty" name:"ShipperId"` // Query start timestamp in milliseconds, which can be within the last three days StartTime *int64 `json:"StartTime,omitempty" name:"StartTime"` // Query end timestamp in milliseconds EndTime *int64 `json:"EndTime,omitempty" name:"EndTime"` }
func NewDescribeShipperTasksRequest ¶
func NewDescribeShipperTasksRequest() (request *DescribeShipperTasksRequest)
func (*DescribeShipperTasksRequest) FromJsonString ¶
func (r *DescribeShipperTasksRequest) 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 (*DescribeShipperTasksRequest) ToJsonString ¶
func (r *DescribeShipperTasksRequest) ToJsonString() string
type DescribeShipperTasksResponse ¶
type DescribeShipperTasksResponse struct { *tchttp.BaseResponse Response *struct { // Shipping task list // Note: this field may return `null`, indicating that no valid values can be obtained. Tasks []*ShipperTaskInfo `json:"Tasks,omitempty" name:"Tasks"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeShipperTasksResponse ¶
func NewDescribeShipperTasksResponse() (response *DescribeShipperTasksResponse)
func (*DescribeShipperTasksResponse) FromJsonString ¶
func (r *DescribeShipperTasksResponse) 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 (*DescribeShipperTasksResponse) ToJsonString ¶
func (r *DescribeShipperTasksResponse) ToJsonString() string
type DescribeShippersRequest ¶
type DescribeShippersRequest struct { *tchttp.BaseRequest // <br><li> shipperName // // Filter by **shipping rule name**. // Type: String // // Required: no // // <br><li> shipperId // // Filter by **shipping rule ID**. // Type: String // // Required: no // // <br><li> topicId // // Filter by **log topic**. // // Type: String // // Required: no // // Each request can contain up to 10 `Filters` and 5 `Filter.Values`. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Page offset. Default value: 0 Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of entries per page. Default value: 20. Maximum value: 100 Limit *uint64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeShippersRequest ¶
func NewDescribeShippersRequest() (request *DescribeShippersRequest)
func (*DescribeShippersRequest) FromJsonString ¶
func (r *DescribeShippersRequest) 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 (*DescribeShippersRequest) ToJsonString ¶
func (r *DescribeShippersRequest) ToJsonString() string
type DescribeShippersResponse ¶
type DescribeShippersResponse struct { *tchttp.BaseResponse Response *struct { // Shipping rule list // Note: this field may return `null`, indicating that no valid values can be obtained. Shippers []*ShipperInfo `json:"Shippers,omitempty" name:"Shippers"` // Total number of results obtained in this query TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeShippersResponse ¶
func NewDescribeShippersResponse() (response *DescribeShippersResponse)
func (*DescribeShippersResponse) FromJsonString ¶
func (r *DescribeShippersResponse) 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 (*DescribeShippersResponse) ToJsonString ¶
func (r *DescribeShippersResponse) ToJsonString() string
type DescribeTopicsRequest ¶
type DescribeTopicsRequest struct { *tchttp.BaseRequest // <br><li> `topicName` filters by **log topic name**. Type: String. Required: No<br><li> `logsetName` filters by **logset name**. Type: String. Required: No<br><li> `topicId` filters by **log topic ID**. Type: String. Required: No<br><li> `logsetId` filters by **logset ID**. You can call the `DescribeLogsets` API to query the list of created logsets or log in to the console to view them. You can also call the `CreateLogset` API to create a logset. Type: String. Required: No<br><li> `tagKey` filters by **tag key**. Type: String. Required: No<br><li> `tag:tagKey` filters by **tag key-value pair**. The tagKey should be replaced with a specified tag key, such as “tag:exampleKey”. Type: String. Required: No<br><li> `storageType` filters by **log topic storage type**. Valid values: `hot` (STANDARD storage); `cold`: (IA storage). Type: String. Required: No. Each request can contain up to 10 `Filters` and 100 `Filter.Values`. Filters []*Filter `json:"Filters,omitempty" name:"Filters"` // Page offset. Default value: 0. Offset *int64 `json:"Offset,omitempty" name:"Offset"` // Maximum number of entries per page. Default value: 20. Maximum value: 100. Limit *int64 `json:"Limit,omitempty" name:"Limit"` }
func NewDescribeTopicsRequest ¶
func NewDescribeTopicsRequest() (request *DescribeTopicsRequest)
func (*DescribeTopicsRequest) FromJsonString ¶
func (r *DescribeTopicsRequest) 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 (*DescribeTopicsRequest) ToJsonString ¶
func (r *DescribeTopicsRequest) ToJsonString() string
type DescribeTopicsResponse ¶
type DescribeTopicsResponse struct { *tchttp.BaseResponse Response *struct { // Log topic list Topics []*TopicInfo `json:"Topics,omitempty" name:"Topics"` // Total number TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeTopicsResponse ¶
func NewDescribeTopicsResponse() (response *DescribeTopicsResponse)
func (*DescribeTopicsResponse) FromJsonString ¶
func (r *DescribeTopicsResponse) 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 (*DescribeTopicsResponse) ToJsonString ¶
func (r *DescribeTopicsResponse) ToJsonString() string
type ExcludePathInfo ¶
type ExportInfo ¶
type ExportInfo struct { // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Log export task ID ExportId *string `json:"ExportId,omitempty" name:"ExportId"` // Log export query statement Query *string `json:"Query,omitempty" name:"Query"` // Log export filename FileName *string `json:"FileName,omitempty" name:"FileName"` // Log file size FileSize *uint64 `json:"FileSize,omitempty" name:"FileSize"` // Log export time sorting Order *string `json:"Order,omitempty" name:"Order"` // Log export format Format *string `json:"Format,omitempty" name:"Format"` // Number of logs to be exported Count *uint64 `json:"Count,omitempty" name:"Count"` // Log download status. Valid values: `Processing`: exporting; `Complete`: completed; `Failed`: failed; `Expired`: expired (3-day validity period). Status *string `json:"Status,omitempty" name:"Status"` // Log export start time From *int64 `json:"From,omitempty" name:"From"` // Log export end time To *int64 `json:"To,omitempty" name:"To"` // Log export path CosPath *string `json:"CosPath,omitempty" name:"CosPath"` // Log export creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` }
type ExtractRuleInfo ¶
type ExtractRuleInfo struct { // Time field key name. `time_key` and `time_format` must appear in pairs // Note: this field may return `null`, indicating that no valid values can be obtained. TimeKey *string `json:"TimeKey,omitempty" name:"TimeKey"` // Time field format. For more information, please see the output parameters of the time format description of the `strftime` function in C language // Note: this field may return `null`, indicating that no valid values can be obtained. TimeFormat *string `json:"TimeFormat,omitempty" name:"TimeFormat"` // Delimiter for delimited log, which is valid only if `log_type` is `delimiter_log` // Note: this field may return `null`, indicating that no valid values can be obtained. Delimiter *string `json:"Delimiter,omitempty" name:"Delimiter"` // Full log matching rule, which is valid only if `log_type` is `fullregex_log` // Note: this field may return `null`, indicating that no valid values can be obtained. LogRegex *string `json:"LogRegex,omitempty" name:"LogRegex"` // First-Line matching rule, which is valid only if `log_type` is `multiline_log` or `fullregex_log` // Note: this field may return `null`, indicating that no valid values can be obtained. BeginRegex *string `json:"BeginRegex,omitempty" name:"BeginRegex"` // Key name of each extracted field. An empty key indicates to discard the field. This parameter is valid only if `log_type` is `delimiter_log`. `json_log` logs use the key of JSON itself // Note: this field may return `null`, indicating that no valid values can be obtained. Keys []*string `json:"Keys,omitempty" name:"Keys"` // Log keys to be filtered and the corresponding regex // Note: this field may return `null`, indicating that no valid values can be obtained. FilterKeyRegex []*KeyRegexInfo `json:"FilterKeyRegex,omitempty" name:"FilterKeyRegex"` // Whether to upload the logs that failed to be parsed. Valid values: `true`: yes; `false`: no // Note: this field may return `null`, indicating that no valid values can be obtained. UnMatchUpLoadSwitch *bool `json:"UnMatchUpLoadSwitch,omitempty" name:"UnMatchUpLoadSwitch"` // Unmatched log key // Note: this field may return `null`, indicating that no valid values can be obtained. UnMatchLogKey *string `json:"UnMatchLogKey,omitempty" name:"UnMatchLogKey"` // Size of the data to be rewound in incremental collection mode. Default value: -1 (full collection) // Note: this field may return `null`, indicating that no valid values can be obtained. Backtracking *int64 `json:"Backtracking,omitempty" name:"Backtracking"` }
type FilterRuleInfo ¶
type FullTextInfo ¶
type FullTextInfo struct { // Case sensitivity CaseSensitive *bool `json:"CaseSensitive,omitempty" name:"CaseSensitive"` // Full-Text index delimiter. Each character in the string represents a delimiter. Tokenizer *string `json:"Tokenizer,omitempty" name:"Tokenizer"` // Whether Chinese characters are contained // Note: this field may return `null`, indicating that no valid values can be obtained. ContainZH *bool `json:"ContainZH,omitempty" name:"ContainZH"` }
type GetAlarmLogRequest ¶
type GetAlarmLogRequest struct { *tchttp.BaseRequest // Start time of the log to be queried, which is a Unix timestamp in milliseconds From *int64 `json:"From,omitempty" name:"From"` // End time of the log to be queried, which is a Unix timestamp in milliseconds To *int64 `json:"To,omitempty" name:"To"` // Query statement. Maximum length: 1024 Query *string `json:"Query,omitempty" name:"Query"` // Number of logs returned in a single query. Maximum value: 1000 Limit *int64 `json:"Limit,omitempty" name:"Limit"` // This field is used to load more logs. Pass through the last `Context` value returned to get more log content. Context *string `json:"Context,omitempty" name:"Context"` // Order of the logs sorted by time returned by the log API. Valid values: `asc`: ascending; `desc`: descending. Default value: `desc` Sort *string `json:"Sort,omitempty" name:"Sort"` // If the value is `true`, the new search method will be used, and the response parameters `AnalysisRecords` and `Columns` will be valid. If the value is `false`, the old search method will be used, and `AnalysisResults` and `ColNames` will be valid. UseNewAnalysis *bool `json:"UseNewAnalysis,omitempty" name:"UseNewAnalysis"` }
func NewGetAlarmLogRequest ¶
func NewGetAlarmLogRequest() (request *GetAlarmLogRequest)
func (*GetAlarmLogRequest) FromJsonString ¶
func (r *GetAlarmLogRequest) 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 (*GetAlarmLogRequest) ToJsonString ¶
func (r *GetAlarmLogRequest) ToJsonString() string
type GetAlarmLogResponse ¶
type GetAlarmLogResponse struct { *tchttp.BaseResponse Response *struct { // `Context` for loading subsequent content Context *string `json:"Context,omitempty" name:"Context"` // Whether all log query results are returned ListOver *bool `json:"ListOver,omitempty" name:"ListOver"` // Whether the return is the analysis result Analysis *bool `json:"Analysis,omitempty" name:"Analysis"` // If `Analysis` is `true`, column name of the analysis result will be returned; otherwise, empty content will be returned. // Note: this field may return `null`, indicating that no valid values can be obtained. ColNames []*string `json:"ColNames,omitempty" name:"ColNames"` // Log query result. If `Analysis` is `True`, `null` may be returned // Note: this field may return `null`, indicating that no valid values can be obtained. Results []*LogInfo `json:"Results,omitempty" name:"Results"` // Log analysis result. If `Analysis` is `False`, `null` may be returned // Note: this field may return `null`, indicating that no valid values can be obtained. AnalysisResults []*LogItems `json:"AnalysisResults,omitempty" name:"AnalysisResults"` // New log analysis result, which will be valid if `UseNewAnalysis` is `true` // Note: this field may return `null`, indicating that no valid values can be obtained. AnalysisRecords []*string `json:"AnalysisRecords,omitempty" name:"AnalysisRecords"` // Column attribute of log analysis, which will be valid if `UseNewAnalysis` is `true` // Note: this field may return `null`, indicating that no valid values can be obtained. Columns []*Column `json:"Columns,omitempty" name:"Columns"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetAlarmLogResponse ¶
func NewGetAlarmLogResponse() (response *GetAlarmLogResponse)
func (*GetAlarmLogResponse) FromJsonString ¶
func (r *GetAlarmLogResponse) 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 (*GetAlarmLogResponse) ToJsonString ¶
func (r *GetAlarmLogResponse) ToJsonString() string
type HistogramInfo ¶
type JsonInfo ¶
type JsonInfo struct { // Enablement flag EnableTag *bool `json:"EnableTag,omitempty" name:"EnableTag"` // Metadata information list. Valid values: __SOURCE__; __FILENAME__; __TIMESTAMP__ // Note: This field may return `null`, indicating that no valid value was found. MetaFields []*string `json:"MetaFields,omitempty" name:"MetaFields"` }
type KeyRegexInfo ¶
type KeyValueInfo ¶
type KeyValueInfo struct { // When a key value or metafield index needs to be configured for a field, the metafield `Key` does not need to be prefixed with `__TAG__.` and is consistent with the one when logs are uploaded. `__TAG__.` will be prefixed automatically for display in the console. Key *string `json:"Key,omitempty" name:"Key"` // Field index description information Value *ValueInfo `json:"Value,omitempty" name:"Value"` }
type LogContextInfo ¶
type LogContextInfo struct { // Log source device Source *string `json:"Source,omitempty" name:"Source"` // Collection path Filename *string `json:"Filename,omitempty" name:"Filename"` // Log content Content *string `json:"Content,omitempty" name:"Content"` // Log package number PkgId *string `json:"PkgId,omitempty" name:"PkgId"` // Log number in log package PkgLogId *int64 `json:"PkgLogId,omitempty" name:"PkgLogId"` // Log timestamp BTime *int64 `json:"BTime,omitempty" name:"BTime"` // Source host name of logs // Note: This field may return `null`, indicating that no valid value was found. HostName *string `json:"HostName,omitempty" name:"HostName"` }
type LogInfo ¶
type LogInfo struct { // Log time in milliseconds Time *int64 `json:"Time,omitempty" name:"Time"` // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Log topic name TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Log source IP Source *string `json:"Source,omitempty" name:"Source"` // Log filename FileName *string `json:"FileName,omitempty" name:"FileName"` // ID of the request package for log reporting PkgId *string `json:"PkgId,omitempty" name:"PkgId"` // Log ID in request package PkgLogId *string `json:"PkgLogId,omitempty" name:"PkgLogId"` // Serialized JSON string of log content // Note: this field may return `null`, indicating that no valid values can be obtained. LogJson *string `json:"LogJson,omitempty" name:"LogJson"` // Source host name of logs // Note: This field may return `null`, indicating that no valid value was found. HostName *string `json:"HostName,omitempty" name:"HostName"` }
type LogItems ¶
type LogItems struct { // Key-Value pair returned in analysis result Data []*LogItem `json:"Data,omitempty" name:"Data"` }
type LogsetInfo ¶
type LogsetInfo struct { // Logset ID LogsetId *string `json:"LogsetId,omitempty" name:"LogsetId"` // Logset name LogsetName *string `json:"LogsetName,omitempty" name:"LogsetName"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Tag bound to logset // Note: this field may return `null`, indicating that no valid values can be obtained. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Number of log topics in logset TopicCount *int64 `json:"TopicCount,omitempty" name:"TopicCount"` // If `AssumerUin` is not empty, it indicates the service provider who creates the logset RoleName *string `json:"RoleName,omitempty" name:"RoleName"` }
type MachineGroupInfo ¶
type MachineGroupInfo struct { // Machine group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Machine group name GroupName *string `json:"GroupName,omitempty" name:"GroupName"` // Machine group type MachineGroupType *MachineGroupTypeInfo `json:"MachineGroupType,omitempty" name:"MachineGroupType"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // List of tags bound to machine group // Note: this field may return `null`, indicating that no valid values can be obtained. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Whether to enable automatic update for the machine group // Note: this field may return `null`, indicating that no valid values can be obtained. AutoUpdate *string `json:"AutoUpdate,omitempty" name:"AutoUpdate"` // Update start time. We recommend you update LogListener during off-peak hours. // Note: this field may return `null`, indicating that no valid values can be obtained. UpdateStartTime *string `json:"UpdateStartTime,omitempty" name:"UpdateStartTime"` // Update end time. We recommend you update LogListener during off-peak hours. // Note: this field may return `null`, indicating that no valid values can be obtained. UpdateEndTime *string `json:"UpdateEndTime,omitempty" name:"UpdateEndTime"` // Whether to enable the service log to record the logs generated by the LogListener service itself. After it is enabled, the internal logset `cls_service_logging` and the `loglistener_status`, `loglistener_alarm`, and `loglistener_business` log topics will be created, which will not incur fees. // Note: this field may return `null`, indicating that no valid values can be obtained. ServiceLogging *bool `json:"ServiceLogging,omitempty" name:"ServiceLogging"` }
type MachineGroupTypeInfo ¶
type MachineGroupTypeInfo struct { // Machine group type. Valid values: `ip`: the IP addresses of collection machines are stored in `Values` of the machine group; `label`: the tags of the machines are stored in `Values` of the machine group Type *string `json:"Type,omitempty" name:"Type"` // Machine description list Values []*string `json:"Values,omitempty" name:"Values"` }
type MachineInfo ¶
type MachineInfo struct { // Machine IP Ip *string `json:"Ip,omitempty" name:"Ip"` // Machine status. Valid values: `0`: exceptional; `1`: normal Status *uint64 `json:"Status,omitempty" name:"Status"` // Machine disconnection time. If the value is empty, the machine is normal. If the machine is exceptional, a specific value will be returned. OfflineTime *string `json:"OfflineTime,omitempty" name:"OfflineTime"` // Whether to enable automatic update for the machine. Valid values: `0`: no; `1`: yes AutoUpdate *int64 `json:"AutoUpdate,omitempty" name:"AutoUpdate"` // Current machine version number Version *string `json:"Version,omitempty" name:"Version"` // Machine update feature status UpdateStatus *int64 `json:"UpdateStatus,omitempty" name:"UpdateStatus"` // Machine update result flag ErrCode *int64 `json:"ErrCode,omitempty" name:"ErrCode"` // Machine update result information ErrMsg *string `json:"ErrMsg,omitempty" name:"ErrMsg"` }
type MergePartitionRequest ¶
type MergePartitionRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Merged `PartitionId` PartitionId *int64 `json:"PartitionId,omitempty" name:"PartitionId"` }
func NewMergePartitionRequest ¶
func NewMergePartitionRequest() (request *MergePartitionRequest)
func (*MergePartitionRequest) FromJsonString ¶
func (r *MergePartitionRequest) 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 (*MergePartitionRequest) ToJsonString ¶
func (r *MergePartitionRequest) ToJsonString() string
type MergePartitionResponse ¶
type MergePartitionResponse struct { *tchttp.BaseResponse Response *struct { // Merge result set Partitions []*PartitionInfo `json:"Partitions,omitempty" name:"Partitions"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewMergePartitionResponse ¶
func NewMergePartitionResponse() (response *MergePartitionResponse)
func (*MergePartitionResponse) FromJsonString ¶
func (r *MergePartitionResponse) 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 (*MergePartitionResponse) ToJsonString ¶
func (r *MergePartitionResponse) ToJsonString() string
type ModifyAlarmNoticeRequest ¶
type ModifyAlarmNoticeRequest struct { *tchttp.BaseRequest // Notification group ID AlarmNoticeId *string `json:"AlarmNoticeId,omitempty" name:"AlarmNoticeId"` // Notification group name Name *string `json:"Name,omitempty" name:"Name"` // Notification type. Valid values: // <li> `Trigger`: alarm triggered // <li> `Recovery`: alarm cleared // <li> `All`: alarm triggered and alarm cleared Type *string `json:"Type,omitempty" name:"Type"` // Notification recipient NoticeReceivers []*NoticeReceiver `json:"NoticeReceivers,omitempty" name:"NoticeReceivers"` // API callback information (including WeCom) WebCallbacks []*WebCallback `json:"WebCallbacks,omitempty" name:"WebCallbacks"` }
func NewModifyAlarmNoticeRequest ¶
func NewModifyAlarmNoticeRequest() (request *ModifyAlarmNoticeRequest)
func (*ModifyAlarmNoticeRequest) FromJsonString ¶
func (r *ModifyAlarmNoticeRequest) 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 (*ModifyAlarmNoticeRequest) ToJsonString ¶
func (r *ModifyAlarmNoticeRequest) ToJsonString() string
type ModifyAlarmNoticeResponse ¶
type ModifyAlarmNoticeResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyAlarmNoticeResponse ¶
func NewModifyAlarmNoticeResponse() (response *ModifyAlarmNoticeResponse)
func (*ModifyAlarmNoticeResponse) FromJsonString ¶
func (r *ModifyAlarmNoticeResponse) 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 (*ModifyAlarmNoticeResponse) ToJsonString ¶
func (r *ModifyAlarmNoticeResponse) ToJsonString() string
type ModifyAlarmRequest ¶
type ModifyAlarmRequest struct { *tchttp.BaseRequest // Alarm policy ID AlarmId *string `json:"AlarmId,omitempty" name:"AlarmId"` // Alarm policy name Name *string `json:"Name,omitempty" name:"Name"` // Monitoring task running time point MonitorTime *MonitorTime `json:"MonitorTime,omitempty" name:"MonitorTime"` // Trigger condition Condition *string `json:"Condition,omitempty" name:"Condition"` // Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1–10. TriggerCount *int64 `json:"TriggerCount,omitempty" name:"TriggerCount"` // Repeated alarm interval in minutes. Value range: 0–1440. AlarmPeriod *int64 `json:"AlarmPeriod,omitempty" name:"AlarmPeriod"` // List of associated alarm notification templates AlarmNoticeIds []*string `json:"AlarmNoticeIds,omitempty" name:"AlarmNoticeIds"` // Monitoring object list AlarmTargets []*AlarmTarget `json:"AlarmTargets,omitempty" name:"AlarmTargets"` // Whether to enable the alarm policy Status *bool `json:"Status,omitempty" name:"Status"` // Custom alarm content MessageTemplate *string `json:"MessageTemplate,omitempty" name:"MessageTemplate"` // Custom callback CallBack *CallBackInfo `json:"CallBack,omitempty" name:"CallBack"` // Multi-Dimensional analysis Analysis []*AnalysisDimensional `json:"Analysis,omitempty" name:"Analysis"` }
func NewModifyAlarmRequest ¶
func NewModifyAlarmRequest() (request *ModifyAlarmRequest)
func (*ModifyAlarmRequest) FromJsonString ¶
func (r *ModifyAlarmRequest) 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 (*ModifyAlarmRequest) ToJsonString ¶
func (r *ModifyAlarmRequest) ToJsonString() string
type ModifyAlarmResponse ¶
type ModifyAlarmResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyAlarmResponse ¶
func NewModifyAlarmResponse() (response *ModifyAlarmResponse)
func (*ModifyAlarmResponse) FromJsonString ¶
func (r *ModifyAlarmResponse) 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 (*ModifyAlarmResponse) ToJsonString ¶
func (r *ModifyAlarmResponse) ToJsonString() string
type ModifyConfigRequest ¶
type ModifyConfigRequest struct { *tchttp.BaseRequest // Collection rule configuration ID ConfigId *string `json:"ConfigId,omitempty" name:"ConfigId"` // Collection rule configuration name Name *string `json:"Name,omitempty" name:"Name"` // Log collection path containing the filename Path *string `json:"Path,omitempty" name:"Path"` // Type of the log to be collected. Valid values: `json_log`: log in JSON format; `delimiter_log`: log in delimited format; `minimalist_log`: minimalist log; `multiline_log`: log in multi-line format; `fullregex_log`: log in full regex format. Default value: `minimalist_log` LogType *string `json:"LogType,omitempty" name:"LogType"` // Extraction rule. If `ExtractRule` is set, `LogType` must be set. ExtractRule *ExtractRuleInfo `json:"ExtractRule,omitempty" name:"ExtractRule"` // Collection path blocklist ExcludePaths []*ExcludePathInfo `json:"ExcludePaths,omitempty" name:"ExcludePaths"` // Log topic (TopicId) associated with collection configuration Output *string `json:"Output,omitempty" name:"Output"` // Custom parsing string, which is a serialized JSON string UserDefineRule *string `json:"UserDefineRule,omitempty" name:"UserDefineRule"` }
func NewModifyConfigRequest ¶
func NewModifyConfigRequest() (request *ModifyConfigRequest)
func (*ModifyConfigRequest) FromJsonString ¶
func (r *ModifyConfigRequest) 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 (*ModifyConfigRequest) ToJsonString ¶
func (r *ModifyConfigRequest) ToJsonString() string
type ModifyConfigResponse ¶
type ModifyConfigResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyConfigResponse ¶
func NewModifyConfigResponse() (response *ModifyConfigResponse)
func (*ModifyConfigResponse) FromJsonString ¶
func (r *ModifyConfigResponse) 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 (*ModifyConfigResponse) ToJsonString ¶
func (r *ModifyConfigResponse) ToJsonString() string
type ModifyConsumerRequest ¶
type ModifyConsumerRequest struct { *tchttp.BaseRequest // Log topic ID bound to the task TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Whether the shipping task takes effect (default: no) Effective *bool `json:"Effective,omitempty" name:"Effective"` // Whether to ship metadata. Default value: `false` NeedContent *bool `json:"NeedContent,omitempty" name:"NeedContent"` // Metadata to ship if `NeedContent` is `true` Content *ConsumerContent `json:"Content,omitempty" name:"Content"` // CKafka information Ckafka *Ckafka `json:"Ckafka,omitempty" name:"Ckafka"` }
func NewModifyConsumerRequest ¶
func NewModifyConsumerRequest() (request *ModifyConsumerRequest)
func (*ModifyConsumerRequest) FromJsonString ¶
func (r *ModifyConsumerRequest) 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 (*ModifyConsumerRequest) ToJsonString ¶
func (r *ModifyConsumerRequest) ToJsonString() string
type ModifyConsumerResponse ¶
type ModifyConsumerResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyConsumerResponse ¶
func NewModifyConsumerResponse() (response *ModifyConsumerResponse)
func (*ModifyConsumerResponse) FromJsonString ¶
func (r *ModifyConsumerResponse) 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 (*ModifyConsumerResponse) ToJsonString ¶
func (r *ModifyConsumerResponse) ToJsonString() string
type ModifyIndexRequest ¶
type ModifyIndexRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // It does not take effect by default Status *bool `json:"Status,omitempty" name:"Status"` // Index rule Rule *RuleInfo `json:"Rule,omitempty" name:"Rule"` // Internal field marker of full-text index. Default value: `false`. Valid value: `false`: excluding internal fields; `true`: including internal fields IncludeInternalFields *bool `json:"IncludeInternalFields,omitempty" name:"IncludeInternalFields"` // Metadata flag. Default value: `0`. Valid value: `0`: full-text index (including the metadata field with key-value index enabled); `1`: full-text index (including all metadata fields); `2`: full-text index (excluding metadata fields). MetadataFlag *uint64 `json:"MetadataFlag,omitempty" name:"MetadataFlag"` }
func NewModifyIndexRequest ¶
func NewModifyIndexRequest() (request *ModifyIndexRequest)
func (*ModifyIndexRequest) FromJsonString ¶
func (r *ModifyIndexRequest) 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 (*ModifyIndexRequest) ToJsonString ¶
func (r *ModifyIndexRequest) ToJsonString() string
type ModifyIndexResponse ¶
type ModifyIndexResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyIndexResponse ¶
func NewModifyIndexResponse() (response *ModifyIndexResponse)
func (*ModifyIndexResponse) FromJsonString ¶
func (r *ModifyIndexResponse) 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 (*ModifyIndexResponse) ToJsonString ¶
func (r *ModifyIndexResponse) ToJsonString() string
type ModifyLogsetRequest ¶
type ModifyLogsetRequest struct { *tchttp.BaseRequest // Logset ID LogsetId *string `json:"LogsetId,omitempty" name:"LogsetId"` // Logset name LogsetName *string `json:"LogsetName,omitempty" name:"LogsetName"` // Tag key-value pair bound to logset. Up to 10 tag key-value pairs are supported, and a resource can be bound to only one tag key at any time. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
func NewModifyLogsetRequest ¶
func NewModifyLogsetRequest() (request *ModifyLogsetRequest)
func (*ModifyLogsetRequest) FromJsonString ¶
func (r *ModifyLogsetRequest) 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 (*ModifyLogsetRequest) ToJsonString ¶
func (r *ModifyLogsetRequest) ToJsonString() string
type ModifyLogsetResponse ¶
type ModifyLogsetResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyLogsetResponse ¶
func NewModifyLogsetResponse() (response *ModifyLogsetResponse)
func (*ModifyLogsetResponse) FromJsonString ¶
func (r *ModifyLogsetResponse) 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 (*ModifyLogsetResponse) ToJsonString ¶
func (r *ModifyLogsetResponse) ToJsonString() string
type ModifyMachineGroupRequest ¶
type ModifyMachineGroupRequest struct { *tchttp.BaseRequest // Machine group ID GroupId *string `json:"GroupId,omitempty" name:"GroupId"` // Machine group name GroupName *string `json:"GroupName,omitempty" name:"GroupName"` // Machine group type MachineGroupType *MachineGroupTypeInfo `json:"MachineGroupType,omitempty" name:"MachineGroupType"` // Tag list Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Whether to enable automatic update for the machine group AutoUpdate *bool `json:"AutoUpdate,omitempty" name:"AutoUpdate"` // Update start time. We recommend you update LogListener during off-peak hours. UpdateStartTime *string `json:"UpdateStartTime,omitempty" name:"UpdateStartTime"` // Update end time. We recommend you update LogListener during off-peak hours. UpdateEndTime *string `json:"UpdateEndTime,omitempty" name:"UpdateEndTime"` // Whether to enable the service log to record the logs generated by the LogListener service itself. After it is enabled, the internal logset `cls_service_logging` and the `loglistener_status`, `loglistener_alarm`, and `loglistener_business` log topics will be created, which will not incur fees. ServiceLogging *bool `json:"ServiceLogging,omitempty" name:"ServiceLogging"` }
func NewModifyMachineGroupRequest ¶
func NewModifyMachineGroupRequest() (request *ModifyMachineGroupRequest)
func (*ModifyMachineGroupRequest) FromJsonString ¶
func (r *ModifyMachineGroupRequest) 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 (*ModifyMachineGroupRequest) ToJsonString ¶
func (r *ModifyMachineGroupRequest) ToJsonString() string
type ModifyMachineGroupResponse ¶
type ModifyMachineGroupResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyMachineGroupResponse ¶
func NewModifyMachineGroupResponse() (response *ModifyMachineGroupResponse)
func (*ModifyMachineGroupResponse) FromJsonString ¶
func (r *ModifyMachineGroupResponse) 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 (*ModifyMachineGroupResponse) ToJsonString ¶
func (r *ModifyMachineGroupResponse) ToJsonString() string
type ModifyShipperRequest ¶
type ModifyShipperRequest struct { *tchttp.BaseRequest // Shipping rule ID ShipperId *string `json:"ShipperId,omitempty" name:"ShipperId"` // New destination bucket in shipping rule Bucket *string `json:"Bucket,omitempty" name:"Bucket"` // New destination directory prefix in shipping rule Prefix *string `json:"Prefix,omitempty" name:"Prefix"` // Shipping rule status Status *bool `json:"Status,omitempty" name:"Status"` // Shipping rule name ShipperName *string `json:"ShipperName,omitempty" name:"ShipperName"` // Shipping time interval in seconds. Default value: 300. Value range: 300–900 Interval *uint64 `json:"Interval,omitempty" name:"Interval"` // Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 100–256 MaxSize *uint64 `json:"MaxSize,omitempty" name:"MaxSize"` // Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped. FilterRules []*FilterRuleInfo `json:"FilterRules,omitempty" name:"FilterRules"` // Partition rule of shipped log, which can be represented in `strftime` time format Partition *string `json:"Partition,omitempty" name:"Partition"` // Compression configuration of shipped log Compress *CompressInfo `json:"Compress,omitempty" name:"Compress"` // Format configuration of shipped log content Content *ContentInfo `json:"Content,omitempty" name:"Content"` }
func NewModifyShipperRequest ¶
func NewModifyShipperRequest() (request *ModifyShipperRequest)
func (*ModifyShipperRequest) FromJsonString ¶
func (r *ModifyShipperRequest) 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 (*ModifyShipperRequest) ToJsonString ¶
func (r *ModifyShipperRequest) ToJsonString() string
type ModifyShipperResponse ¶
type ModifyShipperResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyShipperResponse ¶
func NewModifyShipperResponse() (response *ModifyShipperResponse)
func (*ModifyShipperResponse) FromJsonString ¶
func (r *ModifyShipperResponse) 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 (*ModifyShipperResponse) ToJsonString ¶
func (r *ModifyShipperResponse) ToJsonString() string
type ModifyTopicRequest ¶
type ModifyTopicRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Log topic name TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Tag description list. This parameter is used to bind a tag to a log topic. Up to 10 tag key-value pairs are supported, and they must be unique. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Whether to start collection for this log topic Status *bool `json:"Status,omitempty" name:"Status"` // Whether to enable automatic split AutoSplit *bool `json:"AutoSplit,omitempty" name:"AutoSplit"` // Maximum number of partitions to split into for this topic if automatic split is enabled MaxSplitPartitions *int64 `json:"MaxSplitPartitions,omitempty" name:"MaxSplitPartitions"` // Lifecycle in days. Value range: 1-3600 (3640 indicates permanent retention) Period *int64 `json:"Period,omitempty" name:"Period"` }
func NewModifyTopicRequest ¶
func NewModifyTopicRequest() (request *ModifyTopicRequest)
func (*ModifyTopicRequest) FromJsonString ¶
func (r *ModifyTopicRequest) 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 (*ModifyTopicRequest) ToJsonString ¶
func (r *ModifyTopicRequest) ToJsonString() string
type ModifyTopicResponse ¶
type ModifyTopicResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewModifyTopicResponse ¶
func NewModifyTopicResponse() (response *ModifyTopicResponse)
func (*ModifyTopicResponse) FromJsonString ¶
func (r *ModifyTopicResponse) 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 (*ModifyTopicResponse) ToJsonString ¶
func (r *ModifyTopicResponse) ToJsonString() string
type MonitorTime ¶
type MonitorTime struct { // Valid values: // <br><li> `Period`: periodic execution // <br><li> `Fixed`: scheduled execution Type *string `json:"Type,omitempty" name:"Type"` // Execution interval or scheduled time point in minutes. Value range: 1–1440. Time *int64 `json:"Time,omitempty" name:"Time"` }
type NoticeReceiver ¶
type NoticeReceiver struct { // Recipient type. Valid values: // <br><li> `Uin`: user ID // <br><li> `Group`: user group ID // Currently, other recipient types are not supported. ReceiverType *string `json:"ReceiverType,omitempty" name:"ReceiverType"` // Recipient ReceiverIds []*int64 `json:"ReceiverIds,omitempty" name:"ReceiverIds"` // Notification method // <br><li> `Email`: email // <br><li> `Sms`: SMS // <br><li> `WeChat`: WeChat // <br><li> `Phone`: phone ReceiverChannels []*string `json:"ReceiverChannels,omitempty" name:"ReceiverChannels"` // Start time for allowed message receipt StartTime *string `json:"StartTime,omitempty" name:"StartTime"` // End time for allowed message receipt EndTime *string `json:"EndTime,omitempty" name:"EndTime"` // Index Index *int64 `json:"Index,omitempty" name:"Index"` }
type OpenKafkaConsumerRequest ¶
type OpenKafkaConsumerRequest struct { *tchttp.BaseRequest // `TopicId` created by the CLS console FromTopicId *string `json:"FromTopicId,omitempty" name:"FromTopicId"` }
func NewOpenKafkaConsumerRequest ¶
func NewOpenKafkaConsumerRequest() (request *OpenKafkaConsumerRequest)
func (*OpenKafkaConsumerRequest) FromJsonString ¶
func (r *OpenKafkaConsumerRequest) 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 (*OpenKafkaConsumerRequest) ToJsonString ¶
func (r *OpenKafkaConsumerRequest) ToJsonString() string
type OpenKafkaConsumerResponse ¶
type OpenKafkaConsumerResponse struct { *tchttp.BaseResponse Response *struct { // `TopicId` to be consumed TopicID *string `json:"TopicID,omitempty" name:"TopicID"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewOpenKafkaConsumerResponse ¶
func NewOpenKafkaConsumerResponse() (response *OpenKafkaConsumerResponse)
func (*OpenKafkaConsumerResponse) FromJsonString ¶
func (r *OpenKafkaConsumerResponse) 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 (*OpenKafkaConsumerResponse) ToJsonString ¶
func (r *OpenKafkaConsumerResponse) ToJsonString() string
type ParquetInfo ¶
type ParquetInfo struct { // `ParquetKeyInfo` array ParquetKeyInfo []*ParquetKeyInfo `json:"ParquetKeyInfo,omitempty" name:"ParquetKeyInfo"` }
type ParquetKeyInfo ¶
type ParquetKeyInfo struct { // Key name KeyName *string `json:"KeyName,omitempty" name:"KeyName"` // Supported data types: string, boolean, int32, int64, float, and double KeyType *string `json:"KeyType,omitempty" name:"KeyType"` // Assignment information returned upon resolution failure // Note: This field may return `null`, indicating that no valid value can be obtained. KeyNonExistingField *string `json:"KeyNonExistingField,omitempty" name:"KeyNonExistingField"` }
type PartitionInfo ¶
type PartitionInfo struct { // Partition ID PartitionId *int64 `json:"PartitionId,omitempty" name:"PartitionId"` // Partition status. Valid values: `readwrite`, `readonly` Status *string `json:"Status,omitempty" name:"Status"` // Partition hash start key InclusiveBeginKey *string `json:"InclusiveBeginKey,omitempty" name:"InclusiveBeginKey"` // Partition hash end key ExclusiveEndKey *string `json:"ExclusiveEndKey,omitempty" name:"ExclusiveEndKey"` // Partition creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Last modified of read-only partition // Note: this field may return `null`, indicating that no valid values can be obtained. LastWriteTime *string `json:"LastWriteTime,omitempty" name:"LastWriteTime"` }
type RetryShipperTaskRequest ¶
type RetryShipperTaskRequest struct { *tchttp.BaseRequest // Shipping rule ID ShipperId *string `json:"ShipperId,omitempty" name:"ShipperId"` // Shipping task ID TaskId *string `json:"TaskId,omitempty" name:"TaskId"` }
func NewRetryShipperTaskRequest ¶
func NewRetryShipperTaskRequest() (request *RetryShipperTaskRequest)
func (*RetryShipperTaskRequest) FromJsonString ¶
func (r *RetryShipperTaskRequest) 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 (*RetryShipperTaskRequest) ToJsonString ¶
func (r *RetryShipperTaskRequest) ToJsonString() string
type RetryShipperTaskResponse ¶
type RetryShipperTaskResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewRetryShipperTaskResponse ¶
func NewRetryShipperTaskResponse() (response *RetryShipperTaskResponse)
func (*RetryShipperTaskResponse) FromJsonString ¶
func (r *RetryShipperTaskResponse) 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 (*RetryShipperTaskResponse) ToJsonString ¶
func (r *RetryShipperTaskResponse) ToJsonString() string
type RuleInfo ¶
type RuleInfo struct { // Full-Text index configuration // Note: this field may return `null`, indicating that no valid values can be obtained. FullText *FullTextInfo `json:"FullText,omitempty" name:"FullText"` // Key-Value index configuration // Note: this field may return `null`, indicating that no valid values can be obtained. KeyValue *RuleKeyValueInfo `json:"KeyValue,omitempty" name:"KeyValue"` // Metafield index configuration // Note: this field may return `null`, indicating that no valid values can be obtained. Tag *RuleTagInfo `json:"Tag,omitempty" name:"Tag"` }
type RuleKeyValueInfo ¶
type RuleKeyValueInfo struct { // Case sensitivity CaseSensitive *bool `json:"CaseSensitive,omitempty" name:"CaseSensitive"` // Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured. KeyValues []*KeyValueInfo `json:"KeyValues,omitempty" name:"KeyValues"` }
type RuleTagInfo ¶
type RuleTagInfo struct { // Case sensitivity CaseSensitive *bool `json:"CaseSensitive,omitempty" name:"CaseSensitive"` // Field information in the metafield index configuration KeyValues []*KeyValueInfo `json:"KeyValues,omitempty" name:"KeyValues"` }
type SearchLogRequest ¶
type SearchLogRequest struct { *tchttp.BaseRequest // ID of the log topic to be searched TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Start time of the log to be searched, which is a Unix timestamp in milliseconds From *int64 `json:"From,omitempty" name:"From"` // End time of the log to be searched, which is a Unix timestamp in milliseconds To *int64 `json:"To,omitempty" name:"To"` // Statement for search and analysis. Maximum length: 12 KB // A statement is in the format of <a href="https://intl.cloud.tencent.com/document/product/614/47044?from_cn_redirect=1" target="_blank">[search rule]</a> | <a href="https://intl.cloud.tencent.com/document/product/614/44061?from_cn_redirect=1" target="_blank">[SQL statement]</a>. You can omit the pipe symbol <code> | </code> and SQL statement when log analysis is not required. Query *string `json:"Query,omitempty" name:"Query"` // The number of raw logs returned by a single query. Maximum value: 1000. You need to use `Context` to continue to get logs. // Notes: // * This parameter is valid only when the query statement (`Query`) does not contain an SQL statement. // * To limit the number of analysis results, see <a href="https://intl.cloud.tencent.com/document/product/614/58977?from_cn_redirect=1" target="_blank">SQL LIMIT Syntax</a>. Limit *int64 `json:"Limit,omitempty" name:"Limit"` // You can pass through the `Context` value (validity: 1 hour) returned by the last API to continue to get logs, which can get up to 10,000 raw logs. // Notes: // * This parameter is valid only when the query statement (`Query`) does not contain an SQL statement. // * To continue to get analysis results, see <a href="https://intl.cloud.tencent.com/document/product/614/58977?from_cn_redirect=1" target="_blank">SQL LIMIT Syntax</a>. Context *string `json:"Context,omitempty" name:"Context"` // Time order of the logs returned. Valid values: `asc` (ascending); `desc`: (descending). Default value: `desc` // Notes: // * This parameter is valid only when the query statement (`Query`) does not contain an SQL statement. // * To sort the analysis results, see <a href="https://intl.cloud.tencent.com/document/product/614/58978?from_cn_redirect=1" target="_blank">SQL ORDER BY Syntax</a>. Sort *string `json:"Sort,omitempty" name:"Sort"` // If the value is `true`, the new response method will be used, and the output parameters `AnalysisRecords` and `Columns` will be valid. // If the value is `false`, the old response method will be used, and the output parameters `AnalysisResults` and `ColNames` will be valid. // The two response methods differ slightly in terms of encoding format. You are advised to use the new method (`true`). UseNewAnalysis *bool `json:"UseNewAnalysis,omitempty" name:"UseNewAnalysis"` }
func NewSearchLogRequest ¶
func NewSearchLogRequest() (request *SearchLogRequest)
func (*SearchLogRequest) FromJsonString ¶
func (r *SearchLogRequest) 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 (*SearchLogRequest) ToJsonString ¶
func (r *SearchLogRequest) ToJsonString() string
type SearchLogResponse ¶
type SearchLogResponse struct { *tchttp.BaseResponse Response *struct { // You can pass through the `Context` value (validity: 1 hour) returned by this API to continue to get more logs. Context *string `json:"Context,omitempty" name:"Context"` // Whether to return all raw log query results. If not, you can use `Context` to continue to get logs. // Note: This parameter is valid only when the query statement (`Query`) does not contain an SQL statement. ListOver *bool `json:"ListOver,omitempty" name:"ListOver"` // Whether the returned data is the analysis (SQL) result Analysis *bool `json:"Analysis,omitempty" name:"Analysis"` // Raw logs that meet the search conditions // Note: This field may return `null`, indicating that no valid value was found. Results []*LogInfo `json:"Results,omitempty" name:"Results"` // Column names of log analysis // This parameter is valid only when `UseNewAnalysis` is `false`. // Note: This field may return `null`, indicating that no valid value was found. ColNames []*string `json:"ColNames,omitempty" name:"ColNames"` // Log analysis result // This parameter is valid only when `UseNewAnalysis` is `false`. // Note: This field may return `null`, indicating that no valid value was found. AnalysisResults []*LogItems `json:"AnalysisResults,omitempty" name:"AnalysisResults"` // Log analysis result // This parameter is valid only when `UseNewAnalysis` is `true`. // Note: This field may return `null`, indicating that no valid value was found. AnalysisRecords []*string `json:"AnalysisRecords,omitempty" name:"AnalysisRecords"` // Column attributes of log analysis // This parameter is valid only when `UseNewAnalysis` is `true`. // Note: This field may return `null`, indicating that no valid value was found. Columns []*Column `json:"Columns,omitempty" name:"Columns"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewSearchLogResponse ¶
func NewSearchLogResponse() (response *SearchLogResponse)
func (*SearchLogResponse) FromJsonString ¶
func (r *SearchLogResponse) 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 (*SearchLogResponse) ToJsonString ¶
func (r *SearchLogResponse) ToJsonString() string
type ShipperInfo ¶
type ShipperInfo struct { // Shipping rule ID ShipperId *string `json:"ShipperId,omitempty" name:"ShipperId"` // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Bucket address shipped to Bucket *string `json:"Bucket,omitempty" name:"Bucket"` // Shipping prefix directory Prefix *string `json:"Prefix,omitempty" name:"Prefix"` // Shipping rule name ShipperName *string `json:"ShipperName,omitempty" name:"ShipperName"` // Shipping time interval in seconds Interval *uint64 `json:"Interval,omitempty" name:"Interval"` // Maximum size of shipped file in MB MaxSize *uint64 `json:"MaxSize,omitempty" name:"MaxSize"` // Whether it takes effect Status *bool `json:"Status,omitempty" name:"Status"` // Filter rule for shipped log // Note: this field may return `null`, indicating that no valid values can be obtained. FilterRules []*FilterRuleInfo `json:"FilterRules,omitempty" name:"FilterRules"` // Partition rule of shipped log, which can be represented in `strftime` time format Partition *string `json:"Partition,omitempty" name:"Partition"` // Compression configuration of shipped log // Note: this field may return `null`, indicating that no valid values can be obtained. Compress *CompressInfo `json:"Compress,omitempty" name:"Compress"` // Format configuration of shipped log content // Note: this field may return `null`, indicating that no valid values can be obtained. Content *ContentInfo `json:"Content,omitempty" name:"Content"` // Creation time of shipped log CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` }
type ShipperTaskInfo ¶
type ShipperTaskInfo struct { // Shipping task ID TaskId *string `json:"TaskId,omitempty" name:"TaskId"` // Shipping information ID ShipperId *string `json:"ShipperId,omitempty" name:"ShipperId"` // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Start timestamp of the current batch of shipped logs in milliseconds RangeStart *int64 `json:"RangeStart,omitempty" name:"RangeStart"` // End timestamp of the current batch of shipped logs in milliseconds RangeEnd *int64 `json:"RangeEnd,omitempty" name:"RangeEnd"` // Start timestamp of the current shipping task in milliseconds StartTime *int64 `json:"StartTime,omitempty" name:"StartTime"` // End timestamp of the current shipping task in milliseconds EndTime *int64 `json:"EndTime,omitempty" name:"EndTime"` // Result of the current shipping task. Valid values: `success`, `running`, `failed` Status *string `json:"Status,omitempty" name:"Status"` // Result details Message *string `json:"Message,omitempty" name:"Message"` }
type SplitPartitionRequest ¶
type SplitPartitionRequest struct { *tchttp.BaseRequest // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // ID of the partition to be split PartitionId *int64 `json:"PartitionId,omitempty" name:"PartitionId"` // Partition split hash key position, which is meaningful only if `Number=2` is set SplitKey *string `json:"SplitKey,omitempty" name:"SplitKey"` // Number of partitions to split into, which is optional. Default value: 2 Number *int64 `json:"Number,omitempty" name:"Number"` }
func NewSplitPartitionRequest ¶
func NewSplitPartitionRequest() (request *SplitPartitionRequest)
func (*SplitPartitionRequest) FromJsonString ¶
func (r *SplitPartitionRequest) 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 (*SplitPartitionRequest) ToJsonString ¶
func (r *SplitPartitionRequest) ToJsonString() string
type SplitPartitionResponse ¶
type SplitPartitionResponse struct { *tchttp.BaseResponse Response *struct { // Split result set Partitions []*PartitionInfo `json:"Partitions,omitempty" name:"Partitions"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewSplitPartitionResponse ¶
func NewSplitPartitionResponse() (response *SplitPartitionResponse)
func (*SplitPartitionResponse) FromJsonString ¶
func (r *SplitPartitionResponse) 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 (*SplitPartitionResponse) ToJsonString ¶
func (r *SplitPartitionResponse) ToJsonString() string
type TopicInfo ¶
type TopicInfo struct { // Logset ID LogsetId *string `json:"LogsetId,omitempty" name:"LogsetId"` // Log topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Log topic name TopicName *string `json:"TopicName,omitempty" name:"TopicName"` // Number of topic partitions PartitionCount *int64 `json:"PartitionCount,omitempty" name:"PartitionCount"` // Whether index is enabled Index *bool `json:"Index,omitempty" name:"Index"` // Creation time CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"` // Whether collection is enabled in the log topic Status *bool `json:"Status,omitempty" name:"Status"` // Information of tags bound to log topic // Note: this field may return `null`, indicating that no valid values can be obtained. Tags []*Tag `json:"Tags,omitempty" name:"Tags"` // Whether automatic split is enabled for this topic // Note: this field may return `null`, indicating that no valid values can be obtained. AutoSplit *bool `json:"AutoSplit,omitempty" name:"AutoSplit"` // Maximum number of partitions to split into for this topic if automatic split is enabled // Note: this field may return `null`, indicating that no valid values can be obtained. MaxSplitPartitions *int64 `json:"MaxSplitPartitions,omitempty" name:"MaxSplitPartitions"` // Log topic storage class // Note: this field may return `null`, indicating that no valid values can be obtained. StorageType *string `json:"StorageType,omitempty" name:"StorageType"` // Lifecycle in days. Value range: 1-3600 (3640 indicates permanent retention) // Note: This field may return `null`, indicating that no valid value was found. Period *int64 `json:"Period,omitempty" name:"Period"` }
type UploadLogRequest ¶
type UploadLogRequest struct { *tchttp.BaseRequest // Topic ID TopicId *string `json:"TopicId,omitempty" name:"TopicId"` // Topic partition where data will be written into by `HashKey` HashKey *string `json:"HashKey,omitempty" name:"HashKey"` // Compression type CompressType *string `json:"CompressType,omitempty" name:"CompressType"` }
func NewUploadLogRequest ¶
func NewUploadLogRequest() (request *UploadLogRequest)
func (*UploadLogRequest) FromJsonString ¶
func (r *UploadLogRequest) 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 (*UploadLogRequest) ToJsonString ¶
func (r *UploadLogRequest) ToJsonString() string
type UploadLogResponse ¶
type UploadLogResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewUploadLogResponse ¶
func NewUploadLogResponse() (response *UploadLogResponse)
func (*UploadLogResponse) FromJsonString ¶
func (r *UploadLogResponse) 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 (*UploadLogResponse) ToJsonString ¶
func (r *UploadLogResponse) ToJsonString() string
type ValueInfo ¶
type ValueInfo struct { // Field type. Valid values: `long`, `text`, `double` Type *string `json:"Type,omitempty" name:"Type"` // Field delimiter, which is meaningful only if the field type is `text`. Each character in the entered string represents a delimiter. Tokenizer *string `json:"Tokenizer,omitempty" name:"Tokenizer"` // Whether the analysis feature is enabled for the field SqlFlag *bool `json:"SqlFlag,omitempty" name:"SqlFlag"` // Whether Chinese characters are contained // Note: this field may return `null`, indicating that no valid values can be obtained. ContainZH *bool `json:"ContainZH,omitempty" name:"ContainZH"` }
type WebCallback ¶
type WebCallback struct { // Callback address Url *string `json:"Url,omitempty" name:"Url"` // Callback type. Valid values: // <li> WeCom // <li> Http CallbackType *string `json:"CallbackType,omitempty" name:"CallbackType"` // Callback method. Valid values: // <li> POST // <li> PUT // Default value: `POST`. This parameter is required if `CallbackType` is `Http`. // Note: This field may return `null`, indicating that no valid value was found. Method *string `json:"Method,omitempty" name:"Method"` // Request header // Note: This parameter is disused. To specify request headers, see `CallBack` in <a href="https://intl.cloud.tencent.com/document/product/614/56466?from_cn_redirect=1">CreateAlarmNotice</a>. // Note: This field may return `null`, indicating that no valid value was found. Headers []*string `json:"Headers,omitempty" name:"Headers"` // Request content // Note: This parameter is disused. To specify request content, see `CallBack` in <a href="https://intl.cloud.tencent.com/document/product/614/56466?from_cn_redirect=1">CreateAlarmNotice</a>. // Note: This field may return `null`, indicating that no valid value was found. Body *string `json:"Body,omitempty" name:"Body"` // Number Index *int64 `json:"Index,omitempty" name:"Index"` }