'1.0', 'info' => ['style' => 'ROA', 'product' => 'Sls', 'version' => '2020-12-30'], 'directories' => [ [ 'children' => [ 'CreateLogStore', 'CreateIndex', 'DeleteLogStore', 'DeleteIndex', 'PutWebtracking', 'UpdateLogStore', 'UpdateIndex', 'SplitShard', 'UpdateLogStoreMeteringMode', 'MergeShard', 'ListLogStores', 'GetLogStore', 'GetIndex', 'ListShards', 'GetLogs', 'UpdateLogStoreEncryption', 'GetCursor', 'GetContextLogs', 'GetHistograms', 'GetCursorTime', 'GetLogsV2', 'PullLogs', 'PutLogs', 'GetLogStoreMeteringMode', 'SubmitAsyncSql', 'GetAsyncSql', ], 'type' => 'directory', 'title' => 'Logstore', ], [ 'children' => ['ListMetricStores', 'CreateMetricStore', 'DeleteMetricStore', 'UpdateMetricStore', 'UpdateMetricStoreMeteringMode', 'GetMetricStore', 'GetMetricStoreMeteringMode'], 'type' => 'directory', 'title' => 'Metricstore', ], [ 'children' => ['CreateStoreView', 'DeleteStoreView', 'UpdateStoreView', 'GetStoreView', 'GetStoreViewIndex', 'ListStoreViews'], 'type' => 'directory', 'title' => 'Storeview', ], [ 'children' => ['CreateMachineGroup', 'DeleteMachineGroup', 'RemoveConfigFromMachineGroup', 'ApplyConfigToMachineGroup', 'UpdateMachineGroup', 'UpdateMachineGroupMachine', 'ListMachineGroup', 'ListMachines', 'GetMachineGroup', 'GetAppliedConfigs', 'GetAppliedMachineGroups'], 'type' => 'directory', 'title' => 'Machine group', ], [ 'children' => ['CreateConfig', 'CreateLogtailPipelineConfig', 'DeleteConfig', 'DeleteLogtailPipelineConfig', 'UpdateConfig', 'UpdateLogtailPipelineConfig', 'GetConfig', 'ListConfig', 'GetLogtailPipelineConfig', 'ListLogtailPipelineConfig'], 'type' => 'directory', 'title' => 'Collection configuration', ], [ 'children' => ['CreateDashboard', 'DeleteDashboard', 'UpdateDashboard', 'GetDashboard', 'ListDashboard'], 'type' => 'directory', 'title' => 'Dashboard', ], [ 'children' => ['CreateConsumerGroup', 'DeleteConsumerGroup', 'ConsumerGroupUpdateCheckPoint', 'UpdateConsumerGroup', 'ConsumerGroupHeartBeat', 'ListConsumerGroup', 'GetCheckPoint'], 'type' => 'directory', 'title' => 'Consumer group', ], [ 'children' => ['CreateSavedSearch', 'DeleteSavedSearch', 'UpdateSavedSearch', 'ListSavedSearch', 'GetSavedSearch'], 'type' => 'directory', 'title' => 'Saved search', ], [ 'children' => ['CreateAlert', 'DeleteAlert', 'UpdateAlert', 'EnableAlert', 'DisableAlert', 'GetAlert'], 'type' => 'directory', 'title' => 'Alerting', ], [ 'children' => [ [ 'children' => ['UpdateGCSIngestion', 'StopGCSIngestion', 'StartGCSIngestion', 'ListGCSIngestions', 'GetGCSIngestion', 'CreateGCSIngestion'], 'type' => 'directory', 'title' => 'GCS import', ], [ 'children' => ['UpdateElasticsearchIngestion', 'StopElasticsearchIngestion', 'StartElasticsearchIngestion', 'CreateElasticsearchIngestion', 'ListElasticsearchIngestions', 'GetElasticsearchIngestion', 'DeleteElasticsearchIngestion'], 'type' => 'directory', 'title' => 'Elasticsearch import', ], [ 'children' => ['CreateS3Ingestion', 'ListS3Ingestions', 'GetS3Ingestion', 'DeleteS3Ingestion'], 'type' => 'directory', 'title' => 'S3 import', ], [ 'children' => ['StopAzureBlobIngestion', 'StartAzureBlobIngestion', 'DeleteAzureBlobIngestion', 'UpdateAzureBlobIngestion', 'ListAzureBlobIngestion', 'CreateAzureBlobIngestion', 'GetAzureBlobIngestion'], 'type' => 'directory', 'title' => 'AzureBlob import', ], [ 'children' => ['CreateOSSIngestion', 'GetOSSIngestion', 'ListOSSIngestions', 'StopOSSIngestion', 'StartOSSIngestion', 'UpdateOSSIngestion', 'DeleteOSSIngestion'], 'type' => 'directory', 'title' => 'OSS import', ], ], 'type' => 'directory', 'title' => 'Data import', ], [ 'children' => ['CreateOSSExport', 'CreateOSSHDFSExport', 'DeleteOSSExport', 'DeleteOSSHDFSExport', 'UpdateOSSExport', 'StartOSSExport', 'StopOSSExport', 'GetOSSExport', 'UpdateOSSHDFSExport', 'StartOSSHDFSExport', 'StopOSSHDFSExport', 'ListOSSExports', 'GetOSSHDFSExport', 'ListOSSHDFSExports'], 'type' => 'directory', 'title' => 'LogShipper', ], [ 'children' => ['CreateETL', 'DeleteETL', 'UpdateETL', 'StartETL', 'StopETL', 'ListETLs', 'GetETL'], 'type' => 'directory', 'title' => 'Data transformation', ], [ 'children' => ['CreateScheduledSQL', 'DeleteScheduledSQL', 'UpdateScheduledSQL', 'EnableScheduledSQL', 'DisableScheduledSQL', 'ListScheduledSQLs', 'GetScheduledSQL'], 'type' => 'directory', 'title' => 'Scheduled query', ], [ 'children' => ['CreateDownloadJob', 'DeleteDownloadJob', 'GetDownloadJob', 'ListDownloadJobs'], 'type' => 'directory', 'title' => 'Log download', ], [ 'children' => ['PutIngestProcessor', 'GetIngestProcessor', 'ListIngestProcessors', 'DeleteIngestProcessor', 'UpdateLogStoreProcessor', 'UpdateMetricStoreProcessor'], 'type' => 'directory', 'title' => 'Write processor', ], [ 'children' => ['PutConsumeProcessor', 'GetConsumeProcessor', 'ListConsumeProcessors', 'DeleteConsumeProcessor'], 'type' => 'directory', 'title' => 'Consum processor', ], [ 'children' => ['ListAiTools', 'CallAiTools', 'CreateAnnotationLabel', 'PutAnnotationData', 'CreateAnnotationDataSet', 'DeleteAnnotationLabel', 'DeleteAnnotationData', 'DeleteAnnotationDataSet', 'UpdateAnnotationLabel', 'UpdateAnnotationDataSet', 'GetAnnotationLabel', 'ListAnnotationLabels', 'GetAnnotationData', 'ListAnnotationData', 'GetAnnotationDataSet', 'ListAnnotationDataSets', 'GetMLServiceResults'], 'type' => 'directory', 'title' => 'Machine learning', ], [ 'children' => ['PutProjectPolicy', 'DeleteProjectPolicy', 'GetProjectPolicy'], 'type' => 'directory', 'title' => 'Authorization policy', ], [ 'children' => ['UpsertCollectionPolicy', 'DeleteCollectionPolicy', 'ListCollectionPolicies', 'GetCollectionPolicy'], 'type' => 'directory', 'title' => 'Cloud service collection rule', ], [ 'children' => ['CreateSqlInstance', 'UpdateSqlInstance', 'GetSqlInstance'], 'type' => 'directory', 'title' => 'Dedicated SQL instance', ], [ 'children' => ['OpenSlsService'], 'type' => 'directory', 'title' => 'Service activation', ], [ 'children' => ['RefreshToken'], 'type' => 'directory', 'title' => 'Console embedding', ], [ 'children' => ['CreateAgentInstanceConfig', 'DeleteAgentInstanceConfig', 'GetAgentInstanceConfig', 'ListAgentInstanceConfigs', 'UpdateAgentInstanceConfig'], 'type' => 'directory', 'title' => 'Process-level configuration', ], [ 'children' => ['GetMaxComputeExport', 'CreateMaxComputeExport', 'DeleteMaxComputeExport', 'ListMaxComputeExports', 'StartMaxComputeExport', 'StopMaxComputeExport', 'UpdateMaxComputeExport'], 'type' => 'directory', 'title' => 'MaxCompute shipping', ], [ 'children' => ['UntagResources', 'TagResources', 'ListTagResources'], 'type' => 'directory', 'title' => 'Tag', ], [ 'children' => ['CreateProject', 'DeleteProject', 'GetProject', 'ListProject', 'UpdateProject', 'GetProjectLogs'], 'type' => 'directory', 'title' => 'Project', ], [ 'children' => [ 'CancelDownloadJob', 'CreateDomain', 'CreateLogging', 'DeleteDomain', 'DeleteLogging', 'GetLogging', 'ListDomains', 'PutProjectTransferAcceleration', 'UpdateLogging', 'GetLogStoreConfig', 'PutLogStoreConfig', 'ChangeResourceGroup', 'CreateTicket', 'DescribeRegions', 'GetSlsService', 'ListAlerts', 'CreateMaterializedView', 'DeleteMaterializedView', 'GetMaterializedView', 'ListMaterializedView', 'ListMaterializedViews', 'UpdateMaterializedView', 'DeleteLogs', 'UpdateLogs', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'AgentInstanceConfigGrayConfigs' => [ 'title' => 'AgentInstanceConfigGrayConfigs', 'type' => 'object', 'properties' => [ 'condition' => ['title' => 'condition', 'description' => 'The matching rule.', 'type' => 'string', 'example' => 'appVersion="1.0.0"'], 'content' => ['title' => 'content', 'description' => 'The content of the canary release configuration.', 'type' => 'string', 'example' => '{"enable":true}'], ], 'description' => 'The process-level canary release configuration.', 'example' => '', ], 'Alert' => [ 'title' => '告警规则响应结果', 'description' => 'The response for the alert rule.', 'type' => 'object', 'properties' => [ 'name' => ['title' => '告警规则ID', 'description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-123456'], 'displayName' => ['title' => '告警规则名称', 'description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alertNameExample'], 'description' => ['title' => '告警规则描述', 'description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'Alert Desc'], 'configuration' => ['title' => '告警规则配置', 'description' => 'The configuration of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration', 'example' => ''], 'schedule' => ['title' => '调度配置', 'description' => 'The scheduling configuration.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'example' => ''], 'createTime' => ['title' => '创建时间', 'description' => 'The time when the alert rule was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => 'The time when the alert rule was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274900'], 'status' => ['title' => '告警状态', 'description' => 'The status of the alert rule.', 'type' => 'string', 'example' => 'ENABLED/DISABLED'], ], 'example' => '', ], 'AlertConfiguration' => [ 'title' => '', 'description' => 'The alert configuration.', 'type' => 'object', 'properties' => [ 'muteUntil' => ['title' => '', 'description' => 'The time until which the alert is muted.', 'type' => 'integer', 'format' => 'int64', 'example' => '1698907508'], 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'required' => true, 'default' => '2.0', 'example' => '2.0'], 'type' => ['title' => '', 'description' => 'The type of the alert rule.', 'type' => 'string', 'example' => 'default'], 'templateConfiguration' => ['title' => '', 'description' => 'The alert template configuration.', '$ref' => '#/components/schemas/TemplateConfiguration', 'example' => ''], 'dashboard' => ['title' => '', 'description' => 'The ID of the dashboard to which the alert is attached.', 'type' => 'string', 'example' => 'DasnboardExample'], 'threshold' => ['title' => '', 'description' => 'The consecutive trigger threshold.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], 'noDataFire' => ['title' => '', 'description' => 'Specifies whether to enable no-data alerts.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], 'noDataSeverity' => ['title' => '', 'description' => 'The severity of no-data alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], 'sendResolved' => ['title' => '', 'description' => 'Specifies whether to send recovery alerts.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], 'queryList' => [ 'title' => '', 'description' => 'The list of query statements.', 'type' => 'array', 'items' => ['description' => 'The query statement.', '$ref' => '#/components/schemas/AlertQuery', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], 'annotations' => [ 'title' => '', 'description' => 'The alert annotations.', 'type' => 'array', 'items' => ['description' => 'The annotation information.', '$ref' => '#/components/schemas/AlertTag', 'title' => '', 'example' => ''], 'example' => '', ], 'labels' => [ 'title' => '', 'description' => 'The alert labels.', 'type' => 'array', 'items' => ['description' => 'The alert label.', '$ref' => '#/components/schemas/AlertTag', 'title' => '', 'example' => ''], 'example' => '', ], 'conditionConfiguration' => ['title' => '', 'description' => 'The alert trigger condition.', '$ref' => '#/components/schemas/ConditionConfiguration', 'example' => ''], 'severityConfigurations' => [ 'title' => '', 'description' => 'The alert severity configurations.', 'type' => 'array', 'items' => ['description' => 'The alert severity configuration.', '$ref' => '#/components/schemas/SeverityConfiguration', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], 'joinConfigurations' => [ 'title' => '', 'description' => 'The configurations for joining the results of query statements.', 'type' => 'array', 'items' => ['description' => 'The configuration for joining the results of query statements.', '$ref' => '#/components/schemas/JoinConfiguration', 'title' => '', 'example' => ''], 'example' => '', ], 'groupConfiguration' => ['title' => '', 'description' => 'The group evaluation configuration.', 'required' => true, '$ref' => '#/components/schemas/GroupConfiguration', 'example' => ''], 'policyConfiguration' => ['title' => '', 'description' => 'The configuration for the SLS alert notification service.', '$ref' => '#/components/schemas/PolicyConfiguration', 'example' => ''], 'autoAnnotation' => ['title' => '', 'description' => 'Specifies whether to enable automatic annotation.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], 'sinkEventStore' => ['title' => '', 'description' => 'The configuration for sending alerts to the eventstore.', '$ref' => '#/components/schemas/SinkEventStoreConfiguration', 'example' => ''], 'sinkCms' => ['title' => '', 'description' => 'The configuration for sending alerts to Cloud Monitor.', '$ref' => '#/components/schemas/SinkCmsConfiguration', 'example' => ''], 'sinkAlerthub' => ['title' => '', 'description' => 'The configuration for sending alerts to the SLS alert management service.', 'required' => false, '$ref' => '#/components/schemas/SinkAlerthubConfiguration', 'example' => ''], 'tags' => [ 'title' => '', 'description' => 'The custom alert tags.', 'type' => 'array', 'items' => ['description' => 'The tag information.', 'type' => 'string', 'title' => '', 'example' => 'host'], 'example' => '', ], ], 'example' => '', ], 'AlertQuery' => [ 'title' => '', 'description' => 'Configuration of the alert query and analysis statement', 'type' => 'object', 'properties' => [ 'chartTitle' => ['title' => '', 'description' => 'Chart name', 'type' => 'string', 'example' => 'chartExmaple', 'visibility' => 'Public'], 'query' => ['title' => '', 'description' => 'Query and analysis statement', 'type' => 'string', 'required' => true, 'example' => '* | select *', 'visibility' => 'Public'], 'timeSpanType' => ['title' => '', 'description' => 'Time span type', 'type' => 'string', 'required' => true, 'example' => 'Relative', 'visibility' => 'Public'], 'start' => ['title' => '', 'description' => 'Start time', 'type' => 'string', 'required' => true, 'example' => '-5m', 'visibility' => 'Public'], 'end' => ['title' => '', 'description' => 'End time', 'type' => 'string', 'required' => true, 'example' => 'now', 'visibility' => 'Public'], 'storeType' => ['title' => '', 'description' => 'Store type', 'type' => 'string', 'required' => true, 'example' => 'log', 'visibility' => 'Public'], 'project' => ['title' => '', 'description' => 'Project name', 'type' => 'string', 'required' => true, 'example' => 'projectExample', 'visibility' => 'Public'], 'store' => ['title' => '', 'description' => 'Store name', 'type' => 'string', 'required' => true, 'example' => 'store Example', 'visibility' => 'Public'], 'region' => ['title' => '', 'description' => 'Region', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'visibility' => 'Public'], 'roleArn' => ['title' => '', 'description' => 'Role ARN', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], 'dashboardId' => ['title' => '', 'description' => 'Dashboard ID', 'type' => 'string', 'example' => 'dashboardExample', 'visibility' => 'Public'], 'powerSqlMode' => ['title' => '', 'description' => 'Whether to enable Dedicated SQL', 'type' => 'string', 'example' => 'auto', 'visibility' => 'Public'], 'ui' => ['title' => '', 'description' => 'Used by the frontend for specific-scenario alerts', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], ], 'example' => '', 'visibility' => 'Public', ], 'AlertTag' => [ 'title' => 'alertTag', 'description' => 'The alert tag.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'key' => ['title' => '键名', 'description' => 'The key name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'title'], 'value' => ['title' => '值', 'description' => 'The key value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'example value'], ], ], 'AsyncSqlResponseData' => [ 'title' => '异步SQL返回的结果', 'description' => 'The data structure for the response of an asynchronous SQL query.', 'type' => 'object', 'properties' => [ 'id' => ['title' => '异步SQL的ID', 'type' => 'string', 'required' => true, 'description' => 'The ID of the asynchronous SQL query.', 'example' => '690C4F2A16FBD65C40000484_14'], 'state' => ['title' => '异步SQL的当前执行状态，可以为以下三个状态: ● RUNNING ● FINISHED ● FAILED ● CANCELLED 其中，RUNNING是临时状态, 表示SQL还在执行过程中。仅当状态为FINISHED时，才表示请求执行成功，可以读取结果了。', 'type' => 'string', 'required' => true, 'description' => 'The current execution state of the asynchronous SQL query. Valid values are:'."\n" ."\n" .'- RUNNING'."\n" ."\n" .'- FINISHED'."\n" ."\n" .'- FAILED'."\n" ."\n" .'- CANCELLED'."\n" ."\n" .'RUNNING is a temporary state that indicates the SQL query is still running. You can read the results only when the state is FINISHED. The error\\_code and error\\_message parameters are valid only when the state is FAILED.', 'example' => 'FINISHED'], 'AsyncSqlMetaPB' => [ 'title' => 'SQL相关的meta信息', 'type' => 'object', 'properties' => [ 'result_rows' => ['title' => '结果总行数。读取结果是，offset值不应该超过这个值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => 'The total number of rows in the result. When you read the results, the offset value must not exceed this value.', 'example' => '12000'], 'processed_rows' => ['title' => '处理的原始数据行数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => 'The number of raw data rows processed.', 'example' => '10000000'], 'elapsed_milli' => ['title' => 'SQL执行时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => 'The SQL query running time in milliseconds.', 'example' => '30000'], 'cpu_sec' => ['title' => '消耗的cpu总时间（秒）', 'type' => 'number', 'format' => 'double', 'required' => false, 'description' => 'The total CPU time consumed in seconds.', 'example' => '0.2'], 'cpu_cores' => ['title' => '使用了多少个cpu core', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => 'The number of CPU cores used.', 'example' => '10'], 'progress' => ['title' => 'SQL结果是否精确，它可以为以下两个值: ● Complete (表示结果精确) ● Incomplete (表示结果不精确)', 'type' => 'string', 'description' => 'Indicates whether the SQL result is accurate. Valid values are:'."\n" ."\n" .'- Complete: The result is accurate.'."\n" ."\n" .'- Incomplete: The result is not accurate.', 'example' => 'Complete'], 'keys' => [ 'title' => 'SQL结果对应的column名称，这里的keys和select中的字段是一一对应的。', 'type' => 'array', 'items' => ['type' => 'string', 'description' => 'The column name.', 'title' => '', 'example' => '["name", "age", "gender"]'], 'description' => 'The names of the columns in the SQL result. The keys correspond one-to-one with the fields in the SELECT statement.', 'example' => '', ], ], 'required' => false, 'description' => 'The metadata of the SQL query.', 'example' => '', ], 'rows' => [ 'title' => 'SQL结果。array中的每个元素也是数组，对应具体的一行结果。', 'type' => 'array', 'items' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => 'A column of the result.', 'title' => '', 'example' => '["Jimmy", "20", "male"]'], 'description' => 'A row of the result.', 'title' => '', 'example' => '', ], 'description' => 'The SQL result. Each element in the array is also an array that corresponds to a specific row of the result.', 'example' => '', ], 'error_code' => ['title' => 'SQL执行失败后，error_code中包含了具体的错误码', 'type' => 'string', 'description' => 'If the SQL query fails to execute, this parameter contains the specific error code.', 'example' => 'InvalidQuery'], 'error_message' => ['title' => 'SQL执行失败后，error_message中包含了具体的错误信息', 'type' => 'string', 'description' => 'If the SQL query fails to execute, this parameter contains the specific error message.', 'example' => 'line 37:14: Column \'xyz\' cannot be resolved'], ], 'example' => '', ], 'AzureBlobIngestion' => [ 'title' => 'A short description of struct', 'description' => 'AzureBlob数据导入配置', 'type' => 'object', 'properties' => [ 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-azure-blob-123456'], 'description' => ['title' => 'job description', 'type' => 'string', 'example' => 'azure blob ingestion'], 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'azure blob ingestion'], 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], 'configuration' => ['title' => 'azure blob文件导入配置', 'required' => true, '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration'], 'createTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], 'lastModifiedTime' => ['title' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], 'status' => ['title' => '导入状态', 'type' => 'string', 'example' => 'RUNNING'], 'scheduleId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], 'processorId' => ['title' => '写入处理器ID', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], ], ], 'AzureBlobIngestionConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'S3导入配置', 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'logstore', 'type' => 'string', 'example' => 'myLogstore'], 'source' => ['$ref' => '#/components/schemas/AzureBlobIngestionConfigurationSource'], ], ], 'AzureBlobIngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'description' => 'Contains the configuration for ingesting data from Azure Blob Storage.', 'type' => 'object', 'properties' => [ 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => 'The compression codec for the source data. Valid values are `none`, `snappy`, and `gzip`.', 'type' => 'string', 'example' => 'none', 'required' => true], 'encoding' => ['title' => '编码类型', 'description' => 'The character encoding of the source files.', 'type' => 'string', 'example' => 'UTF-8', 'required' => true], 'interval' => ['title' => '检查新文件周期', 'description' => 'The interval at which to check for new files to ingest.', 'type' => 'string', 'example' => '30m', 'required' => true], 'pattern' => ['title' => '文件路径正则过滤', 'description' => 'A pattern used to filter files by path.', 'type' => 'string', 'example' => '.*'], 'prefix' => ['title' => '文件路径前缀过滤', 'description' => 'The file path prefix used to filter files.', 'type' => 'string', 'example' => 'prefix'], 'tagPackId' => ['title' => '支持上下文浏览', 'description' => 'Specifies whether to enable context query.', 'type' => 'boolean', 'example' => 'false'], 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => 'Ingests only files modified after this time, specified as a Unix timestamp.', 'type' => 'integer', 'example' => '1714274081', 'format' => 'int64'], 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => 'Ingests only files modified before this time, specified as a Unix timestamp.', 'type' => 'integer', 'example' => '1714360481', 'format' => 'int64'], 'timeField' => ['title' => '提取时间字段', 'description' => 'The source field for the time value.', 'type' => 'string', 'example' => '__time__'], 'timeFormat' => ['title' => '时间字段格式', 'description' => 'The format of the time field.', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], 'timePattern' => ['title' => '提取时间正则', 'description' => 'The pattern used to extract the time value.', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], 'timeZone' => ['title' => '时间字段分区', 'description' => 'The time zone of the time field.', 'type' => 'string', 'example' => 'GMT+08:00'], 'processorId' => ['title' => '写入处理器ID', 'description' => 'The ID of the processor that receives the data.', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], 'accountName' => ['title' => '账户名', 'description' => 'The name of the Azure Blob Storage account.', 'type' => 'string', 'example' => 'test001', 'required' => true], 'accountKey' => ['title' => '账户密钥', 'description' => 'The access key for the Azure Blob Storage account.', 'type' => 'string', 'example' => 'dGVzdGtleQ==', 'required' => true], 'containerName' => ['title' => '容器名', 'description' => 'The name of the container in Azure Blob Storage.', 'type' => 'string', 'example' => 'test-container', 'required' => true], 'endpoint' => ['description' => 'The service endpoint for Azure Blob Storage.', 'type' => 'string', 'title' => '', 'example' => 'https://your-storage.blob.core.windows.net', 'required' => false], 'format' => [ 'title' => '格式', 'type' => 'object', 'required' => true, 'additionalProperties' => ['description' => 'Defines the properties of the data format.', 'type' => 'any', 'title' => '', 'example' => '{"type": "line"}'], 'description' => 'The format of the source data.', 'example' => '', ], 'advancedParameters' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'Additional advanced parameters, specified as key-value pairs.', 'type' => 'any', 'title' => '', 'example' => ''], 'description' => 'Advanced configuration options.', 'title' => '', 'example' => '', ], ], 'example' => '', ], 'chart' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of the chart.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'title' => ['title' => '图表标题。支持大小写英文字母、数字、下划线_、连字符-，连字符与下划线不能作为名称开头与结尾，长度必须在[2,64] 之间。', 'description' => 'The title of the chart.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-chart'], 'type' => ['title' => '图表的类型。', 'description' => 'The type of the chart.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'linepro'], 'search' => ['title' => '查询配置', 'description' => 'The query statement.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'example' => '(*)| SELECT date_format(__time__ - __time__ % 60, \'%H:%i:%s\') as time, count(1) as count GROUP BY time ORDER BY time'], 'display' => ['title' => '图表的显示配置', 'description' => 'The display configuration of the chart.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true], 'action' => ['title' => 'action', 'description' => 'The action.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true], ], ], 'ConditionConfiguration' => [ 'title' => '触发条件配置', 'description' => 'The trigger condition configurations.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'condition' => ['title' => '评估表达式', 'description' => 'The evaluate expression.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cnt > 100'], 'countCondition' => ['title' => '满足评估表达式的结果条数', 'description' => 'The number of entries that match the evaluate expression to return.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '__count__ > 5'], ], ], 'ConsumeProcessor' => [ 'description' => 'ConsumeProcessor', 'title' => 'ConsumeProcessor', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'processorName' => ['title' => 'Processor ID', 'description' => 'Processor ID', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1'], 'displayName' => ['title' => 'Processor名称', 'description' => 'Processor名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '字段过滤处理'], 'description' => ['title' => 'Processor描述', 'description' => 'Processor描述', 'visibility' => 'Public', 'type' => 'string', 'example' => '过滤content字段'], 'configuration' => ['title' => 'Processor配置', 'description' => 'Processor配置', 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/ConsumeProcessorConfiguration', 'example' => ''], 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1717171200'], 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1717171200'], ], 'example' => '', ], 'ConsumeProcessorConfiguration' => [ 'title' => 'ConsumeProcessor配置', 'description' => 'ConsumeProcessorConfiguration'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'spl' => ['title' => 'SPL语句', 'description' => 'SPL statement'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | project content'], ], ], 'ConsumerGroup' => [ 'title' => 'Consumer Group', 'description' => 'The data structure of the consumer group.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'name' => ['title' => '消费者名称。', 'description' => 'The name of the consumer group.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test-consumer-group'], 'timeout' => ['title' => '消费超时时长，单位为秒', 'description' => 'The timeout period. If Simple Log Service does not receive heartbeats from a consumer within the timeout period, Simple Log Service deletes the consumer. Unit: seconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], 'order' => ['title' => '是否有序消费', 'description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" ."\n" .'* true: If a shard is split, the data in the original shard is consumed first. Then, the data in the new shards is consumed at the same time. If shards are merged, the data in the original shards is consumed first. Then, the data in the new shard is consumed.'."\n" .'* false: The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or shards are merged, the data in the new shard is immediately consumed.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'], ], ], 'dashboard' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of the dashboard.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'dashboardName' => ['title' => '仪表盘ID。同一个Project下，仪表盘ID唯一，不可重复。', 'description' => 'The internal display name of the dashboard.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], 'displayName' => ['title' => '仪表盘的展示名称。', 'description' => 'The display name of the dashboard.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-alert'], 'description' => ['title' => '描述信息。', 'description' => 'The description of the dashboard.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'this is a dashboard'], 'attribute' => [ 'title' => '属性值，可用于修改仪表盘的布局等属性，例如 "type": "free" 自由布局， "type":"grid" 网格布局。', 'description' => 'The properties of the dashboard.', 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => ['description' => 'The value of the property.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => 'yyy'], 'example' => '', ], 'charts' => [ 'title' => '仪表盘内包含的图表。', 'description' => 'The charts in the dashboard.', 'visibility' => 'Public', 'type' => 'array', 'items' => ['description' => 'The data structure of the chart.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/chart', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], ], 'example' => '', ], 'DeleteLogStoreLogsTask' => [ 'title' => '软删除任务', 'type' => 'object', 'properties' => [ 'progress' => ['title' => '进度', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], 'taskId' => ['title' => 'id', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], 'query' => ['title' => '使用的query', 'type' => 'string', 'description' => '', 'example' => ''], 'errorCode' => ['title' => '出错时的errorCode', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], 'from' => ['title' => '起始时间', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], 'to' => ['title' => '结束时间', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], 'errorMessage' => ['title' => '出错时的errorMessage', 'type' => 'string', 'description' => '', 'example' => ''], ], 'description' => 'The soft delete task.', 'example' => '', ], 'EncryptConf' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of the encryption configuration.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'enable' => ['title' => 'enable', 'description' => 'Specifies whether to enable data encryption. Valid values:'."\n" ."\n" .'* true'."\n" .'* false'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'true'], 'encrypt_type' => [ 'title' => '加密算法，只支持default和m4。当 enable 为 true 时，此项必选。', 'description' => 'The encryption algorithm. Valid values: default and sm4. If enable is set to true, you must configure this parameter.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'default', 'default' => 'default', 'enumValueTitles' => ['default' => 'default', 'aes_ecb' => 'aes_ecb', 'aes_cbc' => 'aes_cbc', 'aes_gcm' => 'aes_gcm', 'm4' => 'm4', 'aes_cfb' => 'aes_cfb', 'sm4_ecb' => 'sm4_ecb', 'sm4_cbc' => 'sm4_cbc', 'sm4_gcm' => 'sm4_gcm', 'aes_ofb' => 'aes_ofb'], ], 'user_cmk_info' => ['description' => 'Optional. If you configure this parameter, the bring-your-own-key (BYOK) key is used. If you do not configure this parameter, the service key of Simple Log Service is used.'."\n", 'visibility' => 'Public', 'example' => ' { "cmk_key_id" : "f5136b95-2420-ab31-xxxxxxxxx" "arn" : "acs:ram::13234:role/logsource" "region_id" : "cn-hangzhou" }', '$ref' => '#/components/schemas/EncryptUserCmkConf'], ], ], 'EncryptUserCmkConf' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of the user-defined encryption configuration.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'cmk_key_id' => ['title' => 'cmk_key_id', 'description' => 'The ID of the customer master key (CMK) if you use the bring-your-own-key (BYOK) key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'f5136b95-2420-ab31-xxxxxxxxx'], 'arn' => ['title' => 'arn', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logsource'], 'region_id' => ['title' => 'region_id', 'description' => 'The ID of the region where the CMK resides.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'ESIngestion' => [ 'title' => 'es ingestion job', 'type' => 'object', 'properties' => [ 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-es-123456', 'description' => ''], 'description' => ['title' => 'job description', 'type' => 'string', 'example' => 'es ingestion', 'description' => ''], 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'es ingestion', 'description' => ''], 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'description' => '', 'example' => ''], 'configuration' => ['title' => 'es导入配置', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration', 'description' => '', 'example' => ''], 'createTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481', 'description' => ''], 'lastModifiedTime' => ['title' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481', 'description' => ''], 'status' => ['title' => '导入状态', 'type' => 'string', 'example' => 'RUNNING', 'description' => ''], 'scheduleId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010', 'description' => ''], ], 'description' => 'ES ingestion job', 'example' => '', ], 'ESIngestionConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'ES import configuration.', 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'logstore', 'description' => 'The Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], 'source' => ['description' => 'The source.', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfigurationSource', 'title' => '', 'example' => ''], ], 'example' => '', ], 'ESIngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'description' => 'The resource configuration for ES data import.', 'type' => 'object', 'properties' => [ 'BootstrapServers' => ['title' => '服务实例URL', 'type' => 'string', 'required' => true, 'description' => 'The URL of the service instance.', 'example' => ''], 'Index' => ['title' => 'ES索引列表', 'type' => 'string', 'required' => true, 'description' => 'The list of ES indexes.', 'example' => ''], 'Username' => ['title' => 'ES用户名称', 'type' => 'string', 'required' => false, 'description' => 'The username for ES.', 'example' => ''], 'Password' => ['title' => 'ES用户密码', 'type' => 'string', 'required' => false, 'description' => 'The password for the ES user.', 'example' => ''], 'TimeFieldName' => ['title' => '时间字段', 'type' => 'string', 'description' => 'The time field.', 'example' => ''], 'TimeFormat' => ['title' => '时间字段格式', 'type' => 'string', 'description' => 'The format of the time field.', 'example' => ''], 'TimeZone' => ['title' => '时间字段时区', 'type' => 'string', 'description' => 'The time zone of the time field.', 'example' => ''], 'Query' => ['title' => 'ES查询', 'type' => 'string', 'required' => true, 'description' => 'The ES query.', 'example' => ''], 'ConnectorMode' => ['title' => '导入模式', 'type' => 'string', 'required' => true, 'description' => 'The import mode.', 'example' => ''], 'StartTime' => ['title' => '起始时间', 'type' => 'integer', 'format' => 'int64', 'description' => 'The start time.', 'example' => ''], 'EndTime' => ['title' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'description' => 'The end time.', 'example' => ''], 'MaxDataDelaySec' => ['title' => '数据最大延迟秒数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => 'The maximum data delay in seconds.', 'example' => ''], 'MinFragRangeSec' => ['title' => '检查新数据周期（秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => 'The interval in seconds for checking new data.', 'example' => ''], 'VpcId' => ['title' => 'VPC实例ID', 'type' => 'string', 'description' => 'The ID of the VPC instance.', 'example' => ''], ], 'example' => '', ], 'ETL' => [ 'title' => 'ETL', 'description' => 'ETL'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'name' => ['title' => '任务名称', 'description' => 'job name'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ETL'], 'description' => ['title' => '任务描述', 'description' => 'job description'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ETL'], 'displayName' => ['title' => '显示名称', 'description' => 'job displayName'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ETL'], 'configuration' => ['title' => '数据加工配置', 'description' => 'The configurations of the data transformation job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration'], 'createTime' => ['title' => '创建时间', 'description' => 'The time when the data transformation job was created.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1714274900'], 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => 'The time when the data transformation job was last modified.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1714274900'], 'status' => ['title' => '加工状态', 'description' => 'The status of the data transformation job. Valid values:'."\n" ."\n" .'1. RUNNING'."\n" .'2. STOPPING'."\n" .'3. STOPPED'."\n" .'4. SUCCEEDED'."\n" .'5. FAILED'."\n" .'6. STARTING'."\n" .'7. RESTARTING'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'RUNNING'], 'scheduleId' => ['title' => '调度ID', 'description' => 'The ID of the scheduler.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'f0eb655e501a8780808d1970ef6d04c4'], ], ], 'ETLConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'ETLConfiguration', 'type' => 'object', 'properties' => [ 'script' => ['title' => '加工脚本', 'description' => 'The data transformation script.', 'type' => 'string', 'required' => true, 'example' => '* | extend key=\'value\'', 'visibility' => 'Public'], 'lang' => ['title' => '数据加工语法类型', 'description' => 'The language of the data transformation script.', 'type' => 'string', 'example' => 'SPL', 'visibility' => 'Public'], 'logstore' => ['title' => '源Logstore名称', 'description' => 'The name of the source Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'visibility' => 'Public'], 'roleArn' => ['title' => '授权读取源Logstore的角色ARN', 'description' => 'The ARN of the RAM role that is authorized to read data from the source Logstore.', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logtarget', 'visibility' => 'Public'], 'accessKeyId' => ['title' => '授权读取源Logstore的AccessKey ID，必填。使用角色授权时，填入空字符串', 'description' => 'The AccessKey ID that is required to read data from the source Logstore. This parameter is required. If you use a RAM role for authorization, set this parameter to an empty string.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '', 'visibility' => 'Public'], 'accessKeySecret' => ['title' => '授权读取源Logstore的AccessKey Secret，必填。使用角色授权时，填入空字符串。', 'description' => 'The AccessKey secret that is required to read data from the source Logstore. This parameter is required. If you use a RAM role for authorization, set this parameter to an empty string.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '', 'visibility' => 'Public'], 'fromTime' => ['title' => '加工时间起点时间戳（精确到秒），必填。从源Logstore中最早接收到的第一条日志开始消费时，填入0', 'description' => 'The start time of the data transformation. The value is a UNIX timestamp. Unit: seconds. This parameter is required. To start the data transformation from the earliest log in the source Logstore, set this parameter to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'visibility' => 'Public'], 'toTime' => ['title' => '加工时间结束时间戳（精确到秒），必填。持续消费至手动停止时，填入0', 'description' => 'The end time of the data transformation. The value is a UNIX timestamp. Unit: seconds. This parameter is required. To continuously perform the data transformation until you manually stop it, set this parameter to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'visibility' => 'Public'], 'sinks' => [ 'title' => '加工结果输出目标列表', 'description' => 'The output destinations of the data transformation.', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/ETLConfigurationSink', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], 'required' => true, 'example' => '', 'visibility' => 'Public', ], 'parameters' => ['title' => '高级参数配置', 'description' => 'Advanced parameters.', 'type' => 'object', 'example' => 'config.vpc.vpc_id.test1：vpc-uf6mskb0b****n9yj', 'visibility' => 'Public'], ], 'example' => '', 'visibility' => 'Public', ], 'ETLConfigurationSink' => [ 'title' => 'A short description of struct', 'description' => 'The sink configuration.', 'type' => 'object', 'properties' => [ 'name' => ['title' => '输出目标名称', 'description' => 'The sink name.', 'type' => 'string', 'required' => true, 'example' => 'test-etljob', 'visibility' => 'Public'], 'endpoint' => ['title' => '目标Project所在区域的endpoint', 'description' => 'The endpoint of the destination Project\'s region.', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], 'project' => ['title' => '目标Project名称', 'description' => 'The destination Project name.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'visibility' => 'Public'], 'logstore' => ['title' => '目标Logstore名称', 'description' => 'The destination Logstore name.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'visibility' => 'Public'], 'datasets' => [ 'title' => '写入结果集', 'description' => 'The datasets to write to the sink.', 'type' => 'array', 'items' => ['type' => 'string', 'required' => true, 'example' => '__UNNAMED__', 'description' => '', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], 'minItems' => 1, 'example' => '', 'visibility' => 'Public', ], 'roleArn' => ['title' => '授权写入目标Logstore的角色ARN', 'description' => 'The role ARN used to write to the destination Logstore.', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logtarget', 'visibility' => 'Public'], 'accessKeyId' => ['title' => '授权写入目标Logstore的AccessKey ID', 'description' => 'The AccessKey ID used to write to the destination Logstore.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '', 'visibility' => 'Public'], 'accessKeySecret' => ['title' => '授权写入目标Logstore的AccessKey Secret', 'description' => 'The AccessKey Secret used to write to the destination Logstore.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '', 'visibility' => 'Public'], ], 'example' => '', 'visibility' => 'Public', ], 'etlJob' => [ 'title' => 'A short description of struct', 'description' => '数据加工任务数据结构。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'etlJobName' => ['title' => '任务名称', 'description' => '数据加工任务名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'etl-name'], 'sourceConfig' => [ 'title' => '配置数据来源', 'description' => '配置数据来源。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'logstoreName' => ['title' => 'logstore 名称', 'description' => 'Logstore名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], ], 'required' => true, ], 'triggerConfig' => [ 'title' => '触发器配置', 'description' => '加工任务触发器配置。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'roleArn' => ['title' => '角色授权配置', 'description' => '角色授权配置，例如角色ARN为`acs:ram::13791******44:role/aliyunlogetlrole`。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13791******44:role/aliyunlogetlrole'], 'triggerInterval' => ['title' => '触发间隔，单位为秒，必须在 [3,600] 之间', 'description' => '触发间隔。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5'], 'maxRetryTime' => ['title' => '最大重试次数，必须在[0,100] 之间', 'description' => '最大重试次数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], 'startingPosition' => ['title' => '开始位置，可选 latest、at-unixtime， 默认 latest。', 'description' => '开始位置。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'at-unixtime'], 'startingUnixtime' => ['title' => '开始时间', 'description' => '开始时间。当startingPosition为at-unixtime时生效。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], ], 'required' => true, ], 'functionConfig' => [ 'title' => '运行函数配置', 'description' => '运行函数配置。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'functionProvider' => ['title' => '函数 provider，可选值为 FunctionCompute 、CloudProdLogDispatch。当值为 FunctionCompute 时，endpoint、accountid 、regionName 、serviceName 、functionName 必选。', 'description' => '函数provider。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'FunctionCompute'], 'endpoint' => ['title' => 'endpoint', 'description' => '服务入口Endpoint。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou.log.aliyuncs.com'], 'accountId' => ['title' => '账户 id', 'description' => '阿里云账号ID。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '13791******44'], 'regionName' => ['title' => '地域', 'description' => '地域。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'serviceName' => ['title' => '服务名', 'description' => '服务名。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'my-service'], 'functionName' => ['title' => '函数名', 'description' => '函数名。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'hello-world'], 'roleArn' => ['title' => '角色授权', 'description' => '角色授权配置，例如角色ARN为`acs:ram::13791******44:role/aliyunlogetlrole`。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:ram::13791******44:role/aliyunlogetlrole'], ], 'required' => true, ], 'functionParameter' => ['title' => '参数列表', 'description' => '参数列表。', 'visibility' => 'Public', 'type' => 'object', 'required' => true], 'enable' => ['title' => '是否启用', 'description' => '是否启用。', 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, 'example' => 'true'], 'logConfig' => [ 'title' => '日志配置', 'description' => '日志配置。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'endpoint' => ['title' => 'endpoint', 'description' => '服务入口Endpoint。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou.log.aliyuncs.com'], 'projectName' => ['title' => 'project 名称', 'description' => 'Project名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], 'logstoreName' => ['title' => 'logstore 名称', 'description' => 'Logstore名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], 'required' => true, ], ], ], 'etlMeta' => [ 'title' => 'A short description of struct', 'description' => 'etlMeta数据结构。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'etlMetaName' => ['title' => '名字', 'description' => 'MetaName', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'MetaName'], 'etlMetaKey' => ['title' => 'key', 'description' => 'MetaKey', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'MetaKey'], 'etlMetaTag' => ['title' => 'tag', 'description' => 'MetaTag', 'visibility' => 'Public', 'type' => 'string', 'example' => 'MetaTag'], 'enable' => ['title' => '是否启用', 'description' => 'Enable', 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, 'example' => 'true'], 'etlMetaValue' => ['title' => 'value', 'description' => 'MetaValue', 'visibility' => 'Public', 'type' => 'string', 'example' => 'MetaValue'], ], ], 'externalStore' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of the external store.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'externalStoreName' => ['title' => '外部存储的名称。', 'description' => 'The name of the external store. The name must be unique in a project and must be different from Logstore names.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'rds_store'], 'storeType' => ['title' => '类型。可选 rds-vpc 或者 oss', 'description' => 'The storage type. Set the value to rds-vpc, which indicates a database on an ApsaraDB RDS for MySQL instance in a virtual private cloud (VPC).'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'rds-vpc'], 'parameter' => ['title' => '参数', 'description' => 'The parameters that are configured for the external store.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'example' => '{ "vpc-id": "vpc-bp1aevy8sofi8mh1q****", "instance-id": "i-bp1b6c719dfa08exf****", "host": "192.168.XX.XX", "port": "3306", "username": "root", "password": "sfdsfldsfksfls****", "db": "meta", "table": "join_meta", "region": "cn-qingdao" }'], ], ], 'GCSIngestion' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'name' => ['title' => '导入任务名称', 'description' => 'The job name.', 'type' => 'string', 'example' => 'ingest-gcs-123456', 'required' => true], 'description' => ['title' => 'job description', 'description' => 'A user-friendly description for the job.', 'type' => 'string', 'example' => 'gcs ingestion'], 'displayName' => ['title' => 'job displayName', 'description' => 'The display name for the job.', 'type' => 'string', 'example' => 'gcs ingestion', 'required' => true], 'configuration' => ['title' => 'gcs导入配置', 'description' => 'The GCS ingestion configuration.', 'example' => '', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration'], 'createTime' => ['title' => '创建时间', 'description' => 'Output only. The creation time of the job, as a Unix timestamp.', 'type' => 'integer', 'example' => '1714360481', 'format' => 'int64'], 'status' => ['title' => '导入状态', 'description' => 'Output only. The ingestion status.', 'type' => 'string', 'example' => 'RUNNING'], 'scheduleId' => ['title' => '任务ID', 'description' => 'The job ID.', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], 'lastModifiedTime' => ['description' => 'Output only. The last modified time of the job, as a Unix timestamp.', 'type' => 'integer', 'title' => '', 'example' => '1714360581', 'format' => 'int64'], ], 'description' => 'Represents a data ingestion job that imports data from Google Cloud Storage (GCS).', 'example' => '', ], 'GCSIngestionConfiguration' => [ 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'logstore', 'description' => 'The name of the destination logstore.', 'type' => 'string', 'example' => 'myLogstore', 'required' => true], 'source' => ['description' => 'The data source configuration.', 'title' => '', 'example' => '', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfigurationSource'], ], 'description' => 'The GCS ingestion configuration.', 'title' => '', 'example' => '', ], 'GCSIngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'endpoint' => ['title' => 'gcs endpoint', 'description' => 'The service endpoint for GCS. You can use a custom endpoint for private or accelerated connections.', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com', 'required' => false], 'bucket' => ['title' => 'gcs bucket', 'description' => 'The name of the GCS bucket that contains the source data files.', 'type' => 'string', 'example' => 'gcsbucket', 'required' => true], 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => 'The compression format of the source files. Supported values are `none`, `gzip`, and `zstd`. If not specified, the system infers the format from the file extension.', 'type' => 'string', 'example' => 'none', 'required' => true], 'encoding' => ['title' => '编码类型', 'description' => 'The character encoding of the source files. The default value is `UTF-8`.', 'type' => 'string', 'example' => 'UTF-8', 'required' => true], 'interval' => ['title' => '检查新文件周期', 'description' => 'The interval for checking for new data. Specify the value in a duration format, such as `15m` for 15 minutes. Set to `never` to perform a one-time ingestion.', 'type' => 'string', 'example' => 'never', 'required' => true], 'pattern' => ['title' => '文件路径正则过滤', 'description' => 'A regular expression that specifies which files to ingest. The pattern is matched against the full object key within the specified prefix.', 'type' => 'string', 'example' => '.*'], 'prefix' => ['title' => '文件路径前缀过滤', 'description' => 'The object key prefix used to discover files. This limits the scope of ingestion to a specific "folder" within the bucket.', 'type' => 'string', 'example' => 'prefix'], 'restoreObjectEnabled' => ['title' => '导入归档文件', 'description' => 'Specifies whether to automatically restore objects from archival storage classes before ingestion. Set to `true` to enable this feature. The default is `false`.', 'type' => 'boolean', 'example' => '', 'required' => false, 'default' => 'true'], 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => 'The start of the time range for data ingestion, specified as a Unix timestamp (in seconds). Only objects modified at or after this time are ingested.', 'type' => 'integer', 'example' => '1714274081', 'format' => 'int64'], 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => 'The end of the time range for data ingestion, specified as a Unix timestamp (in seconds). Only objects modified before this time are ingested.', 'type' => 'integer', 'example' => '1714360481', 'format' => 'int64'], 'timeField' => ['title' => '提取时间字段', 'description' => 'The name of the field in your data that contains the timestamp. This timestamp is used as the event time for the ingested records.', 'type' => 'string', 'example' => '__time__'], 'timeFormat' => ['title' => '时间字段格式', 'description' => 'The format of the timestamp in the `timeField`, specified using the Java `SimpleDateFormat` pattern. For example: `yyyy-MM-dd\'T\'HH:mm:ss.SSSZ`.', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], 'timePattern' => ['title' => '提取时间正则', 'description' => 'A regular expression used to extract a timestamp from unstructured data, such as a log entry or filename, if a structured `timeField` is not available.', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], 'timeZone' => ['title' => '时间字段分区', 'description' => 'The time zone for parsing timestamps that lack explicit time zone information. Specify a valid time zone identifier, such as `UTC` or `America/Los_Angeles`.', 'type' => 'string', 'example' => 'GMT+08:00'], 'tagPackId' => ['title' => '启动上下文检索', 'description' => 'The ID of a predefined tag pack to apply to the ingested data. Tag packs contain rules for data enrichment and categorization.', 'type' => 'boolean', 'example' => '', 'default' => 'true'], 'processorId' => ['title' => '写入处理器id', 'description' => 'The unique ID of the processor or pipeline that handles the ingested data.', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], 'accessKeyId' => ['description' => 'The access key ID for authenticating with the GCS service. This parameter is required.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => true], 'accessKeySecret' => ['description' => 'The secret access key corresponding to the `accessKeyId`. This value is sensitive and must be managed securely.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => true], 'format' => [ 'title' => '格式', 'type' => 'object', 'required' => true, 'additionalProperties' => ['description' => 'Specifies format-specific properties as key-value pairs. For example, you can set a `delimiter` for CSV files.', 'type' => 'any', 'title' => '', 'example' => ''], 'description' => 'A nested object that defines the format of the source data, such as CSV, JSON, or Parquet.', 'example' => '', ], 'advancedParameters' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'Specifies additional advanced parameters as key-value pairs.', 'type' => 'any', 'title' => '', 'example' => ''], 'description' => 'A nested object for specifying advanced configuration options as key-value pairs.', 'title' => '', 'example' => '', ], ], 'description' => 'Specifies the configuration for ingesting data from a Google Cloud Storage (GCS) data source.', 'example' => '', ], 'GroupConfiguration' => [ 'title' => '告警分组评估配置.', 'description' => 'The configuration for alert group evaluation.', 'type' => 'object', 'properties' => [ 'type' => ['title' => '分组评估类型', 'description' => 'The group evaluation type.', 'type' => 'string', 'required' => true, 'example' => 'custom'], 'fields' => [ 'title' => '分组评估字段', 'description' => 'The group evaluation fields.', 'type' => 'array', 'items' => ['type' => 'string', 'example' => 'id', 'description' => '', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'Histogram' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of log distribution.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'from' => ['title' => '开始', 'description' => 'The start time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1409529600'], 'to' => ['title' => '结束', 'description' => 'The end time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1409569200'], 'count' => ['title' => 'count', 'description' => 'The number of logs that are generated during the subinterval.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'progress' => ['title' => 'progress', 'description' => 'Indicates whether the query result in the subinterval is complete. Valid values:'."\n" ."\n" .'* Complete: The query is successful, and the complete result is returned.'."\n" .'* Incomplete: The query is successful, but the query result is incomplete. To obtain the complete result, you must repeat the request.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Complete'], ], ], 'index' => [ 'title' => '', 'description' => 'The data structure for the index configuration.', 'type' => 'object', 'properties' => [ 'max_text_len' => ['title' => '', 'description' => 'The default maximum length of a field value in Simple Log Service is 2,048 bytes (2 KB). To change this limit, set the maximum length for a text field. The value must be between 64 and 16,384 bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048'], 'log_reduce_white_list' => [ 'title' => '', 'description' => 'The whitelist of fields for log clustering. This parameter is valid only when log clustering is enabled.', 'type' => 'array', 'items' => ['description' => 'A field in the whitelist.', 'type' => 'string', 'title' => '', 'example' => 'name'], 'example' => '', ], 'log_reduce_black_list' => [ 'title' => '', 'description' => 'The blacklist of fields for log clustering. This parameter is valid only when log clustering is enabled.', 'type' => 'array', 'items' => ['description' => 'A field in the blacklist.', 'type' => 'string', 'title' => '', 'example' => 'time'], 'example' => '', ], 'line' => [ 'title' => '', 'description' => 'The full-text index configuration. You must specify either this parameter or the \\`keys\\` parameter.', 'type' => 'object', 'properties' => [ 'chn' => ['title' => '', 'description' => 'Specifies whether the logs contain Chinese characters.'."\n" ."\n" .'- true: The logs contain Chinese characters.'."\n" ."\n" .'- false (default): The logs do not contain Chinese characters.', 'type' => 'boolean', 'example' => 'false'], 'caseSensitive' => ['title' => '', 'description' => 'Specifies whether the index is case-sensitive.'."\n" ."\n" .'- true: The index is case-sensitive.'."\n" ."\n" .'- false (default): The index is not case-sensitive.', 'type' => 'boolean', 'example' => 'true'], 'token' => [ 'title' => '', 'description' => 'The list of delimiters for tokenization. This parameter specifies how the field is tokenized.', 'type' => 'array', 'items' => ['description' => 'A delimiter. Examples: ",", ".", "'."\r".'", and "'."\n" .'".', 'type' => 'string', 'title' => '', 'example' => ','], 'required' => true, 'example' => '', ], 'include_keys' => [ 'title' => '', 'description' => 'The list of fields to include in the full-text index. This parameter cannot be specified at the same time as \\`exclude\\_keys\\`.', 'type' => 'array', 'items' => ['description' => 'The fields to include.', 'type' => 'string', 'title' => '', 'example' => 'includeField'], 'example' => '', ], 'exclude_keys' => [ 'title' => '', 'description' => 'The list of fields to exclude from the full-text index. This parameter cannot be specified at the same time as \\`include\\_keys\\`.', 'type' => 'array', 'items' => ['description' => 'The fields to exclude.', 'type' => 'string', 'title' => '', 'example' => 'excludeField'], 'example' => '', ], ], 'example' => '', ], 'keys' => [ 'title' => '', 'description' => 'The field index configuration. The key is the field name and the value is the index configuration for the field. You must specify either this parameter or the \\`line\\` parameter.', 'type' => 'object', 'additionalProperties' => ['description' => 'The field index configuration. The key is the field name and the value is the index configuration for the field.', '$ref' => '#/components/schemas/IndexKey', 'title' => '', 'example' => ''], 'example' => '', ], 'log_reduce' => ['title' => '', 'description' => 'Specifies whether to enable log clustering. If enabled, either the whitelist or the blacklist can be active, but not both.'."\n" ."\n" .'- true: Enable log clustering.'."\n" ."\n" .'- false (default): Do not enable log clustering.', 'type' => 'boolean', 'example' => 'true'], 'scan_index' => ['title' => '', 'description' => 'Specifies whether to enable the scan index.', 'type' => 'boolean', 'default' => 'false', 'example' => 'false'], ], 'example' => '', ], 'IndexJsonKey' => [ 'title' => 'index of json type', 'description' => 'The index configuration for a key within a JSON field.', 'type' => 'object', 'properties' => [ 'chn' => ['title' => '是否包含中文', 'description' => 'Specifies whether to enable Chinese tokenization for the field.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], 'caseSensitive' => ['title' => '大小写敏感', 'description' => 'Specifies whether queries on this field are case-sensitive.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], 'token' => [ 'title' => '分词符', 'description' => 'The delimiters used for tokenization.', 'type' => 'array', 'items' => ['description' => 'A delimiter.', 'type' => 'string', 'example' => '|', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], 'example' => '', 'visibility' => 'Public', ], 'alias' => ['title' => '别名', 'description' => 'The alias of the field.', 'type' => 'string', 'example' => 'myAlias', 'visibility' => 'Public'], 'type' => ['title' => '字段类型', 'description' => 'Specifies the field type.', 'type' => 'string', 'required' => true, 'example' => 'text', 'visibility' => 'Public'], 'doc_value' => ['title' => '开启统计', 'description' => 'Specifies whether to enable doc\\_value for the field. This enables sorting, aggregation, and statistical analysis on the field.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], ], 'example' => '', 'visibility' => 'Public', ], 'IndexKey' => [ 'title' => 'A short description of struct', 'description' => 'The index key.', 'type' => 'object', 'properties' => [ 'chn' => ['title' => '是否包含中文', 'description' => 'Specifies whether the field contains Chinese characters.', 'type' => 'boolean', 'example' => 'true'], 'caseSensitive' => ['title' => '大小写敏感', 'description' => 'Specifies whether the field is case-sensitive.', 'type' => 'boolean', 'example' => 'true'], 'alias' => ['title' => '别名', 'description' => 'The alias of the field.', 'type' => 'string', 'example' => 'myAlias'], 'type' => ['title' => '字段类型', 'description' => 'The type of the field.', 'type' => 'string', 'required' => true, 'example' => 'text'], 'doc_value' => ['title' => '开启统计', 'description' => 'Specifies whether to enable statistics for the field.', 'type' => 'boolean', 'example' => 'true'], 'index_all' => ['title' => '是否对Json内所有文本字段自动索引', 'description' => 'Specifies whether to automatically create an index for all text fields in the JSON object.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'], 'max_depth' => ['title' => '最大深度', 'description' => 'The maximum depth.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], 'embedding' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'vector_index' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'token' => [ 'title' => '分词符', 'description' => 'The delimiters used for tokenization.', 'type' => 'array', 'items' => ['type' => 'string', 'example' => '|', 'description' => '', 'title' => ''], 'example' => '', ], 'json_keys' => [ 'title' => 'json key', 'description' => 'The JSON key.', 'type' => 'object', 'additionalProperties' => ['$ref' => '#/components/schemas/IndexJsonKey', 'description' => '', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'IngestProcessor' => [ 'description' => 'IngestProcessor', 'title' => '', 'type' => 'object', 'properties' => [], 'example' => '', 'visibility' => 'Public', ], 'IngestProcessorConfiguration' => [ 'description' => 'IngestProcessorConfiguration', 'title' => '', 'type' => 'object', 'properties' => [], 'example' => '', 'visibility' => 'Public', ], 'JoinConfiguration' => [ 'title' => '告警集合操作配置', 'description' => 'The set operation configurations for the alert rule.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'type' => ['title' => '集合操作类型', 'description' => 'The type of the set operation.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'left_join'], 'condition' => ['title' => '集合操作条件', 'description' => 'The condition of the set operation.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '$0.id == $1.id'], ], ], 'KafkaIngestion' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-kafka-123456', 'description' => ''], 'description' => ['title' => 'job description', 'type' => 'string', 'example' => 'kafka ingestion', 'description' => ''], 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'kafka ingestion', 'description' => ''], 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'description' => '', 'example' => ''], 'configuration' => ['title' => 'kafka导入配置', 'required' => true, '$ref' => '#/components/schemas/KafkaIngestionConfiguration', 'description' => '', 'example' => ''], 'createTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481', 'description' => ''], 'lastModifiedTime' => ['title' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481', 'description' => ''], 'status' => ['title' => '导入状态', 'type' => 'string', 'example' => 'RUNNING', 'description' => ''], 'scheduleId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010', 'description' => ''], ], 'description' => 'A short description of struct ', 'example' => '', ], 'KafkaIngestionConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'The configuration of the Kafka data import source.', 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'logstore', 'type' => 'string', 'required' => true, 'example' => 'logstore', 'description' => ''], 'source' => ['required' => true, '$ref' => '#/components/schemas/KafkaIngestionConfigurationSource', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'KafkaIngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'description' => 'Kafka ingestion source configuration.', 'type' => 'object', 'properties' => [ 'topics' => ['title' => 'Topic列表', 'description' => 'The Kafka topics to subscribe to. Separate multiple topics with a comma (`,`).', 'type' => 'string', 'example' => 'topic1,topic2', 'required' => true], 'fromPosition' => ['title' => '起始位置', 'description' => 'The starting position for data consumption. Valid values: `earliest` and `latest`.', 'type' => 'string', 'example' => 'earliest,latest', 'required' => true], 'consumerGroup' => ['title' => '消费组', 'description' => 'The ID of the Kafka consumer group.', 'type' => 'string', 'example' => 'consumer'], 'valueType' => ['title' => '数据格式', 'description' => 'The format of the message value. Valid values: `text` and `json`.', 'type' => 'string', 'example' => 'text,json', 'required' => true], 'encoding' => ['title' => '编码格式', 'description' => 'The character encoding of the message. This parameter applies only when `valueType` is `text`.', 'type' => 'string', 'example' => 'UTF-8', 'required' => true], 'parseArray' => ['title' => '解析数组元素', 'description' => 'Specifies whether to parse a message as a JSON array. If `true`, each element in the array becomes a separate log entry. This parameter applies only when `valueType` is `json`.', 'type' => 'boolean', 'example' => 'true', 'required' => true], 'vpcId' => ['title' => 'vpcId', 'description' => 'The ID of the VPC that contains the Kafka cluster.', 'type' => 'string', 'example' => '', 'required' => false], 'timeField' => ['title' => '时间字段', 'description' => 'The field that contains the log timestamp. This parameter applies only when `valueType` is `json`.', 'type' => 'string', 'example' => '__time__'], 'timePattern' => ['title' => '提取时间正则', 'description' => 'The regular expression for extracting the timestamp from the field specified by `timeField`.', 'type' => 'string', 'example' => '\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}'], 'timeFormat' => ['title' => '时间字段格式', 'description' => 'The format of the timestamp. For example, you can set this to `epoch` for a Unix timestamp.', 'type' => 'string', 'example' => 'epoch'], 'timeZone' => ['title' => '时区', 'description' => 'The time zone of the timestamp, such as `+0800`.', 'type' => 'string', 'example' => '+0800'], 'defaultTimeSource' => ['title' => '默认时间来源', 'description' => 'The default time source to use if timestamp extraction from the log data fails. Valid values are `system` (the time of the ingestion server) and `kafka` (the timestamp from the Kafka message).', 'type' => 'string', 'example' => 'system,kafka'], 'enableSlsContext' => ['title' => '日志上下文', 'description' => 'Specifies whether to add Simple Log Service (SLS) context fields, such as `__topic__` and `__partition__`, to each log entry.', 'type' => 'boolean', 'example' => 'true'], 'nameResolutions' => ['title' => '私网域名解析', 'description' => 'Custom DNS resolutions in JSON format. Use this parameter to map hostnames to IP addresses.', 'type' => 'string', 'example' => '{"hostname": "192.168.1.28"}'], 'communication' => ['title' => '通信协议', 'description' => 'The authentication and communication protocol settings in JSON format. For example, you can use this parameter to configure SASL authentication.', 'type' => 'string', 'example' => '{ "protocol":"SASL_PLAINTEXT", "sasl":{ "mechanism":"PLAIN", "username":"用户名", "password":"密码" } }'], 'processorId' => ['title' => '写入处理器ID', 'description' => 'The ID of the ingestion processor.', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], 'enableVpcNat' => ['title' => '是否使用vpc-nat', 'description' => 'Specifies whether to enable NAT for VPC connections. Set this to `true` if your Kafka cluster is in a VPC and requires NAT for access.', 'type' => 'boolean', 'example' => ''], 'securityGroups' => ['title' => '安全组', 'description' => 'The ID of the security group to associate with the ingestion source. This parameter is required when connecting to a Kafka cluster in a VPC. Separate multiple IDs with a comma (`,`).', 'type' => 'string', 'example' => ''], 'vswitchId' => ['title' => 'Vswitch Id', 'description' => 'The ID of the VSwitch in the specified VPC. This parameter is required when connecting to a Kafka cluster in a VPC.', 'type' => 'string', 'example' => ''], 'bootstrapServers' => ['title' => '服务地址', 'description' => 'A list of bootstrap servers for the Kafka cluster, formatted as `host1:port1,host2:port2`.', 'type' => 'string', 'example' => '192.168.1.28:9092', 'required' => true], 'format' => [ 'title' => '格式', 'type' => 'object', 'additionalProperties' => ['description' => 'Additional format-specific properties. The supported properties depend on the `valueType`.', 'type' => 'any', 'title' => '', 'example' => ''], 'description' => 'The data format configuration.', 'example' => '', ], ], 'example' => '', ], 'ListAgentInstanceConfigs' => [ 'description' => 'List of process-level configurations ', 'title' => '进程级配置列表', 'type' => 'array', 'items' => [ 'description' => 'Process-level configuration ', 'type' => 'object', 'properties' => [ 'configType' => ['description' => 'Type of the process-level configuration ', 'title' => '进程级配置类型', 'type' => 'string', 'example' => 'apm_biz_trace'], 'attributes' => [ 'description' => 'Ownership of the process-level configuration ', 'additionalProperties' => ['description' => 'Ownership of the process-level configuration ', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" .'"service": "test-service"', 'title' => ''], 'title' => '进程级配置归属', 'type' => 'object', 'example' => '{"workspace": "test-workspace","service": "test-service"}', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'LogContent' => [ 'title' => '日志字段', 'description' => 'The data structure of the log field.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '自定义Key名称。', 'description' => 'The name of the custom key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'key-test'], 'Value' => ['title' => '自定义Key对应的值。', 'description' => 'The value of the custom key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'value-test'], ], ], 'logging' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of the service log feature for the project.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'loggingProject' => ['title' => 'project 名称。', 'description' => 'The name of the project to which service logs are stored.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-project'], 'loggingDetails' => [ 'title' => 'logging 配置项', 'description' => 'The settings of the service log feature.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The configuration items of the service log feature. Each item indicates that a service log type is enabled.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'type' => [ 'title' => 'logging 类型。', 'description' => 'The type of the service logs. Valid values:'."\n" ."\n" .'* consumergroup_log: the consumption delay logs of consumer groups.'."\n" .'* logtail_alarm: the alert logs of Logtail.'."\n" .'* operation_log: the operation logs. You are charged for operation logs.'."\n" .'* logtail_profile: the collection logs of Logtail.'."\n" .'* metering: the metering logs.'."\n" .'* logtail_status: the status logs of Logtail.'."\n" .'* scheduledsqlalert: the operational logs of scheduled SQL jobs.'."\n" .'* etl_alert: the operational logs of data transformation jobs.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'consumergroup_log', 'enum' => ['consumergroup_log', 'logtail_alarm', 'operation_log', 'logtail_profile', 'metering', 'logtail_status', 'scheduled_sql_alert', 'etl_alert'], ], 'logstore' => ['title' => 'logstore 名称。', 'description' => 'The logstore name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], ], 'extendType' => 'true', ], 'required' => true, ], ], ], 'LogGroup' => [ 'title' => '日志组', 'description' => 'Log group', 'type' => 'object', 'properties' => [ 'Topic' => ['title' => '日志主题，用户自定义字段，用于区分不同特征的日志数据。', 'description' => 'The topic of the log. This is a user-defined field that distinguishes log data with different features.', 'type' => 'string', 'required' => false, 'example' => 'topic-test'], 'Source' => ['title' => '日志的来源。例如产生该日志的机器的IP地址。', 'description' => 'The source of the log. For example, the IP address of the machine that generated the log.', 'type' => 'string', 'example' => '192.1.1.1'], 'LogTags' => [ 'title' => '日志的标签列表', 'description' => 'The list of tags for the log.', 'type' => 'array', 'items' => ['description' => 'A tag for the log.', '$ref' => '#/components/schemas/LogTag', 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], 'LogItems' => [ 'title' => '日志列表', 'description' => 'A list of logs.', 'type' => 'array', 'items' => ['description' => 'A log.', '$ref' => '#/components/schemas/LogItem', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], ], 'example' => '', ], 'LogGroupList' => [ 'title' => 'logGroup 列表', 'description' => 'The list of LogGroups.', 'type' => 'object', 'properties' => [ 'LogGroupList' => [ 'title' => 'logGroup 列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/LogGroup', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'description' => '', 'example' => '', ], ], 'required' => true, 'example' => '', ], 'LogItem' => [ 'title' => '日志', 'description' => 'A log entry.', 'type' => 'object', 'properties' => [ 'Time' => ['title' => '日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => 'The time of the log, formatted as a Unix timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1690254376'], 'Contents' => [ 'title' => '日志字段列表。', 'description' => 'A list of log fields.', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/LogContent', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], ], 'example' => '', ], 'logstore' => [ 'title' => '', 'description' => 'The Logstore data structure.', 'type' => 'object', 'properties' => [ 'logstoreName' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'my-logstore'], 'ttl' => ['description' => 'The data retention period in days. Valid values: 1 to 3,650. A value of 3,650 indicates permanent storage.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'required' => true, 'example' => '1'], 'shardCount' => ['description' => 'The number of shards in the Logstore.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'required' => true, 'example' => '2'], 'enable_tracking' => ['description' => 'Specifies whether to enable WebTracking. The default value is false.'."\n" ."\n" .'- true: Enables WebTracking.'."\n" ."\n" .'- false: Disables WebTracking.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'autoSplit' => ['description' => 'Specifies whether to enable auto split.'."\n" ."\n" .'- true: Enables auto split.'."\n" ."\n" .'- false: Disables auto split.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'maxSplitShard' => ['description' => 'The maximum number of shards that an auto split can create. Valid values: 1 to 64.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '6'], 'appendMeta' => ['description' => 'Specifies whether to include the client\'s public IP address in the log data. The default is false.'."\n" ."\n" .'- true: Records the public IP address.'."\n" ."\n" .'- false: Does not record the public IP address.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'telemetryType' => ['description' => 'The type of log data. Valid values:'."\n" ."\n" .'- Metrics: The Logstore is optimized for time-series storage.'."\n" ."\n" .'- None: The Logstore uses standard storage for logs.', 'type' => 'string', 'title' => '', 'example' => 'Metrics'], 'createTime' => ['description' => 'The creation time of the Logstore, specified as a UNIX timestamp (the number of seconds since January 1, 1970, 00:00:00 UTC).', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '1453949705'], 'lastModifyTime' => ['description' => 'The time the Logstore was last modified, specified as a UNIX timestamp (the number of seconds since January 1, 1970, 00:00:00 UTC).', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '1524155379'], 'encrypt_conf' => ['description' => 'The data encryption configuration.', 'title' => '', '$ref' => '#/components/schemas/EncryptConf', 'example' => ''], 'hot_ttl' => ['description' => 'The number of days to retain data in the hot storage tier. The minimum value is 30.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '60'], 'infrequentAccessTTL' => ['description' => 'The number of days to retain data in the infrequent access storage tier.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '30'], 'mode' => ['description' => 'Log Service provides two types of Logstores: Standard and Query.'."\n" ."\n" .'- **Standard**: Supports the full suite of Log Service data analysis features. This mode is ideal for real-time monitoring, interactive analysis, and building complete observability solutions.'."\n" ."\n" .'- **Query**: Optimized for high-performance queries with indexing traffic costs that are approximately half those of the Standard mode. This mode does not support SQL analysis and is best for use cases involving large data volumes and long retention periods, where complex log analysis is not a requirement.', 'type' => 'string', 'title' => '', 'example' => 'standard'], 'productType' => ['description' => 'The product type of the logs.', 'type' => 'string', 'title' => '', 'example' => 'aliyun'], 'processorId' => ['description' => 'The IngestProcessor ID.', 'type' => 'string', 'title' => '', 'example' => ''], 'shardingPolicy' => ['title' => '', '$ref' => '#/components/schemas/ShardingPolicy', 'description' => '', 'example' => ''], 'resourceGroupId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''], 'enableModify' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'LogTag' => [ 'title' => '日志标签', 'description' => 'The log tag.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '自定义Key名称。', 'description' => 'The name of the custom key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'key-test'], 'Value' => ['title' => '自定义Key对应的值。', 'description' => 'The value of the custom key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'value-test'], ], ], 'LogtailConfig' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of the Logtail configuration.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'configName' => ['title' => 'logtail 配置的名称。', 'description' => 'The name of the Logtail configuration. The name must be unique in the project to which the Logtail configuration belongs. After the Logtail configuration is created, you cannot change the name of the Logtail configuration. The name must meet the following requirements:'."\n" ."\n" .'* The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" .'* The name must start and end with a lowercase letter or a digit.'."\n" .'* The name must be 2 to 128 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-config'], 'logSample' => ['title' => '日志样例，可以用于自动生成正则捕获字段。', 'description' => 'The sample log.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], 'inputType' => ['title' => 'logtail 读取日志的输入类型。', 'description' => 'The type of the data source. Valid values:'."\n" ."\n" .'* **plugin**: Logs such as MySQL binary logs are collected by using Logtail plug-ins.'."\n" .'* **file**: Logs from text files are collected by using existing modes, including the full regex mode and delimiter mode.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'file'], 'inputDetail' => ['title' => 'logtail 输入的详细配置。', 'description' => 'The detailed settings of the data source. For more information, see [inputDetail](~~29058~~).'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'example' => '"logType": "common_reg_log", "logPath": "/var/log/httpd/", "filePattern": "access*.log", "localStorage": true, "timeFormat": "%Y/%m/%d %H:%M:%S", "logBeginRegex": ".*", "regex": "(\\w+)(\\s+)", "key" :["key1", "key2"], "filterKey":["key1"], "filterRegex":["regex1"], "fileEncoding":"utf8", "topicFormat": "none"'], 'outputType' => ['title' => 'logtail 输出的目标类型。这里固定选择 LogService。', 'description' => 'The type of the data destination. Set the value to LogService. Collected logs can be uploaded to only Simple Log Service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'LogService'], 'outputDetail' => [ 'title' => 'logtail 输出的详细配置。', 'description' => 'The detailed settings of the data destination. For more information, see [outputDetail](~~29058~~).'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'endpoint' => ['title' => '日志项目的 endpoint。', 'description' => 'The endpoint. For more information, see [Endpoints](~~29008~~).'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com'], 'logstoreName' => ['title' => '输出的目标 logstore 名称。', 'description' => 'The name of the Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], 'region' => ['title' => '地域。', 'description' => 'The ID of the region.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-hangzhou'], 'telemetryType' => ['title' => '目标 Logstore 的可观测数据类型。', 'description' => 'The type of observable data in the Logstore.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'logs'], ], 'required' => true, ], 'createTime' => ['title' => '创建时间，unix 时间戳。', 'description' => 'The time at which the Logtail configuration was created. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], 'lastModifyTime' => ['title' => '最后一次修改时间，unix 时间戳。', 'description' => 'The time at which the Logtail configuration was last modified. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], ], ], 'LogtailPipelineConfig' => [ 'title' => 'Logtail流水线配置', 'description' => 'The Logtail pipeline configuration.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'configName' => ['title' => '配置名称', 'description' => 'The name of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z_-]{0,126}[0-9a-zA-Z]$'], 'logSample' => ['title' => '日志样例', 'description' => 'The sample log.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '127.0.0.1 - - [10/Jun/2022:12:36:49 +0800] "GET /index.html HTTP/1.1" 200'], 'global' => ['title' => '全局信息', 'description' => 'The global configuration.'."\n", 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "TopicType": "custom", "TopicFormat": "aaa", "EnableAlwaysOnline": true, "EnableTimestampNanosecond": true, "UsingOldContentTag": true }'], 'inputs' => [ 'title' => '输入插件', 'description' => 'The data source plug-ins.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => ['description' => 'The data source plug-in.'."\n", 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "input_file", "FilePaths": [ "/home/**/*.log" ], "MaxDirSearchDepth": 10, "Multiline": { "StartPattern": "\\\\d+" }, "TailSizeKB": 1024 }', 'extendType' => 'true'], 'required' => true, 'minItems' => 1, ], 'processors' => [ 'title' => '处理插件', 'description' => 'The processing plug-ins.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => ['description' => 'The processing plug-in.'."\n", 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "processor_regex", "SourceKey": "content", "Regex": "(\\\\d+).*([^;])", "Keys": [ "k1", "k2" ] }', 'extendType' => 'true'], 'minItems' => 1, ], 'aggregators' => [ 'title' => '聚合插件', 'description' => 'The aggregation plug-ins.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => ['description' => 'The aggregation plug-in.'."\n", 'visibility' => 'Public', 'type' => 'object', 'extendType' => 'true', 'example' => '{ "Type": "aggregator_shardhash", "SourceKeys": [ "__source__" ] }'], 'minItems' => 1, ], 'flushers' => [ 'title' => '输出插件', 'description' => 'The data output plug-ins.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => ['description' => 'The data output plug-in.'."\n", 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "flusher_sls", "Logstore": "test_logstore", "Endpoint": "cn-hangzhou-intranet.aliyuncs.com", "Region": "cn-hangzhou", "FlowControlExpireTime": 2, "MaxSendRate": 3, "EnableShardHash": true, "TelemetryType": "log" }', 'extendType' => 'true'], 'required' => true, 'minItems' => 1, ], 'createTime' => ['title' => '创建时间，UNIX时间戳', 'description' => 'The creation time. The value is a UNIX timestamp.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], 'lastModifyTime' => ['title' => '最后修改时间，UNIX时间戳', 'description' => 'The last modification time. The value is a UNIX timestamp.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], 'task' => ['title' => '任务配置', 'description' => '任务配置', 'visibility' => 'Public', 'type' => 'object', 'example' => '{"Type": "task_example"}'], ], ], 'machine' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of a machine.', 'type' => 'object', 'properties' => [ 'ip' => ['title' => '机器 ip 地址。', 'description' => 'The IP address of the machine.', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.x', 'visibility' => 'Public'], 'machine-uniqueid' => ['title' => '机器的唯一标识。', 'description' => 'The unique identifier of the machine.', 'type' => 'string', 'required' => false, 'example' => '3B70F4F1-80F7-46C4-A6C1-100****EE647', 'visibility' => 'Public'], 'lastHeartbeatTime' => ['title' => '最后一次心跳时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => 'The time of the last heartbeat. The value is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1447182247', 'visibility' => 'Public'], 'userdefined-id' => ['title' => '机器的用户自定义标识。', 'description' => 'The custom identifier of the machine. This parameter is valid only when the identity type of the machine group is set to custom.', 'type' => 'string', 'example' => '无', 'visibility' => 'Public'], 'host-id' => ['title' => '机器的主机id。', 'description' => 'The host ID of the machine.', 'type' => 'string', 'example' => 'test', 'visibility' => 'Public'], ], 'example' => '', 'visibility' => 'Public', ], 'machineGroup' => [ 'title' => '机器组结构定义。', 'description' => 'The data structure of a machine group.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'groupName' => ['title' => '机器组名称。', 'description' => 'The name of the machine group.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'machineGroup-test'], 'groupType' => ['title' => '机器组种类。目前固定为空字符串。', 'description' => 'The type of the machine group. This parameter is currently an empty string.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '“”'], 'machineIdentifyType' => ['title' => '机器组标识种类，支持 IP 标识或者用户自定义标识，即 ip 、userdefined 、 host-id。', 'description' => 'The machine identity type.'."\n" ."\n" .'- ip: The machine group is identified by IP addresses.'."\n" ."\n" .'- userdefined: The machine group is identified by custom identifiers.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ip'], 'groupAttribute' => [ 'title' => '机器组属性。', 'description' => 'The properties of the machine group.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'groupTopic' => ['title' => '机器组的日志主题。', 'description' => 'The topic of the machine group.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'testtopic'], 'externalName' => ['title' => '机器组所依赖的外部管理系统标识。', 'description' => 'The identifier of the external management system that the machine group depends on.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'testgroup'], ], 'example' => '', ], 'machineList' => [ 'title' => '机器组标识列表。', 'description' => 'The list of machines.', 'visibility' => 'Public', 'type' => 'array', 'items' => ['description' => 'The IP address or custom ID of the machine.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => '47.100.XX.XX'], 'required' => true, 'example' => '', ], ], 'example' => '', ], 'MaxComputeExport' => [ 'title' => 'MaxCompute投递任务', 'description' => 'max compute export'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'name' => ['title' => '任务名称', 'description' => 'job name'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'MaxComputeExport'], 'description' => ['title' => '任务描述', 'description' => 'job description'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'MaxComputeExport'], 'displayName' => ['title' => '显示名称', 'description' => 'job displayName'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'MaxComputeExport'], 'configuration' => ['title' => 'MaxCompute投递配置', 'description' => 'The setting of the MaxCompute data shipping job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration'], 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1718787534'."\n"], 'lastModifiedTime' => ['title' => '修改时间', 'description' => 'The last modification time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1718787681'."\n"], 'status' => ['title' => 'MaxCompute投递任务状态', 'description' => 'The status of the MaxCompute data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'RUNNING'], 'scheduleId' => ['title' => '任务ID', 'description' => 'The ID of the MaxCompute data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], ], 'MaxComputeExportConfiguration' => [ 'title' => 'MaxCompute投递配置', 'description' => 'The configurations of the MaxCompute data shipping job.'."\n", 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'Logstore名称', 'description' => 'The name of the Logstore.'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], 'roleArn' => ['title' => '角色roleArn', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that is used to read data from Simple Log Service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'."\n"], 'sink' => ['title' => '投递配MaxCompute置', 'description' => 'The configuration of the MaxCompute data shipping job.'."\n", 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfigurationSink', 'example' => ''], 'fromTime' => ['title' => '开始时间', 'description' => 'The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1718380800'."\n"], 'toTime' => ['title' => '结束时间', 'description' => 'The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1718390800'], ], 'example' => '', ], 'MaxComputeExportConfigurationSink' => [ 'title' => 'MaxCompute投递配置', 'description' => 'The MaxCompute data shipping job.'."\n", 'type' => 'object', 'properties' => [ 'odpsEndpoint' => ['title' => 'MaxCompute Endpoint', 'description' => 'The endpoint of MaxCompute.'."\n" ."\n" .'* ⚠️Note: The endpoint of MaxCompute must be the same as that of the Simple Log Service project.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api'], 'odpsTunnelEndpoint' => ['title' => 'Tunnel Endpoint', 'description' => 'The Tunnel endpoint of MaxCompute.'."\n" ."\n" .'* ⚠️Note: The Tunnel endpoint of MaxCompute must be the same as that of the Simple Log Service project.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com'], 'odpsProject' => ['title' => 'MaxCompute项目名', 'description' => 'The name of the MaxCompute project.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo_project'], 'odpsTable' => ['title' => 'MaxCompute表名', 'description' => 'The name of the MaxCompute table.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo_table'], 'odpsRolearn' => ['title' => '写MaxCompute ram角色', 'description' => 'The Resource Access Management (RAM) role the data shipping job assumes to write data to MaxCompute.'."\n", 'type' => 'string', 'required' => true, 'example' => 'acs:ram::xxxxxxx'], 'odpsAccessKeyId' => ['title' => '写数据ak id', 'description' => 'The AccessKey ID used to write data to MaxCompute.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'axxxxxxxxxxxb'], 'odpsAccessSecret' => ['title' => '写数据ak secret', 'description' => 'The AccessKey secret used to write data to MaxCompute.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'aaxxxxxxxxxxxxxxxxxxxxxbb'], 'partitionTimeFormat' => ['title' => '时间分区格式', 'description' => 'The time partition format.'."\n", 'type' => 'string', 'required' => true, 'example' => '%Y_%m_%d'], 'timeZone' => ['title' => '时区', 'description' => 'The time zone.'."\n", 'type' => 'string', 'required' => true, 'example' => '+0800'], 'fields' => [ 'title' => 'MaxCompute普通列', 'description' => 'The fields that you want to ship.'."\n", 'type' => 'array', 'items' => ['description' => 'The Simple Log Service log field.'."\n", 'type' => 'string', 'example' => '\'f1\'', 'title' => ''], 'required' => true, 'example' => '', ], 'partitionColumn' => [ 'title' => 'MaxCompute分区列', 'description' => 'The partition key columns that you want to ship.'."\n", 'type' => 'array', 'items' => ['description' => 'The Simple Log Service log field or reserved field. The reserved field \\__partition_time\\_\\_ is used as a partition key column.'."\n", 'type' => 'string', 'example' => '\'p1\'', 'title' => ''], 'required' => true, 'example' => '', ], 'filterInvalid' => ['title' => '过滤无效内容', 'description' => 'Specifies whether to filter the invalid content.'."\n" ."\n" .'* true (default)'."\n" .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'timeFormatType' => ['title' => '分区时间类型', 'description' => 'The time partition type. Valid values:'."\n" ."\n" .'* StrfTimeFormat (default)'."\n" .'* JavaSimpleDateFormat'."\n", 'type' => 'string', 'example' => 'StrfTimeFormat'], 'bufferInterval' => ['title' => '计算投递时间分区时的最小时间粒度', 'description' => 'Specifies the minimum time granularity between two data shipping jobs. Unit: seconds. Valid values:'."\n" ."\n" .'* 1800 (default)'."\n" .'* 3600'."\n", 'type' => 'string', 'example' => '1800'], ], 'example' => '', ], 'MLDataParam' => [ 'title' => 'A short description of struct', 'description' => 'The ML data parameter.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'annotationdataId' => ['title' => '数据的唯一标识', 'description' => 'The unique identifier of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'dc74b0f569126bb310e1ba6454c351ac', 'backendName' => 'annotationdataId'], 'dataHash' => ['title' => '数据内容的hash值', 'description' => 'The hash value of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '59db060bd89468245d76416a68a510ac', 'backendName' => 'dataHash'], 'datasetId' => ['title' => '关联的数据集的id', 'description' => 'The ID of the associated dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'backendName' => 'datasetId'], 'value' => ['title' => '数据来源', 'description' => 'The data source.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxx/xxx/xxx/', 'backendName' => 'value'], 'valueType' => ['title' => '数据来源格式', 'description' => 'The type of the data source.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss', 'backendName' => 'valueType'], 'config' => [ 'title' => '数据的配置信息', 'description' => 'The configurations of the data.'."\n", 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => ['description' => 'The configuration of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'simulator-nginx-demo'], 'backendName' => 'config', ], 'annotations' => [ 'title' => '标注信息', 'description' => 'The annotations of the data.'."\n", 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => 'The annotation of the data.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'annotatedBy' => ['title' => '标注人', 'description' => 'The Alibaba Cloud account ID of the annotator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxxx', 'backendName' => 'annotatedBy'], 'updateTime' => ['title' => '更新的时间', 'description' => 'The update time. The value is a UNIX timestamp.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1694761550', 'backendName' => 'updateTime'], 'results' => [ 'title' => '标注的结果', 'description' => 'The annotation results.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The annotation result.'."\n", 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => ['description' => 'The annotation result.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SPIKE_UP_TYPE'], 'extendType' => 'true', ], 'backendName' => 'results', ], ], ], 'backendName' => 'annotations', ], 'predictions' => [ 'title' => '模型预览结果信息', 'description' => 'The model preview results.'."\n", 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => [ 'description' => 'The model preview result.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'annotatedBy' => ['title' => '标注人', 'description' => 'The annotator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxx', 'backendName' => 'annotatedBy'], 'updateTime' => ['title' => '更新的时间', 'description' => 'The update time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1694761550', 'backendName' => 'updateTime'], 'results' => [ 'title' => '模型预览结果', 'description' => 'The results.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The model preview result.'."\n", 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => ['description' => 'The model preview result.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SPIKE_UP_TYPE'], 'extendType' => 'true', ], 'backendName' => 'results', ], ], ], 'backendName' => 'predictions', ], 'createTime' => ['title' => '创建的时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695094335'], 'lastModifyTime' => ['title' => '最后一次修改的时间', 'description' => 'The last modification time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695094335'], ], ], 'MLDataSetParam' => [ 'title' => 'A short description of struct', 'description' => 'The ML dataset parameter.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'datasetId' => ['title' => '数据集的唯一标识', 'description' => 'The unique identifier of the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'd9bd488f6dd42d294495fb780858e83d'], 'name' => ['title' => '数据集的名称', 'description' => 'The name of the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls_builtin_dataset_metric.shapeclassification.anomalydetection'], 'description' => ['title' => '数据集的描述', 'description' => 'The description of the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '数据集A'], 'dataType' => ['title' => '数据类型', 'description' => 'The type of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Metric'], 'labelId' => ['title' => '数据集对应的标签系统id', 'description' => 'The ID of the tag system that corresponds to the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'a191ae4ca615b0ccb93c211fc8a998af'], 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], 'lastModifyTime' => ['title' => '最终修改时间', 'description' => 'The last modification time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], 'createBy' => ['title' => '创建的对象', 'description' => 'The creator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls-console'], 'settingType' => ['title' => 'label表配置类型', 'description' => 'The configuration type of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Metric.ShapeClassification.AnomalyDetection'], ], ], 'MLLabelParam' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'labelId' => ['title' => '标签表的唯一标识', 'description' => 'The unique identifier of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'abbd488f6dd42d294495fb780858e83d'], 'name' => ['title' => '标签表的名称', 'description' => 'The name of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '标签表'], 'description' => ['title' => '标签表的描述信息', 'description' => 'The description of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '默认表'], 'type' => ['title' => '标签表的类型', 'description' => 'The type of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'settings' => [ 'title' => '标签表的配置', 'description' => 'The configurations of the tag tables.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The configuration of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'mode' => ['title' => '配置的模式', 'description' => 'The mode of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'builtin'], 'type' => ['title' => '配置的任务类型', 'description' => 'The task type of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Trace.RCA'], 'config' => ['title' => '配置的具体信息', 'description' => 'The details of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '""'], 'version' => ['title' => '配置的版本号', 'description' => 'The version number of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0.01'], ], 'extendType' => 'true', ], ], 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], 'lastModifyTime' => ['title' => '最后修改时间', 'description' => 'The last modification time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], ], 'required' => false, ], 'MLServiceAnalysisParam' => [ 'title' => 'A short description of struct', 'description' => 'The ML service analysis parameter.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'parameter' => [ 'title' => 'parameter', 'description' => 'The parameter.'."\n", 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => ['description' => 'The parameter.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'parameter'], ], 'input' => [ 'title' => 'input', 'description' => 'The input data.'."\n", 'visibility' => 'Public', 'type' => 'array', 'items' => [ 'description' => 'The input data.'."\n", 'visibility' => 'Public', 'type' => 'object', 'additionalProperties' => ['description' => 'The input data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'data'], 'extendType' => 'true', ], ], ], ], 'MLServiceParam' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'name' => ['title' => '微服务名称', 'type' => 'string', 'description' => '', 'example' => 'service_name'], 'description' => ['title' => '微服务描述', 'type' => 'string', 'description' => '', 'example' => '某某服务'], 'serviceType' => ['title' => '微服务类型', 'type' => 'string', 'description' => '', 'example' => 'sls_builtin'], 'status' => ['title' => '微服务状态', 'type' => 'string', 'description' => '', 'example' => 'running'], 'updateTimestamp' => ['title' => '微服务更新时间', 'type' => 'integer', 'description' => '', 'example' => '1695090077', 'format' => 'int64'], 'model' => [ 'title' => '微服务依赖的模型配置', 'type' => 'object', 'properties' => [ 'modelResourceId' => ['title' => '模型资源ID', 'type' => 'string', 'description' => '', 'example' => 'xxxx'], 'modelResourceType' => ['title' => '模型资源类型', 'type' => 'string', 'description' => '', 'example' => 'xxx_type'], ], 'description' => '', 'example' => '', ], 'resource' => [ 'title' => '微服务资源配置', 'type' => 'object', 'properties' => [ 'cpuLimit' => ['title' => '所需要CPU资源上限', 'type' => 'integer', 'description' => '', 'example' => '2', 'format' => 'int32'], 'memoryLimit' => ['title' => '所需要内存资源上限', 'type' => 'integer', 'description' => '', 'example' => '64', 'format' => 'int32'], 'replica' => ['title' => '微服务的副本数', 'type' => 'integer', 'description' => '', 'example' => '2', 'format' => 'int32'], 'gpu' => ['title' => '需要的GPU显存大小', 'type' => 'integer', 'description' => '', 'example' => '20', 'format' => 'int32'], ], 'description' => '', 'example' => '', ], ], 'description' => 'A short description of struct ', 'example' => '', ], 'OSSExport' => [ 'title' => 'OSS投递任务', 'description' => 'The configurations of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'name' => ['title' => '任务名称', 'description' => 'The name of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'myossexportjob'], 'description' => ['title' => '任务描述', 'description' => 'The description of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'This is a oss export'], 'displayName' => ['title' => '显示名称', 'description' => 'The display name of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'This is a oss export'], 'configuration' => ['title' => 'OSS投递配置', 'description' => 'The OSS export configuration.'."\n", 'visibility' => 'Public', 'required' => false, '$ref' => '#/components/schemas/OSSExportConfiguration'], 'createTime' => ['title' => '创建时间', 'description' => 'The time when the OSS data shipping job was created.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789'], 'lastModifiedTime' => ['title' => '修改时间', 'description' => 'The time when the OSS data shipping job was last modified.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789'], 'status' => ['title' => 'OSS投递任务状态', 'description' => 'The status of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], 'scheduleId' => ['title' => '任务ID', 'description' => 'The ID of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], 'required' => true, ], 'OSSExportConfiguration' => [ 'title' => 'OSS投递配置', 'description' => 'The configuration for exporting data to Object Storage Service (OSS).', 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'Logstore名称', 'description' => 'The name of the source Logstore.', 'type' => 'string', 'required' => false, 'example' => 'my-logstore'], 'roleArn' => ['title' => '角色roleArn', 'description' => 'The ARN of the Resource Access Management (RAM) role that Log Service assumes to read data from the Logstore. You must specify the ARN of your role.', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'], 'sink' => [ 'title' => '投递OSS配置', 'description' => 'The configuration of the destination OSS sink.', 'type' => 'object', 'properties' => [ 'endpoint' => ['title' => 'OSS Endpoint', 'description' => '- For Object Storage Service (OSS): The OSS internal endpoint. You must use an endpoint in the same region as the Logstore. For more information, see [OSS access domains and data centers](~~31837~~). The endpoint must use the HTTPS protocol.'."\n" ."\n" .'- For OSS-HDFS: The OSS-HDFS internal endpoint. You must use an endpoint in the same region as the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'https://oss-cn-hangzhou-internal.aliyuncs.com'], 'bucket' => ['title' => 'OSS Bucket', 'description' => 'The name of the destination OSS bucket.', 'type' => 'string', 'required' => true, 'example' => 'my-bucket'], 'prefix' => ['title' => '文件前缀', 'description' => 'The prefix for files exported to the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'prefix-demo/'], 'suffix' => ['title' => '文件后缀', 'description' => 'The suffix for the exported files.', 'type' => 'string', 'required' => false, 'example' => '.json'], 'roleArn' => ['title' => '写角色roleArn', 'description' => 'The ARN of the RAM role that Log Service assumes to write data to the OSS bucket. You must specify the ARN of your role.', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'], 'pathFormat' => ['title' => '分区格式', 'description' => 'The path format for exported files. For more information, see [Path format](~~371934~~).', 'type' => 'string', 'required' => true, 'example' => '%Y/%m/%d/%H/%M'], 'pathFormatType' => ['title' => '分区格式类型', 'description' => 'The type of the path format.', 'type' => 'string', 'required' => true, 'example' => 'time'], 'timeZone' => ['title' => '时区', 'description' => 'The time zone used for the path format. For more information, see [Time zones](~~375323~~).', 'type' => 'string', 'required' => false, 'example' => '+0800'], 'contentType' => ['title' => '存储格式', 'description' => 'The format of the files stored in OSS. Valid values: `json`, `parquet`, `csv`, and `orc`.', 'type' => 'string', 'required' => false, 'example' => 'csv'], 'contentDetail' => [ 'title' => '内容详情', 'description' => 'Format-specific settings. The structure of this JSON object depends on the `contentType` value.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => '**If `contentType` is `json`, `contentDetail` supports the following parameter:**'."\n" ."\n" .'- `enableTag`'."\n" ."\n" .' - **Required**: Yes'."\n" ."\n" .' - **Type**: Boolean'."\n" ."\n" .' - **Description**: Specifies whether to include the log tags in the output.'."\n" ."\n" .' - **Valid values**:'."\n" ."\n" .' - `true`'."\n" ."\n" .' - **Description**: Includes the log tags.'."\n" ."\n" .' - **Example**: `{"enableTag": true}`'."\n" ."\n" .' - `false`'."\n" ."\n" .' - **Description**: Excludes the log tags.'."\n" ."\n" .' - **Example**: `{"enableTag": false}`'."\n" ."\n" .'**If `contentType` is `csv`, `contentDetail` supports the following parameters:**'."\n" ."\n" .'- `columns`'."\n" ."\n" .' - **Required**: Yes'."\n" ."\n" .' - **Type**: Array'."\n" ."\n" .' - **Description**: The log keys to export from the source Logstore.'."\n" ."\n" .' - **Example**: `{"columns":["a", "b", "c", "d"]}`'."\n" ."\n" .'- `delimiter`'."\n" ."\n" .' - **Required**: Yes'."\n" ."\n" .' - **Type**: String'."\n" ."\n" .' - **Description**: The delimiter to use between fields.'."\n" ."\n" .' - **Valid values**: `","`, `"|"`, `" "`, or `" "`'."\n" ."\n" .'- `header`'."\n" ."\n" .' - **Required**: Yes'."\n" ."\n" .' - **Type**: Boolean'."\n" ."\n" .' - **Description**: Specifies whether to write a header row with the key names.'."\n" ."\n" .' - **Valid values**:'."\n" ."\n" .' - `true`'."\n" ."\n" .' - `false`'."\n" ."\n" .'- `lineFeed`'."\n" ."\n" .' - **Required**: No'."\n" ."\n" .' - **Type**: String'."\n" ."\n" .' - **Description**: The character to use for line breaks.'."\n" ."\n" .' - **Valid values**: `" "`, `"'."\n" .'"`, or `""`'."\n" ."\n" .' - **Default**: `"'."\n" .'"`'."\n" ."\n" .'- `null`'."\n" ."\n" .' - **Required**: No'."\n" ."\n" .' - **Type**: String'."\n" ."\n" .' - **Description**: The string to use for fields with null values.'."\n" ."\n" .' - **Default**: `""`'."\n" ."\n" .'- `quote`'."\n" ."\n" .' - **Required**: Yes'."\n" ."\n" .' - **Type**: String'."\n" ."\n" .' - **Description**: The quote character to use for enclosing fields.'."\n" ."\n" .' - **Valid values**: `"\\""`, `"\'"`, or `""`.'."\n" .' A complete example for a `csv` `contentDetail` is: `{"null": "-", "header": false, "lineFeed": "'."\n" .'", "quote": "", "delimiter": ",", "columns": ["a", "b", "c", "d"]}`'."\n" ."\n" .'**If `contentType` is `parquet`, `contentDetail` supports the following parameter:**'."\n" ."\n" .'- `columns`'."\n" ."\n" .' - **Required**: Yes'."\n" ."\n" .' - **Type**: Array of objects'."\n" ."\n" .' - **Description**: The log keys and their corresponding data types to export from the source Logstore.'."\n" ."\n" .' - **Example**: `{"columns": [{"name": "a", "type": "string"}, {"name": "b", "type": "string"}, {"name": "c", "type": "string"},{"name": "d", "type": "string"}]}`'."\n" ."\n" .'**If `contentType` is `orc`, `contentDetail` supports the following parameter:**'."\n" ."\n" .'- `columns`'."\n" ."\n" .' - **Required**: Yes'."\n" ."\n" .' - **Type**: Array of objects'."\n" ."\n" .' - **Description**: The log keys and their corresponding data types to export from the source Logstore.'."\n" ."\n" .' - **Example**: `{"columns": [{"name": "a", "type": "string"}, {"name": "b", "type": "string"}, {"name": "c", "type": "string"},{"name": "d", "type": "string"}]}`', 'type' => 'any', 'example' => '{'."\n" .' "columns": ['."\n" .' "your log key1",'."\n" .' "your log key2",'."\n" .' "your log key3",'."\n" .' ],'."\n" .' "delimiter": " ",'."\n" .' "header": true,'."\n" .' "lineFeed": "\\n",'."\n" .' "null": "-",'."\n" .' "quote": "\\""'."\n" .'},', 'title' => ''], 'example' => '', ], 'compressionType' => ['title' => '压缩类型', 'description' => 'The compression type for the exported files. Valid values: `snappy`, `gzip`, `zstd`, and `none` (no compression).', 'type' => 'string', 'required' => false, 'example' => 'snappy'], 'bufferInterval' => ['title' => '投递时间', 'description' => 'The time in seconds to buffer data before exporting. The value must be an integer from 300 to 900.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'], 'bufferSize' => ['title' => '投递大小', 'description' => 'The amount of data in MB to buffer before exporting. The value must be an integer from 5 to 256.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '256'], 'delaySec' => ['title' => '废弃', 'description' => 'The delivery delay.'."\n" ."\n" .'> - This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '123'], 'delaySeconds' => ['title' => '延迟投递', 'description' => 'The delivery delay, in seconds. This value cannot exceed the data retention period of the source Logstore.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900'], ], 'required' => false, 'example' => '', ], 'fromTime' => ['title' => '时间范围开始', 'description' => 'The start time for the export, specified as a Unix timestamp. Set to 1 to export from the earliest available data in the Logstore.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718380800'], 'toTime' => ['title' => '时间范围结束', 'description' => 'The end time for the export, specified as a Unix timestamp. Set to 0 to run the task continuously until it is stopped.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718380800'], 'sourceSecureTransport' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => '', 'default' => 'false'], ], 'required' => false, 'example' => '', ], 'OSSIngestion' => [ 'title' => 'oss ingestion job', 'description' => 'The Object Storage Service (OSS) data import job.'."\n", 'type' => 'object', 'properties' => [ 'name' => ['title' => '导入任务名称', 'description' => 'The name of the data import job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456'], 'description' => ['title' => 'job description', 'description' => 'The description of the data import job.'."\n", 'type' => 'string', 'example' => 'oss ingestion'], 'displayName' => ['title' => 'job displayName', 'description' => 'The display name of the data import job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'oss ingestion'], 'schedule' => ['title' => '调度配置', 'description' => 'The scheduling settings.'."\n", 'required' => true, '$ref' => '#/components/schemas/Schedule', 'example' => ''], 'configuration' => ['title' => 'oss导入配置', 'description' => 'The configurations of the OSS data import job.'."\n", 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration', 'example' => ''], 'createTime' => ['title' => '创建时间', 'description' => 'The time when the data import job was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => 'The time when the data import job was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], 'status' => ['title' => '导入状态', 'description' => 'The status of the data import job.'."\n", 'type' => 'string', 'example' => 'RUNNING'], 'scheduleId' => ['title' => '任务ID', 'description' => 'The ID of the data import job.'."\n", 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], 'example' => '', ], 'OSSIngestionConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'The configurations of the OSS data import job.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'logstore', 'description' => 'The Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'myLogstore'], 'source' => ['description' => 'The source that you specify for the configurations of the OSS data import job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfigurationSource'], ], ], 'OSSIngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'description' => 'The configuration for ingesting data from OSS.', 'type' => 'object', 'properties' => [ 'endpoint' => ['title' => 'oss endpoint', 'description' => 'The OSS endpoint.', 'type' => 'string', 'required' => true, 'example' => 'oss-cn-hangzhou.aliyuncs.com'], 'bucket' => ['title' => 'oss bucket', 'description' => 'The name of the OSS bucket.', 'type' => 'string', 'required' => true, 'example' => 'ossbucket'], 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => 'The compression type of the source files.', 'type' => 'string', 'required' => true, 'example' => 'none'], 'encoding' => ['title' => '编码类型', 'description' => 'The encoding of the source files.', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], 'interval' => ['title' => '检查新文件周期', 'description' => 'The check interval for new files.', 'type' => 'string', 'required' => true, 'example' => 'never'], 'pattern' => ['title' => '文件路径正则过滤', 'description' => 'A regular expression to filter files by path.', 'type' => 'string', 'example' => '.*'], 'prefix' => ['title' => '文件路径前缀过滤', 'description' => 'The path prefix for filtering files.', 'type' => 'string', 'example' => 'prefix'], 'restoreObjectEnabled' => ['title' => '导入归档文件', 'description' => 'Specifies whether to import archived files.', 'type' => 'boolean', 'example' => 'true'], 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => 'Imports only files modified after this time. The value is a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274081'], 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => 'Imports only files modified before this time. The value is a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], 'timeField' => ['title' => '提取时间字段', 'description' => 'The field containing the log time.', 'type' => 'string', 'example' => '__time__'], 'timeFormat' => ['title' => '时间字段格式', 'description' => 'The format of the time field.', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], 'timePattern' => ['title' => '提取时间正则', 'description' => 'The regular expression to extract the time value from a log.', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], 'timeZone' => ['title' => '时间字段分区', 'description' => 'The time zone of the timestamp in the source data.', 'type' => 'string', 'example' => 'GMT+08:00'], 'useMetaIndex' => ['title' => '使用OSS元数据索引', 'description' => 'Specifies whether to use the OSS metadata index to accelerate file discovery.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], 'roleARN' => ['title' => 'roleArn', 'description' => 'The Role ARN to use for accessing the OSS bucket.', 'type' => 'string', 'example' => 'acs:ram::12345:role/aliyunlogdefaultrole'], 'tagPackId' => ['title' => '启动上下文检索', 'description' => 'Specifies whether to enable context retrieval.', 'type' => 'boolean', 'example' => 'true'], 'processorId' => ['title' => '写入处理器id', 'description' => 'The ID of the writer processor.', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], 'format' => [ 'title' => '格式', 'description' => 'Defines the format of the source data.', 'type' => 'object', 'required' => true, 'additionalProperties' => ['description' => 'The data format of the objects in OSS.'."\n" ."\n" .'- Single-line Text Log: `{"type":"Line"}`'."\n" ."\n" .'- CSV:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "type": "CSV",'."\n" .' "fieldDelimiter": ",", // Delimiter'."\n" .' "quoteChar": "\\"", // Quote character'."\n" .' "escapeChar": "\\", // Escape character'."\n" .' "firstRowAsHeader": true, // Use first row as header'."\n" .' "maxLines": 1, // Max lines per log'."\n" .' "skipLeadingRows": 0 // Rows to skip at the beginning'."\n" .'}'."\n" .'```'."\n" ."\n" .'- Single-line JSON: `{"type": "JSON"}`'."\n" ."\n" .'- Multi-line Text Log:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "type": "Multiline",'."\n" .' "match": "after", // Pattern matching position'."\n" .' "pattern": "\\d+", // Regular expression'."\n" .' "maxLines": 10 // Max lines per log'."\n" .'}'."\n" .'```'."\n" ."\n" .'- ORC: `{"type": "ORC"}`'."\n" ."\n" .'- Parquet: `{"type": "Parquet"}`'."\n" ."\n" .'- Alibaba Cloud OSS Access Log: `{"type": "ossAccessLog"}`'."\n" ."\n" .'- Alibaba Cloud CDN Download Log: `{"type": "cdnDownloadedLog"}`', 'type' => 'any', 'example' => '{"type": "Line"}', 'title' => ''], 'example' => '', ], 'advancedParameters' => [ 'type' => 'object', 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'title' => '', 'example' => '', ], ], 'example' => '', ], 'PolicyConfiguration' => [ 'title' => '告警通知策略配置', 'description' => 'The notification configurations of the alert rule.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'alertPolicyId' => ['title' => '告警策略', 'description' => 'The alert policy.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls.builtin.dynamic'], 'actionPolicyId' => ['title' => '行动策略', 'description' => 'The action policy.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'example_action_policy'], 'repeatInterval' => ['title' => '重复等待时间', 'description' => 'The repeat interval.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '10m'], ], ], 'ProcessorAssociate' => [ 'title' => 'ProcessorAssociate', 'description' => 'ProcessorAssociate', 'type' => 'object', 'properties' => [ 'processorId' => ['title' => 'Processor ID', 'type' => 'string', 'required' => true, 'example' => 'ingest-processor-1', 'description' => ''], ], 'example' => '', ], 'project' => [ 'title' => '', 'description' => 'The data structure of a Simple Log Service project.', 'type' => 'object', 'properties' => [ 'createTime' => ['title' => '', 'description' => 'The time when the project was created.', 'type' => 'string', 'example' => '2021-07-07 14:08:09'], 'lastModifyTime' => ['title' => '', 'description' => 'The time when the project was last modified.', 'type' => 'string', 'example' => '2022-04-18 13:30:19'], 'description' => ['title' => '', 'description' => 'The description of the project.', 'type' => 'string', 'required' => true, 'example' => 'Description of my-project'], 'owner' => ['title' => '', 'description' => 'The Alibaba Cloud account to which the project belongs.', 'type' => 'string', 'example' => '""'], 'projectName' => ['title' => '', 'description' => 'The name of the project, which is used as part of the host. The project name is globally unique within an Alibaba Cloud region and cannot be modified after creation.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], 'region' => ['title' => '', 'description' => 'The region to which the project belongs.', 'type' => 'string', 'example' => 'cn-hangzhou'], 'status' => ['title' => '', 'description' => 'The status of the project. Valid values:'."\n" ."\n" .'- Normal: Normal.'."\n" .'- Disable: Disabled.', 'type' => 'string', 'example' => 'Normal'], 'resourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group to which the project belongs.', 'type' => 'string', 'example' => 'rg-acf******sq'], 'dataRedundancyType' => ['title' => '', 'description' => 'The data redundancy type.', 'type' => 'string', 'example' => 'LRS'], 'recycleBinEnabled' => ['title' => '', 'description' => 'Indicates whether the recycle bin is enabled.', 'type' => 'boolean', 'example' => 'false'], 'internetEndpoint' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], 'internalEndpoint' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], 'quota' => [ 'title' => '', 'description' => 'The project quota.', 'type' => 'object', 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'ProjectSummary' => [ 'title' => 'Project', 'description' => 'Project information.', 'type' => 'object', 'properties' => [ 'projectName' => ['title' => 'Project名称', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], 'description' => ['title' => 'Project描述', 'description' => 'The description of the project.', 'type' => 'string', 'required' => true, 'example' => '描述信息'], 'createTime' => ['title' => '创建时间', 'description' => 'The time when the project was created.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1714360481'], 'updateTime' => ['title' => '更新时间', 'description' => 'The time when the project was last updated.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710230272'], 'region' => ['title' => '所在Region', 'description' => 'The region where the project resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], 'resourceGroupId' => ['title' => '资源组ID', 'description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-acf******sq'], ], 'example' => '', ], 'S3Ingestion' => [ 'title' => 's3 ingestion job', 'type' => 'object', 'properties' => [ 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'description' => 'Task Name ', 'example' => 'ingest-s3-123456'], 'description' => ['title' => 'job description', 'type' => 'string', 'description' => 'Job description ', 'example' => 's3 ingestion'], 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'description' => 'Job display name ', 'example' => 's3 ingestion'], 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'description' => 'Scan Configuration ', 'example' => ''], 'createTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'description' => 'Creation Time ', 'example' => '1714360481'], 'lastModifiedTime' => ['title' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'description' => 'Updated At ', 'example' => '1714360481'], 'status' => ['title' => '导入状态', 'type' => 'string', 'description' => 'Import Status ', 'example' => 'RUNNING'], 'scheduleId' => ['title' => '任务ID', 'type' => 'string', 'description' => 'Job ID ', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], 'configuration' => ['title' => 's3导入配置', 'required' => true, '$ref' => '#/components/schemas/S3IngestionConfiguration', 'description' => 'S3 import configuration ', 'example' => ''], ], 'description' => 'S3 ingestion job ', 'example' => '', ], 'S3IngestionConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'S3 ingestion configuration.', 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'logstore', 'description' => 'The name of the Logstore.', 'type' => 'string', 'example' => 'myLogstore'], 'source' => ['description' => 'The source.', '$ref' => '#/components/schemas/S3IngestionConfigurationSource', 'title' => '', 'example' => ''], ], 'example' => '', ], 'S3IngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'description' => 'S3 ingestion configuration', 'type' => 'object', 'properties' => [ 'awsRegion' => ['title' => 's3 region', 'description' => 'Amazon S3 region', 'type' => 'string', 'required' => true, 'example' => 'ap-northeast-1'], 'awsAccessKey' => ['title' => 'aws access key', 'description' => 'Amazon Web Services (AWS) access key ID', 'type' => 'string', 'required' => true, 'example' => 'AKIxxxxxxxxxxYJE'], 'awsAccessKeySecret' => ['title' => 'aws access key secret', 'description' => 'Amazon Web Services (AWS) secret access key', 'type' => 'string', 'required' => true, 'example' => '123xxxxxxxxxxfjf'], 'bucket' => ['title' => 's3 bucket', 'description' => 'Amazon S3 bucket name', 'type' => 'string', 'required' => true, 'example' => 's3bucket'], 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => 'Compression codec. Valid values: none, snappy, gzip', 'type' => 'string', 'required' => true, 'example' => 'none'], 'encoding' => ['title' => '编码类型', 'description' => 'Character encoding', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], 'interval' => ['title' => '检查新文件周期', 'description' => 'Polling interval for new files', 'type' => 'string', 'required' => true, 'example' => '30m'], 'pattern' => ['title' => '文件路径正则过滤', 'description' => 'Regular expression to filter file paths', 'type' => 'string', 'example' => '.*'], 'prefix' => ['title' => '文件路径前缀过滤', 'description' => 'Prefix to filter file paths', 'type' => 'string', 'example' => 'prefix'], 'awsUseSQS' => ['title' => '使用sqs', 'description' => 'Specifies whether to use SQS.', 'type' => 'boolean', 'example' => 'false'], 'awsSQSQueueUrl' => ['title' => 'sqs queue url', 'description' => 'Amazon SQS queue URL', 'type' => 'string', 'example' => 'https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan'], 'useAwsSQSOnly' => ['title' => '仅使用sqs获取新文件', 'description' => 'Use only Amazon SQS to detect new files', 'type' => 'boolean', 'example' => 'false'], 'tagPackId' => ['title' => '支持上下文浏览', 'description' => 'Enable context browsing', 'type' => 'boolean', 'example' => 'false'], 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => 'Include only files modified after this Unix timestamp', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274081'], 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => 'Include only files modified before this Unix timestamp', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], 'timeField' => ['title' => '提取时间字段', 'description' => 'Name of the field that contains event timestamps', 'type' => 'string', 'example' => '__time__'], 'timeFormat' => ['title' => '时间字段格式', 'description' => 'Timestamp format in the time field', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], 'timePattern' => ['title' => '提取时间正则', 'description' => 'Regular expression to extract timestamps from file names or content', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], 'timeZone' => ['title' => '时间字段分区', 'description' => 'Time zone for the time field', 'type' => 'string', 'example' => 'GMT+08:00'], 'processorId' => ['title' => '写入处理器ID', 'description' => 'Ingest processor ID', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], 'endpoint' => ['title' => 's3 endpoint', 'description' => 'Amazon S3 endpoint', 'type' => 'string', 'example' => 's3.us-east-1.amazonaws.com'], 'cloudFrontEndpoint' => ['description' => 'The endpoint for the CloudFront distribution.', 'type' => 'string', 'title' => '', 'example' => 'dtfsb7voqy76q.cloudfront.net '], 'cloudFrontToken' => ['description' => 'The authentication token for accessing the CloudFront endpoint.', 'type' => 'string', 'title' => '', 'example' => '@test-s3-access/ABS'], 'useCloudFront' => ['title' => '使用CloudFront', 'description' => 'Specifies whether to access S3 through a CloudFront distribution.', 'type' => 'boolean', 'example' => ''], 'format' => [ 'title' => '格式', 'type' => 'object', 'required' => true, 'additionalProperties' => ['description' => 'Format', 'type' => 'any', 'title' => '', 'example' => '{"type": "line"}'], 'description' => 'Format', 'example' => '', ], 'advancedParameters' => [ 'type' => 'object', 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'title' => '', 'example' => '', ], ], 'example' => '', ], 'SavedSearch' => [ 'title' => 'A short description of struct', 'description' => 'The data structure for a saved search.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'savedsearchName' => ['sdkPropertyName' => 'savedsearchName', 'title' => 'savedsearchName', 'description' => 'The name of the saved search.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name'], 'searchQuery' => ['title' => 'searchQuery', 'description' => 'The search statement or analytic statement.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5'], 'logstore' => ['title' => 'logstore', 'description' => 'The name of the logstore.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore'], 'topic' => ['title' => 'topic', 'description' => 'The topic of the log. The default value is an empty string ("").', 'visibility' => 'Public', 'type' => 'string', 'example' => 'topic-test'], 'displayName' => ['title' => 'displayName', 'description' => 'The display name of the saved search.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'Method'], ], 'example' => '', ], 'Schedule' => [ 'title' => 'job schedule', 'description' => 'The schedule structure.', 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '定时类型：FixedRate/Cron', 'description' => 'schedule type', 'type' => 'string', 'required' => true, 'example' => 'FixedRate', 'enum' => ['FixedRate', 'Cron'], ], 'cronExpression' => ['title' => 'Cron情况下：cron表达式', 'description' => 'The cron expression.', 'type' => 'string', 'required' => false, 'example' => '0/5 * * * *'], 'runImmediately' => ['title' => '定时任务是否立即执行', 'description' => 'Specifies whether to execute the scheduled task immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], 'timeZone' => ['title' => 'Cron表达式所在时区，默认为空，表示东八区', 'description' => 'The time zone of the cron expression. If this parameter is left empty, the default time zone UTC+8 is used.', 'type' => 'string', 'required' => false, 'example' => '+0800'], 'delay' => ['title' => '定时类任务延迟执行（单位是秒：s）', 'description' => 'The delay before a scheduled task is executed, in seconds (s).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], 'interval' => ['title' => 'FixedRate情况下：固定间隔', 'description' => 'The fixed interval.', 'type' => 'string', 'required' => false, 'example' => '60s'], ], 'required' => false, 'example' => '', ], 'ScheduledSQL' => [ 'title' => '定时sql调度任务', 'description' => 'The request configuration of the scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'description' => ['title' => '定时sql任务描述', 'description' => 'The description of the scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'This is a scheduled sql job'], 'displayName' => ['title' => '定时sql显示名称', 'description' => 'The display name of the scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'This is a scheduled sql job'], 'name' => ['title' => '定时sql任务名称', 'description' => 'The name of the scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-scheduled-sql'], 'schedule' => ['title' => '调度配置', 'description' => 'The scheduling settings of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/Schedule'], 'configuration' => ['title' => '定时sql配置', 'description' => 'The configuration of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration'], 'createTime' => ['title' => '创建时间', 'description' => 'The time when the Scheduled SQL job was created.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1714123644'], 'lastModifiedTime' => ['title' => '最近修改时间', 'description' => 'The time when the Scheduled SQL job was last modified.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1714123644'], 'scheduleId' => ['title' => '调度ID', 'description' => 'The ID of the scheduler.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'e73f43732852064ad5d091914e39342f'], 'status' => ['title' => '定时SQL状态', 'description' => 'The status of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ENABLED'], ], 'required' => false, ], 'ScheduledSQLConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'The detailed configurations of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'script' => ['title' => 'SQL代码', 'description' => 'The query statement of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | select *'], 'sqlType' => ['title' => 'SQL类型', 'description' => 'The type of the query statement.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'searchQuery'], 'destEndpoint' => ['title' => '目标Region', 'description' => 'The endpoint.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com'], 'destProject' => ['title' => '目标Project', 'description' => 'The destination project.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'project-demo'], 'sourceLogstore' => ['title' => '源库', 'description' => 'The source Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'source-logstore-demo'], 'destLogstore' => ['title' => '目标库', 'description' => 'The destination Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'dest-logstore-demo'], 'roleArn' => ['title' => '角色ARN', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that is assigned to the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], 'destRoleArn' => ['title' => '写角色ARN', 'description' => 'The ARN of the RAM role that is assumed to write data to the destination Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], 'fromTimeExpr' => ['title' => 'SQL时间窗口开始', 'description' => 'The start time of the SQL time window.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '@m-1m'], 'toTimeExpr' => ['title' => 'SQL时间窗口结束', 'description' => 'The end time of the SQL time window.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '@m'], 'maxRunTimeInSeconds' => ['title' => 'SQL超时最长时间', 'description' => 'The maximum timeout period of SQL analysis. Unit: seconds. Valid values: 60 to 1800.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '600'], 'resourcePool' => ['title' => 'resourcePool', 'description' => 'The type of the resource pool. The value enhanced specifies an enhanced resource pool.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'enhanced'], 'maxRetries' => ['title' => 'SQL超时最大次数', 'description' => 'The maximum number of SQL timeouts allowed. Valid values: 1 to 100.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], 'fromTime' => ['title' => '调度时间范围开始', 'description' => 'The start time. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1712592000'], 'toTime' => ['title' => '调度时间范围结束', 'description' => 'The end time. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], 'dataFormat' => ['title' => '定时sql写入模式', 'description' => 'The data format. Valid values: log2log, log2metric, and metric2metric.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'log2log'], 'parameters' => ['title' => 'parameters', 'description' => 'The SQL configurations. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'example' => '{'."\n" .' addLabels: "{}",'."\n" .' hashLabels: "[]",'."\n" .' labelKeys: "[\\"your label1\\",\\"your label2\\"]",'."\n" .' metricKeys: "[\\"your Indicator1\\",\\"your Indicator2\\"]",'."\n" .' metricName: "",'."\n" .' timeKey: ""'."\n" .'}'], ], 'required' => false, ], 'serviceStatus' => [ 'description' => 'Activation status of Simple Log Service.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'status' => [ 'title' => '当前状态', 'description' => 'Current status.'."\n" ."\n" .'* Opened: The service is activated.'."\n" .'* NotExist: The service does not exist.'."\n" .'* Opening: The service is activating.'."\n" .'* Closed: The service has overdue payments and is disabled.'."\n", 'visibility' => 'Public', 'type' => 'string', 'enumValueTitles' => ['Opened' => 'Opened', 'NotExist' => 'NotExist', 'Opening' => 'Opening', 'Closed' => 'Closed'], 'example' => 'NotExist', ], 'enabled' => ['title' => '是否开通', 'description' => 'Indicates whether the service is activated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'], ], ], 'SeverityConfiguration' => [ 'title' => '告警严重度配置', 'description' => 'The alert severity configurations.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'severity' => ['title' => '告警严重度数值', 'description' => 'The value of the alert severity.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], 'evalCondition' => ['title' => '触发条件配置', 'description' => 'The trigger condition configurations.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/ConditionConfiguration'], ], ], 'shard' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of the shard.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'shardID' => ['title' => 'shard id', 'description' => 'shard id'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'status' => ['title' => 'shard 的读写状态，readwrite 或者 readonly。', 'description' => 'The status of the shard. After you create a shard, the shard enters the readwrite state. If you split a shard or merge shards, the shard status changes to readonly. The newly generated shards are in the readwrite state. The status of a shard does not affect the performance of read operations that are performed on the shard. Data can be written to the shards that are in the readwrite state, but data cannot be written to the shards that are in the readonly state. Valid values:'."\n" ."\n" .'* readwrite'."\n" .'* readonly'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'readwrite'], 'inclusiveBeginKey' => ['title' => '指定Shard范围的起始值，Shard范围中包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', 'description' => 'The start of the MD5 hash range. The value is included in the MD5 hash range of the shard.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '00000000000000000000000000000000'], 'exclusiveEndKey' => ['title' => '指定Shard范围的结束值，Shard范围中不包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', 'description' => 'The end of the MD5 hash range.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '8000000000000000000000000000000'], 'serverIp' => ['title' => '所在的服务器 ip。', 'description' => '服务IP地址。', 'visibility' => 'Private', 'type' => 'string', 'example' => '203.0.113.10'], 'createTime' => ['title' => 'Shard的创建时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => 'The time at which the shard was created. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1524222931'], ], ], 'ShardingPolicy' => [ 'title' => '', 'description' => 'Hashing configuration for writes.', 'type' => 'object', 'properties' => [ 'shardGroup' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'keys' => [ 'title' => '', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'userId'], 'required' => true, 'description' => '', 'example' => '', ], 'groupCount' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'description' => '', 'example' => '8'], ], 'description' => '', 'example' => '', ], 'shardHash' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'keys' => [ 'title' => '', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'instanceId'], 'required' => true, 'description' => '', 'example' => '', ], 'maxHashCount' => [ 'title' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'default' => '2', 'enum' => ['1', '2', '4'], 'description' => '', 'example' => '2', ], ], 'required' => true, 'description' => '', 'example' => '', ], 'queryActiveTime' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1764659409'], ], 'example' => '', ], 'SinkAlerthubConfiguration' => [ 'title' => '告警发送到SLS告警管理服务的配置', 'description' => 'The configurations of the alerts that are sent to the alert management system of Simple Log Service.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'enabled' => ['title' => '是否开启', 'description' => 'Specifies whether to send alerts.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], ], 'required' => false, ], 'SinkCmsConfiguration' => [ 'title' => '告警发送到云监控的配置', 'description' => 'The configurations that allow alerts to be sent to CloudMonitor.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'enabled' => ['title' => '是否开启', 'description' => 'Specifies whether to send alerts.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], ], ], 'SinkEventStoreConfiguration' => [ 'title' => '告警发送到EventStore的配置', 'description' => 'The configurations that allow alerts to be sent to an Eventstore.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'enabled' => ['title' => '是否开启', 'description' => 'Specifies whether to send alerts.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], 'endpoint' => ['title' => 'endpoint', 'description' => 'endpoint'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai-intranet.log.aliyuncs.com'], 'project' => ['title' => '项目名称', 'description' => 'The name of the project.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'exampleProject'], 'eventStore' => ['title' => '事件库名称', 'description' => 'The name of the Eventstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'exampleStore'], 'roleArn' => ['title' => '角色', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], ], ], 'StoreViewStore' => [ 'title' => '数据集中关联的日志库或时序库', 'description' => 'StoreView store', 'type' => 'object', 'properties' => [ 'project' => ['title' => 'Project 名称', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], 'storeName' => ['title' => 'LogStore 或 MetricStore 名称', 'description' => 'The name of the LogStore or MetricStore.', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], 'query' => ['title' => '查询过滤语句', 'description' => 'The query filter statement.', 'type' => 'string', 'example' => 'job: IT | select name, age, gender from log'], ], 'example' => '', ], 'SubmitAsyncSqlParams' => [ 'title' => '提交异步SQL的输入', 'description' => 'Parameters to submit an asynchronous SQL query.', 'type' => 'object', 'properties' => [ 'logstore' => ['title' => 'logstore的名称', 'description' => 'The name of the logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], 'query' => ['title' => '待执行的SQL内容', 'description' => 'The SQL statement to execute.', 'type' => 'string', 'required' => true, 'example' => 'job: IT | select name, age, gender from log'], 'from' => ['title' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', 'description' => 'The start of the query time range. This time is the log time specified when the log was written. The time range defined by the from and to parameters is left-inclusive and right-exclusive. This means the time range includes the start time but excludes the end time. If the from and to values are the same, the time range is invalid and the function returns an error. The value is a UNIX timestamp in seconds since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268100'], 'to' => ['title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', 'description' => 'The end of the query time range. This time is the log time specified when the log was written. The time range defined by the from and to parameters is left-inclusive and right-exclusive. This means the time range includes the start time but excludes the end time. If the from and to values are the same, the time range is invalid and the function returns an error. The value is a UNIX timestamp in seconds since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200'], 'extensions' => [ 'title' => '扩展项', 'type' => 'object', 'properties' => [ 'maxRunTime' => ['title' => '允许请求执行的最大时间（单位毫秒），当前设置的允许最大执行时间不得超过600000（即10分钟），默认值为600000', 'description' => 'The maximum running time for the request in milliseconds. Maximum value: 600,000 (10 minutes). Default value: 600,000.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000'], 'powerSql' => ['title' => '是否开启增强SQL，默认为false', 'description' => 'Specifies whether to enable enhanced SQL. The default value is false.', 'type' => 'boolean', 'example' => 'true'], ], 'description' => 'Extensions.', 'example' => '', ], ], 'example' => '', ], 'TemplateConfiguration' => [ 'title' => '模板告警配置', 'description' => 'The template configurations.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'id' => ['title' => '模板ID', 'description' => 'The ID of the template.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'sls.app.ack.ip.not_enough'], 'type' => ['title' => '模板类型', 'description' => 'The type of the template.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'sys'], 'version' => ['title' => '模板版本', 'description' => 'The version of the template.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '1'], 'lang' => ['title' => '模板语言', 'description' => 'The language of the template.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn'], 'tokens' => ['title' => '模板携带的token', 'description' => 'The tokens that are carried by the template.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => false], 'aonotations' => ['title' => '模板标注', 'description' => 'The annotations of the template.'."\n", 'visibility' => 'Public', 'type' => 'object'], ], ], 'Ticket' => [ 'title' => 'Ticket结构', 'description' => 'The ticket information.', 'type' => 'object', 'properties' => [ 'ticketId' => ['title' => 'ticket对应唯一Id', 'type' => 'string', 'description' => '', 'example' => 'xxxxx'], 'ticket' => ['title' => 'ticket', 'type' => 'string', 'description' => '', 'example' => 'xxxxx'], 'number' => ['title' => 'ticket最大使用次数', 'type' => 'integer', 'description' => '', 'example' => '1', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '0'], 'expirationTime' => ['title' => 'ticket过期时间，秒为单位', 'type' => 'integer', 'description' => '', 'example' => '100', 'format' => 'int64'], 'extra' => ['title' => '扩展字段', 'type' => 'string', 'description' => '', 'example' => '{"xx":"yy"}'], 'callerUid' => ['title' => 'ticket创建时的Uid', 'type' => 'integer', 'description' => '', 'example' => '1000000000', 'format' => 'int64'], 'name' => ['title' => '名称', 'type' => 'string', 'description' => '', 'example' => '测试'], 'usedNumber' => ['title' => 'ticket已使用次数', 'type' => 'integer', 'description' => '', 'example' => '1', 'format' => 'int32'], 'createDate' => ['title' => 'ticket创建时间', 'type' => 'string', 'description' => '', 'example' => '2023-09-06 14:57:07'], 'expireDate' => ['title' => 'ticket过期时间', 'type' => 'string', 'description' => '', 'example' => '2023-09-06 14:58:07'], 'valid' => ['title' => '是否禁止', 'type' => 'boolean', 'description' => '', 'example' => 'false'], 'sharingTo' => ['title' => '分享对象', 'type' => 'string', 'description' => '', 'example' => '{"type":"aliyun","ids":[1,2]}'], ], 'example' => '', ], ], ], 'apis' => [ 'ApplyConfigToMachineGroup' => [ 'summary' => 'Applies a Logtail configuration to a machine group.', 'path' => '/machinegroups/{machineGroup}/configs/{configName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'sample-group', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'ApplyConfigToMachineGroup', 'description' => '- The Host consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.'."\n" ."\n" .'- Create an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).
An AccessKey pair for an Alibaba Cloud account provides full access to all API operations. This poses a security risk. For security reasons, we recommend that you create and use a RAM user for API access or routine O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).
'."\n" ."\n" .'- Identify the name and region of the project. For more information, see [Manage projects](~~48984~~).'."\n" ."\n" .'- Create a Logtail configuration and obtain its name. For more information, see [CreateConfig](~~29042~~).'."\n" ."\n" .'- Create a machine group and obtain its name. For more information, see [CreateMachineGroup](~~29032~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | MachineGroupNotExist| MachineGroupdoes not exist. | 机器组不存在。 |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | ConfigNotExist | Configdoes not exist. | Logtail配置不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:ApplyConfigToGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], ], ], 'CallAiTools' => [ 'summary' => 'Invokes an observability AI tool. Tool capabilities are continuously updated. You can call the tool list operation to retrieve the currently supported capabilities.', 'path' => '/ml/tool/call', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '267815', 'abilityTreeNodes' => ['FEATUREslsOO5P9U'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'toolName' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'params' => [ 'description' => 'The tool parameters.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'regionId' => ['description' => 'The target region.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Invoke an observability AI tool capability', 'description' => 'This operation is available only at the endpoints in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\"\\"","type":"json"}]', ], 'CancelDownloadJob' => [ 'summary' => 'Cancel Download', 'path' => '/downloadjobs/{downloadJobName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '217895', 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'Project name', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'downloadJobName', 'in' => 'path', 'schema' => ['description' => 'Log download job name', 'type' => 'string', 'required' => true, 'example' => 'download-123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Cancel Log Download Job', 'description' => 'Currently supported region: Heyuan', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'ChangeResourceGroup' => [ 'summary' => 'Changes the resource group to which a resource belongs.', 'path' => '/resourcegroup', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '158383', 'abilityTreeNodes' => ['FEATUREslsKS6FGY'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project to which the resource belongs.', 'type' => 'string', 'example' => 'ali-test-project', 'title' => '', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'resourceType' => ['description' => 'The type of the resource. Only PROJECT is supported. Set the value to PROJECT.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT', 'default' => 'PROJECT', 'title' => ''], 'resourceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-ae******ey', 'title' => ''], ], 'required' => false, 'example' => 'ali-test-project', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'ChangeResourceGroup', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], 'ConsumerGroupHeartBeat' => [ 'summary' => 'A consumer sends a heartbeat to the server to maintain its active status.', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}?type=heartbeat', 'methods' => ['post'], 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ 'name' => 'consumerGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the consumer group. The name must be unique within a project.', 'type' => 'string', 'required' => true, 'example' => 'consumer_group_test', 'title' => ''], ], [ 'name' => 'consumer', 'in' => 'query', 'schema' => ['description' => 'The consumer.', 'type' => 'string', 'required' => true, 'example' => 'consumer_1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The list of shard IDs that are being consumed.', 'type' => 'array', 'items' => ['description' => 'The list of shard IDs that are being consumed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[0]', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], ], 'schema' => [ 'description' => 'The list of all shard IDs that are consumed by the consumer.', 'type' => 'array', 'items' => ['description' => 'The list of all shard IDs that are consumed by the consumer.', 'type' => 'integer', 'format' => 'int32', 'example' => '[0]', 'title' => ''], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n 0\\n]","type":"json"}]', 'title' => 'ConsumerGroupHeartBeat', 'description' => '### API description'."\n" ."\n" .'- The Host consists of a project name and a Simple Log Service Endpoint. You must specify the project in the Host.'."\n" ."\n" .'- A consumer sends heartbeats to the server at fixed intervals to maintain its connection. If the server does not receive a heartbeat from the consumer within a specified period, the consumer is deleted.'."\n" ."\n" .'- Obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair of an Alibaba Cloud account has permissions for all API operations. This poses a high security threat. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- Obtain the project name, region, and Logstore name. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- Obtain the consumer group name. For more information, see [ListConsumerGroup](~~74964~~).'."\n" ."\n" .'### Authorization information'."\n" ."\n" .'The following table describes the authorization information for this operation. Add this information to the Action element of a RAM policy to grant a RAM user or RAM role the permissions to call this API operation.'."\n" ."\n" .'| Action | Resource in an authorization policy |'."\n" .'| :--------------------------- | :-------------------------------------------------------------------------------------------------------------------- |'."\n" .'| `log:ConsumerGroupHeartBeat` | `acs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400| NotExistConsumerWithBody| non-exist consumer with non-empty body of heartbeat message. | 不存在非空心跳消息的消费者。请求参数中的Shard实际分配的消费者，与请求参数中的消费者不一致。可能原因是和服务端心跳断开后，Shard已经分配给其他消费者，建议传入空Shard列表。 |'."\n" .'| 404| ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 404 | ConsumerGroupNotExist| consumer group not exist. | 消费组不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:ConsumerGroupHeartBeat', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ConsumerGroupUpdateCheckPoint' => [ 'summary' => 'Updates the checkpoint of a shard for a consumer group.', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}?type=checkpoint', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '155573', 'abilityTreeNodes' => ['FEATUREslsD1VSU4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ 'name' => 'consumerGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'consumer_group_test', 'title' => ''], ], [ 'name' => 'consumer', 'in' => 'query', 'schema' => ['description' => 'The consumer.', 'type' => 'string', 'required' => true, 'example' => 'consumer_1', 'title' => ''], ], [ 'name' => 'forceSuccess', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable forceful updates. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The IDs of the shards.', 'type' => 'object', 'properties' => [ 'shard' => ['description' => 'The ID of the shard.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], 'checkpoint' => ['description' => 'The value of the checkpoint.', 'type' => 'string', 'required' => true, 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng==', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'ConsumerGroupUpdateCheckPoint', 'description' => '- If you do not specify a consumer, you must set **forceSuccess** to **true**. Otherwise, the checkpoint cannot be updated.'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | InvalidShardCheckPoint| shard checkpoint not encoded by base64. |checkpoint不是Base64编码，格式错误。 |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 404 | ConsumerGroupNotExist| consumer group not exist. | 消费组不存在。 |'."\n" .'| 404 | ConsumerNotExist| consumer not exist in the consumer group.| 消费组中不存在该消费者。 |'."\n" .'| 404 | ShardNotExist| shard not exist.| Shard不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:ConsumerGroupUpdateCheckPoint', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateAgentInstanceConfig' => [ 'path' => '/agentinstanceconfigs', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '233752', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'configType' => [ 'description' => 'The type of the process-level configuration.', 'enumValueTitles' => [ 'apm_biz_trace' => 'apm\\_biz\\_trace', 'apm_self_protect' => 'apm\\_self\\_protect', 'apm_convergence' => 'apm\\_convergence', 'apm_custom_extract' => 'apm\\_custom\\_extract', 'apm_pilot' => 'apm\\_pilot', 'apm_trace' => 'apm\\_trace', 'rum_app_config' => 'rum\\_app\\_config', 'security_rasp' => 'security\\_rasp', 'rum_web_config' => 'rum\\_web\\_config', 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', 'apm_intacheap' => 'apm\\_intacheap', 'apm_user_method' => 'apm\\_user\\_method', 'apm_global' => 'apm\\_global', 'apm_forward_process' => 'apm\\_forward\\_process', ], 'type' => 'string', 'required' => true, 'example' => 'apm_trace', 'title' => '', ], 'attributes' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'The process to which the configuration applies.', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" .'"service": "test-service"', 'title' => ''], 'description' => 'The process that the configuration applies to.', 'required' => false, 'title' => '', 'example' => '', ], 'config' => ['description' => 'The default configurations.', 'type' => 'string', 'required' => true, 'example' => '{}', 'title' => ''], 'grayConfigs' => [ 'type' => 'array', 'items' => ['description' => 'The canary release environment.', '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', 'required' => false, 'title' => '', 'example' => ''], 'description' => 'The canary release environment.', 'required' => false, 'title' => '', 'example' => '', ], ], 'description' => 'The request struct.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateAgentInstanceConfig', 'summary' => 'Creates a process-level configuration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateAlert' => [ 'summary' => 'Creates an alert rule in a project.', 'path' => '/alerts', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '200211', 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configurations of the alert rule.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the alert rule. Make sure that the name is unique in a project.', 'type' => 'string', 'required' => true, 'example' => 'alert-123456', 'title' => ''], 'displayName' => ['description' => 'The display name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'test-alert', 'title' => ''], 'description' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'An alert rule', 'required' => false, 'title' => ''], 'configuration' => ['description' => 'The detailed configurations of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration', 'title' => '', 'example' => ''], 'schedule' => ['description' => 'The scheduling configurations of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateAnnotationDataSet' => [ 'summary' => 'Creates a dataset.', 'path' => '/ml/annotationdataset', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The request struct for the dataset.', '$ref' => '#/components/schemas/MLDataSetParam', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'datasetId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'Create a dataset', 'description' => 'This operation is available only at the China (Shanghai) and Singapore endpoints.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CreateAnnotationLabel' => [ 'summary' => 'Creates an annotation label table.', 'path' => '/ml/annotationlabel', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The struct of the annotation label table.', '$ref' => '#/components/schemas/MLLabelParam', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateAnnotationLabel', 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CreateAzureBlobIngestion' => [ 'summary' => 'Creates an Azure BLOB ingestion task.', 'path' => '/azureblobingestions', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '291227', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'displayName' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'schedule' => ['$ref' => '#/components/schemas/Schedule', 'description' => '', 'title' => '', 'example' => ''], 'configuration' => ['required' => true, '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', 'description' => '', 'title' => '', 'example' => ''], 'name' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateAzureBlobIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateConfig' => [ 'summary' => 'Creates a Logtail configuration.', 'path' => '/configs', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8979', 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The body of the request.', '$ref' => '#/components/schemas/LogtailConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateConfig', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'- You can create up to 100 Logtail configurations in a project.'."\n" ."\n" .'- The Logtail configuration is planned out. For more information, see [Logtail configurations](~~29058~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | ConfigAlreadyExist | config configname already exists. | Logtail配置已存在。 |'."\n" .'| 400 | InvalidParameter | Invalid config resource json.| 无效的Logtail配置参数。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], ], ], 'CreateConsumerGroup' => [ 'summary' => 'Creates a consumer group for a Logstore.', 'path' => '/logstores/{logstore}/consumergroups', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore', 'title' => ''], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The information about the consumer group.', 'type' => 'object', 'properties' => [ 'consumerGroup' => ['description' => 'The name of the consumer group. The name must be unique in a project.', 'type' => 'string', 'required' => true, 'example' => 'consumerGroupX', 'title' => ''], 'timeout' => ['description' => 'The timeout period. If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '300', 'title' => ''], 'order' => ['description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .' - In a shard, data is consumed in ascending order based on the value of the \\*\\*\\_\\_tag\\_\\_:\\_\\_receive\\_time\\_\\_\\*\\* field.'."\n" ."\n" .' - If a shard is split, data in the original shard is consumed first. Then, data in the new shards is consumed at the same time.'."\n" ."\n" .' - If shards are merged, data in the original shards is consumed first. Then, data in the new shard is consumed.'."\n" ."\n" .'- false Data in all shards is consumed at the same time. If a new shard is generated after a shard is split or after shards are merged, data in the new shard is immediately consumed.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateConsumerGroup', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- You can create up to 30 consumer groups for a Logstore. The name of a consumer group must be unique in a project.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- Simple Log Service provides examples of both regular log consumption and consumer group-based log consumption by using Simple Log Service SDK for Java. For more information, see [Consume log data](~~120035~~) and [Use consumer groups to consume data](~~28998~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :------------------------ | :---------------------------------------------------------------------------------------------------------------- |'."\n" .'| `log:CreateConsumerGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 400 | ConsumerGroupAlreadyExist | consumer group already exist.| 消费组已存在。 |'."\n" .'| 400 | JsonInfoInvalid | consumerGroup or timeout is of error format. | 参数consumerGroup或timeout格式错误。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], ], ], 'CreateDashboard' => [ 'summary' => 'Creates a dashboard.', 'path' => '/dashboards', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '10278', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => ['description' => 'The data structure of the dashboard.', 'required' => true, '$ref' => '#/components/schemas/dashboard', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateDashboard', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateDomain' => [ 'summary' => 'Binds a new custom domain name to a project.', 'path' => '/domains', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The information about the domain name.', 'type' => 'object', 'properties' => [ 'domainName' => ['description' => 'The domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateDomain', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 403 | ExceedQuota| domain quota exceed. | 域名创建达到上限，目前最多只支持绑定一个域名。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateDomain', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], ], ], ], ], ], 'CreateDownloadJob' => [ 'summary' => 'Creates a log download task in a specified project.', 'path' => '/downloadjobs', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '216705', 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The configuration of the log download task.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the job. The name must meet the following requirements:'."\n" ."\n" .'The job name must be unique within a project.'."\n" ."\n" .'- It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- It must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'download-123'], 'description' => ['description' => 'The description of the log download task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Log download task'], 'configuration' => [ 'title' => '', 'description' => 'The download configuration.', 'type' => 'object', 'properties' => [ 'logstore' => ['description' => 'The source Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-logstore'], 'fromTime' => ['description' => 'The start time. This is a UNIX timestamp that is accurate to the second.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1722406260'], 'toTime' => ['description' => 'The end time. This is a UNIX timestamp that is accurate to the second.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1722409860'], 'query' => ['description' => 'The search statement.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '* | select *'], 'powerSql' => [ 'description' => 'Specifies whether to enable PowerSQL. Valid values: \\`true\\` and \\`false\\`.', 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true', ], 'allowInComplete' => [ 'description' => 'Specifies whether to allow the download of incomplete results. Valid values: \\`true\\` and \\`false\\`.', 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => '', ], 'sink' => [ 'title' => '', 'description' => 'The export configuration.', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => 'The type of the destination. Set the value to \\`AliyunOSS\\`.', 'enumValueTitles' => ['AliyunOSS' => 'AliyunOSS'], 'type' => 'string', 'required' => true, 'example' => 'AliyunOSS', 'title' => '', ], 'contentType' => [ 'description' => 'The format of the downloaded file. Valid values: \\`csv\\` and \\`json\\`.', 'enumValueTitles' => ['csv' => 'The file is in CSV format.', 'json' => 'The file is in JSON format.'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'csv', ], 'compressionType' => [ 'description' => 'The compression format of the file. Valid values: \\`zstd\\`, \\`lz4\\`, \\`gzip\\`, and \\`none\\`.', 'enumValueTitles' => ['zstd' => 'The file is compressed using zstd.', 'lz4' => 'The file is compressed using lz4.', 'gzip' => 'The file is compressed using gzip.', 'none' => 'The file is not compressed.'], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'none', ], 'roleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role to use for the download.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole'], 'bucket' => ['description' => 'The destination Object Storage Service (OSS) bucket.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'oss-test-bucket'], 'prefix' => ['description' => 'The prefix of the path in the destination OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'download/', 'title' => ''], ], 'required' => true, 'example' => '', ], ], 'required' => true, 'example' => '', ], 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'download-123456789'], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateDownloadJob', 'extraInfo' => '下载数据量限制'."\n" ."\n" .'- 仅查询：华东1（杭州）、华东2（上海）、华北2（北京）、华南1（深圳）和新加坡地域最多支持下载2000万行数据，其他地域最多支持下载100万行数据。数据量不超过20 GB。'."\n" ."\n" .'- SQL分析：最多支持下载100万行数据。数据量不超过2GB。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CreateETL' => [ 'summary' => 'Creates a data transformation job in a specified project.', 'path' => '/etls', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203162', 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configuration of the data transformation job.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The job name. The naming convention is as follows:'."\n" ."\n" .'The job name must be unique within the project.'."\n" ."\n" .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- The name must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- The length must be 2 to 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'etl-123456', 'title' => ''], 'displayName' => ['description' => 'The display name of the data transformation job.', 'type' => 'string', 'required' => true, 'example' => 'sls-test-etl', 'title' => ''], 'description' => ['description' => 'The description of the data transformation job.', 'type' => 'string', 'required' => false, 'example' => 'this is ETL', 'title' => ''], 'configuration' => ['description' => 'The detailed configuration of the data transformation job.', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateETL', 'requestParamsDescription' => 'To create a data transformation job that uses the new feature, you must also specify the lang and datasets parameters. The following Python code provides an example.'."\n" ."\n" .'```python'."\n" .'# -*- coding: utf-8 -*-'."\n" .'# This file is auto-generated, don\'t edit it. Thanks.'."\n" .'import os'."\n" .'import sys'."\n" ."\n" .'from typing import List'."\n" ."\n" .'from alibabacloud_sls20201230.client import Client as Sls20201230Client'."\n" .'from alibabacloud_tea_openapi import models as open_api_models'."\n" .'from alibabacloud_sls20201230 import models as sls_20201230_models'."\n" .'from alibabacloud_tea_util import models as util_models'."\n" .'from alibabacloud_tea_util.client import Client as UtilClient'."\n" ."\n\n" .'class Sample:'."\n" .' def __init__(self):'."\n" .' pass'."\n" ."\n" .' @staticmethod'."\n" .' def create_client() -> Sls20201230Client:'."\n" .' """'."\n" .' @return: Client'."\n" .' @throws Exception'."\n" .' """'."\n" .' config = open_api_models.Config('."\n" .' access_key_id=os.environ[\'ALIBABA_CLOUD_ACCESS_KEY_ID\'],'."\n" .' access_key_secret=os.environ[\'ALIBABA_CLOUD_ACCESS_KEY_SECRET\']'."\n" .' )'."\n" .' config.endpoint = f\'cn-hangzhou.log.aliyuncs.com\''."\n" .' return Sls20201230Client(config)'."\n" ."\n" .' @staticmethod'."\n" .' def main('."\n" .' args: List[str],'."\n" .' ) -> None:'."\n" .' client = Sample.create_client()'."\n" .' etlconfiguration_etlconfiguration_sink_0 = sls_20201230_models.ETLConfigurationSink('."\n" .' name=\'my-test\','."\n" .' project=\'my-test\','."\n" .' endpoint=\'cn-hangzhou.log.aliyuncs.com\','."\n" .' logstore=\'target\','."\n" .' role_arn=\'***\','."\n" .' datasets=["__UNNAMED__"]'."\n" .' )'."\n" .' etlconfiguration = sls_20201230_models.ETLConfiguration('."\n" .' script=\'* | where 1 = 1\','."\n" .' lang=\'SPL\','."\n" .' logstore=\'mock\','."\n" .' role_arn=\'***\','."\n" .' from_time=1729740027,'."\n" .' to_time=0,'."\n" .' sinks=['."\n" .' etlconfiguration_etlconfiguration_sink_0'."\n" .' ]'."\n" .' )'."\n" .' create_etlrequest = sls_20201230_models.CreateETLRequest('."\n" .' name=\'etl-my-test\','."\n" .' display_name=\'my-test\','."\n" .' configuration=etlconfiguration'."\n" .' )'."\n" .' runtime = util_models.RuntimeOptions()'."\n" .' headers = {}'."\n" .' try:'."\n" .' client.create_etlwith_options(\'my-test\', create_etlrequest, headers, runtime)'."\n" .' except Exception as error:'."\n" .' print(error.message)'."\n" .' print(error.data.get("Recommend"))'."\n" .' UtilClient.assert_as_string(error.message)'."\n" ."\n\n" ."\n" .'if __name__ == \'__main__\':'."\n" .' Sample.main(sys.argv[1:])'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'CreateElasticsearchIngestion' => [ 'path' => '/elasticsearchingestions', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '273937', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'description' => [ 'description' => 'The description of the job.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'es ingestion', 'title' => '', ], 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'es ingestion'."\n", 'title' => ''], 'schedule' => ['description' => 'The schedule structure.', '$ref' => '#/components/schemas/Schedule', 'required' => false, 'title' => '', 'example' => ''], 'configuration' => ['description' => 'The configuration for the ES or OpenSearch import job.', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration', 'title' => '', 'example' => ''], 'name' => ['description' => 'The unique identifier of the ES or OpenSearch import job.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch- 123456-123', 'title' => ''], ], 'description' => 'The request body.', 'title' => '', 'example' => '', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateElasticsearchIngestion', 'summary' => 'Creates an ES or OpenSearch import job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateGCSIngestion' => [ 'path' => '/gcsingestions', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'description' => ['description' => 'The task description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], 'configuration' => ['description' => 'The ingestion configuration.', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration', 'title' => '', 'example' => ''], 'name' => ['description' => 'The job name. Must be unique within the same project. Naming rules:'."\n" ."\n" .'- Can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- Must start and end with a lowercase letter or digit.'."\n" ."\n" .'- Must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], 'description' => 'The request body.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], 'schema' => ['description' => 'The response body.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateGCSIngestion', 'summary' => 'Creates a GCS file import task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', ], 'CreateIndex' => [ 'path' => '/logstores/{logstore}/index', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'chargeType' => 'paid', 'abilityTreeCode' => '8963', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-logstore-test', 'title' => ''], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'keys' => [ 'description' => 'The configuration of field indexes. A field index is a key-value pair in which the key specifies the name of the field and the value specifies the index configuration of the field. You must specify this parameter, the line parameter, or both parameters. For more information, see Example.', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'object', 'properties' => [ 'caseSensitive' => ['description' => 'Specifies whether to enable case sensitivity. This parameter is required only when **type** is set to **text**. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false (default)', 'type' => 'boolean'], 'chn' => ['description' => 'Specifies whether to include Chinese characters. This parameter is required only when **type** is set to **text**. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false (default)', 'type' => 'boolean'], 'type' => ['description' => 'The data type of the field value. Valid values: text, json, double, and long.', 'type' => 'string'], 'alias' => ['description' => 'The alias of the field.', 'type' => 'string'], 'token' => [ 'title' => '', 'description' => 'The delimiters that are used to split text.', 'type' => 'array', 'items' => ['description' => 'The delimiter.', 'type' => 'string'], 'required' => false, ], 'doc_value' => ['description' => 'Specifies whether to turn on Enable Analytics for the field.', 'type' => 'boolean'], ], 'description' => 'The index configuration of the field.', ], ], 'line' => [ 'title' => '', 'description' => 'The configuration of full-text indexes. You must specify this parameter, the keys parameter, or both parameters. For more information, see Example.', 'type' => 'object', 'properties' => [ 'chn' => ['description' => 'Specifies whether to include Chinese characters. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false (default)', 'type' => 'boolean'], 'caseSensitive' => ['description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false (default)', 'type' => 'boolean'], 'token' => [ 'title' => '', 'description' => 'The delimiters. You can specify a delimiter to delimit the content of a field value. For more information about delimiters, see Example.', 'type' => 'array', 'items' => ['description' => 'The delimiter. You can specify a delimiter to delimit the content of a field value. For more information about delimiters, see Example.', 'type' => 'string'], 'required' => true, ], 'include_keys' => [ 'title' => '', 'description' => 'The included fields. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'array', 'items' => ['description' => 'The included field. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'string'], 'required' => false, ], 'exclude_keys' => [ 'title' => '', 'description' => 'The excluded fields. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'array', 'items' => ['description' => 'The excluded field. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'string'], 'required' => false, ], ], 'required' => false, ], 'ttl' => ['description' => 'The retention period of logs. Unit: days. Valid values: 7, 30, and 90.', 'type' => 'integer'], 'max_text_len' => ['description' => 'The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of max\\_text\\_len. Valid values: 64 to 16384.', 'type' => 'integer'], 'log_reduce' => ['description' => 'Specifies whether to turn on LogReduce. After you turn on LogReduce, either the whitelist or blacklist takes effect.', 'type' => 'boolean'], 'log_reduce_white_list' => [ 'title' => '', 'description' => 'The fields in the whitelist that you want to use to cluster logs.', 'type' => 'array', 'items' => ['description' => 'The field in the whitelist that you want to use to cluster logs.', 'type' => 'string'], 'required' => false, ], 'log_reduce_black_list' => [ 'title' => '', 'description' => 'The fields in the blacklist that you want to use to cluster logs.', 'type' => 'array', 'items' => ['description' => 'The field in the blacklist that you want to use to cluster logs.', 'type' => 'string'], 'required' => false, ], ], 'required' => false, '$ref' => '#/components/schemas/index', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], 'title' => 'CreateIndex', 'summary' => 'Creates indexes for a Logstore.', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | IndexInfoInvalid | Required field token is lacking or of error format. | 缺少必要的字段标记或格式配置错误。 |'."\n" .'| 400 | IndexAlreadyExist | Logstore index is already created. | 日志索引已经创建。 |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateIndex', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateLogStore' => [ 'summary' => 'Creates a Logstore.', 'path' => '/logstores', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '115729', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ 'logstoreName' => ['description' => 'The name of the Logstore. The name must meet the following requirements:'."\n" ."\n" .'- The name must be unique within a project.'."\n" ."\n" .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- The name must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- The name must be 2 to 63 characters long.', 'type' => 'string', 'required' => true, 'example' => 'my-logstore', 'title' => ''], 'shardCount' => ['description' => 'The number of shards.'."\n" ."\n" .'> You cannot update the shard count with this operation. To do so, call the SplitShard or MergeShards operation.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], 'ttl' => ['description' => 'The data retention period in days. Valid values: 1 to 3,650. If you set this parameter to 3,650, data is stored permanently.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], 'encrypt_conf' => ['description' => 'The encryption configuration. This data structure includes the `enable`, `encrypt_type`, and `user_cmk_info` parameters. For more information, see [EncryptConf](~~409461~~).'."\n" ."\n" .'Example 1 (Enable default encryption):'."\n" ."\n" .'```'."\n" .'{'."\n" .' "enable": true,'."\n" .' "encrypt_conf": "default"'."\n" .'}'."\n" .'```'."\n" ."\n" .'Example 2 (Enable BYOK encryption):'."\n" ."\n" .'```'."\n" .'{'."\n" .' "enable": true,'."\n" .' "encrypt_conf": "default",'."\n" .' "user_cmk_info": {'."\n" .' "cmk_key_id": "xxxxx",'."\n" .' "arn": "acs:ram::112340000000:role/rolename",'."\n" .' "region": "cn-hangzhou"'."\n" .' }'."\n" .'}'."\n" .'```', 'required' => false, '$ref' => '#/components/schemas/EncryptConf', 'title' => '', 'example' => ''], 'autoSplit' => ['description' => 'Specifies whether to enable automatic shard splitting. If you set this parameter to true, Log Service automatically splits a shard to increase write throughput when the write traffic to the shard continuously exceeds the service limit. If you enable automatic shard splitting, you must also specify `maxSplitShard`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'enable_tracking' => ['description' => 'Specifies whether to enable WebTracking. The default value is false. This feature lets you collect and analyze user behavior data from browsers or mini programs, such as page views, purchase history, and dwell time.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'maxSplitShard' => ['description' => 'The maximum number of shards after an automatic split. The value must be an integer from 1 to 256.'."\n" ."\n" .'> This parameter is required if you set `autoSplit` to true.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64', 'title' => ''], 'appendMeta' => ['description' => 'Specifies whether to record the source **public IP address** and the **server reception time**. Default value: false.'."\n" ."\n" .'- true: Log Service automatically appends the public IP address of the source device and the server reception time to the Tag field of logs.'."\n" ."\n" .'- false: Log Service does not append the source public IP address or the server reception time.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'telemetryType' => ['description' => 'The type of observable data. Default value: log data. Valid values:'."\n" ."\n" .'- **None**: log data. This is the default value.'."\n" ."\n" .'- **Metrics**: Metrics data.', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''], 'hot_ttl' => ['description' => 'The retention period of data in the hot storage tier of the Logstore, in days. The value must be an integer from 7 to the value of `ttl`. If you do not specify this parameter, data is stored in the hot storage tier for the entire data retention period specified by `ttl`.'."\n" ."\n" .'After the hot storage retention period expires, data is moved to the Infrequent Access (IA) storage tier. To enable IA storage, you must set the hot storage retention period to at least 7 days. For more information, see [Smart Tiered Storage](~~308645~~).'."\n" ."\n" .'Examples:'."\n" ."\n" .'- Scenario 1 (Store data in the hot storage tier for 30 days): `{"ttl": 30}` or `{"ttl": 30, "hot_ttl": 30}`'."\n" ."\n" .'- Scenario 2 (Store data in the hot storage tier for 7 days and in the IA storage tier for 23 days): `{"ttl": 30, "hot_ttl": 7}`', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '60'], 'mode' => ['description' => 'Log Service provides two types of Logstores: standard and query.'."\n" ."\n" .'- **standard**: Supports end-to-end data analytics. This mode is suitable for scenarios such as real-time monitoring, interactive analysis, and building a complete observability system.'."\n" ."\n" .'- **query**: Supports high-performance queries. The index traffic cost is approximately half that of the standard mode, but SQL analysis is not supported. This mode is suitable for scenarios that involve large volumes of data, long retention periods such as weeks or months, and do not require SQL-based analysis.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], 'infrequentAccessTTL' => ['description' => 'The retention period for Infrequent Access (IA) storage, in days. While this parameter has no minimum value, data must remain in the IA storage tier for at least 30 days before it can be moved to archive storage.'."\n" ."\n" .'If the total retention period (`ttl`) is longer than the sum of the hot storage period (`hot_ttl`) and the IA storage period (`infrequentAccessTTL`), the remaining time is the archive storage period.'."\n" ."\n" .'Examples:'."\n" ."\n" .'- Scenario 1 (Store data in the hot storage tier for 7 days and in the IA storage tier for 23 days): `{"ttl": 30, "hot_ttl": 7}`'."\n" ."\n" .'- Scenario 2 (Store data in the hot storage tier for 7 days, in the IA storage tier for 30 days, and in the archive storage tier for 60 days): `{"ttl": 97, "hot_ttl": 7, "infrequentAccessTTL": 30}`'."\n" ."\n" .'- Scenario 3 (Store data in the hot storage tier for 60 days and in the archive storage tier for 60 days, with the IA storage period being 0 days): `{"ttl": 120, "hot_ttl": 60, "infrequentAccessTTL": 0}`', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], 'processorId' => ['description' => 'The ID of the IngestProcessor.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'processor-nginx-parser-001'], 'shardingPolicy' => ['description' => 'The configuration for hash-based writes. When you write data, logs are stored in a shard that is selected based on the configured hash-based sharding policy. Before you configure this parameter, make sure that the hash ranges of the shards are evenly distributed. Improper configuration may affect write performance. Configure this parameter with caution.', '$ref' => '#/components/schemas/ShardingPolicy', 'title' => '', 'required' => false, 'example' => ''], 'resourceGroupId' => ['description' => 'The ID of the resource group to which the Logstore belongs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-xxxxxxxx'], 'enableModify' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], [], ], 'title' => 'CreateLogStore', 'description' => '### Usage notes'."\n" ."\n" .'- The Host header of the request consists of a project name and a Log Service endpoint. You must specify the project in this header.'."\n" ."\n" .'- You must create and obtain an AccessKey. For more information, see [AccessKey](~~29009~~).'."\n" ."\n" .'An Alibaba Cloud account\'s AccessKey pair has full permissions for all API operations, which poses a security risk. For enhanced security, we strongly recommend using a RAM user to call API operations or perform routine O\\&M. You must grant the RAM user permissions to manage Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- Ensure you have the name and region of the project where you want to create the Logstore. For more information, see [Manage projects](~~48984~~).'."\n" ."\n" .'- You can create a maximum of 200 Logstores in a project.'."\n" ."\n" .'- Log Service automatically deletes logs after the specified data retention period expires.'."\n" ."\n" .'### Authorization'."\n" ."\n" .'The following table lists the permission required to call this API. To grant this permission to a RAM user or RAM role, add the corresponding Action to a RAM policy statement.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :------------------- | :----------------------------------------------------------------------------- |'."\n" .'| `log:CreateLogStore` | `acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}` |', 'extraInfo' => "\n" .'| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 400 | LogstoreAlreadyExist | Logstore already exists. | Logstore已存在。 |'."\n" .'| 400 | LogStoreInfoInvalid| Logstore info is invalid | Logstore信息无效。 |'."\n" .'| 400 | ProjectQuotaExceed| Project Quota Exceed. | 超过Project限额。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [ ['createdAt' => '2025-12-03T01:37:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-12-02T11:55:04.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateLogStore', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ['conditionKey' => 'log:Encrypted', 'validationType' => 'conditional'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateLogging' => [ 'summary' => 'Enables the service log feature for a project.', 'path' => '/logging', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'loggingProject' => ['description' => 'The name of the project to which service logs are stored.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], 'loggingDetails' => [ 'title' => '', 'description' => 'The configurations of service logs.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => 'The type of service logs. Valid values:'."\n" ."\n" .'- consumergroup\\_log: the consumption delay logs of consumer groups.'."\n" ."\n" .'- logtail\\_alarm: the alert logs of Logtail.'."\n" ."\n" .'- operation\\_log: the operation logs.'."\n" ."\n" .'- logtail\\_profile: the collection logs of Logtail.'."\n" ."\n" .'- metering: the metering logs.'."\n" ."\n" .'- logtail\\_status: the status logs of Logtail.'."\n" ."\n" .'- scheduledsqlalert: the run logs of Scheduled SQL jobs.'."\n" ."\n" .'- etl\\_alert: the run logs of data transformation jobs.', 'type' => 'string', 'required' => true, 'example' => 'consumergroup_log', 'enum' => ['consumergroup_log', 'logtail_alarm', 'operation_log', 'logtail_profile', 'metering', 'logtail_status', 'scheduled_sql_alert', 'etl_alert'], 'title' => '', ], 'logstore' => ['description' => 'The name of the Logstore to which service logs of the type are stored.', 'type' => 'string', 'required' => true, 'example' => 'my-logstore', 'title' => ''], ], 'required' => false, 'example' => '', ], 'required' => true, 'example' => '', ], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateLogging', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], ], ], 'CreateLogtailPipelineConfig' => [ 'summary' => 'Creates a Logtail pipeline configuration.', 'path' => '/pipelineconfigs', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191781', 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The content of the Logtail pipeline configuration.', 'type' => 'object', 'properties' => [ 'configName' => ['description' => 'The name of the configuration.'."\n" ."\n" .'> The configuration name must be unique within the project and cannot be modified after the configuration is created. The name must follow these rules:'."\n" .'>'."\n" .'> - It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" .'>'."\n" .'> - It must start and end with a lowercase letter or a digit.'."\n" .'>'."\n" .'> - It must be 2 to 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], 'logSample' => ['description' => 'A sample log. Multiple log entries are supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], 'global' => ['description' => 'The global configuration.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => ''], 'inputs' => [ 'title' => '', 'description' => 'The list of input plugins. >Currently, you can configure only one input plugin.>', 'type' => 'array', 'items' => ['description' => 'The input plugin.'."\n" ."\n" .'> For information about the parameters of the file input plugin, see [File plugin](~~65064~~). For information about the parameters of other input plugins, see [Processing plugins](~~64957~~).', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "Type": "input_file",'."\n" .' "FilePaths": ["/var/log/*.log"]'."\n" .'}'], 'required' => true, 'minItems' => 1, 'example' => '', ], 'processors' => [ 'title' => '', 'description' => 'The list of processing plugins.'."\n" ."\n" .'> Processing plugins are classified into native processing plugins and extension processing plugins. For more information, see [Processing plugins](~~64957~~).'."\n" ."\n" .'>'."\n" ."\n" .'> - Native plugins can be used only to collect text logs.'."\n" .'>'."\n" .'> - You cannot add native plugins and extension plugins at the same time.'."\n" .'>'."\n" .'> - When you use native plugins, the following requirements must be met:'."\n" .'>'."\n" .'> - The first processing plugin must be a regular expression-based parsing plugin, a separator-based parsing plugin, a JSON-based parsing plugin, an NGINX-based parsing plugin, an Apache-based parsing plugin, or an IIS-based parsing plugin.'."\n" .'>'."\n" .'> - After the first processing plugin, you can add only one time parsing processing plugin, one filter plugin, and multiple data masking plugins.'."\n" ."\n" .'>', 'type' => 'array', 'items' => ['description' => 'The processing plugin.'."\n" ."\n" .'> For more information about native and extension processing plugins, see [Processing plugins](~~64957~~).', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "Type": "processor_parse_json_native",'."\n" .' "SourceKey": "content"'."\n" .'}'], 'required' => false, 'minItems' => 1, 'example' => '', ], 'aggregators' => [ 'title' => '', 'description' => 'The list of aggregation plugins. >This parameter is valid only when you use extension processing plugins. You can use a maximum of one aggregation plugin.>', 'type' => 'array', 'items' => ['description' => 'The aggregation plugin.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => ''], 'required' => false, 'minItems' => 1, 'example' => '', ], 'flushers' => [ 'title' => '', 'description' => 'The list of output plugins. >Currently, you can add only one flusher\\_sls plugin.>', 'type' => 'array', 'items' => ['description' => 'The output plugin.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "Type": "flusher_sls",'."\n" .' "Logstore": "test"'."\n" .'}'], 'required' => true, 'minItems' => 1, 'example' => '', ], 'task' => ['description' => 'The task configuration.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateLogtailPipelineConfig', 'requestParamsDescription' => '## Global configuration'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------------- | -------- | -------------------------------------------------------------------------- | ----------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| TopicType | string | No | None | filepath | The topic type. Valid values:* filepath: extracts information from the log file path as the topic. This value is valid only when the input plugin is input\\_file.
* machine\\_group\\_topic: uses the topic of the machine group to which the configuration is applied.
* custom: a custom topic. For more information, see [Log topic](~~60069~~). |'."\n" .'| TopicFormat | string | No. This parameter is required if you set TopicType to filepath or custom. | / | /var/log/(.*).log | The topic format. |'."\n" .'| EnableTimestampNanosecond | bool | No | false | false | Specifies whether to enable nanosecond precision for timestamps. |'."\n" .'| PipelineMetaTagKey | object | No | None | {"HOST_NAME":"__hostname__"} | >This parameter is supported only by LoongCollector 3.0.10 and later.> Controls the tags related to LoongCollector information. The key is the tag parameter name, and the value is the field name of the tag in the log. If you set the value to __default__, the default value is used. If you set the value to an empty string, the tag is deleted. The following tags can be configured:* HOST\\_NAME: the hostname. This tag is added by default. The default value is "\\_\\_hostname\\_\\_".
* AGENT\\_TAG: the custom identifier. This tag is added by default. The default value is "\\_\\_user\\_defined\\_id\\_\\_".
* HOST\\_ID: the host ID. This tag is not added by default. The default value is "\\_\\_host\\_id\\_\\_".
* CLOUD\\_PROVIDER: This tag is not added by default. The default value is "\\_\\_cloud\\_provider\\_\\_". |'."\n" ."\n" .'## Input plugins'."\n" ."\n" .'### File input plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------------------------------- | --------- | ------------------------------------------- | ----------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | input_file | The plugin type. Set the value to input_file. |'."\n" .'| FilePaths | \\[string] | Yes | / | \\["/var/log/*.log"] | The paths of the log files that you want to collect. Currently, only one path is supported. You can use the wildcard characters (*) and (**) in the path. The double-asterisk (**) wildcard character can appear only once and can be used only before the file name. |'."\n" .'| MaxDirSearchDepth | uint | No | 0 | 0 | The maximum depth of the directories that are matched by the double-asterisk (**) wildcard character in a file path. This parameter is valid only when a file path contains the double-asterisk (**) wildcard character. Valid values: 0 to 1000. |'."\n" .'| ExcludeFilePaths | \\[string] | No | None | \\["/home/admin/*.log"] | The blacklist of file paths. The paths must be absolute paths. The wildcard character (*) is supported. |'."\n" .'| ExcludeFiles | \\[string] | No | None | \\["app*.log", "password"] | The blacklist of file names. The wildcard character (*) is supported. |'."\n" .'| ExcludeDirs | \\[string] | No | None | \\["/home/admin/dir1", "/home/admin/dir2*"] | The blacklist of directories. The paths must be absolute paths. The wildcard character (*) is supported. |'."\n" .'| FileEncoding | string | No | utf8 | utf8 | The encoding format of the file. Valid values: utf8 and gbk. |'."\n" .'| TailSizeKB | uint | No | 1024 | 1024 | The size of the data to be collected from the end of a file when the configuration is applied for the first time. If the file size is smaller than the specified value, data is collected from the beginning of the file. Unit: KB. Valid values: 0 to 10485760. |'."\n" .'| Multiline | object | No | None | / | The multiline log aggregation options. |'."\n" .'| Multiline.Mode | string | No | custom | custom | The multiline log aggregation mode. Valid values: custom and JSON. |'."\n" .'| Multiline.StartPattern | string | Required if Multiline.Mode is set to custom | None | \\d+-\\d+-\\d+.* | The regular expression to match the first line of a multiline log. |'."\n" .'| EnableContainerDiscovery | bool | No | false | true | Specifies whether to enable container discovery. This parameter is valid only when Logtail runs in DaemonSet mode and the collection path is a path within a container. |'."\n" .'| ContainerFilters | object | No | None | / | The container filtering options. Multiple options are combined using the AND operator. This parameter is valid only if you set EnableContainerDiscovery to true. |'."\n" .'| ContainerFilters.K8sNamespaceRegex | string | No | None | default | For containers in a Kubernetes environment, specifies the namespace of the pods where the containers to be collected reside. If you do not specify this parameter, all containers are collected. Regular expressions are supported. |'."\n" .'| ContainerFilters.K8sPodRegex | string | No | None | test-pod | For containers in a Kubernetes environment, specifies the names of the pods where the containers to be collected reside. If you do not specify this parameter, all containers are collected. Regular expressions are supported. |'."\n" .'| ContainerFilters.IncludeK8sLabel | map | No | None | / | For containers in a Kubernetes environment, specifies the labels of the pods where the containers to be collected reside. Multiple conditions are combined using the OR operator. If you do not specify this parameter, all containers are collected. Regular expressions are supported. The key in the map is the pod label name, and the value is the pod label value. The following rules apply:* If the value in the map is empty, pods that contain the key are matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, pods that have a label name matching the key and a label value matching the regular expression are matched.
- In other cases, pods that have a label name matching the key and a label value matching the value are matched. |'."\n" .'| ContainerFilters.ExcludeK8sLabel | map | No | None | / | For containers in a Kubernetes environment, specifies the labels of the pods where the containers to be excluded reside. Multiple conditions are combined using the OR operator. If you do not specify this parameter, all containers are collected. Regular expressions are supported. The key in the map is the pod label name, and the value is the pod label value. The following rules apply:* If the value in the map is empty, pods that contain the key are matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, pods that have a label name matching the key and a label value matching the regular expression are matched.
- In other cases, pods that have a label name matching the key and a label value matching the value are matched. |'."\n" .'| ContainerFilters.K8sContainerRegex | string | No | None | test-container | For containers in a Kubernetes environment, specifies the names of the containers to be collected. If you do not specify this parameter, all containers are collected. Regular expressions are supported. |'."\n" .'| ContainerFilters.IncludeEnv | map | No | None | / | The environment variables of the containers to be collected. Multiple conditions are combined using the OR operator. If you do not specify this parameter, all containers are collected. Regular expressions are supported. The key in the map is the environment variable name, and the value is the environment variable value. The following rules apply:* If the value in the map is empty, containers whose environment variables contain the key are matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, containers that have an environment variable name matching the key and an environment variable value matching the regular expression are matched.
- In other cases, containers that have an environment variable name matching the key and an environment variable value matching the value are matched. |'."\n" .'| ContainerFilters.ExcludeEnv | map | No | None | / | The environment variables of the containers to be excluded. Multiple conditions are combined using the OR operator. If you do not specify this parameter, all containers are collected. Regular expressions are supported. The key in the map is the environment variable name, and the value is the environment variable value. The following rules apply:* If the value in the map is empty, containers whose environment variables contain the key are matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, containers that have an environment variable name matching the key and an environment variable value matching the regular expression are matched.
- In other cases, containers that have an environment variable name matching the key and an environment variable value matching the value are matched. |'."\n" .'| ContainerFilters.IncludeContainerLabel | map | No | None | / | The labels of the containers to be collected. Multiple conditions are combined using the OR operator. If you do not specify this parameter, the default value is empty, which indicates that all containers are collected. Regular expressions are supported. The key in the map is the container label name, and the value is the container label value. The following rules apply:* If the value in the map is empty, containers that contain the key are matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, containers that have a label name matching the key and a label value matching the regular expression are matched.
- In other cases, containers that have a label name matching the key and a label value matching the value are matched. |'."\n" .'| ContainerFilters.ExcludeContainerLabel | map | No | None | / | The labels of the containers to be excluded. Multiple conditions are combined using the OR operator. If you do not specify this parameter, the default value is empty, which indicates that all containers are collected. Regular expressions are supported. The key in the map is the container label name, and the value is the container label value. The following rules apply:* If the value in the map is empty, containers that contain the key are matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, containers that have a label name matching the key and a label value matching the regular expression are matched.
- In other cases, containers that have a label name matching the key and a label value matching the value are matched. |'."\n" .'| ExternalK8sLabelTag | map | No | None | / | For containers in a Kubernetes environment, specifies the pod label-related tags that you want to add to logs. The key in the map is the pod label name, and the value is the corresponding tag name. For example, if you add `app: k8s_label_app` to the map and a pod contains the `app=serviceA` label, the information is added to the log as a tag. The added field is `__tag__:k8s_label_app: serviceA`. If the pod does not contain the `app` label, the empty field `__tag__:k8s_label_app: `is added. |'."\n" .'| ExternalEnvTag | map | No | None | / | For containers in a Kubernetes environment, specifies the container environment variable-related tags that you want to add to logs. The key in the map is the environment variable name, and the value is the corresponding tag name. For example, if you add `VERSION: env_version` to the map and a container has the `VERSION=v1.0.0` environment variable, the information is added to the log as a tag. The added field is `__tag__:env_version: v1.0.0`. If the container does not have the `VERSION` environment variable, the empty field `__tag__:env_version: `is added. |'."\n" .'| CollectingContainersMeta | bool | No | false | true | Specifies whether to enable container metadata preview. |'."\n" .'| AppendingLogPositionMeta | bool | No | false | false | Specifies whether to add the metadata of the file to which the log belongs. The metadata includes the __tag__:__inode__ field and the __file_offset__ field. |'."\n" .'| AllowingIncludedByMultiConfigs | bool | No | false | false | Specifies whether to allow the current configuration to collect files that are matched by other configurations. |'."\n" .'| Tags | object | No | None | {"FileInodeTagKey":"__inode__"} | >This parameter is supported only by LoongCollector 3.0.10 and later.> Controls the tags related to file collection. The key is the tag parameter name, and the value is the field name of the tag in the log. If you set the value to __default__, the default value is used. If you set the value to an empty string, the tag is deleted. The following tags can be configured:* FileInodeTagKey: the inode of the file. This tag is not added by default. The default value is "\\_\\_inode\\_\\_".
* FilePathTagKey: the file path. This tag is added by default. The default value is "\\_\\_path\\_\\_".The following parameters are valid only if you set the EnableContainerDiscovery parameter to true.* K8sNamespaceTagKey: the namespace of the container in which the file is located. This tag is added by default. The default value is "\\_namespace\\_".
* K8sPodNameTagKey: the name of the pod in which the file is located. This tag is added by default. The default value is "\\_pod\\_name\\_".
* K8sPodUidTagKey: the UID of the pod in which the file is located. This tag is added by default. The default value is "\\_pod\\_uid\\_".
* ContainerNameTagKey: the name of the container in which the file is located. This tag is added by default. The default value is "\\_container\\_name\\_".
* ContainerIpTagKey: the IP address of the container in which the file is located. This tag is added by default. The default value is "\\_container\\_ip\\_".
* ContainerImageNameTagKey: the image of the container in which the file is located. This tag is added by default. The default value is "\\_image\\_name\\_". |'."\n" .'| FileOffsetKey | string | No | None | \\__file_offset__ | >This parameter is supported only by LoongCollector 3.0.10 and later.> The tag for the position of the log in the file. This tag is not added by default. The default value is __file_offset__. If you set the value to __default__, the default value is used. If you set the value to an empty string, the tag is deleted. If the AppendingLogPositionMeta parameter and the Tags.FileInodeTagKey or FileOffsetKey parameter are specified at the same time, the AppendingLogPositionMeta parameter is ignored. |'."\n" ."\n" .'### Container stdout (legacy)'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------- | --------------------------------------------------------- | ------------ | ----------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_docker_stdout | The plugin type. Set the value to service_docker_stdout. |'."\n" .'| Stdout | Boolean | No | true | true | Specifies whether to collect stdout. |'."\n" .'| Stderr | Boolean | No | true | true | Specifies whether to collect stderr. |'."\n" .'| StartLogMaxOffset | Integer | No | 128×1024 | 131072 | The length of historical data to be collected for the first time. Unit: bytes. We recommend that you set this parameter to a value between 131072 and 1048576. |'."\n" .'| IncludeLabel | Map, where LabelKey and LabelValue are of the String type | No | None | | The whitelist of container labels. This parameter specifies the containers from which you want to collect logs. By default, this parameter is left empty, which indicates that the standard output of all containers is collected. If you want to configure a whitelist of container labels, you must specify LabelKey. LabelValue is optional.
- If LabelValue is empty, containers whose labels contain LabelKey are matched.
- If LabelValue is not empty, only containers whose labels contain LabelKey=LabelValue are matched.
By default, LabelValue is used for string matching. A match is found only if LabelValue is identical to the value of a container label. If the value starts with `^` and ends with `$`, it is used for regular expression matching. For example, if you set LabelKey to `io.kubernetes.container.name` and LabelValue to `^(nginx|cube)$`, containers named nginx and cube are matched.
Multiple whitelists are combined using the OR operator. A container is matched if its label meets the condition in any of the whitelists. |'."\n" .'| ExcludeLabel | Map, where LabelKey and LabelValue are of the String type | No | None | | The blacklist of container labels. This parameter specifies the containers that you want to exclude. By default, this parameter is left empty, which indicates that no containers are excluded. If you want to configure a blacklist of container labels, you must specify LabelKey. LabelValue is optional.
- If LabelValue is empty, containers whose labels contain LabelKey are excluded.
- If LabelValue is not empty, only containers whose labels contain LabelKey=LabelValue are excluded.
By default, LabelValue is used for string matching. A match is found only if LabelValue is identical to the value of a container label. If the value starts with `^` and ends with `$`, it is used for regular expression matching. For example, if you set LabelKey to `io.kubernetes.container.name` and LabelValue to `^(nginx|cube)$`, containers named nginx and cube are matched.
Multiple blacklists are combined using the OR operator. A container is excluded if its label meets the condition in any of the blacklists. |'."\n" .'| IncludeEnv | Map, where EnvKey and EnvValue are of the String type | No | None | | The whitelist of environment variables. This parameter specifies the containers from which you want to collect logs. By default, this parameter is left empty, which indicates that the standard output of all containers is collected. If you want to configure a whitelist of environment variables, you must specify EnvKey. EnvValue is optional.
- If EnvValue is empty, containers whose environment variables contain EnvKey are matched.
- If EnvValue is not empty, only containers whose environment variables contain EnvKey=EnvValue are matched.
By default, EnvValue is used for string matching. A match is found only if EnvValue is identical to the value of an environment variable. If the value starts with `^` and ends with `$`, it is used for regular expression matching. For example, if you set EnvKey to `NGINX_SERVICE_PORT` and EnvValue to \\`^(80 |'."\n" .'| ExcludeEnv | Map, where EnvKey and EnvValue are of the String type | No | None | | The blacklist of environment variables. This parameter specifies the containers that you want to exclude. By default, this parameter is left empty, which indicates that no containers are excluded. If you want to configure a blacklist of environment variables, you must specify EnvKey. EnvValue is optional.
- If EnvValue is empty, logs from containers whose environment variables contain EnvKey are excluded.
- If EnvValue is not empty, only containers whose environment variables contain EnvKey=EnvValue are excluded.
By default, EnvValue is used for string matching. A match is found only if EnvValue is identical to the value of an environment variable. If the value starts with `^` and ends with `$`, it is used for regular expression matching. For example, if you set EnvKey to `NGINX_SERVICE_PORT` and EnvValue to `^(80|6379)$`, containers whose service ports are 80 and 6379 are matched.
Multiple blacklists are combined using the OR operator. A container is excluded if its environment variable meets the condition in any of the key-value pairs. |'."\n" .'| IncludeK8sLabel | Map, where LabelKey and LabelValue are of the String type | No | None | | The whitelist of Kubernetes labels (defined in template.metadata). This parameter specifies the containers from which you want to collect logs. If you want to configure a whitelist of Kubernetes labels, you must specify LabelKey. LabelValue is optional.
- If LabelValue is empty, containers whose Kubernetes labels contain LabelKey are matched.
- If LabelValue is not empty, only containers whose Kubernetes labels contain LabelKey=LabelValue are matched.
By default, LabelValue is used for string matching. A match is found only if LabelValue is identical to the value of a Kubernetes label. If the value starts with `^` and ends with `$`, it is used for regular expression matching. For example, if you set LabelKey to `app` and LabelValue to `^(test1|test2)$`, containers whose Kubernetes labels contain app:test1 or app:test2 are matched.
Multiple whitelists are combined using the OR operator. A container is matched if its Kubernetes label meets the condition in any of the whitelists. |'."\n" .'| ExcludeK8sLabel | Map, where LabelKey and LabelValue are of the String type | No | None | | The blacklist of Kubernetes labels (defined in template.metadata). This parameter specifies the containers that you want to exclude. If you want to configure a blacklist of Kubernetes labels, you must specify LabelKey. LabelValue is optional.
- If LabelValue is empty, containers whose Kubernetes labels contain LabelKey are excluded.
- If LabelValue is not empty, only containers whose Kubernetes labels contain LabelKey=LabelValue are excluded.
By default, LabelValue is used for string matching. A match is found only if LabelValue is identical to the value of a Kubernetes label. If the value starts with `^` and ends with `$`, it is used for regular expression matching. For example, if you set LabelKey to `app` and LabelValue to `^(test1|test2)$`, containers whose Kubernetes labels contain app:test1 or app:test2 are matched.
Multiple blacklists are combined using the OR operator. A container is excluded if its Kubernetes label meets the condition in any of the blacklists. |'."\n" .'| K8sNamespaceRegex | String | No | None | ^(default|nginx)$ | The namespace based on which you want to collect logs from containers. Regular expressions are supported. For example, if you set this parameter to `^(default|nginx)$`, all containers in the nginx and default namespaces are matched. |'."\n" .'| K8sPodRegex | String | No | None | ^(nginx-log-demo.*)$ | The pod name based on which you want to collect logs from containers. Regular expressions are supported. For example, if you set this parameter to `^(nginx-log-demo.*)$`, all containers in pods whose names start with nginx-log-demo are matched. |'."\n" .'| K8sContainerRegex | String | No | None | ^(container-test)$ | The container name based on which you want to collect logs. The Kubernetes container name is defined in spec.containers. Regular expressions are supported. For example, if you set this parameter to `^(container-test)$`, all containers named container-test are matched. |'."\n" ."\n" .'#### Data processing parameters'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------------- | --------------------------------------------------------- | ------------ | ----------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| BeginLineRegex | String | No | None | | The regular expression to match the first line of a log.
If you leave this parameter empty, the single-line mode is used.
If the beginning of a line matches the regular expression, the line is considered the first line of a new log. Otherwise, the line is appended to the previous log. |'."\n" .'| BeginLineCheckLength | Integer | No | None | | The maximum length for first-line matching. Unit: bytes.
The default value is 10 × 1024 bytes.
If the regular expression for first-line matching can be matched within the first N bytes, we recommend that you set this parameter to improve matching efficiency. |'."\n" .'| BeginLineTimeoutMs | Integer | No | None | | The timeout period for first-line matching. Unit: milliseconds.
The default value is 3,000 milliseconds.
If no new log is generated within 3,000 milliseconds, the matching ends, and the last log is uploaded to Simple Log Service. |'."\n" .'| MaxLogSize | Integer | No | None | | The maximum length of a log**.** The default value is 0. Unit: bytes.
The default value is 512 × 1024 bytes.
If the length of a log exceeds the specified value, the system stops searching for the first line and directly uploads the log. |'."\n" .'| ExternalK8sLabelTag | Map, where LabelKey and LabelValue are of the String type | No | None | | The Kubernetes label (defined in template.metadata) tags. After you configure this parameter, iLogtail adds Kubernetes label-related fields to logs.
For example, if you set LabelKey to app and LabelValue to `k8s_label_app`, and a pod contains the label `app=serviceA`, iLogtail adds this information to the log. The added field is k8s\\_label\\_app: serviceA. If the pod does not contain the app label, the empty field k8s\\_label\\_app: is added. |'."\n" .'| ExternalEnvTag | Map, where EnvKey and EnvValue are of the String type | No | None | | The container environment variable tags. After you configure this parameter, iLogtail adds container environment variable-related fields to logs.
For example, if you set EnvKey to `VERSION` and EnvValue to `env_version`, and a container has the environment variable `VERSION=v1.0.0`, this information is added to the log as a tag. The added field is env\\_version: v1.0.0. If the container does not have the VERSION environment variable, the empty field env\\_version: is added. |'."\n" ."\n" .'#### Data processing environment variables'."\n" ."\n" .'| **Environment variable** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------------ | -------- | ------------ | ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| ALIYUN_LOG_ENV_TAGS | String | No | None | | The global environment variable tags. After you configure this parameter, iLogtail adds fields related to the environment variables of the container where iLogtail resides to logs. Separate multiple environment variable names with vertical bars (`|`).
For example, if you set this parameter to node\\_name|node\\_ip and the iLogtail container exposes the related environment variables, this information is added to the log as tags. The added fields are node\\_ip:172.16.0.1 and node\\_name:worknode. |'."\n" ."\n" .'### Container stdout (new version)'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------------------ | ----------------------------------------- | ------------ | ----------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | input_container_stdio | The plugin type. Set the value to `input_container_stdio`. |'."\n" .'| IgnoringStdout | Boolean | No | false | false | Specifies whether to **ignore** stdout. `false` indicates that stdout is collected. `true` indicates that stdout is not collected. |'."\n" .'| IgnoringStderr | Boolean | No | false | false | Specifies whether to **ignore** stderr. `false` indicates that stderr is collected. `true` indicates that stderr is not collected. |'."\n" .'| TailSizeKB | Integer (uint) | No | 1024 | 2048 | The size of the data to be collected from the end of a file when the configuration is applied for the first time. Unit: KB. If the file size is smaller than the specified value, data is collected from the beginning of the file. Valid values: 0 to 104857600. |'."\n" .'| AllowingIncludedByMultiConfigs | Boolean | No | false | true | Specifies whether to allow the current configuration to collect stdout logs from containers that are matched by other configurations. The default value `false` prevents duplicate collection by multiple configurations. |'."\n" .'| ContainerFilters | Object | No | None | See the Container filtering options (ContainerFilters) table below | The container filtering options. Multiple options are combined using the AND operator. |'."\n" .'| ExternalK8sLabelTag | Map, where LabelKey/LabelValue are String | No | None | {"app":"k8s_label_app"} | For Kubernetes scenarios: retrieves values from pod labels and appends them to logs as tags. The key of the map is the pod label name, and the value is the log field name (tag name). If a pod does not have the specified label, an empty field is appended. |'."\n" .'| ExternalEnvTag | Map, where EnvKey/EnvValue are String | No | None | {"VERSION":"env_version"} | For container scenarios: retrieves values from container environment variables and appends them to logs as tags. The key of the map is the environment variable name, and the value is the log field name (tag name). If a container does not have the specified environment variable, an empty field is appended. |'."\n" .'| Multiline | Object | No | None | See the Multiline aggregation options (Multiline) table below | The multiline aggregation options. |'."\n" ."\n" .'#### Container filtering options (ContainerFilters)'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------------- | ----------------------------------------- | ------------ | ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| IncludeK8sLabel | Map, where LabelKey/LabelValue are String | No | None | {"app":"^(test1|test2)$"} | The whitelist of Kubernetes labels (defined in the `metadata.labels` of a pod). This parameter specifies the containers from which you want to collect logs. By default, this parameter is left empty, which indicates that the standard output of all containers is collected.
- If LabelValue is empty, containers whose Kubernetes labels contain LabelKey are matched.
- If LabelValue is not empty, only containers whose Kubernetes labels contain LabelKey=LabelValue are matched.
By default, LabelValue is used for string matching. A match is found only if LabelValue is identical to the value of a Kubernetes label. If the value starts with `^` and ends with `$`, it is used for regular expression matching.
Multiple whitelists are combined using the OR operator. A container is matched if its Kubernetes label meets the condition in any of the whitelists. |'."\n" .'| ExcludeK8sLabel | Map, where LabelKey/LabelValue are String | No | None | {"env":"^(test.*)$"} | The blacklist of Kubernetes labels (defined in the `metadata.labels` of a pod). This parameter specifies the containers that you want to exclude. By default, this parameter is left empty, which indicates that no containers are excluded.
- If LabelValue is empty, containers whose Kubernetes labels contain LabelKey are excluded.
- If LabelValue is not empty, only containers whose Kubernetes labels contain LabelKey=LabelValue are excluded.
By default, LabelValue is used for string matching. A match is found only if LabelValue is identical to the value of a Kubernetes label. If the value starts with `^` and ends with `$`, it is used for regular expression matching.
Multiple blacklists are combined using the OR operator. A container is excluded if its Kubernetes label meets the condition in any of the blacklists. |'."\n" .'| IncludeEnv | Map, where EnvKey/EnvValue are String | No | None | {"NGINX_SERVICE_PORT":"^(80|6379)$"} | The whitelist of environment variables. This parameter specifies the containers from which you want to collect logs. By default, this parameter is left empty, which indicates that the standard output of all containers is collected. If you want to configure a whitelist of environment variables, you must specify EnvKey. EnvValue is optional.
- If EnvValue is empty, containers whose environment variables contain EnvKey are matched.
- If EnvValue is not empty, only containers whose environment variables contain EnvKey=EnvValue are matched.
By default, EnvValue is used for string matching. A match is found only if EnvValue is identical to the value of an environment variable. If the value starts with `^` and ends with `$`, it is used for regular expression matching.
Multiple whitelists are combined using the OR operator. A container is matched if its environment variable meets the condition in any of the key-value pairs. |'."\n" .'| ExcludeEnv | Map, where EnvKey/EnvValue are String | No | None | {"POD_NAMESPACE":"kube-system"} | The blacklist of environment variables. This parameter specifies the containers that you want to exclude. By default, this parameter is left empty, which indicates that no containers are excluded. If you want to configure a blacklist of environment variables, you must specify EnvKey. EnvValue is optional.
- If EnvValue is empty, containers whose environment variables contain EnvKey are excluded.
- If EnvValue is not empty, only containers whose environment variables contain EnvKey=EnvValue are excluded.
By default, EnvValue is used for string matching. A match is found only if EnvValue is identical to the value of an environment variable. If the value starts with `^` and ends with `$`, it is used for regular expression matching.
Multiple blacklists are combined using the OR operator. A container is excluded if its environment variable meets the condition in any of the key-value pairs. |'."\n" .'| IncludeContainerLabel | Map, where LabelKey/LabelValue are String | No | None | {"io.kubernetes.container.name":"nginx"} | The whitelist of container labels. This parameter specifies the containers from which you want to collect logs. By default, this parameter is left empty, which indicates that the standard output of all containers is collected. If you want to configure a whitelist of container labels, you must specify LabelKey. LabelValue is optional.
- If LabelValue is empty, containers whose labels contain LabelKey are matched.
- If LabelValue is not empty, only containers whose labels contain LabelKey=LabelValue are matched.
By default, LabelValue is used for string matching. A match is found only if LabelValue is identical to the value of a container label. If the value starts with `^` and ends with `$`, it is used for regular expression matching.
Multiple whitelists are combined using the OR operator. A container is matched if its label meets the condition in any of the whitelists. |'."\n" .'| ExcludeContainerLabel | Map, where LabelKey/LabelValue are String | No | None | {"io.kubernetes.pod.namespace":"kube-system"} | The blacklist of container labels. This parameter specifies the containers that you want to exclude. By default, this parameter is left empty, which indicates that no containers are excluded. If you want to configure a blacklist of container labels, you must specify LabelKey. LabelValue is optional.
- If LabelValue is empty, containers whose labels contain LabelKey are excluded.
- If LabelValue is not empty, only containers whose labels contain LabelKey=LabelValue are excluded.
By default, LabelValue is used for string matching. A match is found only if LabelValue is identical to the value of a container label. If the value starts with `^` and ends with `$`, it is used for regular expression matching.
Multiple blacklists are combined using the OR operator. A container is excluded if its label meets the condition in any of the blacklists. |'."\n" ."\n" .'#### Multiline aggregation options (Multiline)'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------------- | -------- | ---------------------------- | ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Mode | String | No | custom | custom | The multiline aggregation mode. Valid values: `custom` and `JSON`. If you set this parameter to `JSON`, logs are read and concatenated in JSON format. |'."\n" .'| StartPattern | String | No (required in custom mode) | None | \\d+-\\d+-\\d+.* | The regular expression for the first line of a log. A match indicates the start of a new log. |'."\n" .'| UnmatchedContentTreatment | String | No | single_line | discard | The processing method for unmatched log segments. Valid values: `discard` (discards the segment) and `single_line` (outputs each unmatched segment as a single-line log). |'."\n" ."\n" .'### MySQL input plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------------- | -------- | ------------ | ----------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_mysql | The plugin type. Set the value to service_mysql. |'."\n" .'| Address | string | No | 127.0.0.1:3306 | rm-*.mysql.rds.aliyuncs.com | The address of the MySQL database. |'."\n" .'| User | string | No | root | root | The username that is used to log on to the MySQL database. |'."\n" .'| Password | string | No | None | | The password of the user that is used to log on to the MySQL database. For security purposes, you can set the username and password to xxx. After the collection configuration is synchronized to your on-premises machine, find the configuration in the `/usr/local/ilogtail/user_log_config.json` file and modify it. For more information, see [Modify local configurations](~~64955~~).> If you modify this parameter in the console, the local configuration is overwritten after synchronization.> |'."\n" .'| DataBase | string | No | / | project_database | The name of the database. |'."\n" .'| DialTimeOutMs | int | No | 5000 | 5000 | The timeout period for connecting to the MySQL database. Unit: ms. |'."\n" .'| ReadTimeOutMs | int | No | 5000 | 5000 | The timeout period for reading the MySQL query results. Unit: ms. |'."\n" .'| StateMent | string | No | / | | The SELECT statement. If you set CheckPoint to true, the WHERE clause in the SELECT statement must contain the checkpoint column (CheckPointColumn). You can use a question mark (?) as a placeholder to work with the checkpoint column. For example, you can set CheckPointColumn to id, CheckPointStart to 0, and StateMent to `SELECT * from ... where id > ?`. After each collection, the system saves the ID of the last data entry as a checkpoint. In the next collection, the question mark (?) in the query statement is replaced with the ID corresponding to the checkpoint. |'."\n" .'| Limit | bool | No | false | true | Specifies whether to use LIMIT for paging.* true: uses LIMIT for paging.
* false (default): does not use LIMIT for paging.We recommend that you use LIMIT for paging. If you set Limit to true, the system automatically appends a LIMIT clause to the SELECT statement during SQL queries. |'."\n" .'| PageSize | int | No | / | 10 | The number of entries to return on each page. This parameter is required if you set Limit to true. |'."\n" .'| MaxSyncSize | int | No | 0 | 0 | The maximum number of records to synchronize at a time. The default value is 0, which indicates that no limit is imposed. |'."\n" .'| CheckPoint | bool | No | false | true | Specifies whether to use a checkpoint.* true: uses a checkpoint.
* false (default): does not use a checkpoint.A checkpoint can be used as the starting point for the next data collection to implement incremental data collection. |'."\n" .'| CheckPointColumn | string | No | None | 1 | The name of the checkpoint column. This parameter is required if you set CheckPoint to true. **Warning** The values in this column must be incremental. Otherwise, data may fail to be collected. The maximum value in each query result is used as the input for the next query. |'."\n" .'| CheckPointColumnType | string | No | None | int | The data type of the checkpoint column. Valid values: int and time. The int type is stored as int64. The time type supports the date, datetime, and time types of MySQL. This parameter is required if you set CheckPoint to true. |'."\n" .'| CheckPointStart | string | No | None | | The initial value of the checkpoint column. This parameter is required if you set CheckPoint to true. |'."\n" .'| CheckPointSavePerPage | bool | No | true | true | Specifies whether to save a checkpoint for each page.* true (default): saves a checkpoint for each page.
* false: saves a checkpoint after each synchronization is complete. |'."\n" .'| IntervalMs | int | No | 60000 | 60000 | The synchronization interval. The default value is 60,000. Unit: ms. |'."\n" ."\n" .'### HTTP input plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------- | -------- | ------------ | ----------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | metric_http | The plugin type. Set the value to metric_http. |'."\n" .'| Address | string | Yes | / | | The list of URLs. **Important** The URLs must start with `http` or `https`. |'."\n" .'| IntervalMs | int | Yes | / | 10 | The interval between requests. Unit: ms. |'."\n" .'| Method | string | No | GET | GET | The request method. The value must be in uppercase. |'."\n" .'| Body | string | No | None | | The content of the HTTP body. |'."\n" .'| Headers | map | No | None | {"key":"value"} | The content of the HTTP header. For example, `{"key":"value"}`. Replace the content with the actual value. |'."\n" .'| PerAddressSleepMs | int | No | 100 | 100 | The interval between requests for each URL in the Addresses list. Unit: ms. |'."\n" .'| ResponseTimeoutMs | int | No | 5000 | 5000 | The request timeout period. Unit: ms. |'."\n" .'| IncludeBody | bool | No | false | true | Specifies whether to collect the request body. The default value is false. If you set this parameter to true, the request body content is stored in a key named content. |'."\n" .'| FollowRedirects | bool | No | false | false | Specifies whether to automatically handle redirections. |'."\n" .'| InsecureSkipVerify | bool | No | false | false | Specifies whether to skip HTTPS security checks. |'."\n" .'| ResponseStringMatch | string | No | / | | Performs a regular expression check on the returned body content. The check result is stored in a key named _response_match_. If a match is found, the value is yes. If no match is found, the value is no. |'."\n" ."\n" .'### Syslog input plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------ | -------- | ------------ | -------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_syslog | The plugin type. Set the value to service_syslog. |'."\n" .'| Address | string | No | tcp://127.0.0.1:9999 | | The protocol, address, and port that Logtail listens on. Logtail listens on the specified protocol, address, and port and obtains log data. The format is `[tcp/udp]://[` *ip* `]:[` *port* `]`. If you do not configure this parameter, the default value `tcp://127.0.0.1:9999` is used. This indicates that only logs forwarded from the local machine can be received. **Note*** The protocol, address, and port number specified in the Logtail configuration must be the same as the forwarding rule specified in the rsyslog configuration file.
* If the server where Logtail is installed has multiple IP addresses that can receive logs, you can set the address to `0.0.0.0`. This indicates that Logtail listens on all IP addresses of the server. |'."\n" .'| ParseProtocol | string | No | None | rfc3164 | The protocol used to parse logs. The default value is empty, which indicates that logs are not parsed. Valid values:* Empty: does not parse logs.
* rfc3164: uses the RFC3164 protocol to parse logs.
* rfc5424: uses the RFC5424 protocol to parse logs.
auto: automatically selects a suitable parsing protocol based on the log content. |'."\n" .'| IgnoreParseFailure | bool | No | true | true | The operation to perform after a parsing failure. If you do not configure this parameter, the default value `true` is used, which indicates that parsing is abandoned and the returned content field is directly populated. If you set this parameter to `false`, the log is discarded if parsing fails. |'."\n" ."\n" .'### Systemd Journal input plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------- | --------- | ------------ | ----------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_journal | The plugin type. Set the value to service_journal. |'."\n" .'| JournalPaths | \\[string] | Yes | None | /var/log/journal | The Journal log path. We recommend that you set this parameter to the directory where Journal logs are stored. |'."\n" .'| SeekPosition | string | No | tail | tail | The initial collection method. Valid values: head and tail.* head: collects all data.
* tail: collects only new data after the Logtail collection configuration is applied. |'."\n" .'| Kernel | bool | No | true | true | Specifies whether to collect kernel logs. |'."\n" .'| Units | \\[string] | No | None | "" | The list of units to collect. By default, this parameter is left empty, which indicates that all units are collected. |'."\n" .'| ParseSyslogFacility | bool | No | false | false | Specifies whether to parse the facility field of syslog logs. If you do not configure this parameter, the field is not parsed. |'."\n" .'| ParsePriority | bool | No | false | false | Specifies whether to parse the Priority field. If you do not configure this parameter, the field is not parsed. If you set this parameter to true, the Priority field is mapped as follows: `plaintext "0": "emergency" "1": "alert" "2": "critical" "3": "error" "4": "warning" "5": "notice" "6": "informational" "7": "debug"` |'."\n" .'| UseJournalEventTime | bool | No | false | false | Specifies whether to use the field in the Journal log as the log time. If you do not configure this parameter, the collection time is used as the log time. The time difference for real-time log collection is generally within 3 seconds. |'."\n" ."\n" .'### SQL Server input plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------------- | -------- | ------------ | ----------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_mssql | The plugin type. Set the value to service_mssql. |'."\n" .'| Address | string | No | 127.0.0.1:1433 | rm-*.sqlserver.rds.aliyuncs.com | The address of the SQL Server database. |'."\n" .'| User | string | No | root | root | The username that is used to log on to the SQL Server database. |'."\n" .'| Password | string | No | None | | The password of the user that is used to log on to the SQL Server database. For security purposes, you can set the username and password to xxx. After the collection configuration is synchronized to your on-premises machine, find the configuration in the `/usr/local/ilogtail/user_log_config.json` file and modify it. For more information, see [Modify local configurations](~~64955~~).> If you modify this parameter in the console, the local configuration is overwritten after synchronization.> |'."\n" .'| DataBase | string | No | / | project_database | The name of the database. |'."\n" .'| DialTimeOutMs | int | No | 5000 | 5000 | The timeout period for connecting to the SQL Server database. Unit: ms. |'."\n" .'| ReadTimeOutMs | int | No | 5000 | 5000 | The timeout period for reading the SQL Server query results. Unit: ms. |'."\n" .'| StateMent | string | No | / | | The SELECT statement. If you set CheckPoint to true, the WHERE clause in the SELECT statement must contain the checkpoint column (CheckPointColumn). You can use a question mark (?) as a placeholder to work with the checkpoint column. For example, you can set CheckPointColumn to id, CheckPointStart to 0, and StateMent to `SELECT * from ... where id > ?`. After each collection, the system saves the ID of the last data entry as a checkpoint. In the next collection, the question mark (?) in the query statement is replaced with the ID corresponding to the checkpoint. |'."\n" .'| Limit | bool | No | false | true | Specifies whether to use LIMIT for paging.* true: uses LIMIT for paging.
* false (default): does not use LIMIT for paging.We recommend that you use LIMIT for paging. If you set Limit to true, the system automatically appends a LIMIT clause to the SELECT statement during SQL queries. |'."\n" .'| PageSize | int | No | / | 10 | The number of entries to return on each page. This parameter is required if you set Limit to true. |'."\n" .'| MaxSyncSize | int | No | 0 | 0 | The maximum number of records to synchronize at a time. The default value is 0, which indicates that no limit is imposed. |'."\n" .'| CheckPoint | bool | No | false | true | Specifies whether to use a checkpoint.* true: uses a checkpoint.
* false (default): does not use a checkpoint.A checkpoint can be used as the starting point for the next data collection to implement incremental data collection. |'."\n" .'| CheckPointColumn | string | No | None | 1 | The name of the checkpoint column. This parameter is required if you set CheckPoint to true. **Warning** The values in this column must be incremental. Otherwise, data may fail to be collected. The maximum value in each query result is used as the input for the next query. |'."\n" .'| CheckPointColumnType | string | No | None | int | The data type of the checkpoint column. Valid values: int and time. The int type is stored as int64. The time type supports the date, datetime, and time types of SQL Server. This parameter is required if you set CheckPoint to true. |'."\n" .'| CheckPointStart | string | No | None | | The initial value of the checkpoint column. This parameter is required if you set CheckPoint to true. |'."\n" .'| CheckPointSavePerPage | bool | No | true | true | Specifies whether to save a checkpoint for each page.* true (default): saves a checkpoint for each page.
* false: saves a checkpoint after each synchronization is complete. |'."\n" .'| IntervalMs | int | No | 60000 | 60000 | The synchronization interval. The default value is 60,000. Unit: ms. |'."\n" ."\n" .'### PostgreSQL input plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------------- | -------- | ------------ | ----------------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_pgsql | The plugin type. Set the value to service_pgsql. |'."\n" .'| Address | string | No | 127.0.0.1:5432 | rm-*.pg.rds.aliyuncs.com | The address of the PostgreSQL database. |'."\n" .'| User | string | No | root | root | The username that is used to log on to the PostgreSQL database. |'."\n" .'| Password | string | No | None | | The password of the user that is used to log on to the PostgreSQL database. For security purposes, you can set the username and password to xxx. After the collection configuration is synchronized to your on-premises machine, find the configuration in the `/usr/local/ilogtail/user_log_config.json` file and modify it. For more information, see [Modify local configurations](~~64955~~).> If you modify this parameter in the console, the local configuration is overwritten after synchronization.> |'."\n" .'| DataBase | string | No | / | project_database | The name of the PostgreSQL database. |'."\n" .'| DialTimeOutMs | int | No | 5000 | 5000 | The connection timeout for the PostgreSQL database, in milliseconds. |'."\n" .'| ReadTimeOutMs | int | No | 5000 | 5000 | The timeout for reading PostgreSQL query results. Unit: ms. |'."\n" .'| StateMent | string | No | / | | The SELECT statement. If CheckPoint is set to true, the WHERE clause in the StateMent must include a condition for the checkpoint column. The checkpoint column is specified by the CheckPointColumn parameter. This condition must use $1 as a placeholder for the checkpoint value. For example: Set CheckPointColumn to id and StateMent to `SELECT * from ... where id > $1` |'."\n" .'| Limit | Boolean | No | false | true | Specifies whether to use Limit for paging.* true: Use Limit.
* false (default): Do not use Limit.Use Limit for paging. If set to true, the system automatically appends a LIMIT statement to SELECT statements during SQL queries. |'."\n" .'| PageSize | int | No | / | 10 | The page size. This parameter is required if `Limit` is set to `true`. |'."\n" .'| MaxSyncSize | int | No | 0 | 0 | The maximum number of records to sync each time. The default value is 0, which means there is no limit. |'."\n" .'| CheckPoint | bool | No | false | true | Specifies whether to use a checkpoint.* true: Use a checkpoint.
* false: (Default) Do not use a checkpoint.A checkpoint can be used as the starting point for the next data collection to enable incremental data collection. |'."\n" .'| CheckPointColumn | string | No | Empty | 1 | The name of the CheckPoint column. This parameter is required when CheckPoint is set to true. **Warning** The value of this column must be incremental. Otherwise, data collection issues may occur because the maximum value from each query is used as the input for the next query. |'."\n" .'| CheckPointColumnType | string | No | empty | int | The data type of the CheckPoint column. Supported values are `int` and `time`. The `int` type is stored as `int64`. The `time` type supports PostgreSQL time types. This parameter is required when the CheckPoint parameter is set to `true`. |'."\n" .'| CheckPointStart | string | No | empty | | The initial value of the CheckPoint column. This parameter is required when CheckPoint is set to true. |'."\n" .'| CheckPointSavePerPage | bool | No | true | true | Specifies whether to save a checkpoint for each page.* true (Default): Saves a checkpoint for each page.
* false: Saves a checkpoint after each sync is complete. |'."\n" .'| IntervalMs | int | No | 60000 | 60000 | The synchronization interval. The default value is 60000 ms. |'."\n" ."\n" .'### SNMP input plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------------ | --------- | ------------ | ----------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Targets | \\[string] | Yes | / | 127.0.0.1 | The IP addresses of the target machine group. |'."\n" .'| Port | string | No | 161 | 161 | The port used by the SNMP protocol. |'."\n" .'| Community | string | No | public | public | The community string. SNMPv1 and SNMPv2 use the community string for authentication. |'."\n" .'| UserName | string | No | Empty | root | The username. SNMPv3 supports authentication using a username. |'."\n" .'| AuthenticationProtocol | string | No | NoAuth | NoAuth | The authentication protocol. SNMPv3 supports authentication using an authentication protocol. |'."\n" .'| AuthenticationPassphrase | string | No | Empty | | The authentication passphrase. The default value is empty. If you set `AuthenticationProtocol` to `MD5` or `SHA`, you must set `AuthenticationPassphrase`. |'."\n" .'| PrivacyProtocol | string | No | NoPriv | NoPriv | The privacy protocol. SNMPv3 supports authentication using a privacy protocol. |'."\n" .'| PrivacyPassphrase | string | No | Empty | | The privacy protocol passphrase. By default, it is the same as the authentication passphrase. If you set `PrivacyProtocol` to `DES` or `AES`, you must set `PrivacyPassphrase`. |'."\n" .'| Timeout | int | No | 5 | 5 | The timeout period for a query operation, in seconds. |'."\n" .'| Version | int | No | 2 | 2 | The SNMP protocol version. Valid values are `1`, `2`, and `3`. |'."\n" .'| Transport | string | No | udp | udp | The SNMP communication method. Valid values are `udp` and `tcp`. |'."\n" .'| MaxRepetitions | int | No | 0 | 0 | The number of retries after a query times out. |'."\n" .'| Oids | \\[string] | No | Empty | 1 | The Object Identifiers (OIDs) to query on the target machine. |'."\n" .'| Fields | \\[string] | No | Empty | int | The fields to query on the target machine. The plugin looks up these fields in the local Management Information Base (MIB), translates them into Object Identifiers (OIDs), and then queries them. |'."\n" .'| Tables | \\[string] | No | Empty | | The tables to query on the target machine. The plugin finds all fields within the specified tables, looks them up in the local Management Information Base (MIB), translates them into Object Identifiers (OIDs), and then queries them. |'."\n" ."\n" .'### Script output collector plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------- | --------- | ------------ | ----------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | input_command | The type of the plugin. The value is fixed to input_command. |'."\n" .'| ScriptType | string | Yes | Empty | shell | The type of the script content. Valid values are bash, shell, python2, and python3. |'."\n" .'| User | string | Yes | / | public | The username used to run the command. Only non-root users are supported. **Note** * Ensure the specified username exists on the machine. Configure the least privilege. Grant only rwx permissions for the folders or files to be monitored. |'."\n" .'| ScriptContent | string | Yes | Empty | | The content of the script. The content can be in plain text or Base64-encoded. The length cannot exceed 512 × 1024 bytes. |'."\n" .'| ContentEncoding | string | No | PlainText | PlainText | The encoding format of the script content. This parameter is optional. Valid values:* PlainText (Default): The script content is plain text and not encoded.
* Base64: The script content is Base64-encoded. |'."\n" .'| LineSplitSep | string | No | Empty | | The separator used to split the script output. If you leave this parameter empty, the output is not split and is returned as a single log entry. |'."\n" .'| CmdPath | string | No | Empty | /usr/bin/bash | The execution path of the script. If this parameter is empty, a default path is used. The default paths are as follows:* bash: /usr/bin/bash
* shell: /usr/bin/sh
* python2: /usr/bin/python2
* python3: /usr/bin/python3 |'."\n" .'| TimeoutMilliSeconds | int | No | 3000 | 3000 | The timeout period for script execution. Unit: milliseconds. |'."\n" .'| IgnoreError | bool | No | false | false | Specifies whether to ignore error logs if the plugin fails to execute. The default value is false, which indicates that errors are not ignored. |'."\n" .'| Environments | \\[string] | No | | | The environment variables. By default, the value of os.Environ() is used. If you set this parameter, the specified environment variables are appended to the os.Environ() value. |'."\n" .'| IntervalMs | int | No | 5000 | 5000 | The interval at which data is collected or the script is executed. Unit: milliseconds. |'."\n" ."\n" .'## Native processor plugins'."\n" ."\n" .'### Native regex parsing plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------------------- | --------- | ------------ | ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | None | processor_parse_regex_native | The plugin type. The value is fixed to processor_parse_regex_native. |'."\n" .'| SourceKey | string | Yes | None | content | The source field name. |'."\n" .'| Regex | string | Yes | None | (\\d+-\\d+-\\d+)\\s+(.*) | The regular expression. |'."\n" .'| Keys | \\[string] | Yes | None | \\["time", "msg"] | The list of extracted fields. |'."\n" .'| KeepingSourceWhenParseFail | bool | No | false | false | Specifies whether to keep the source field if parsing fails. |'."\n" .'| KeepingSourceWhenParseSucceed | bool | No | false | false | Specifies whether to keep the source field if parsing succeeds. |'."\n" .'| RenamedSourceKey | string | No | Empty | key | The new name for the source field if it is kept. If you leave this parameter empty, the source field is not renamed. |'."\n" ."\n" .'### Native JSON parsing plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default Value** | **Example** | **Description** |'."\n" .'| ----------------------------- | -------- | ------------ | ----------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_parse_json_native | The type of the plug-in. The value is fixed to processor_parse_json_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| KeepingSourceWhenParseFail | bool | No | false | false | Specifies whether to keep the source field if parsing fails. |'."\n" .'| KeepingSourceWhenParseSucceed | bool | No | false | false | Specifies whether to keep the source field if parsing succeeds. |'."\n" .'| RenamedSourceKey | string | No | empty | key | The new field name for the source field when it is kept. If this parameter is left empty, the source field is not renamed. |'."\n" ."\n" .'### Native separator parsing plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------------------- | --------- | ------------ | ----------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_parse_delimiter_native | The type of the plug-in. The value must be processor_parse_delimiter_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| Separator | string | Yes | / | , | The separator character. |'."\n" .'| Quote | string | No | " | " | The quote character. |'."\n" .'| Keys | \\[string] | Yes | / | \\["time", "msg"] | The list of keys for the extracted fields. |'."\n" .'| AllowingShortenedFields | bool | No | true | true | Specifies whether to allow fewer extracted fields than keys. If set to false, parsing fails if the number of fields is smaller than the number of keys. |'."\n" .'| OverflowedFieldsTreatment | string | No | extend | extend | The behavior when the number of extracted fields is greater than the number of keys. Valid values:* extend: Keeps the extra fields and adds each one to the log as a separate field. The extra fields are named \\_\\_column$i\\_\\_, where $i is the ordinal number of the field, starting from 0.
* keep: Keeps the extra fields and adds them to the log as a single field named \\_\\_column0\\_\\_.
* discard: Discards the extra fields. |'."\n" .'| KeepingSourceWhenParseFail | bool | No | false | false | Specifies whether to keep the source field if parsing fails. |'."\n" .'| KeepingSourceWhenParseSucceed | bool | No | false | false | Specifies whether to keep the source field if parsing succeeds. |'."\n" .'| RenamedSourceKey | string | No | empty | key | The name of the field used to store the source field when the source field is kept. If you do not specify a name, the source field is not renamed. |'."\n" ."\n" .'### Native Apsara parsing plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------------------- | -------- | ------------ | ----------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_parse_apsara_native | The plugin type. The value is fixed to processor_parse_apsara_native. |'."\n" .'| SourceKey | string | Yes | / | content | The source field name. |'."\n" .'| Timezone | string | No | Empty | GMT+08:00 | The time zone of the log. The format is GMT+HH:MM for eastern time zones or GMT-HH:MM for western time zones. |'."\n" .'| KeepingSourceWhenParseFail | bool | No | false | false | Specifies whether to keep the source field when parsing fails. |'."\n" .'| KeepingSourceWhenParseSucceed | bool | No | false | false | Specifies whether to keep the source field when parsing succeeds. |'."\n" .'| RenamedSourceKey | string | No | Empty | key | The name of the field that stores the source field if the source field is kept. If this parameter is empty, the source field is not renamed. |'."\n" ."\n" .'### Native time parsing plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------- | -------- | ------------ | ----------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_parse_timestamp_native | The type of the plugin. The value must be processor_parse_timestamp_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| SourceFormat | string | Yes | / | %Y/%m/%d %H:%M:%S | The time format of the log. For more information, see [Time formats](~~28980~~). |'."\n" .'| SourceTimezone | string | No | Empty | GMT+08:00 | The time zone of the log. The format is GMT+HH:MM for eastern time zones or GMT-HH:MM for western time zones. |'."\n" ."\n" .'### Native filtering plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Example** | **Default value** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | processor_filter_regex_native | / | The plugin type. The value is fixed to processor_filter_regex_native. |'."\n" .'| Include | map | Yes | / | / | A whitelist for log fields. The key is a field name and the value is a regular expression. A log is collected only if the content of the specified field matches the regular expression. If you define multiple conditions, a log is collected only if it meets all of them. |'."\n" ."\n" .'### Native data masking plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------------------- | -------- | ----------------------------------------------------------- | ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_desensitize_native | The plugin type. The value is fixed to processor_desensitize_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| Method | string | Yes | / | const | The data masking method. Valid values include the following: const: Replaces sensitive content with a constant string. md5: Replaces sensitive content with its MD5 value. |'."\n" .'| ReplacingString | string | No. This parameter is required when Method is set to const. | / | \\****** | The constant string used to replace sensitive content. |'."\n" .'| ContentPatternBeforeReplacedString | string | Yes | / | \'password:\' | The regular expression for the prefix of the sensitive content. |'."\n" .'| ReplacedContentPattern | string | Yes | / | \\[^\']* | The regular expression for the sensitive content. |'."\n" .'| ReplacingAll | bool | No | true | true | Specifies whether to replace all matched sensitive content. |'."\n" ."\n" .'## Extension processor plugins'."\n" ."\n" .'### Fetch fields'."\n" ."\n" .'#### Regular expression pattern'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------- | --------- | ------------ | ----------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | processor_regex | The type of the plugin. This is fixed to processor_regex. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| Regex | string | Yes | / | (\\d+-\\d+-\\d+)\\s+(.*) | The regular expression. Use parentheses `()` to annotate the fields to fetch. |'."\n" .'| Keys | \\[string] | Yes | / | \\["ip", "time", "method"] | Specifies the field names for the fetched content, such as ["ip", "time", "method"]. |'."\n" .'| NoKeyError | boolean | No | false | false | Specifies whether the system reports an error if the source field does not exist in the raw log.* true: The system reports an error.
* false (default): The system does not report an error. |'."\n" .'| NoMatchError | boolean | No | false | false | Specifies whether the system reports an error if the regular expression does not match the value of the source field.* true: The system reports an error.
* false (default): The system does not report an error. |'."\n" .'| KeepSource | boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keeps the source field.
* false (default): Does not keep the source field. |'."\n" .'| FullMatch | boolean | No | true | true | Specifies whether to fetch field values only when a full match is found.* true (default): Field values are fetched only if all fields that you set in the Keys parameter match the value of the source field based on the regular expression in the Regex parameter.
* false: Field values are fetched even if only a partial match is found. |'."\n" .'| KeepSourceIfParseError | boolean | No | true | false | Specifies whether to keep the source field in the log if parsing fails.* true (default): Keeps the source field.
* false: Does not keep the source field. |'."\n" ."\n" .'#### Delimiter mode'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default Value** | **Example** | **Description** |'."\n" .'| --------------- | -------- | ------------ | ----------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | N/A | processor_anchor | The type of the plug-in. This is fixed to processor_anchor. |'."\n" .'| SourceKey | string | Yes | N/A | content | The name of the source field. |'."\n" .'| Anchors | array | Yes | N/A | | The list of anchor items. |'."\n" .'| Start | string | Yes | Empty | time | The start keyword. If this parameter is empty, it matches the beginning of the string. |'."\n" .'| Stop | string | Yes | Empty | \\t | The end keyword. If this parameter is empty, it matches the end of the string. |'."\n" .'| FieldName | string | Yes | Empty | time | The name of the field for the extracted content. |'."\n" .'| FieldType | string | Yes | Empty | string | The type of the field. Valid values are string and json. |'."\n" .'| ExpandJson | boolean | No | false | false | Specifies whether to expand the JSON field.* true: Expand the field.
* false (default): Do not expand the field. |'."\n" .'| ExpandConnector | string | No | \\_ | \\_ | The connector used for JSON expansion. The default value is an underscore (_). |'."\n" .'| MaxExpandDepth | integer | No | 0 | 0 | The maximum depth for JSON expansion. The default value is 0, which means no limit. |'."\n" .'| NoAnchorError | boolean | No | false | false | Specifies whether to report an error if an anchor item is not found.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| NoKeyError | boolean | No | false | false | Specifies whether to report an error if the specified source field does not exist in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| KeepSource | boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keep the source field.
* false (default): Do not keep the source field. |'."\n" ."\n" .'#### CSV pattern'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------- | ------------ | ------------ | ----------------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | None | processor_csv | The plugin type. Set this to processor_csv. |'."\n" .'| SourceKey | String | Yes | None | csv | The name of the source field. |'."\n" .'| SplitKeys | String array | Yes | None | \\["date", "ip", "content"] | Specify the field names for the extracted content, such as ["date", "ip", "content"]. **Important** If the number of fields to split is smaller than the number of fields specified in the SplitKeys parameter, the excess fields in SplitKeys are ignored. |'."\n" .'| PreserveOthers | Boolean | No | false | false | Specifies whether to keep remaining content when the source data contains more fields than specified in the SplitKeys parameter.* true: Keep the remaining content.
* false (default): Do not keep the remaining content. |'."\n" .'| ExpandOthers | Boolean | No | false | false | Specifies whether to parse the remaining content.* true: Parse the content. Use the ExpandKeyPrefix parameter to specify a prefix for the names of the extra fields.
* false (default): Do not parse the content. If PreserveOthers is set to true and ExpandOthers is set to false, the remaining content is stored in the \\_decode\\_preserve\\_ field.**Note** If the content of the extra fields is not in standard CSV format, normalize it before storage. |'."\n" .'| ExpandKeyPrefix | String | No | | | The prefix for the names of the extra fields. For example, if you set this parameter to `expand_`, the field names are expand_1, expand_2, and so on. |'."\n" .'| TrimLeadingSpace | Boolean | No | false | false | Specifies whether to ignore leading spaces in field values.* true: Ignore leading spaces.
* false (default): Do not ignore leading spaces. |'."\n" .'| SplitSep | String | No | , | , | The separator. The default value is a comma (,). |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keep the source field.
* false (default): Do not keep the source field. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether to report an error if the specified source field does not exist in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" ."\n" .'#### Single-character separator pattern'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------- | ------------ | ------------ | ----------------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_split_char | The type of the plugin. The value must be processor_split_char. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| SplitSep | String | Yes | | | The separator. This must be a single character. A non-printable character, such as \\u0001, can be used. |'."\n" .'| SplitKeys | String array | Yes | | \\["ip", "time", "method"] | Specify the field names for the extracted content. For example, ["ip", "time", "method"]. |'."\n" .'| PreserveOthers | Boolean | No | false | false | Specifies whether to keep the remaining fields when the number of split fields is greater than the number of keys in SplitKeys.* true: Keep the remaining fields.
* false (default): Do not keep the remaining fields. |'."\n" .'| QuoteFlag | Boolean | No | false | false | Specifies whether to use a quote character.* true: Use a quote character.
* false (default): Do not use a quote character. |'."\n" .'| Quote | String | No | / | \\u0001 | The quote character. This must be a single character. A non-printable character, such as \\u0001, can be used. This parameter is valid only when QuoteFlag is set to true. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether to report an error if the specified source field does not exist in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| NoMatchError | Boolean | No | false | false | Specifies whether to report an error if the specified separator does not match the separator in the log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keep the source field.
* false (default): Do not keep the source field. |'."\n" ."\n" .'#### Multi-character separator pattern'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------- | ------------ | ------------ | ----------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_split_string | The type of the plugin. This parameter is fixed to `processor_split_string`. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| SplitSep | String | Yes | | | The separator. This must be a single character. You can set this parameter to a non-printable character, such as `\\u0001`. |'."\n" .'| SplitKeys | String array | Yes | | \\["key1","key2"] | The field names for the extracted content, such as `["key1","key2"]`. **Note** If the number of fields to split is smaller than the number of keys in the `SplitKeys` parameter, the extra keys are ignored. |'."\n" .'| PreserveOthers | Boolean | No | false | false | Specifies whether to keep the remaining fields when the number of split fields is greater than the number of keys in the `SplitKeys` parameter.* \\`true\\`: Keep the remaining fields.
* \\`false\\` (default): Do not keep the remaining fields. |'."\n" .'| ExpandOthers | Boolean | No | false | false | Specifies whether to expand the remaining fields into separate key-value pairs. This parameter takes effect only when `PreserveOthers` is set to `true`.* \\`true\\`: Expand the fields.
* \\`false\\` (default): Do not expand the fields. |'."\n" .'| ExpandKeyPrefix | String | No | / | expand_ | The prefix for the names of the remaining fields. For example, if you set this parameter to `expand_`, the field names are `expand_1`, `expand_2`, and so on. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether to report an error if the source field specified in `SourceKey` does not exist in the raw log.* \\`true\\`: Report an error.
* \\`false\\` (default): Do not report an error. |'."\n" .'| NoMatchError | Boolean | No | false | false | Specifies whether to report an error if the log content cannot be split by the separator specified in `SplitSep`.* \\`true\\`: Report an error.
* \\`false\\` (default): Do not report an error. |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* \\`true\\`: Keep the source field.
* \\`false\\` (default): Do not keep the source field. |'."\n" ."\n" .'#### Key-value pair pattern'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default Value** | **Example** | **Description** |'."\n" .'| ---------------------------- | -------- | ------------ | ----------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_split_key_value | The plug-in type. Set this to processor_split_key_value. |'."\n" .'| SourceKey | string | Yes | | | The name of the source field. |'."\n" .'| Delimiter | string | No | \\t | \\t | The separator between key-value pairs. The default value is the tab character `\\t`. |'."\n" .'| Separator | string | No | : | : | The separator between the key and the value in a key-value pair. The default value is a colon (:). |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the log after parsing.* true: Keeps the source field.
* false (default): Does not keep the source field. |'."\n" .'| ErrIfSourceKeyNotFound | Boolean | No | true | false | Specifies whether to report an error if the source field is not found in the raw log.* true (default): Reports an error.
* false: Does not report an error. |'."\n" .'| DiscardWhenSeparatorNotFound | Boolean | No | false | false | Specifies whether to discard the key-value pair if the separator is not found.* true: Discards the pair.
* false (default): Does not discard the pair. |'."\n" .'| ErrIfSeparatorNotFound | Boolean | No | true | false | Specifies whether to report an error if the specified separator is not found.* true (default): Reports an error.
* false: Does not report an error. |'."\n" .'| ErrIfKeyIsEmpty | Boolean | No | true | false | Specifies whether to report an error if a key is empty after splitting.* true (default): Reports an error.
* false: Does not report an error. |'."\n" .'| Quote | String | No | | | The quote character. If a value is enclosed in the specified quote characters, the content within the quotes is extracted as the value. This parameter supports multiple characters. By default, this feature is disabled. **Important** * To use a double quotation mark (") as the quote character, you must escape it with a backslash (\\\\\\\\). When a backslash is used with the quote character inside a quoted value, the backslash is included as part of the output value. |'."\n" ."\n" .'#### Grok pattern'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------- | ------------ | ------------ | ----------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_grok | The type of the plugin. This is fixed to processor_grok. |'."\n" .'| CustomPatternDir | String array | No | | | The folder where the custom Grok pattern files are located. The processor_grok plugin reads all files in the folder. If you do not add this parameter, custom Grok pattern files are not imported. **Important** After updating a custom Grok pattern file, restart Logtail for the changes to take effect. |'."\n" .'| CustomPatterns | Map | No | | | Custom GROK patterns. The key is the rule name and the value is the Grok expression. For more information about the default supported expressions, see [processor_grok](https://github.com/alibaba/ilogtail/blob/main/plugins/processor/grok/processor_grok_default_patterns.go). If the expression you need is not in the link, enter a custom Grok expression in Match. If you do not add this parameter, custom GROK patterns are not used. |'."\n" .'| SourceKey | String | No | content | content | The name of the source field. The default value is the content field. |'."\n" .'| Match | String array | Yes | | | An array of Grok expressions. The processor_grok plugin matches logs against the expressions in this list from top to bottom. It returns the result of the first successful match. **Note** Configuring multiple Grok expressions may affect performance. For best performance, use no more than five expressions. |'."\n" .'| TimeoutMilliSeconds | Long | No | | 0 | The maximum time to try fetching fields using a Grok expression, in milliseconds. If you do not add this parameter or set it to 0, no timeout occurs. |'."\n" .'| IgnoreParseFailure | Boolean | No | true | true | Specifies whether to ignore logs that fail to be parsed.* true (default): Ignores the logs.
* false: Deletes the logs. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field after successful parsing.* true (default): Keeps the source field.
* false: Discards the source field. |'."\n" .'| NoKeyError | Boolean | No | false | true | Specifies whether the system reports an error if the source field you specified does not exist in the raw log.* true: Reports an error.
* false (default): Does not report an error. |'."\n" .'| NoMatchError | Boolean | No | true | true | Specifies whether the system reports an error if none of the expressions set in the Match parameter match the log.* true (default): Reports an error.
* false: Does not report an error. |'."\n" .'| TimeoutError | Boolean | No | true | true | Specifies whether the system reports an error if a match times out.* true (default): Reports an error.
* false: Does not report an error. |'."\n" ."\n" .'### Add fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_add_fields | The plugin type. The value must be processor_add_fields. |'."\n" .'| Fields | Map | Yes | | | The field names and values to add. Specify the fields as key-value pairs. Multiple fields can be added. |'."\n" .'| IgnoreIfExist | Boolean | No | false | false | Specifies whether to ignore the new field if a field with the same name already exists.* true: Ignores the new field.
* false (Default): Overwrites the existing field with the new field. |'."\n" ."\n" .'### Drop fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | ------------ | ------------ | ----------------- | -------------- | -------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_drop | The type of the plug-in. The value is fixed to processor_drop. |'."\n" .'| DropKeys | String array | Yes | | | The fields to drop. You can specify multiple fields. |'."\n" ."\n" .'### Rename fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | ------------ | ------------ | ----------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_rename | The type of the plugin. The value is fixed to processor_rename. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether to report an error if a source field is not found in a log.* true: Report an error.
* false: Do not report an error. This is the default value. |'."\n" .'| SourceKeys | String array | Yes | | | The source fields to rename. |'."\n" .'| DestKeys | String array | Yes | | | The new names for the fields. |'."\n" ."\n" .'### Package fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------- | ------------ | ------------ | ----------------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_packjson | The type of the plugin. This value is fixed to processor_packjson. |'."\n" .'| SourceKeys | String array | Yes | | | The raw fields to package. |'."\n" .'| DestKey | String | No | | | The destination field for the packaged data. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to retain the raw fields in the log after parsing.* true (default): Retains the raw fields.
* false: Discards the raw fields. |'."\n" .'| AlarmIfIncomplete | Boolean | No | true | true | Specifies whether to report an error if a specified raw field does not exist in the raw log.* true (default): Reports an error.
* false: Does not report an error. |'."\n" ."\n" .'### Expand JSON fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------- | -------- | ------------ | ----------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_json | The type of the plug-in. This value is fixed to processor_json. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field to parse. |'."\n" .'| NoKeyError | Boolean | No | true | true | Specifies whether to report an error if the specified source field does not exist in the raw log.* true (default): Reports an error.
* false: Does not report an error. |'."\n" .'| ExpandDepth | Int | No | 0 | 1 | The expansion depth for the JSON object. The default value is 0, which indicates no limit. A value of 1 indicates the current level, and so on. |'."\n" .'| ExpandConnector | String | No | \\_ | \\_ | The connector used to join field names during JSON expansion. The default value is an underscore (_). |'."\n" .'| Prefix | String | No | | | The prefix to add to the names of expanded fields. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field in the log after it is parsed.* true (default): Keeps the source field.
* false: Discards the source field. |'."\n" .'| UseSourceKeyAsPrefix | Boolean | No | | | Specifies whether to use the source field name as the prefix for all expanded field names. |'."\n" .'| KeepSourceIfParseError | Boolean | No | true | true | Specifies whether to keep the raw log if parsing fails.* true (default): Keeps the raw log.
* false: Discards the raw log. |'."\n" .'| ExpandArray | Boolean | No | false | false | Specifies whether to expand arrays. This parameter is supported in Logtail 1.8.0 and later versions.* false (default): Does not expand arrays.
* true: Expands arrays. For example, `{"k":["1","2"]}` is expanded into `{"k[0]":"1","k[1]":"2"}`. |'."\n" ."\n" .'### Filter logs'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default Value** | **Example** | **Description** |'."\n" .'| ------------- | ----------- | ------------ | ----------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_filter_regex | The plugin type. The value is fixed to processor_filter_regex. |'."\n" .'| Include | JSON Object | No | | | The key is a log field and the value is a regular expression. A logical AND is applied between key-value pairs. A log is collected only if all specified fields match their corresponding regular expressions. |'."\n" .'| Exclude | JSON Object | No | | | The key is a log field and the value is a regular expression. A logical OR is applied between key-value pairs. A log is discarded if any specified field matches its corresponding regular expression. |'."\n" ."\n" .'### Fetch log time'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------- | -------- | ------------ | ----------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_gotime | The type of the plugin. The value is fixed to processor_gotime. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| SourceFormat | String | Yes | | | The format of the source time. |'."\n" .'| SourceLocation | Int | Yes | | | The time zone of the source time. If this parameter is left empty, the time zone of the host or container where Logtail is running is used. |'."\n" .'| DestKey | String | Yes | | | The destination field for the parsed data. |'."\n" .'| DestFormat | String | Yes | | | The format of the parsed time. |'."\n" .'| DestLocation | Int | No | | | The time zone of the parsed time. If this parameter is left empty, the local time zone is used. |'."\n" .'| SetTime | Boolean | No | true | true | Specifies whether to use the parsed time as the log time.* true (default): Use the parsed time as the log time.
* false: Do not use the parsed time as the log time. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field in the log after it is parsed.* true (default): Keep the source field.
* false: Do not keep the source field. |'."\n" .'| NoKeyError | Boolean | No | true | true | Specifies whether to report an error if the specified source field is not found in the raw log.* true (default): Report an error.
* false: Do not report an error. |'."\n" .'| AlarmIfFail | Boolean | No | true | true | Specifies whether to report an error if parsing the log time fails.* true (default): Report an error.
* false: Do not report an error. |'."\n" ."\n" .'### Transform IP addresses'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | processor_geoip | The plugin type. This value is fixed to processor_geoip. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field that contains the IP address to transform. |'."\n" .'| DBPath | String | Yes | | /user/data/GeoLite2-City_20180102/GeoLite2-City.mmdb | The full path of the GeoIP database. For example, /user/data/GeoLite2-City_20180102/GeoLite2-City.mmdb. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether to report an error if the source field is missing from the raw log.* true: Reports an error.
* false (default): Does not report an error. |'."\n" .'| NoMatchError | Boolean | No | true | true | Specifies whether to report an error if the IP address is invalid or not found in the database.* true (default): Reports an error.
* false: Does not report an error. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field in the log after parsing.* true (default): Keeps the source field.
* false: Does not keep the source field. |'."\n" .'| Language | String | No | zh-CN | zh-CN | The language property. The default value is zh-CN. **Important** Make sure your GeoIP database includes the specified language. |'."\n" ."\n" .'### Data masking'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------- | -------- | ------------ | ----------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_desensitize | The type of the plugin. The value is fixed to processor_desensitize. |'."\n" .'| **SourceKey** | string | Yes | | | The name of the log field. |'."\n" .'| **Method** | string | Yes | | const | The desensitization method. Valid values:* **const**: Replaces sensitive content with a specified string. Use the **ReplaceString** parameter to specify the string.
* **md5**: Replaces sensitive content with its MD5 hash. |'."\n" .'| **Match** | string | No | full | full | The method to identify the sensitive content. Valid values:* **full** (default): Replaces the entire value of the target field.
* **regex**: Uses a regular expression to identify the sensitive content. |'."\n" .'| **ReplaceString** | string | No | | | The string that replaces the sensitive content. This parameter is required if you set **Method** to **const**. |'."\n" .'| **RegexBegin** | string | No | | | The regular expression that matches the prefix of the sensitive content. This parameter is required if you set **Match** to **regex**. |'."\n" .'| **RegexContent** | string | No | | | The regular expression that matches the sensitive content. This parameter is required if you set **Match** to **regex**. |'."\n" ."\n" .'### Field value mapping'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_dict_map | The plugin type. This value is fixed to processor_dict_map. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| MapDict | Map | No | | | The mapping dictionary. Use this parameter to configure a small mapping dictionary. A local CSV dictionary file is not required. **Important** If you set the DictFilePath parameter, the settings in the MapDict parameter do not take effect. |'."\n" .'| DictFilePath | String | No | | | A dictionary file in CSV format. This file uses a comma (,) as the separator and double quotation marks (") to enclose field references. |'."\n" .'| DestKey | String | No | | | The name of the destination field. |'."\n" .'| HandleMissing | Boolean | No | false | false | Specifies whether to process a raw log if the destination field is missing.* true: Process the log. The system fills the field with the value of the Missing parameter.
* false (default): Do not process the log. |'."\n" .'| Missing | String | No | Unknown | Unknown | The value to use for the destination field if it is missing from the raw log. The default value is Unknown. This parameter takes effect only when HandleMissing is set to `true`. |'."\n" .'| MaxDictSize | Int | No | 1000 | 1000 | The maximum size of the mapping dictionary. The default value is 1000, which means you can store up to 1000 mapping rules. To limit the server memory used by the plugin, decrease this value. |'."\n" .'| Mode | String | No | overwrite | overwrite | The action to take if the destination field already exists in the raw log.* overwrite (default): Overwrites the original field.
* fill: Does not overwrite the original field. |'."\n" ."\n" .'### Field encryption'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------- | ------------ | ------------ | -------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_encrypt | The type of the plugin. The value is fixed to processor_encrypt. |'."\n" .'| SourceKey | String array | Yes | | | The names of the source fields. |'."\n" .'| EncryptionParameters | Object | Yes | | | The configuration for the encryption key. |'."\n" .'| Key | String | Yes | | | The encryption key. The value must be a 64-character hexadecimal string. |'."\n" .'| IV | String | No | 00000000000000000000000000000000 | | The initialization vector (IV) for encryption. The value must be a 32-character hexadecimal string. The default value is `00000000000000000000000000000000`. |'."\n" .'| KeyFilePath | Boolean | No | | | The path to the file that contains the encryption parameters. If this parameter is not set, the system uses the path from File Path in the **Input Settings** of the Logtail configuration. |'."\n" .'| KeepSourceValueIfError | String | No | false | false | Specifies whether to keep the original field value if encryption fails.* \\`true\\`: Keeps the original value.
* \\`false\\` (default): Does not keep the original value.If encryption fails, the field value is replaced with `ENCRYPT_ERROR`. |'."\n" ."\n" .'### String replacement'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_string_replace | The type of the plugin. The value is fixed to processor_string_replace. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| Method | String | Yes | | | Specifies the matching method. Valid values:* `const`: Replaces content with a string.
* `regex`: Replaces content using a regular expression.
* `unquote`: Removes escape characters. |'."\n" .'| Match | String | No | | | The content to match.* If `Method` is set to `const`, enter the string to replace. All matching strings are replaced.
* If `Method` is set to `regex`, enter the regular expression to match the content to replace. All matching strings are replaced. You can also use regular expression groups to match specific groups.
* If `Method` is set to `unquote`, this parameter is not required. |'."\n" .'| ReplaceString | String | No | | | The string used for replacement. The default value is "".* If `Method` is set to `const`, enter the string to replace the original content.
* If `Method` is set to `regex`, enter the string to replace the original content. Replacement based on regular expression groups is supported.
* If `Method` is set to `unquote`, this parameter is not required. |'."\n" .'| DestKey | String | No | | | Specifies a new field for the replaced content. By default, no new field is added. |'."\n" ."\n" .'### Data encoding and decoding'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_base64_encoding | The type of the plugin. This parameter is fixed to processor_base64_encoding. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| NewKey | String | Yes | | | The name of the field that stores the encoded result. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether to report an error if the source field does not exist in the raw log.* true: Reports an error.
* false (default): Does not report an error. |'."\n" ."\n" .'### Log to metric'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------ | --------- | ------------ | ----------------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_log_to_sls_metric | The plugin type. The value is fixed to processor_log_to_sls_metric. |'."\n" .'| MetricTimeKey | String | No | | | Specifies the time field in the log. This field is mapped to the `__time_nano__` field in the time series data. By default, the value of the `__time__` field is used. Make sure the specified field is a valid UNIX timestamp. Supported units include seconds (10 digits), milliseconds (13 digits), microseconds (16 digits), and nanoseconds (19 digits). |'."\n" .'| MetricLabelKeys | \\[]String | Yes | | | Specifies the list of keys for the `__labels__` field. The keys must follow the regular expression `^[a-zA-Z_][a-zA-Z0-9_]*$`. The values cannot contain vertical bars (|) or `#$#`. For more information, see [Time series data (Metric)](~~171773~~). Do not add the `__labels__` field to the MetricLabelKeys parameter. If the original log contains a `__labels__` field, its value is appended to the new `__labels__` field. |'."\n" .'| MetricValues | Map | Yes | | | Specifies the metric name and metric value. The metric name corresponds to the `__name__` field and must follow the regular expression `^[a-zA-Z_:][a-zA-Z0-9_:]*$`. The metric value corresponds to the `__value__` field and must be of the Double type. For more information, see [Time series data (Metric)](~~171773~~). |'."\n" .'| CustomMetricLabels | Map | No | | | Custom `__labels__` fields. The keys must follow the regular expression `^[a-zA-Z_][a-zA-Z0-9_]*$`. The values cannot contain vertical bars (|) or `#$#`. For more information, see [Time series data (Metric)](~~171773~~). |'."\n" .'| IgnoreError | Boolean | No | | | Specifies whether to output an error log if no logs are matched. The default value is false, which means no error log is output. |'."\n" ."\n" .'### Log to trace'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default Value** | **Example** | **Description** |'."\n" .'| ---------------------- | -------- | ------------ | ----------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_otel_trace | The type of the plug-in. This parameter is fixed to processor_otel_trace. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| Format | String | Yes | | json | The format after transformation. Valid values: protobuf, json, and protojson. |'."\n" .'| NoKeyError | Boolean | No | false | true | Specifies whether to report an error if the source field does not exist in the log. The default value is false. |'."\n" .'| TraceIDNeedDecode | Boolean | No | | | Specifies whether to decode the TraceID from Base64. The default value is false. If you set Format to protojson and the TraceID is Base64-encoded, set TraceIDNeedDecode to true. Otherwise, the transformation fails. |'."\n" .'| SpanIDNeedDecode | Boolean | No | | | Specifies whether to decode the SpanID from Base64. The default value is false. If you set Format to protojson and the SpanID is Base64-encoded, set SpanIDNeedDecode to true. Otherwise, the transformation fails. |'."\n" .'| ParentSpanIDNeedDecode | Boolean | No | | | Specifies whether to decode the ParentSpanID from Base64. The default value is false. If you set Format to protojson and the ParentSpanID is Base64-encoded, set ParentSpanIDNeedDecode to true. Otherwise, the transformation fails. |'."\n" ."\n" .'## Output plugins'."\n" ."\n" .'### SLS output plugin'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default Value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ------------- | ----------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | flusher_sls | The type of the plugin. This value is fixed to flusher_sls. |'."\n" .'| Logstore | string | Yes | / | test-logstore | The name of the Logstore. |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateMachineGroup' => [ 'summary' => 'Creates a machine group.', 'path' => '/machinegroups', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The information about the machine group.', 'type' => 'object', 'properties' => [ 'groupName' => ['description' => 'The name of the machine group. The name must meet the following requirements:'."\n" ."\n" .'- The name of each machine group in a project must be unique.'."\n" ."\n" .'- It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- It must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- It must be 3 to 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group', 'title' => ''], 'machineIdentifyType' => ['description' => 'The type of the machine group identifier. Valid values:'."\n" ."\n" .'- ip: The machine group uses IP addresses as identifiers.'."\n" ."\n" .'- userdefined: The machine group uses custom identifiers.', 'type' => 'string', 'required' => true, 'example' => 'ip', 'default' => 'ip', 'title' => ''], 'groupType' => ['description' => 'The type of the machine group. The parameter can be left empty.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '""'], 'groupAttribute' => [ 'title' => '', 'description' => 'The attributes of the machine group.', 'type' => 'object', 'properties' => [ 'groupTopic' => ['description' => 'The log topic of the machine group.', 'type' => 'string', 'required' => false, 'example' => 'testtopic', 'title' => ''], 'externalName' => ['description' => 'The identifier of the external management system on which the machine group depends.', 'type' => 'string', 'required' => false, 'example' => 'testgroup', 'title' => ''], ], 'required' => false, 'example' => '', ], 'machineList' => [ 'title' => '', 'description' => 'The identifiers of machine group.'."\n" ."\n" .'- If you set machineIdentifyType to ip, enter the IP address of the machine.'."\n" ."\n" .'- If you set machineIdentifyType to userdefined, enter a custom identifier.', 'type' => 'array', 'items' => ['description' => 'The machine identifier. Enter an IP address or a custom identifier based on the type of the machine group.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => '', 'required' => false], 'required' => true, 'example' => '', ], ], 'required' => true, 'example' => 'ali-test-project', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateMachineGroup', 'description' => '### Usage notes'."\n" ."\n" .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | MachineGroupAlreadyExist| groupName already exists. | 机器组已存在。 |'."\n" .'| 400 | InvalidParameter| invalid group resource json. | 无效机器组参数。 |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], ], ], 'CreateMaterializedView' => [ 'summary' => 'Creates a materialized view.', 'path' => '/materializedviews', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'abilityTreeCode' => '294418', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project. This parameter is specified in the request path.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the materialized view. The name must be unique within the project, 2 to 63 characters long, and contain only lowercase letters, digits, hyphens (-), and underscores (_). It must also start and end with a lowercase letter or a digit.', 'type' => 'string', 'title' => '', 'example' => ''], 'logstore' => ['description' => 'The destination Logstore for the aggregated data from the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], 'originalSql' => ['description' => 'The query statement that defines the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], 'aggIntervalMins' => ['description' => 'The aggregation interval in minutes. The system creates aggregation tasks based on this interval.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'startTime' => ['description' => 'The time when the materialized view starts to aggregate data. Specify the time as a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'ttl' => ['description' => 'The time-to-live (TTL) of the data in the materialized view, in days. After this period, the data expires and is automatically deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], 'description' => 'The configuration of the materialized view.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateMaterializedView', ], 'CreateMaxComputeExport' => [ 'summary' => 'Creates a MaxCompute data shipping job.', 'path' => '/maxcomputeexports', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203409', 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The body parameters.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The unique identifier of the MaxCompute data shipping job.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456'."\n", 'title' => ''], 'displayName' => ['description' => 'The display name of the MaxCompute data shipping job.', 'type' => 'string', 'required' => true, 'example' => 'my-mc-job', 'title' => ''], 'description' => ['description' => 'The description of the MaxCompute data shipping job.', 'type' => 'string', 'example' => 'Create a MaxCompute delivery task', 'required' => false, 'title' => ''], 'configuration' => ['description' => 'The setting of the MaxCompute data shipping job.', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateMaxComputeExport', 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'CreateMetricStore' => [ 'summary' => 'Creates a Metricstore to store metrics.', 'path' => '/metricstores', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225682', 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the Metricstore to create.', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store', 'title' => ''], 'ttl' => ['description' => 'The data retention period of the Metricstore. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', 'title' => ''], 'shardCount' => ['description' => 'The number of [shards](~~28976~~) for the Metricstore.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], 'autoSplit' => ['description' => 'Specifies whether to enable automatic shard splitting.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'true'], 'maxSplitShard' => ['description' => 'The maximum number of shards into which a shard can be split. This parameter is valid only if autoSplit is set to true.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => '', 'required' => false], 'mode' => ['description' => 'The type of the Metricstore. Only standard is supported. The default value is standard.', 'type' => 'string', 'default' => 'standard', 'title' => '', 'required' => false, 'example' => 'standard'], 'metricType' => ['description' => 'The type of the Metricstore. Only prometheus is supported. The default value is prometheus.', 'type' => 'string', 'default' => 'prometheus', 'title' => '', 'required' => false, 'example' => 'prometheus'], 'hot_ttl' => ['description' => 'The period for which data is stored in the hot tier. Unit: days. The value must be at least 7 and cannot be greater than the value of ttl. If you set this parameter to -1, all data is stored in the hot tier for the duration specified by ttl.'."\n" ."\n" .'When the hot storage period ends, the data is moved to the IA storage class. For more information, see [Tiered Storage of Hot and Cold Data](~~308645~~).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '60'], 'infrequentAccessTTL' => ['description' => 'The retention period of data in the IA storage class. Unit: days. The minimum value is 30. After this period, data is moved to Archive Storage.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], 'appendMeta' => ['description' => 'Specifies whether to record the public IP address of the client. The default value is false.'."\n" ."\n" .'- true: Records the public IP address.'."\n" ."\n" .'- false: Does not record the public IP address.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], 'shardingPolicy' => ['description' => 'The write hashing configuration.', '$ref' => '#/components/schemas/ShardingPolicy', 'title' => '', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'MetricStoreAlreadyExist', 'errorMessage' => 'The specified metricstore xxx already exists.', 'description' => 'The specified metricstore xxx already exists.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateMetricStore', 'description' => 'A [Metricstore](~~171723~~) is used to store [metrics](~~174965~~).'."\n" ."\n" .'- The Host in the request syntax consists of a project name and a Simple Log Service Endpoint. The project name must be specified in the Host.'."\n" ."\n" .'- An AccessKey pair is required. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has full permissions on all API operations. This poses a high security risk. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform operations and maintenance (O\\&M). If you use a RAM user, you must grant the RAM user the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- The name and region of the project are required. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'- A project can contain a maximum of 200 Logstores or Metricstores.'."\n" ."\n" .'- Metrics are deleted after the specified data retention period ends.'."\n" ."\n" .'- A Logstore and a Metricstore in the same project cannot have the same name.', 'changeSet' => [ ['createdAt' => '2025-12-03T01:37:07.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-12-02T11:55:01.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-11-24T09:35:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateMetricStore', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#name}'], ], ], ], ], ], 'CreateOSSExport' => [ 'summary' => 'Exports logs from a Logstore to an OSS bucket.', 'path' => '/ossexports', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203278', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configuration of the OSS data shipping job.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the job. The name must meet the following requirements:'."\n" ."\n" .'The job name must be unique within the project.'."\n" ."\n" .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- The name must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456', 'title' => ''], 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'my-oss-job', 'title' => ''], 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Create a Unit OSS delivery task', 'required' => false, 'title' => ''], 'configuration' => ['description' => 'The configuration of the job.', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'CreateOSSHDFSExport' => [ 'summary' => 'Creates an export job from OSS to HDFS in a specified project.', 'path' => '/osshdfsexports', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203480', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configuration of the OSS to Hadoop Distributed File System (HDFS) export job.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the job. The name must be unique within the project and follow these conventions:'."\n" ."\n" .'The job name must be unique within the project.'."\n" ."\n" .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- The name must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456', 'title' => ''], 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'my-oss-hdfs-job'."\n", 'title' => ''], 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Create a Unit OSS-HDFS delivery task', 'required' => false, 'title' => ''], 'configuration' => ['description' => 'The configuration of the job.', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateOSSHDFSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'CreateOSSIngestion' => [ 'summary' => 'Creates an OSS import task in a specified project.', 'path' => '/ossingestions', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203082', 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configuration of the OSS import job.', 'type' => 'object', 'properties' => [ 'description' => ['description' => 'The job description.', 'type' => 'string', 'example' => 'Task description', 'required' => false, 'title' => ''], 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'OSS import', 'required' => true, 'title' => ''], 'schedule' => ['description' => 'The scheduling configuration. This parameter is optional. To meet specific timing requirements, such as importing data at 8:00 AM every Monday, use a cron expression.', '$ref' => '#/components/schemas/Schedule', 'required' => false, 'title' => '', 'example' => ''], 'configuration' => ['description' => 'The OSS import configuration.', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration', 'title' => '', 'example' => ''], 'name' => ['description' => 'The job name. The naming conventions are as follows:'."\n" ."\n" .'The job name must be unique within the project.'."\n" ."\n" .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- The name must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateOSSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'CreateProject' => [ 'summary' => 'Creates a project.', 'path' => '/', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8733', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'description' => ['description' => 'The description of the project.', 'type' => 'string', 'required' => true, 'example' => 'this is test', 'title' => ''], 'projectName' => ['description' => 'The project name must be unique in a region. You cannot change the name after you create the project. The name must meet the following requirements:'."\n" ."\n" .'- The name must be globally unique.'."\n" ."\n" .'- The name can contain only lowercase letters, digits, and hyphens (-).'."\n" ."\n" .'- The name must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- The name must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-project'], 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-aekzf******sxby'], 'dataRedundancyType' => [ 'description' => 'The disaster recovery type. Valid values:'."\n" ."\n" .'- LRS: locally redundant storage'."\n" ."\n" .'- ZRS: zone-redundant storage', 'type' => 'string', 'example' => 'LRS', 'enum' => ['LRS', 'ZRS'], 'title' => '', 'required' => false, ], 'recycleBinEnabled' => [ 'description' => 'Specifies whether to enable the recycle bin feature.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '', ], ], 'required' => true, 'example' => 'test-project', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateProject', 'description' => '### Usage notes'."\n" ."\n" .'- An AccessKey pair is required. For more information, see[AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations, which is high risk. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have permissions to manage Simple Log Service resources. For more information, see[Create a RAM user and authorize the RAM user](~~47664~~).'."\n" ."\n" .'- A project name must be globally unique in an Alibaba Cloud region and cannot be changed after the project is created.'."\n" ."\n" .'- For limits on the number of projects per Alibaba Cloud account, see[Basic resources](~~86660~~).'."\n" ."\n" .'### Authorization information'."\n" ."\n" .'The following table describes the authorization information for this API operation. You can add this information to the Action element of a RAM policy statement to grant RAM users or RAM roles permissions to call this operation.'."\n" ."\n" .'| Action | Resource in policy |'."\n" .'| :------------------ | :-------------------------------------------------------- |'."\n" .'| `log:CreateProject` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', 'requestParamsDescription' => '**Sample request**'."\n" ."\n" .'```'."\n" .'POST / HTTP/1.1'."\n" .'Host:test-project.cn-hangzhou.log.aliyuncs.com'."\n" .'Content-Type:application/json'."\n" ."\n" .'{'."\n" .' "description" : "this is test",'."\n" .' "projectName" : "test-project",'."\n" .' "resourceGroupId" : "rg-aekzf******sxby"'."\n" .'}'."\n" .'```', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | ProjectAlreadyExist | Project already exist. | Project已存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#projectName}'], ], ], ], ], ], 'CreateS3Ingestion' => [ 'summary' => 'Creates an S3 file import job.', 'path' => '/s3ingestions', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '263575', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'testproject', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], 'schedule' => ['$ref' => '#/components/schemas/Schedule', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'configuration' => ['description' => 'The configuration.', '$ref' => '#/components/schemas/S3IngestionConfiguration', 'required' => false, 'title' => '', 'example' => ''], 'name' => ['description' => 'The name of the job. Follow these naming rules:'."\n" ."\n" .'Each job in the same project must have a unique name.'."\n" ."\n" .'- Use only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- Start and end with a lowercase letter or digit.'."\n" ."\n" .'- Be 2 to 64 characters long.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'title' => 'CreateS3Ingestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateSavedSearch' => [ 'summary' => 'Creates a saved search.', 'path' => '/savedsearches', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '10284', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ 'savedsearchName' => ['description' => 'The name of the saved search. The name must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'pv in minutes', 'title' => ''], 'searchQuery' => ['description' => 'The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the `Search statement|Analytic statement` format. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).', 'type' => 'string', 'required' => true, 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time', 'title' => ''], 'logstore' => ['description' => 'The name of the Logstore to which the saved search belongs.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore', 'title' => ''], 'topic' => ['description' => 'The topic of the logs.', 'type' => 'string', 'required' => true, 'example' => 'theme', 'title' => ''], 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'displayname', 'title' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateSavedSearch', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :---------------------- | :--------------------------------------------------------------------------------------- |'."\n" .'| `log:CreateSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], ], ], 'CreateScheduledSQL' => [ 'summary' => 'Creates a scheduled SQL job in a specified project.', 'path' => '/scheduledsqls', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209629', 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configurations of the scheduled SQL job.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The job name. The name must be unique within a project.'."\n" ."\n" .'The naming convention is as follows:'."\n" ."\n" .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- The name must start and end with a lowercase letter or a digit.'."\n" ."\n" .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456', 'title' => ''], 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-scheduled-sql', 'title' => ''], 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Create a scheduled SQL task', 'required' => false, 'title' => ''], 'schedule' => ['description' => 'The scheduling configuration for the job.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], 'configuration' => ['description' => 'The configuration of the job.', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateScheduledSQL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'CreateSqlInstance' => [ 'summary' => 'If you use Standard SQL to analyze a large volume of data, a single query may not be able to scan all logs within a specified time range, which can result in incomplete data. Adding shards improves read and write performance, but this change applies only to new data. To analyze a larger volume of data in a single query, you can enable Dedicated SQL and increase its compute resources.', 'path' => '/sqlinstance', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project for which you want to enable Dedicated SQL.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'cu' => ['description' => 'The number of compute units (CUs). CUs are the compute cores that can be used in parallel when Dedicated SQL is running.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '2'], 'useAsDefault' => ['description' => 'Specifies whether to enable Dedicated SQL by default for the project. If you set this parameter to \\`true\\`, all query and analysis operations in the project, such as alerting and dashboards, use Dedicated SQL.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateSqlInstance', 'description' => '**Ensure that you understand the billing methods and [pricing](~~223777~~) of Dedicated SQL before you use this operation.**', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateSqlInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], 'CreateStoreView' => [ 'summary' => 'Creates a dataset.', 'path' => '/storeviews', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208488', 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The dataset configuration.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the dataset.'."\n" ."\n" .'- The name can contain only lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- The name must start with a lowercase letter.'."\n" ."\n" .'- The name must be 3 to 62 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], 'storeType' => [ 'description' => 'The type of the dataset. Set this parameter to metricstore to create a Metricstore dataset. Set this parameter to logstore to create a Logstore dataset.', 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'type' => 'string', 'required' => true, 'example' => 'logstore', 'title' => '', ], 'stores' => [ 'description' => 'A list of Logstores or Metricstores.', 'type' => 'array', 'items' => ['description' => 'A Logstore or Metricstore.', 'required' => true, '$ref' => '#/components/schemas/StoreViewStore', 'title' => '', 'example' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateStoreView', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateStoreView', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateTicket' => [ 'summary' => 'Obtains a ticket. Simple Log Service allows you to share the query and analysis pages and dashboard pages with other users and embed the console pages into third-party systems. This way, other users can view your logs in password-free mode. The URLs of the shared pages are referred to as password-free URLs. You can call the CreateTicket operation to obtain a ticket and generate a password-free URL based on the ticket and the URL of the console page that you want to share.', 'path' => '/tickets', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'expirationTime', 'in' => 'query', 'schema' => ['description' => '- You must use the Simple Log Service endpoint for the China (Shanghai) or Singapore region to call the CreateTicket operation. After you obtain the ticket, you can use the ticket regardless of the region.'."\n" ."\n" .'- The validity period for the URL of the console page that you want to embed. Unit: seconds. Default value: 86400 (one day). Valid values: 0 to 2592000 (30 days).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86400', 'title' => ''], ], [ 'name' => 'accessTokenExpirationTime', 'in' => 'query', 'schema' => ['description' => '- The validity period of the access token. Unit: seconds. Default value: 86400, which specifies one day. Valid values: 0 to 86400.'."\n" ."\n" .'- The validity period of the access token is the smaller value between accessTokenExpirationTime and expirationTime.'."\n" ."\n" .'- If you use a Security Token Service (STS) token to call this operation, the validity period of the access token is the smallest value among accessTokenExpirationTime, expirationTime, and the validity period of the STS token.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ 'ticket' => ['description' => 'The ticket that is used for logon-free access.', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', 'title' => 'CreateTicket', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteAgentInstanceConfig' => [ 'summary' => 'Deletes a process configuration.', 'path' => '/agentinstanceconfigs/{configType}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227415', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'configType', 'in' => 'path', 'schema' => [ 'description' => 'The type of the process-level configuration.', 'enumValueTitles' => [ 'apm_biz_trace' => 'apm\\_biz\\_trace', 'apm_self_protect' => 'apm\\_self\\_protect', 'apm_convergence' => 'apm\\_convergence', 'apm_custom_extract' => 'apm\\_custom\\_extract', 'apm_pilot' => 'apm\\_pilot', 'apm_trace' => 'apm\\_trace', 'rum_app_config' => 'rum\\_app\\_config', 'security_rasp' => 'security\\_rasp', 'rum_web_config' => 'rum\\_web\\_config', 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', 'apm_intacheap' => 'apm\\_intacheap', 'apm_user_method' => 'apm\\_user\\_method', 'apm_global' => 'apm\\_global', 'apm_forward_process' => 'apm\\_forward\\_process', ], 'type' => 'string', 'required' => true, 'example' => 'apm_biz_trace', 'title' => '', ], ], [ 'name' => 'attributes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'The process to which the process-level configuration belongs.', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" .'"service": "test-service"', 'title' => ''], 'description' => 'The process to which the configuration applies.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteAgentInstanceConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'DeleteAlert' => [ 'summary' => 'Deletes an alert rule.', 'path' => '/alerts/{alertName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '200218', 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteAnnotationData' => [ 'summary' => 'Deletes data from a dataset.', 'path' => '/ml/annotationdataset/{datasetId}/annotationdata/{annotationdataId}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], [ 'name' => 'annotationdataId', 'in' => 'path', 'schema' => ['description' => 'The unique ID of the data.', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteAnnotationData', 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteAnnotationDataSet' => [ 'summary' => 'Deletes a dataset. You can delete a dataset only if it contains no data structures.', 'path' => '/ml/annotationdataset/{datasetId}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteAnnotationDataSet', 'description' => 'The endpoint for this API is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteAnnotationLabel' => [ 'summary' => 'Deletes a custom annotation label.', 'path' => '/ml/annotationlabel/{labelId}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'labelId', 'in' => 'path', 'schema' => ['description' => 'The label ID.', 'type' => 'string', 'required' => false, 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteAnnotationLabel', 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteAzureBlobIngestion' => [ 'summary' => 'Create a file import task from Azure Blob', 'path' => '/azureblobingestions/{azureBlobIngestionName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '291243', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteAzureBlobIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'DeleteCollectionPolicy' => [ 'summary' => 'Deletes a log collection rule for an Alibaba Cloud product.', 'path' => '/collectionpolicy/{policyName}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194655', 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ 'name' => 'policyName', 'in' => 'path', 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'maxLength' => 63, 'minLength' => 3, 'example' => 'your_log_policy', 'title' => ''], ], [ 'name' => 'productCode', 'in' => 'query', 'schema' => ['description' => 'The code of the product.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''], ], [ 'name' => 'dataCode', 'in' => 'query', 'schema' => ['description' => 'The code of the log type.', 'type' => 'string', 'required' => false, 'example' => 'access_log', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteCollectionPolicy', 'description' => 'This API can be called only from endpoints in the China (Shanghai), Singapore, and China (Heyuan) Automotive Compliance Cloud (cn-heyuan-acdr-1) regions.', 'responseParamsDescription' => 'For more information about error codes, see [Manage new audit policies](~~2835059~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteConfig' => [ 'summary' => 'Deletes a Logtail configuration.', 'path' => '/configs/{configName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '9090', 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteConfig', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- If a Logtail configuration is applied to a machine group, you cannot collect data from the machine group after you delete the Logtail configuration.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'- The name of the required Logtail configuration is obtained. For more information, see [ListConfig](~~29043~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | ConfigNotExist| Config configname does not exist. | Logtail配置不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteConsumeProcessor' => [ 'summary' => 'Deletes a consume processor.', 'path' => '/consumeprocessors/{processorName}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '225104', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'processorName', 'in' => 'path', 'schema' => ['description' => 'The name of the consume processor.', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteConsumeProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteConsumerGroup' => [ 'summary' => 'Deletes a consumer group.', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'Project name', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['title' => 'Logstore name', 'description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'consumerGroup', 'in' => 'path', 'schema' => ['title' => 'Consumer group', 'description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Length' => [ 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Access-Control-Allow-Origin' => [ 'schema' => ['type' => 'string', 'example' => '*'], ], 'Date' => [ 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteConsumerGroup', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- The name of the consumer group is obtained. For more information, see [ListConsumerGroup](~~74964~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :------------------------ | :---------------------------------------------------------------------------------------------------------------- |'."\n" .'| `log:DeleteConsumerGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], ], ], 'DeleteDashboard' => [ 'summary' => 'Deletes a dashboard.', 'path' => '/dashboards/{dashboardName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '10280', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'Project name', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'dashboardName', 'in' => 'path', 'schema' => ['title' => 'Dashboard name', 'description' => 'The name of the dashboard.', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteDashboard', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteDomain' => [ 'summary' => 'Deletes a custom domain name that is bound to a project.', 'path' => '/domains/{domainName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'domainName', 'in' => 'path', 'schema' => ['description' => 'The domain name to be deleted.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'example.com'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteDomain', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | ParameterInvalid| specified domain does not exist. | 要删除的域名不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteDomain', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], ], ], ], ], ], 'DeleteDownloadJob' => [ 'summary' => 'Deletes a download job.', 'path' => '/downloadjobs/{downloadJobName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '216706', 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ 'name' => 'downloadJobName', 'in' => 'path', 'schema' => [ 'description' => 'The name of the log download job.', 'properties' => [], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'download-123', ], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteDownloadJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteETL' => [ 'summary' => 'Deletes a data transformation job.', 'path' => '/etls/{etlName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203167', 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'etlName', 'in' => 'path', 'schema' => ['description' => 'The name of the data transformation job.', 'type' => 'string', 'required' => true, 'example' => 'etl-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteETL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteElasticsearchIngestion' => [ 'summary' => 'Deletes an ES/OpenSearch ingestion task.', 'path' => '/elasticsearchingestions/{esIngestionName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '273960', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'esIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the ES/OpenSearch ingestion task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteElasticsearchIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'DeleteIndex' => [ 'summary' => 'Deletes an index of a Logstore.', 'path' => '/logstores/{logstore}/index', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteIndex', 'description' => '### Usage notes'."\n" ."\n" .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | ParameterInvalid | Log store index not created. | 没有创建日志索引。 |'."\n" .'| 404 | ProjectNotExist | The Project does not exist : projectName. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist |logstore logstoreName does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteIndex', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], ], 'DeleteIngestProcessor' => [ 'summary' => 'Deletes an ingest processor.', 'path' => '/ingestprocessors/{processorName}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '225107', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'processorName', 'in' => 'path', 'schema' => ['description' => 'The identifier of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'parse-nginx-log'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteIngestProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteLogStore' => [ 'summary' => 'Deletes a Logstore, including all shards and indexes in the Logstore.', 'path' => '/logstores/{logstore}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aliyun-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteLogStore', 'description' => '### Usage notes'."\n" ."\n" .'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 405 | InvalidTimeRange | invalid request method: /logstores/logstoreName| logstoreName参数不合法。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteLogStore', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], ], 'DeleteLogging' => [ 'summary' => 'Deletes the service log for a specified project.', 'path' => '/logging', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'Project 名称。', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteLogging', 'description' => 'The host must be specified as a combination of the project name and the Simple Log Service endpoint.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteLogs' => [ 'path' => '/logstores/{logstore}/deletelogs', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'Request parameters.', 'type' => 'object', 'properties' => [ 'from' => ['description' => 'The start time of the query. This time refers to the log time specified when the log data was written.'."\n" ."\n" .'The time interval defined by the request parameters from and to follows the left-closed, right-open principle. That is, the interval includes the start time but does not include the end time. If the values of from and to are the same, the interval is invalid, and the function returns an error directly.'."\n" .'Unix timestamp format, indicating the number of seconds elapsed since 1970-01-01 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268100', 'title' => ''], 'to' => ['description' => 'The end time of the query. This time refers to the log time specified when the log data was written.'."\n" ."\n" .'The time interval defined by the request parameters from and to follows the left-closed, right-open principle. That is, the interval includes the start time but does not include the end time. If the values of from and to are the same, the interval is invalid, and the function returns an error directly.'."\n" .'Unix timestamp format, indicating the number of seconds elapsed since 1970-01-01 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200', 'title' => ''], 'query' => ['description' => 'Optional: The query statement used to filter the logs to be updated. For more information, see [Query overview](~~43772~~).'."\n" ."\n" .'Note: This parameter supports only query statements. Analysis statements such as SPL and SQL are not supported.', 'type' => 'string', 'required' => false, 'example' => 'status:400', 'title' => ''], 'rowId' => ['description' => 'Optional: The value of the built-in field __rowid__ that is automatically returned in the query results.'."\n" ."\n" .'One of rowId and query must be specified. If both are specified, rowId takes precedence.', 'type' => 'string', 'required' => false, 'example' => ' 0|1000001|638732499', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-project-test', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'Queries data in the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'affectedRows' => ['description' => 'The number of log rows that were deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete logs', 'summary' => 'Deletes log data from a Logstore under a specified project', 'description' => 'The Host is composed of the project name and the Log Service endpoint. You need to specify the project in the Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"affectedRows\\": 10\\n}","type":"json"}]', ], 'DeleteLogtailPipelineConfig' => [ 'summary' => 'Deletes a Logtail pipeline configuration.', 'path' => '/pipelineconfigs/{configName}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail pipeline configuration.', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteLogtailPipelineConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'description' => 'The UK (London) region is supported. Supported regions are constantly updated.', ], 'DeleteMachineGroup' => [ 'summary' => 'Deletes a machine group. If the Logtail configurations for log collection are applied to a machine group, the configurations are disassociated from the machine group after the machine group is deleted.', 'path' => '/machinegroups/{machineGroup}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group-4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteMachineGroup', 'description' => '### Usage notes'."\n" ."\n" .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | MachineGroupNotExist| MachineGroup groupName does not exist.| 机器组不存在。 |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], ], ], 'DeleteMaterializedView' => [ 'summary' => 'Deletes a materialized view.', 'path' => '/materializedviews/{name}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'abilityTreeCode' => '294477', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteMaterializedView', ], 'DeleteMaxComputeExport' => [ 'summary' => 'Deletes a MaxCompute data shipping job.', 'path' => '/maxcomputeexports/{mcExportName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203413', 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'mcExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the MaxCompute data shipping job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteMaxComputeExport', 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteMetricStore' => [ 'summary' => 'Deletes an existing Metricstore. When you delete a Metricstore, the metric data stored in the Metricstore and associated resources such as associated collection settings and transformation settings are also deleted.', 'path' => '/metricstores/{name}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225684', 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => 'The specified metricstore xxx does not exist.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteMetricStore', 'description' => 'Metricstores are used to store metric data. For more information, see [Metric data](~~174965~~).'."\n" ."\n" .'- You must specify an existing Metricstore.'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query metric data is obtained. The information includes the name of the project to which the metric data belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'- You can create up to 200 Logstores or Metricstores in a project.'."\n" ."\n" .'- Metric data is automatically deleted when the retention period of the metric data ends.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteOSSExport' => [ 'summary' => 'Deletes a specified OSS data shipping job.', 'path' => '/ossexports/{ossExportName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203472', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'Project name', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The name of the OSS data shipping job.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'machine', ], 'DeleteOSSHDFSExport' => [ 'summary' => 'Deletes an OSS-HDFS data shipping job.', 'path' => '/osshdfsexports/{ossExportName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203483', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n" ."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteOSSHDFSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteOSSIngestion' => [ 'summary' => 'Deletes an OSS import task.', 'path' => '/ossingestions/{ossIngestionName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203138', 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'ossIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the OSS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteOSSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'DeleteProject' => [ 'summary' => 'Deletes a specified project.', 'path' => '/', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '8740', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test', 'title' => ''], ], [ 'name' => 'forceDelete', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteProject', 'description' => '### Description'."\n" ."\n" .'- The Host parameter consists of a project name and a Simple Log Service Endpoint. You must specify the project name in the Host parameter.'."\n" ."\n" .'- You must create and obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has permissions on all API operations, which poses a high security threat. We recommend that you use a RAM user to call API operations or perform O\\&M. The RAM user must have the permissions to operate on Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- When you delete a project, all its log data and configurations are released and cannot be recovered. To prevent data loss, confirm the action before you delete the project.'."\n" ."\n" .'### Authorization'."\n" ."\n" .'The following table lists the authorization information for this API operation. To grant a RAM user or RAM role the permissions to call this API operation, add this information to the Action element of a RAM access policy statement.'."\n" ."\n" .'| Action | Resource description in an authorization policy |'."\n" .'| :------------------ | :-------------------------------------------------------- |'."\n" .'| `log:DeleteProject` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', 'requestParamsDescription' => 'Request example:'."\n" ."\n" .'DELETE / HTTP/1.1 Host:ali-project-test.cn-hangzhou.log.aliyuncs.com Content-Type:application/json'."\n" ."\n" .'Common request parameters', 'responseParamsDescription' => 'Response example:'."\n" ."\n" .'HTTP/1.1 200 OK', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist| The Project does not exist : projectName. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}'], ], ], ], ], ], 'DeleteProjectPolicy' => [ 'summary' => 'Deletes a project policy.', 'path' => '/policy', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '157643', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteProjectPolicy', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteProjectPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteS3Ingestion' => [ 'path' => '/s3ingestions/{s3IngestionName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '263584', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 's3IngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the S3 ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'title' => 'DeleteS3Ingestion', 'summary' => 'Deletes an S3 ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'DeleteSavedSearch' => [ 'summary' => 'Deletes a saved search.', 'path' => '/savedsearches/{savedsearchName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'savedsearchName', 'in' => 'path', 'schema' => ['description' => 'The name of the saved search to be deleted.', 'type' => 'string', 'required' => true, 'example' => 'test-savedsearch-name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteSavedSearch', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- After you delete a saved search, it cannot be restored. Proceed with caution.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :---------------------- | :--------------------------------------------------------------------------------------- |'."\n" .'| `log:DeleteSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], ], ], 'DeleteScheduledSQL' => [ 'summary' => 'Deletes a Scheduled SQL job.', 'path' => '/scheduledsqls/{scheduledSQLName}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '209792', 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteScheduledSQL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteScheduledSQL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteStoreView' => [ 'summary' => 'Deletes a dataset by using the name of the dataset.', 'path' => '/storeviews/{name}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '208667', 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteStoreView', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteStoreView', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeRegions' => [ 'path' => '/regions', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226892', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'language', 'in' => 'query', 'schema' => [ 'title' => 'A short description of struct', 'description' => 'The language of the returned `localName` value.', 'enumValueTitles' => ['ja' => 'ja', 'en' => 'en', 'zh' => 'zh'], 'type' => 'string', 'required' => false, 'example' => 'zh', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'regions' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'region' => ['description' => 'The ID of the region.', 'type' => 'string', 'title' => '', 'example' => ''], 'localName' => ['description' => 'The display name of the region.', 'type' => 'string', 'title' => '', 'example' => ''], 'intranetEndpoint' => ['description' => 'The intranet endpoint of the region.', 'type' => 'string', 'title' => '', 'example' => ''], 'internetEndpoint' => ['description' => 'The public endpoint of the region.', 'type' => 'string', 'title' => '', 'example' => ''], 'internalEndpoint' => ['description' => 'The accelerated endpoint of the region.', 'type' => 'string', 'title' => '', 'example' => ''], 'dataRedundancyType' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => 'The supported data redundancy types.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of available regions and their details.', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeRegions', 'summary' => 'Queries the available regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regions\\": [\\n {\\n \\"region\\": \\"\\",\\n \\"localName\\": \\"\\",\\n \\"intranetEndpoint\\": \\"\\",\\n \\"internetEndpoint\\": \\"\\",\\n \\"internalEndpoint\\": \\"\\",\\n \\"dataRedundancyType\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'DisableAlert' => [ 'summary' => 'Disables an alert rule.', 'path' => '/alerts/{alertName}?action=disable', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '200858', 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DisableAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:DisableAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DisableScheduledSQL' => [ 'summary' => 'Disables the Scheduled SQL feature.', 'path' => '/scheduledsqls/{scheduledSQLName}?action=disable', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '219106', 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DisableScheduledSQL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:DisableScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'EnableAlert' => [ 'summary' => 'Enables an alert rule.', 'path' => '/alerts/{alertName}?action=enable', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '200854', 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'EnableAlert', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:EnableAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'EnableScheduledSQL' => [ 'summary' => 'Enables the Scheduled SQL feature.', 'path' => '/scheduledsqls/{scheduledSQLName}?action=enable', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '219089', 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'EnableScheduledSQL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:EnableScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetAgentInstanceConfig' => [ 'path' => '/agentinstanceconfigs/{configType}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227420', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'configType', 'in' => 'path', 'schema' => [ 'description' => 'The type of the process-level configuration.', 'enumValueTitles' => [ 'apm_biz_trace' => 'apm\\_biz\\_trace', 'apm_self_protect' => 'apm\\_self\\_protect', 'apm_convergence' => 'APM Convergence', 'apm_custom_extract' => 'apm\\_custom\\_extract', 'apm_pilot' => 'apm\\_pilot', 'apm_trace' => 'apm\\_trace', 'rum_app_config' => 'rum\\_app\\_config', 'security_rasp' => 'security\\_rasp', 'rum_web_config' => 'rum\\_web\\_config', 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', 'apm_intacheap' => 'apm\\_intacheap', 'apm_user_method' => 'apm\\_user\\_method', 'apm_global' => 'apm\\_global', 'apm_forward_process' => 'apm\\_forward\\_process', ], 'type' => 'string', 'required' => true, 'example' => 'apm_biz_trace', 'title' => '', ], ], [ 'name' => 'attributes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'Process configuration owner', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" .'"service": "test-service"', 'title' => ''], 'description' => 'The owner of the process-level configuration.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'configType' => ['description' => 'The type of the process-level configuration.', 'type' => 'string', 'title' => '', 'example' => 'apm_biz_trace'], 'attributes' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'The source of the process configuration.', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" .'"service": "test-service"', 'title' => ''], 'description' => 'The owner of the configuration for the process.', 'title' => '', 'example' => '', ], 'config' => ['description' => 'The default configuration.', 'type' => 'string', 'title' => '', 'example' => '{}'], 'grayConfigs' => [ 'type' => 'array', 'items' => ['description' => 'A canary release configuration.', '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', 'title' => '', 'example' => ''], 'title' => '', 'description' => 'The canary release configurations.', 'example' => '', ], 'createTime' => ['description' => 'The time when the configuration was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1749543828'], 'lastModifyTime' => ['description' => 'The time when the configuration was last modified.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1749543828'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAgentInstanceConfig', 'summary' => 'Retrieves a process-level configuration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"configType\\": \\"apm_biz_trace\\",\\n \\"attributes\\": {\\n \\"key\\": \\"\\\\\\"workspace\\\\\\": \\\\\\"test-workspace\\\\\\"\\\\n\\\\\\"service\\\\\\": \\\\\\"test-service\\\\\\"\\"\\n },\\n \\"config\\": \\"{}\\",\\n \\"grayConfigs\\": [\\n {\\n \\"condition\\": \\"appVersion=\\\\\\"1.0.0\\\\\\"\\",\\n \\"content\\": \\"{\\\\\\"enable\\\\\\":true}\\"\\n }\\n ],\\n \\"createTime\\": 1749543828,\\n \\"lastModifyTime\\": 1749543828\\n}","type":"json"}]', ], 'GetAlert' => [ 'summary' => 'Queries the information about an alert rule.', 'path' => '/alerts/{alertName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '200220', 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => ['description' => 'The configurations of the alert rule.', '$ref' => '#/components/schemas/Alert', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"alert-123456\\",\\n \\"displayName\\": \\"alertNameExample\\",\\n \\"description\\": \\"Alert Desc\\",\\n \\"configuration\\": {\\n \\"muteUntil\\": 1698907508,\\n \\"version\\": \\"2.0\\",\\n \\"type\\": \\"default\\",\\n \\"templateConfiguration\\": {\\n \\"id\\": \\"sls.app.ack.ip.not_enough\\",\\n \\"type\\": \\"sys\\",\\n \\"version\\": \\"1\\",\\n \\"lang\\": \\"cn\\",\\n \\"tokens\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"aonotations\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"dashboard\\": \\"DasnboardExample\\",\\n \\"threshold\\": 1,\\n \\"noDataFire\\": false,\\n \\"noDataSeverity\\": 6,\\n \\"sendResolved\\": false,\\n \\"queryList\\": [\\n {\\n \\"chartTitle\\": \\"chartExmaple\\",\\n \\"query\\": \\"* | select *\\",\\n \\"timeSpanType\\": \\"Relative\\",\\n \\"start\\": \\"-5m\\",\\n \\"end\\": \\"now\\",\\n \\"storeType\\": \\"log\\",\\n \\"project\\": \\"projectExample\\",\\n \\"store\\": \\"store Example\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"roleArn\\": \\"\\",\\n \\"dashboardId\\": \\"dashboardExample\\",\\n \\"powerSqlMode\\": \\"auto\\",\\n \\"ui\\": \\"\\"\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"key\\": \\"title\\",\\n \\"value\\": \\"example value\\"\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"key\\": \\"title\\",\\n \\"value\\": \\"example value\\"\\n }\\n ],\\n \\"conditionConfiguration\\": {\\n \\"condition\\": \\"cnt > 100\\",\\n \\"countCondition\\": \\"__count__ > 5\\"\\n },\\n \\"severityConfigurations\\": [\\n {\\n \\"severity\\": 8,\\n \\"evalCondition\\": {\\n \\"condition\\": \\"cnt > 100\\",\\n \\"countCondition\\": \\"__count__ > 5\\"\\n }\\n }\\n ],\\n \\"joinConfigurations\\": [\\n {\\n \\"type\\": \\"left_join\\",\\n \\"condition\\": \\"$0.id == $1.id\\"\\n }\\n ],\\n \\"groupConfiguration\\": {\\n \\"type\\": \\"custom\\",\\n \\"fields\\": [\\n \\"id\\"\\n ]\\n },\\n \\"policyConfiguration\\": {\\n \\"alertPolicyId\\": \\"sls.builtin.dynamic\\",\\n \\"actionPolicyId\\": \\"example_action_policy\\",\\n \\"repeatInterval\\": \\"10m\\"\\n },\\n \\"autoAnnotation\\": false,\\n \\"sinkEventStore\\": {\\n \\"enabled\\": true,\\n \\"endpoint\\": \\"cn-shanghai-intranet.log.aliyuncs.com\\",\\n \\"project\\": \\"exampleProject\\",\\n \\"eventStore\\": \\"exampleStore\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\"\\n },\\n \\"sinkCms\\": {\\n \\"enabled\\": true\\n },\\n \\"sinkAlerthub\\": {\\n \\"enabled\\": true\\n },\\n \\"tags\\": [\\n \\"host\\"\\n ]\\n },\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"createTime\\": 1695090077,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"ENABLED/DISABLED\\"\\n}","type":"json"}]', ], 'GetAnnotationData' => [ 'summary' => 'Retrieves a data struct from a dataset by its unique identity.', 'path' => '/ml/annotationdataset/{datasetId}/annotationdata/{annotationdataId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', 'schema' => ['description' => 'The unique identity of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], [ 'name' => 'annotationdataId', 'in' => 'path', 'schema' => ['description' => 'The unique identity of the data.', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The data struct.', '$ref' => '#/components/schemas/MLDataParam', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"annotationdataId\\": \\"dc74b0f569126bb310e1ba6454c351ac\\",\\n \\"dataHash\\": \\"59db060bd89468245d76416a68a510ac\\",\\n \\"datasetId\\": \\"cb8cc4eb51a85e823471cdb368fae9be\\",\\n \\"value\\": \\"xxx/xxx/xxx/\\",\\n \\"valueType\\": \\"oss\\",\\n \\"config\\": {\\n \\"key\\": \\"simulator-nginx-demo\\"\\n },\\n \\"annotations\\": {\\n \\"key\\": {\\n \\"annotatedBy\\": \\"xxxx\\",\\n \\"updateTime\\": 1694761550,\\n \\"results\\": [\\n {\\n \\"key\\": \\"SPIKE_UP_TYPE\\"\\n }\\n ]\\n }\\n },\\n \\"predictions\\": {\\n \\"key\\": {\\n \\"annotatedBy\\": \\"xxx\\",\\n \\"updateTime\\": 1694761550,\\n \\"results\\": [\\n {\\n \\"key\\": \\"SPIKE_UP_TYPE\\"\\n }\\n ]\\n }\\n },\\n \\"createTime\\": 1695094335,\\n \\"lastModifyTime\\": 1695094335\\n}","type":"json"}]', 'title' => 'GetAnnotationData', 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetAnnotationDataSet' => [ 'summary' => 'Retrieves information about a dataset.', 'path' => '/ml/annotationdataset/{datasetId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The dataset struct.', '$ref' => '#/components/schemas/MLDataSetParam', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"datasetId\\": \\"d9bd488f6dd42d294495fb780858e83d\\",\\n \\"name\\": \\"sls_builtin_dataset_metric.shapeclassification.anomalydetection\\",\\n \\"description\\": \\"数据集A\\",\\n \\"dataType\\": \\"Metric\\",\\n \\"labelId\\": \\"a191ae4ca615b0ccb93c211fc8a998af\\",\\n \\"createTime\\": 1695090077,\\n \\"lastModifyTime\\": 1695090077,\\n \\"createBy\\": \\"sls-console\\",\\n \\"settingType\\": \\"Metric.ShapeClassification.AnomalyDetection\\"\\n}","type":"json"}]', 'title' => 'GetAnnotationDataSet', 'description' => 'The endpoint for this API is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetAnnotationLabel' => [ 'summary' => 'Retrieves a label table by its ID.', 'path' => '/ml/annotationlabel/{labelId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'labelId', 'in' => 'path', 'schema' => ['description' => 'The ID of the label.', 'type' => 'string', 'required' => false, 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The label table struct.', '$ref' => '#/components/schemas/MLLabelParam', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"labelId\\": \\"abbd488f6dd42d294495fb780858e83d\\",\\n \\"name\\": \\"标签表\\",\\n \\"description\\": \\"默认表\\",\\n \\"type\\": \\"xxx\\",\\n \\"settings\\": [\\n {\\n \\"mode\\": \\"builtin\\",\\n \\"type\\": \\"Trace.RCA\\",\\n \\"config\\": \\"\\\\\\"\\\\\\"\\",\\n \\"version\\": \\"0.01\\"\\n }\\n ],\\n \\"createTime\\": 1695090077,\\n \\"lastModifyTime\\": 1695090077\\n}","type":"json"}]', 'title' => 'GetAnnotationLabel', 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetAppliedConfigs' => [ 'summary' => 'Queries the Logtail configurations that are applied to a machine group.', 'path' => '/machinegroups/{machineGroup}/configs', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'The information about the Logtail configurations.', 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of Logtail configurations.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'configs' => [ 'title' => '', 'description' => 'The names of the Logtail configurations.', 'type' => 'array', 'items' => ['description' => 'The information about the Logtail configuration.', 'type' => 'string', 'example' => '[ "two", "three", "test_logstore" ]', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 2,\\n \\"configs\\": [\\n \\"[ \\\\\\"two\\\\\\", \\\\\\"three\\\\\\", \\\\\\"test_logstore\\\\\\" ]\\"\\n ]\\n}","type":"json"}]', 'title' => 'GetAppliedConfigs', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | MachineGroupNotExist| MachineGroup groupName does not exist. | 机器组不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetAppliedConfigs', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], ], ], 'GetAppliedMachineGroups' => [ 'summary' => 'Queries the machine groups to which a Logtail configuration is bound.', 'path' => '/configs/{configName}/machinegroups', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'The information about the machine groups.', 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of returned machine groups.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], 'machinegroups' => [ 'title' => '', 'description' => 'The names of the returned machine groups.', 'type' => 'array', 'items' => ['description' => 'The name of the machine group.', 'type' => 'string', 'title' => '', 'example' => 'sample-group1'], 'example' => '[ "sample-group1","sample-group2" ]', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 2,\\n \\"machinegroups\\": [\\n \\"sample-group1\\"\\n ]\\n}","type":"json"}]', 'title' => 'GetAppliedMachineGroups', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | ConfigNotExist | Config confiName does not exist. | Logtail配置不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetAppliedMachineGroups', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], ], ], 'GetAsyncSql' => [ 'summary' => 'Retrieves the status and results of an asynchronous SQL query.', 'path' => '/asyncsql/{queryId}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '292959', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'allowEmptyValue' => true, 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'sls-demo-project', 'title' => ''], ], [ 'name' => 'queryId', 'in' => 'path', 'schema' => ['description' => 'The ID of the asynchronous SQL query. This ID is fixed throughout the SQL lifecycle.', 'type' => 'string', 'required' => false, 'example' => '690C4F2A16FBD65C40000484_14', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The offset for paginated results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'line', 'in' => 'query', 'schema' => ['description' => 'The number of results to return per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The data format of the response body. This corresponds to the protobuf format.', '$ref' => '#/components/schemas/AsyncSqlResponseData', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAsyncSql', 'description' => 'After you submit an SQL request using the SubmitAsyncSql operation, you can use this operation to poll the execution status of the request. You can set the polling interval to 1 second or longer. When the query is complete, use the GetAsyncSql operation to retrieve the results in pages.', 'responseParamsDescription' => 'The error\\_code and error\\_message parameters are valid only when the state parameter is FAILED.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"id\\": \\"690C4F2A16FBD65C40000484_14\\",\\n \\"state\\": \\"FINISHED\\",\\n \\"AsyncSqlMetaPB\\": {\\n \\"result_rows\\": 12000,\\n \\"processed_rows\\": 10000000,\\n \\"elapsed_milli\\": 30000,\\n \\"cpu_sec\\": 0.2,\\n \\"cpu_cores\\": 10,\\n \\"progress\\": \\"Complete\\",\\n \\"keys\\": [\\n \\"[\\\\\\"name\\\\\\", \\\\\\"age\\\\\\", \\\\\\"gender\\\\\\"]\\"\\n ]\\n },\\n \\"rows\\": [\\n [\\n \\"[\\\\\\"Jimmy\\\\\\", \\\\\\"20\\\\\\", \\\\\\"male\\\\\\"]\\"\\n ]\\n ],\\n \\"error_code\\": \\"InvalidQuery\\",\\n \\"error_message\\": \\"line 37:14: Column \'xyz\' cannot be resolved\\"\\n}","type":"json"}]', ], 'GetAzureBlobIngestion' => [ 'path' => '/azureblobingestions/{azureBlobIngestionName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '291248', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['$ref' => '#/components/schemas/AzureBlobIngestion', 'description' => '', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAzureBlobIngestion', 'summary' => 'Gets the details of an Azure Blob ingestion.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-azure-blob-123456\\",\\n \\"description\\": \\"azure blob ingestion\\",\\n \\"displayName\\": \\"azure blob ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"30m\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"tagPackId\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accountName\\": \\"test001\\",\\n \\"accountKey\\": \\"dGVzdGtleQ==\\",\\n \\"containerName\\": \\"test-container\\",\\n \\"endpoint\\": \\"https://your-storage.blob.core.windows.net\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\"\\n}","type":"json"}]', ], 'GetCheckPoint' => [ 'summary' => 'Queries the checkpoints of a shard from which data is consumed by a consumer group.', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'consumerGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1', 'title' => ''], ], [ 'name' => 'shard', 'in' => 'query', 'schema' => ['description' => 'The shard ID.'."\n" ."\n" .'- If the specified shard does not exist, an empty list is returned.'."\n" ."\n" .'- If no shard ID is specified, the checkpoints of all shards are returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'The checkpoints of the shard from which data is consumed by a consumer group.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'shard' => ['title' => 'shard id。', 'description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'checkpoint' => ['description' => 'The value of the checkpoint.', 'type' => 'string', 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng==', 'title' => ''], 'updateTime' => ['description' => 'The time when the checkpoint was last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1524224984800922', 'title' => ''], 'consumer' => ['description' => 'The consumer at the checkpoint.', 'type' => 'string', 'example' => 'consumer_1', 'title' => ''], ], 'example' => '', ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shard\\": 0,\\n \\"checkpoint\\": \\"MTUyNDE1NTM3OTM3MzkwODQ5Ng==\\",\\n \\"updateTime\\": 1524224984800922,\\n \\"consumer\\": \\"consumer_1\\"\\n }\\n]","type":"json"}]', 'title' => 'GetCheckPoint', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 404 | ConsumerGroupNotExist| consumer group not exist.| 消费组不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetCollectionPolicy' => [ 'summary' => 'You can call the GetCollectionPolicy operation to retrieve the details of a specific rule.', 'path' => '/collectionpolicy/{policyName}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '195429', 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ 'name' => 'policyName', 'in' => 'path', 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'maxLength' => 63, 'minLength' => 3, 'example' => 'your_log_policy'."\n", 'title' => ''], ], [ 'name' => 'productCode', 'in' => 'query', 'schema' => ['description' => 'The code of the product.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''], ], [ 'name' => 'dataCode', 'in' => 'query', 'schema' => ['description' => 'The code for the log type.', 'type' => 'string', 'required' => false, 'example' => 'access_log', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'collectionPolicy' => [ 'description' => 'The details of the rule.', 'type' => 'object', 'properties' => [ 'policyName' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'your_log_policy', 'title' => ''], 'enabled' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], 'productCode' => ['description' => 'The code of the product.', 'type' => 'string', 'example' => 'oss', 'title' => ''], 'dataCode' => ['description' => 'The code for the log type.', 'type' => 'string', 'example' => 'access_log', 'title' => ''], 'policyConfig' => [ 'description' => 'The configuration of the collection rule.', 'type' => 'object', 'properties' => [ 'resourceMode' => ['description' => 'The collection pattern for resources.', 'type' => 'string', 'example' => 'all', 'title' => ''], 'regions' => [ 'description' => 'The regions where the instances reside. Wildcard characters are supported.', 'type' => 'array', 'items' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'title' => '', 'example' => '', ], 'instanceIds' => [ 'description' => 'The instance IDs.', 'type' => 'array', 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'your-test-bucket1'."\n", 'title' => ''], 'title' => '', 'example' => '', ], 'resourceTags' => ['description' => 'The resource tags.', 'type' => 'object', 'example' => '{"tag1":"value1","tag2":"value2"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'centralizeEnabled' => ['description' => 'Indicates whether centralized storage is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'centralizeConfig' => [ 'description' => 'The configuration for centralized shipping.', 'type' => 'object', 'properties' => [ 'destRegion' => ['description' => 'The destination region for centralized shipping.', 'type' => 'string', 'example' => 'cn-beijing'."\n", 'title' => ''], 'destProject' => ['description' => 'The destination project for centralized shipping.', 'type' => 'string', 'example' => 'your-sls-project-in-beijing'."\n", 'title' => ''], 'destLogstore' => ['description' => 'The destination Logstore for centralized shipping.', 'type' => 'string', 'example' => 'your-sls-logstore-in-beijing'."\n", 'title' => ''], 'destTTL' => ['description' => 'The retention period of the destination Logstore. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'resourceDirectory' => [ 'description' => 'The configuration of the resource directory. This parameter is empty if no configuration is specified.', 'type' => 'object', 'properties' => [ 'accountGroupType' => ['description' => 'The mode for selecting accounts in the resource directory. Valid values: \\`all\\` and \\`custom\\`.', 'type' => 'string', 'example' => 'all,custom', 'title' => ''], 'members' => [ 'description' => 'The member accounts. This parameter is returned only when \\`accountGroupType\\` is set to \\`custom\\`.', 'type' => 'array', 'items' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '165***********50', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'dataConfig' => [ 'description' => 'The configuration that is supported only for global log types, such as when \\`productCode\\` is \\`sls\\`. Otherwise, this parameter is empty.', 'type' => 'object', 'properties' => [ 'dataRegion' => ['description' => 'This parameter is supported only for global log types, such as when \\`productCode\\` is \\`sls\\`. This parameter specifies the region to which global logs are collected during the initial configuration.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'dataProject' => ['description' => 'This parameter is valid only for global log types, such as when \\`productCode\\` is \\`sls\\`. If this parameter is left empty, logs are collected to the default project of the account in the specified \\`dataRegion\\`.', 'type' => 'string', 'example' => '""', 'title' => ''], ], 'title' => '', 'example' => '', ], 'internalPolicy' => ['description' => 'Indicates whether the rule is a built-in rule. Built-in rules cannot be modified or deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'policyUid' => ['description' => 'The ID of the Alibaba Cloud account to which the rule belongs. If the rule is created by a resource directory administrator or a delegated administrator, this parameter specifies the ID of the administrator\'s Alibaba Cloud account.', 'type' => 'string', 'example' => '148***********50'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"collectionPolicy\\": {\\n \\"policyName\\": \\"your_log_policy\\",\\n \\"enabled\\": true,\\n \\"productCode\\": \\"oss\\",\\n \\"dataCode\\": \\"access_log\\",\\n \\"policyConfig\\": {\\n \\"resourceMode\\": \\"all\\",\\n \\"regions\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"instanceIds\\": [\\n \\"your-test-bucket1\\\\n\\"\\n ],\\n \\"resourceTags\\": {\\n \\"tag1\\": \\"value1\\",\\n \\"tag2\\": \\"value2\\"\\n }\\n },\\n \\"centralizeEnabled\\": false,\\n \\"centralizeConfig\\": {\\n \\"destRegion\\": \\"cn-beijing\\\\n\\",\\n \\"destProject\\": \\"your-sls-project-in-beijing\\\\n\\",\\n \\"destLogstore\\": \\"your-sls-logstore-in-beijing\\\\n\\",\\n \\"destTTL\\": 0\\n },\\n \\"resourceDirectory\\": {\\n \\"accountGroupType\\": \\"all,custom\\",\\n \\"members\\": [\\n \\"165***********50\\"\\n ]\\n },\\n \\"dataConfig\\": {\\n \\"dataRegion\\": \\"cn-beijing\\",\\n \\"dataProject\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"internalPolicy\\": false,\\n \\"policyUid\\": \\"148***********50\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => 'GetCollectionPolicy', 'description' => 'The endpoint for this operation is available only in the China (Shanghai), Singapore, and China (Heyuan) Automotive Compliance Cloud (cn-heyuan-acdr-1) regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetConfig' => [ 'summary' => 'Gets the details of a Logtail configuration.', 'path' => '/configs/{configName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '9089', 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The data structure of the Logtail configuration.', '$ref' => '#/components/schemas/LogtailConfig', 'title' => '', 'example' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"configName\\": \\"test-config\\",\\n \\"logSample\\": \\"2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world\\",\\n \\"inputType\\": \\"file\\",\\n \\"inputDetail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"outputType\\": \\"LogService\\",\\n \\"outputDetail\\": {\\n \\"endpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"logstoreName\\": \\"test-logstore\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"telemetryType\\": \\"logs\\"\\n },\\n \\"createTime\\": 1655176807,\\n \\"lastModifyTime\\": 1655176807\\n}","type":"json"}]', 'title' => 'GetConfig', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'- The name of the required Logtail configuration is obtained. For more information, see [ListConfig](~~29043~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | ConfigNotExist| Config configName does not exist. | Logtail配置不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], ], ], 'GetConsumeProcessor' => [ 'summary' => 'Retrieves the details of a consume processor.', 'path' => '/consumeprocessors/{processorName}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '225109', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'processorName', 'in' => 'path', 'schema' => ['description' => 'The identifier of the consume processor.', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The details of the consume processor.', '$ref' => '#/components/schemas/ConsumeProcessor', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"processorName\\": \\"consume-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n}","type":"json"}]', 'title' => 'GetConsumeProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetContextLogs' => [ 'summary' => 'Queries the contextual logs of a specified log.', 'path' => '/logstores/{logstore}?type=context_log', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'pack_id', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the log group to which the start log belongs.', 'type' => 'string', 'required' => true, 'example' => '85C897C740352DC6-808', 'title' => ''], ], [ 'name' => 'pack_meta', 'in' => 'query', 'schema' => ['description' => 'The unique context identifier of the start log in the log group.', 'type' => 'string', 'required' => true, 'example' => '2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0', 'title' => ''], ], [ 'name' => 'back_lines', 'in' => 'query', 'schema' => ['description' => 'The number of logs that you want to obtain and are generated before the generation time of the start log. Valid values: `(0,100]`.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'forward_lines', 'in' => 'query', 'schema' => ['description' => 'The number of logs that you want to obtain and are generated after the generation time of the start log. Valid values: `(0,100]`.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'total_lines' => ['description' => 'The total number of logs that are returned. The logs include the start log that is specified in the request.', 'type' => 'integer', 'format' => 'int64', 'example' => '201', 'title' => ''], 'back_lines' => ['description' => 'The number of logs that are generated before the generation time of the start log.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'forward_lines' => ['description' => 'The number of logs that are generated after the generation time of the start log.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'progress' => ['description' => 'Indicates whether the query and analysis results are complete. Valid values:'."\n" ."\n" .'- Complete: The query is successful, and the complete query and analysis results are returned.'."\n" ."\n" .'- Incomplete: The query is successful, but the query and analysis results are incomplete. To obtain the complete results, you must repeat the request.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], 'logs' => [ 'title' => '', 'description' => 'The logs that are returned.', 'type' => 'array', 'items' => ['description' => 'The logs that are returned. The logs are arranged in contextual order. If no contextual logs are found based on the specified start log, this parameter is empty.', 'type' => 'object', 'title' => '', 'example' => '{ "__index_number__": "-100", "__tag__:__pack_id__": "895CEA449A52FE-8c8", "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"}'], 'example' => '', ], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total_lines\\": 201,\\n \\"back_lines\\": 100,\\n \\"forward_lines\\": 100,\\n \\"progress\\": \\"Complete\\",\\n \\"logs\\": [\\n {\\n \\"__index_number__\\": \\"-100\\",\\n \\"__tag__:__pack_id__\\": \\"895CEA449A52FE-8c8\\",\\n \\"__pack_meta__\\": \\"0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetContextLogs', 'description' => '### Usage notes'."\n" ."\n" .'- You can specify a log as the start log. The time range of a contextual query is one day before and one day after the generation time of the start log.'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- Indexes are configured before you query logs. For more information, see [Create indexes](~~90732~~).'."\n" ."\n" .'- The values of the pack\\_id and pack\\_meta fields are obtained before you query logs. The fields are internal fields, and you can obtain the values by using the debugging feature of your browser in the Simple Log Service console.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :--------------------------- | :--------------------------------------------------------------------------------- |'."\n" .'| `log:GetLogStoreContextLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', 'responseParamsDescription' => 'The logs parameter contains log content and the following fields that are formatted in key-value pairs.'."\n" ."\n" .'| Field | Type | Example | Description |'."\n" .'| :-------------------- | :----- | :----------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| `__index_number__` | String | -100 | The position of the log in the context. A negative value indicates that the log is generated before the generation time of the start log. The value 0 indicates that the log is the start log. A positive value indicates that the log is generated after the generation time of the start log. For example, the value -100 indicates that the log is the 100th log before the generation time of the start log. |'."\n" .'| `__tag__:__pack_id__` | String | 895CEA449A52FE-8c8 | The unique identifier of the log group to which the log belongs. The identifier can be used as the value of the pack_id parameter in the request. |'."\n" .'| `__pack_meta__` | String | \\`0 | MTU1OTI4NTExMjg3NTQ2NDU1OA== |', 'extraInfo' => '| HTTP 状态码 | 错误码| 错误信息 | 描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'|404|ProjectNotExist|Project ProjectName does not exist.|Project 不存在。|'."\n" .'|404|LogstoreNotExist|logstore logstoreName does not exist.|Logstore 不存在。|'."\n" .'|400|InvalidParameter|Invalid pack meta/id.|请求参数中的 pack_meta 或 pack_id 为非法值。|'."\n" .'|400|InvalidParameter|back_lines or forward_lines must be postive.|请求参数中的 back_lines 或 forward_lines 中有非法值，其中至少有一个参数应为正数。|'."\n" ."\n" .'更多错误码，请参见[通用错误码](~~29013~~)。'."\n" ."\n" .'**SDK示例**'."\n" ."\n" .'此处以Java SDK为例，请使用Java SDK 0.6.38及以上的版本。 如果您通过Logtail采集方式采集日志，该方式将自动为日志附加上下文信息。 更多示例，请参见[SDK代码示例](https://github.com/aliyun/aliyun-log-java-producer/blob/a5a57cafd9e795ee5a781aa2b0c2742bce3ddef5/src/main/java/com/aliyun/openservices/aliyun/log/producer/internals/SendProducerBatchTask.java)。'."\n" .'```'."\n" .'package sdksample;'."\n" ."\n" .'import com.aliyun.openservices.log.Client;'."\n" .'import com.aliyun.openservices.log.common.LogContent;'."\n" .'import com.aliyun.openservices.log.common.LogItem;'."\n" .'import com.aliyun.openservices.log.common.QueriedLog;'."\n" .'import com.aliyun.openservices.log.common.TagContent;'."\n" .'import com.aliyun.openservices.log.exception.LogException;'."\n" .'import com.aliyun.openservices.log.request.PutLogsRequest;'."\n" .'import com.aliyun.openservices.log.response.GetContextLogsResponse;'."\n" .'import com.aliyun.openservices.log.response.GetLogsResponse;'."\n" ."\n" .'import java.util.ArrayList;'."\n" .'import java.util.Date;'."\n" .'import java.util.List;'."\n" ."\n" .'public class GetContextLogsSample {'."\n" ."\n" .' private static int getCurrentTimestamp() {'."\n" .' return (int) (new Date().getTime() / 1000);'."\n" .' }'."\n" ."\n" .' private static class PackInfo {'."\n" .' public String packID;'."\n" .' public String packMeta;'."\n" ."\n" .' public PackInfo(String id, String meta) {'."\n" .' this.packID = id;'."\n" .' this.packMeta = meta;'."\n" .' }'."\n" .' }'."\n" ."\n" .' private static PackInfo extractPackInfo(QueriedLog log) {'."\n" .' PackInfo ret = new PackInfo("", "");'."\n" .' ArrayList contents = log.GetLogItem().GetLogContents();'."\n" .' for (int i = 0; i < contents.size(); ++i) {'."\n" .' LogContent content = contents.get(i);'."\n" .' if (content.GetKey().equals("__tag__:__pack_id__")) {'."\n" .' ret.packID = content.GetValue();'."\n" .' } else if (content.GetKey().equals("__pack_meta__")) {'."\n" .' ret.packMeta = content.GetValue();'."\n" .' }'."\n" .' }'."\n" .' return ret;'."\n" .' }'."\n" ."\n" .' public static void main(String args[]) throws InterruptedException, LogException {'."\n" .' // 日志服务的服务接入点。此处以杭州为例，其它地域请根据实际情况填写。'."\n" .' String endpoint = "https://cn-hangzhou.log.aliyuncs.com"; '."\n" .' // 本示例从环境变量中获取AccessKey ID和AccessKey Secret。'."\n" .' String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")；'."\n" .' String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"); '."\n" .' // 待查询的Project名称。'."\n" .' String project = "ProjectName"; '."\n" .' // 待查询的Logstore名称。'."\n" .' String logstore = "logstoreName"; '."\n" .' // 构建一个客户端实例。'."\n" .' Client client = new Client(endpoint, accessKeyId, accessKeySecret);'."\n" ."\n" .' System.out.println("请确保指定的logstore已开启索引。");'."\n" .' Thread.sleep(3000);'."\n" ."\n" .' // 使用GetLogs并在查询语句中加上|with_pack_meta来获取起始日志的pack_id和pack_meta。'."\n" .' // 查询时间范围：最近15分钟。'."\n" .' // 起始日志：返回结果的第一条。'."\n" .' String query = "*|with_pack_meta";'."\n" .' GetLogsResponse response = client.GetLogs(project, logstore,'."\n" .' (int) getCurrentTimestamp() - 900, (int) getCurrentTimestamp(),"", query);'."\n" .' ArrayList logs = response.GetLogs();'."\n" .' if (logs.isEmpty()) {'."\n" .' System.out.println("未查询到任何日志。");'."\n" .' System.exit(1);'."\n" .' }'."\n" ."\n" .' // 提取第一条日志的pack信息。'."\n" .' PackInfo info = extractPackInfo(logs.get(0));'."\n" .' if (info.packMeta.isEmpty() || info.packID.isEmpty()) {'."\n" .' System.out.println("pack ID: " + info.packID + ", pack meta: " + info.packMeta);'."\n" .' System.out.println("起始日志的pack信息不完整，请确保该日志是通过logtail写入。");'."\n" .' System.exit(1);'."\n" .' }'."\n" ."\n" .' // 使用得到的pack信息进行上下文查询（双向查询）。'."\n" .' GetContextLogsResponse contextRes = client.getContextLogs(project, logstore,'."\n" .' info.packID, info.packMeta, 10, 10);'."\n" .' System.out.println("双向查询");'."\n" .' System.out.println("pack ID: " + info.packID + ", pack meta: " + info.packMeta);'."\n" .' System.out.println("is complete: " + contextRes.isCompleted());'."\n" .' System.out.println("total lines: " + contextRes.getTotalLines());'."\n" .' System.out.println("back lines: " + contextRes.getBackLines());'."\n" .' System.out.println("forward lines: " + contextRes.getForwardLines());'."\n" .' Thread.sleep(1000);'."\n" ."\n" .' // 使用查询结果中的第一条日志，向前查询上文（单向），至多三次。'."\n" .' List contextLogs = contextRes.getLogs();'."\n" .' for (int i = 0; i < 3 && !contextLogs.isEmpty(); i++) {'."\n" .' QueriedLog log = contextLogs.get(0);'."\n" .' info = extractPackInfo(log);'."\n" .' GetContextLogsResponse res = client.getContextLogs(project, logstore,'."\n" .' info.packID, info.packMeta, 10, 0);'."\n" .' System.out.println("向前查询上文");'."\n" .' System.out.println("pack ID: " + info.packID + ", pack meta: " + info.packMeta);'."\n" .' System.out.println("is complete: " + res.isCompleted());'."\n" .' System.out.println("total lines: " + res.getTotalLines());'."\n" .' System.out.println("back lines: " + res.getBackLines());'."\n" .' System.out.println("forward lines: " + res.getForwardLines());'."\n" .' contextLogs = res.getLogs();'."\n" ."\n" .' Thread.sleep(1000);'."\n" .' }'."\n" ."\n" .' // 使用查询结果中的最后一条日志，向后查询下文（单向），至多三次。'."\n" .' contextLogs = contextRes.getLogs();'."\n" .' for (int i = 0; i < 3 && !contextLogs.isEmpty(); i++) {'."\n" .' QueriedLog log = contextLogs.get(contextLogs.size() - 1);'."\n" .' info = extractPackInfo(log);'."\n" .' GetContextLogsResponse res = client.getContextLogs(project, logstore,'."\n" .' info.packID, info.packMeta, 0, 10);'."\n" .' System.out.println("向后查询下文");'."\n" .' System.out.println("pack ID: " + info.packID + ", pack meta: " + info.packMeta);'."\n" .' System.out.println("is complete: " + res.isCompleted());'."\n" .' System.out.println("total lines: " + res.getTotalLines());'."\n" .' System.out.println("back lines: " + res.getBackLines());'."\n" .' System.out.println("forward lines: " + res.getForwardLines());'."\n" .' contextLogs = res.getLogs();'."\n" ."\n" .' Thread.sleep(1000);'."\n" .' }'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n\n" ."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetCursor' => [ 'summary' => 'Retrieves a cursor based on a specified time.', 'path' => '/logstores/{logstore}/shards/{shardId}?type=cursor', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The logstore name.', 'type' => 'string', 'required' => true, 'example' => 'sls-test-logstore', 'title' => ''], ], [ 'name' => 'shardId', 'in' => 'path', 'schema' => ['title' => 'shard id。', 'description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'from', 'in' => 'query', 'schema' => ['description' => 'A point in time. This can be a UNIX timestamp or the string `begin` or `end`.', 'type' => 'string', 'required' => true, 'example' => 'begin', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => 'The cursor value.', 'type' => 'object', 'properties' => [ 'cursor' => ['description' => 'The cursor value.', 'type' => 'string', 'example' => 'MTQ0NzI5OTYwNjg5NjYzMjM1Ng==', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cursor\\": \\"MTQ0NzI5OTYwNjg5NjYzMjM1Ng==\\"\\n}","type":"json"}]', 'title' => 'GetCursor', 'description' => '### Description'."\n" ."\n" .'- The host consists of a project name and a Simple Log Service endpoint. You must specify the project name in the host.'."\n" ."\n" .'- The relationship among a cursor, a project, a Logstore, and a shard is as follows:'."\n" ."\n" .' - A project contains multiple Logstores.'."\n" ."\n" .' - Each Logstore contains multiple shards.'."\n" ."\n" .' - A cursor indicates the position of a specific log.', 'requestParamsDescription' => 'You can use the from parameter to locate logs within the lifecycle of a shard. If the lifecycle of the Logstore is \\[begin\\_time,end\\_time) and the `from` parameter is set to `from_time`, the behavior is as follows:'."\n" ."\n" .'- If from\\_time is less than or equal to begin\\_time, or if from\\_time is set to \'begin\', the cursor for the position at `begin_time` is returned.'."\n" ."\n" .'- If from\\_time is greater than or equal to end\\_time, or if `from_time` is set to \'end\', the cursor for the position where the next log will be written is returned. No data exists at this cursor position.'."\n" ."\n" .'- If from\\_time is greater than begin\\_time and less than end\\_time, the cursor for the first data packet whose server reception time is greater than or equal to `from_time` is returned.'."\n" ."\n" .'> The lifecycle of a Logstore is specified by the TTL field in its properties. For example, if the current time is `2018-11-11 09:00:00` and the TTL is 5, the time range of data that can be consumed in each shard is `[2018-11-05 09:00:00,2018-11-11 09:00:00)`. This time refers to the server time. For more information, see [Data retention period](~~48990~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | ParameterInvalid | ParameterInvalid | 无效参数。 |'."\n" .'| 400 | ShardNotExist | Shard ShardID does not exist.| Shard不存在。 |'."\n" .'| 400 | LogStoreWithoutShard |The logstore has no shard. | Logstore没有Shard。 |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetCursorOrData', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], ], ], 'GetCursorTime' => [ 'summary' => 'Retrieves the server time that corresponds to a cursor.', 'path' => '/logstores/{logstore}/shards/{shardId}?type=cursor_time', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The logstore name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ 'name' => 'shardId', 'in' => 'path', 'schema' => ['title' => 'shard id。', 'description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'cursor', 'in' => 'query', 'schema' => ['description' => 'The cursor for which you want to obtain the timestamp. Call the [GetCursor](~~2771314~~) operation to obtain a cursor.'."\n" ."\n" .'> If the value of the cursor is less than the begin cursor or greater than the end cursor, InvalidCursor is returned. If the shard contains no data, the current time is returned.', 'type' => 'string', 'required' => true, 'example' => 'MTU0NzQ3MDY4MjM3NjUxMzQ0Ng==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'cursor_time' => ['description' => 'The server time that corresponds to the cursor. The value is a UNIX timestamp. A UNIX timestamp represents the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.', 'type' => 'string', 'example' => '1554260243', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cursor_time\\": \\"1554260243\\"\\n}","type":"json"}]', 'title' => 'GetCursorTime', 'description' => '### Description'."\n" ."\n" .'- The host consists of a project name and a Simple Log Service endpoint. You must specify the project in the host.'."\n" ."\n" .'- Create and obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair that belongs to an Alibaba Cloud account has access permissions on all API operations. Using this AccessKey pair poses a high security threat. For security, we recommend that you create and use a RAM user to call API operations or perform routine operations and maintenance (O\\&M). The RAM user must be granted the permissions to perform operations on Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- Obtain the project name, the project\'s region, and the logstore name. For more information, see [Manage a project](~~48984~~) and [Manage a logstore](~~48990~~).'."\n" ."\n" .'### Authorization'."\n" ."\n" .'The following table describes the authorization information for this operation. Add this information to the Action element of a RAM policy to grant a RAM user or RAM role the permissions to call this API operation.'."\n" ."\n" .'| Action | Resource description in an authorization policy |'."\n" .'| --------------------- | ---------------------------------------------------------------------------------- |'."\n" .'| `log:GetCursorOrData` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 400 | ShardNotExist| Shard shardID does not exist.| Shard不存在。 |'."\n" .'| 400 | LogStoreWithoutShard| the logstore has no shard.| Logstore没有Shard。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetCursorOrData', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], ], ], 'GetDashboard' => [ 'summary' => 'Queries a dashboard.', 'path' => '/dashboards/{dashboardName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '10281', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'dashboardName', 'in' => 'path', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the dashboard.', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Length' => [ 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The data structure of the dashboard.', '$ref' => '#/components/schemas/dashboard', 'title' => '', 'example' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"dashboardName\\": \\"dashboard-1609294922657-434834\\",\\n \\"displayName\\": \\"test-alert\\",\\n \\"description\\": \\"this is a dashboard\\",\\n \\"attribute\\": {\\n \\"key\\": \\"yyy\\"\\n },\\n \\"charts\\": [\\n {\\n \\"title\\": \\"my-chart\\",\\n \\"type\\": \\"linepro\\",\\n \\"search\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"display\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"action\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetDashboard', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ], ], ], ], ], 'GetDownloadJob' => [ 'summary' => 'Retrieves information about a download task.', 'path' => '/downloadjobs/{downloadJobName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '216704', 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ 'name' => 'downloadJobName', 'in' => 'path', 'schema' => [ 'description' => 'The name of the log download task.', 'properties' => [], 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'download-123', ], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The information about the download job.', 'type' => 'object', 'properties' => [ 'status' => ['description' => 'The status of the download task.', 'type' => 'string', 'title' => '', 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR'], 'name' => ['description' => 'The name of the download task.', 'type' => 'string', 'title' => '', 'example' => 'download-123'], 'description' => ['description' => 'The description of the task.', 'type' => 'string', 'title' => '', 'example' => 'a download job'], 'configuration' => [ 'title' => '', 'description' => 'The download configuration.', 'type' => 'object', 'properties' => [ 'logstore' => ['description' => 'The source Logstore.', 'type' => 'string', 'title' => '', 'example' => 'ali-test-logstore'], 'fromTime' => ['description' => 'The start time of the download task. The value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722409860'], 'toTime' => ['description' => 'The end time of the download task. The value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722411060'], 'query' => ['description' => 'The search statement.', 'type' => 'string', 'title' => '', 'example' => '* | select *'], 'powerSql' => ['description' => 'Specifies whether to enable PowerSQL.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'allowInComplete' => [ 'description' => 'Specifies whether to allow downloading incomplete data.', 'enumValueTitles' => ['true' => 'yes', 'false' => 'no'], 'type' => 'boolean', 'example' => 'true', 'title' => '', ], 'sink' => [ 'title' => '', 'description' => 'The export configuration.', 'type' => 'object', 'properties' => [ 'type' => ['description' => 'The value is fixed to AliyunOSS.', 'type' => 'string', 'example' => 'AliyunOSS', 'title' => ''], 'contentType' => ['description' => 'The file format.', 'type' => 'string', 'title' => '', 'example' => 'csv'], 'compressionType' => ['description' => 'The compression format.', 'type' => 'string', 'title' => '', 'example' => 'none'], 'roleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role that is used for the download.', 'type' => 'string', 'title' => '', 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole'], 'bucket' => ['description' => 'The Object Storage Service (OSS) bucket.', 'type' => 'string', 'title' => '', 'example' => 'ali-test-oss-bucket'], 'prefix' => ['description' => 'The prefix of the file that is saved to the bucket.', 'type' => 'string', 'example' => 'download/', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'createTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'title' => '', 'example' => '1722411060'], 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'title' => '', 'example' => 'download-123456'], 'executionDetails' => [ 'title' => '', 'description' => 'The execution details.', 'type' => 'object', 'properties' => [ 'progress' => ['description' => 'The download progress.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], 'filePath' => ['description' => 'The URL of the download result.', 'type' => 'string', 'title' => '', 'example' => 'https://xxx.csv.zst?xxx'], 'fileSize' => ['description' => 'The size of the downloaded file in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123456'], 'executeTime' => ['description' => 'The duration of the download task in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], 'logCount' => ['description' => 'The number of downloaded log entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], 'errorMessage' => ['description' => 'The error message if the download fails.', 'type' => 'string', 'title' => '', 'example' => 'timeout'], 'checkSum' => ['description' => 'The ETag of the file.', 'type' => 'string', 'example' => 'EXSFGSDASDASDG123ASD', 'title' => ''], 'notice' => ['type' => 'string', 'description' => 'Notification text. ', 'example' => 'test', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"STARTING、RUNNING、SUCCEEDED、ERROR\\",\\n \\"name\\": \\"download-123\\",\\n \\"description\\": \\"a download job\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"ali-test-logstore\\",\\n \\"fromTime\\": 1722409860,\\n \\"toTime\\": 1722411060,\\n \\"query\\": \\"* | select *\\",\\n \\"powerSql\\": false,\\n \\"allowInComplete\\": true,\\n \\"sink\\": {\\n \\"type\\": \\"AliyunOSS\\",\\n \\"contentType\\": \\"csv\\",\\n \\"compressionType\\": \\"none\\",\\n \\"roleArn\\": \\"acs:ram::0123456789:role/aliyunlogdefaultrole\\",\\n \\"bucket\\": \\"ali-test-oss-bucket\\",\\n \\"prefix\\": \\"download/\\"\\n }\\n },\\n \\"createTime\\": \\"1722411060\\",\\n \\"displayName\\": \\"download-123456\\",\\n \\"executionDetails\\": {\\n \\"progress\\": 100,\\n \\"filePath\\": \\"https://xxx.csv.zst?xxx\\",\\n \\"fileSize\\": 123456,\\n \\"executeTime\\": 123,\\n \\"logCount\\": 123,\\n \\"errorMessage\\": \\"timeout\\",\\n \\"checkSum\\": \\"EXSFGSDASDASDG123ASD\\",\\n \\"notice\\": \\"test\\"\\n }\\n}","type":"json"}]', 'title' => 'GetDownloadJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetETL' => [ 'summary' => 'Retrieves the configuration of a specified extract, transform, and load (ETL) job.', 'path' => '/etls/{etlName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '203168', 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'etlName', 'in' => 'path', 'schema' => ['description' => 'The name of the ETL job.', 'type' => 'string', 'required' => false, 'example' => 'etl-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The configuration of the ETL job.', '$ref' => '#/components/schemas/ETL', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ETL\\",\\n \\"description\\": \\"ETL\\",\\n \\"displayName\\": \\"ETL\\",\\n \\"configuration\\": {\\n \\"script\\": \\"e_set(\\\\\\"key\\\\\\",\\\\\\"value\\\\\\")\\",\\n \\"lang\\": \\"SPL\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"fromTime\\": 0,\\n \\"toTime\\": 0,\\n \\"sinks\\": [\\n {\\n \\"name\\": \\"test-etljob\\",\\n \\"endpoint\\": \\"\\",\\n \\"project\\": \\"test-project\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"datasets\\": [\\n \\"__UNNAMED__\\"\\n ],\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\"\\n }\\n ],\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714274900,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"f0eb655e501a8780808d1970ef6d04c4\\"\\n}","type":"json"}]', 'title' => 'GetETL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetETL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetElasticsearchIngestion' => [ 'path' => '/elasticsearchingestions/{esIngestionName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '278185', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'esIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the ES/OpenSearch job.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The configuration of the ES/OpenSearch import job.', '$ref' => '#/components/schemas/ESIngestion', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetElasticsearchIngestion', 'summary' => 'Retrieves information about an ES/OpenSearch import job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-es-123456\\",\\n \\"description\\": \\"es ingestion\\",\\n \\"displayName\\": \\"es ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"test-logstore\\",\\n \\"source\\": {\\n \\"BootstrapServers\\": \\"\\",\\n \\"Index\\": \\"\\",\\n \\"Username\\": \\"\\",\\n \\"Password\\": \\"\\",\\n \\"TimeFieldName\\": \\"\\",\\n \\"TimeFormat\\": \\"\\",\\n \\"TimeZone\\": \\"\\",\\n \\"Query\\": \\"\\",\\n \\"ConnectorMode\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"MaxDataDelaySec\\": 0,\\n \\"MinFragRangeSec\\": 0,\\n \\"VpcId\\": \\"\\"\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', ], 'GetGCSIngestion' => [ 'path' => '/gcsingestions/{gcsIngestionName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], ], [ 'name' => 'gcsIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the GCS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The GCS import task.', '$ref' => '#/components/schemas/GCSIngestion', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetGCSIngestion', 'summary' => 'Retrieves a Google Cloud Storage (GCS) file import task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-gcs-123456\\",\\n \\"description\\": \\"gcs ingestion\\",\\n \\"displayName\\": \\"gcs ingestion\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"gcsbucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"never\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"restoreObjectEnabled\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"tagPackId\\": false,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"format\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"lastModifiedTime\\": 1714360581\\n}","type":"json"}]', ], 'GetHistograms' => [ 'summary' => 'Queries the distribution of logs that meet the specified query conditions in a Logstore by calling the GetHistograms operation.', 'path' => '/logstores/{logstore}/index?type=histogram', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The Logstore name.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'from', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The start time of the subinterval. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1409529600'], ], [ 'name' => 'to', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The end time of the subinterval. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1409569200'], ], [ 'name' => 'topic', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The topic of the logs.', 'type' => 'string', 'required' => false, 'example' => 'topic'], ], [ 'name' => 'query', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The query statement. Only query statements are supported. Analytic statements are not supported. For more information about the query syntax, see [Query syntax](~~43772~~).', 'type' => 'string', 'required' => false, 'example' => 'with_pack_meta'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'from' => ['title' => '', 'description' => 'The start time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" ."\n" .'The time interval follows the left-closed, right-open principle. The interval includes the start time but excludes the end time. If the values of from and to are the same, the interval is invalid and the function returns an error.', 'type' => 'integer', 'format' => 'int64', 'example' => '1409529600'], 'to' => ['title' => '', 'description' => 'The end time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" ."\n" .'The time interval follows the left-closed, right-open principle. The interval includes the start time but excludes the end time. If the values of from and to are the same, the interval is invalid and the function returns an error.', 'type' => 'integer', 'format' => 'int64', 'example' => '1409569200'], 'count' => ['title' => '', 'description' => 'The number of logs queried in the subinterval.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'progress' => ['title' => '', 'description' => 'Indicates whether the query results in the subinterval are complete.'."\n" ."\n" .'Complete: The query is complete and the returned results are complete.'."\n" ."\n" .'Incomplete: The query is complete but the returned results are incomplete. Repeat the request to obtain complete results.', 'type' => 'string', 'example' => 'Complete'], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"from\\": 1409529600,\\n \\"to\\": 1409569200,\\n \\"count\\": 2,\\n \\"progress\\": \\"Complete\\"\\n }\\n]","type":"json"}]', 'title' => 'Query log distribution', 'description' => '### Operation description'."\n" ."\n" .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. Specify the project in the Host.'."\n" .'- The subinterval division in the response is always stable. If the time range in your query request remains unchanged, the subinterval division in the response also remains unchanged.'."\n" .'- When the number of logs involved in a query changes significantly, the Simple Log Service API cannot predict how many times this operation needs to be invoked to obtain complete results. Check the progress status value in the response of each request to determine whether to invoke this operation again to obtain the final complete results. Each repeated invocation consumes the same number of query CUs.'."\n" .'- The latency between writing a log to a Logstore and querying the log by using LogSearch operations (GetHistograms and GetLogs) varies depending on the log type. Simple Log Service classifies logs into the following two types based on log UNIX timestamps:'."\n" .' - Real-time data: The time point in the log is within the range of (-180 seconds, 900 seconds] relative to the current server time. For example, if the log time is UTC 2014-09-25 12:03:00 and the server receives the log at UTC 2014-09-25 12:05:00, the log is processed as real-time data. The latency from writing real-time data to querying the data in the LogSearch interface is 3 seconds.'."\n" .' - Historical data: The time point in the log is within the range of [-7x86400 seconds, -180 seconds) relative to the current server time. For example, if the log time is UTC 2014-09-25 12:00:00 and the server receives the log at UTC 2014-09-25 12:05:00, the log is processed as historical data. This typically occurs in data backfill scenarios.'."\n" .' The maximum latency from writing real-time data to querying the data is 3 seconds. In 99.9% of cases, the query is completed within 1 second.'."\n" ."\n" .'> Simple Log Service calculates the difference between the log time (field name: \\_\\_time\\_\\_) and the server receive time (field name: \\_\\_tag\\_\\_:\\_\\_receive\\_time\\__). If the difference is within the range of \\(-180 seconds, 900 seconds], the log is real-time data. If the difference is within the range of \\[-7x86400 seconds, -180 seconds), the log is historical data.'."\n" ."\n" .'- Simple Log Service provides a usage example of GetHistograms queries in the Java SDK. For more information, see [Use GetHistograms to query log distribution](~~462234~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | Error code description |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist| Project does not exist. | The specified project does not exist. |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | The specified Logstore does not exist. |'."\n" .'| 400 | InvalidTimeRange| request time range is invalid. | The specified time range is invalid. |'."\n" .'| 400 | InvalidQueryString| query string is invalid. | The specified query statement is invalid. |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | An internal service invoke error occurred. |'."\n" ."\n" .'For more information, see [Common error codes](~~29013~~).'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetIndex' => [ 'path' => '/logstores/{logstore}/index', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '8966', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ 'description' => 'The information about the index.', 'type' => 'object', 'properties' => [ 'ttl' => ['description' => 'The lifecycle of the index file. Valid values: 7, 30, and 90. Unit: day.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', 'title' => ''], 'max_text_len' => ['description' => 'The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of the max\\_text\\_len parameter. Valid values: 64 to 16384. Unit: bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''], 'log_reduce_white_list' => [ 'title' => '', 'description' => 'The fields in the whitelist that are used to cluster logs. This parameter is valid only if the log clustering feature is enabled.', 'type' => 'array', 'items' => ['description' => 'The field in the whitelist.', 'type' => 'string', 'example' => 'a', 'title' => ''], 'example' => '', ], 'log_reduce_black_list' => [ 'title' => '', 'description' => 'The fields in the blacklist that are used to cluster logs. This parameter is valid only if the log clustering feature is enabled.', 'type' => 'array', 'items' => ['description' => 'The field in the blacklist.', 'type' => 'string', 'example' => 'b', 'title' => ''], 'example' => '', ], 'line' => [ 'title' => '', 'description' => 'The configurations of full-text indexes.', 'type' => 'object', 'properties' => [ 'chn' => ['description' => 'Indicates whether Chinese characters are included. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'caseSensitive' => ['description' => 'Indicates whether case sensitivity is enabled. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'token' => [ 'title' => '', 'description' => 'The delimiters.', 'type' => 'array', 'items' => ['description' => 'The delimiter. Examples: ",", ".", "'."\r".'", and "'."\n" .'".', 'type' => 'string', 'example' => ',', 'title' => ''], 'required' => true, 'example' => '', ], 'include_keys' => [ 'title' => '', 'description' => 'The included fields.', 'type' => 'array', 'items' => ['description' => 'The included field.', 'type' => 'string', 'example' => 'includeField', 'title' => ''], 'example' => '', ], 'exclude_keys' => [ 'title' => '', 'description' => 'The excluded fields.', 'type' => 'array', 'items' => ['description' => 'The excluded field.', 'type' => 'string', 'example' => 'excludeField', 'title' => ''], 'example' => '', ], ], 'example' => '', ], 'keys' => [ 'title' => '', 'description' => 'The configurations of field indexes. A field index is in the key-value format in which the key specifies the name of the field and the value specifies the index configuration of the field.', 'type' => 'object', 'additionalProperties' => [ 'title' => '', 'description' => 'The configurations of the field index.', 'type' => 'object', 'properties' => [ 'caseSensitive' => ['description' => 'Indicates whether case sensitivity is enabled. This parameter is required only when **type** is set to **text**. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean'], 'chn' => ['description' => 'Indicates whether Chinese characters are included. This parameter is required only when **type** is set to **text**. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean'], 'token' => [ 'title' => '', 'description' => 'The delimiters.', 'type' => 'array', 'items' => ['description' => 'The delimiter. This parameter is required only when **type** is set to **text**.', 'type' => 'string'], ], 'type' => ['description' => 'The data type of the field value. Valid values: text, json, double, and long.', 'type' => 'string'], 'doc_value' => ['description' => 'Indicates whether the analytics feature is enabled for the field. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean'], 'alias' => ['description' => 'The alias of the field.', 'type' => 'string'], ], '$ref' => '#/components/schemas/IndexKey', 'example' => '', ], 'example' => '', ], 'log_reduce' => ['description' => 'Indicates whether the log clustering feature is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'lastModifyTime' => ['description' => 'The time when the index configurations were last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1524155379', 'title' => ''], 'index_mode' => ['description' => 'The type of the index.', 'type' => 'string', 'title' => '', 'example' => 'v2'], 'storage' => ['description' => 'The storage type. The value is fixed as pg.', 'type' => 'string', 'title' => '', 'example' => 'pg'], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'GetIndex', 'summary' => 'Queries the index of a Logstore.', 'description' => '### Usage notes'."\n" ."\n" .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 404 | IndexConfigNotExist| index config doesn’t exist. | 查询的索引不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetIndex', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ttl\\": 30,\\n \\"max_text_len\\": 2048,\\n \\"log_reduce_white_list\\": [\\n \\"a\\"\\n ],\\n \\"log_reduce_black_list\\": [\\n \\"b\\"\\n ],\\n \\"line\\": {\\n \\"chn\\": false,\\n \\"caseSensitive\\": false,\\n \\"token\\": [\\n \\",\\"\\n ],\\n \\"include_keys\\": [\\n \\"includeField\\"\\n ],\\n \\"exclude_keys\\": [\\n \\"excludeField\\"\\n ]\\n },\\n \\"keys\\": {\\n \\"key\\": {\\n \\"caseSensitive\\": true,\\n \\"chn\\": true,\\n \\"token\\": [\\n \\"\\"\\n ],\\n \\"type\\": \\"\\",\\n \\"doc_value\\": true,\\n \\"alias\\": \\"\\"\\n }\\n },\\n \\"log_reduce\\": false,\\n \\"lastModifyTime\\": 1524155379,\\n \\"index_mode\\": \\"v2\\",\\n \\"storage\\": \\"pg\\"\\n}","type":"json"}]', ], 'GetIngestProcessor' => [ 'summary' => 'Retrieves information about an ingest processor.', 'path' => '/ingestprocessors/{processorName}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '225108', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'processorName', 'in' => 'path', 'schema' => ['description' => 'The identity of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'parse-nginx-log'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The information about the ingest processor.', '$ref' => '#/components/schemas/IngestProcessor', 'title' => '', 'example' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'GetIngestProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetLogStore' => [ 'path' => '/logstores/{logstore}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '115730', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The Logstore object.', '$ref' => '#/components/schemas/logstore', 'title' => '', 'example' => 'ali-test-logstore'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetLogStore', 'summary' => 'Retrieves the details of a Logstore.', 'description' => '### Description'."\n" ."\n" .'The host consists of the project name and the Log Service endpoint.', 'extraInfo' => '### 错误码'."\n" .'| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetLogStore', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"logstoreName\\": \\"my-logstore\\",\\n \\"ttl\\": 1,\\n \\"shardCount\\": 2,\\n \\"enable_tracking\\": false,\\n \\"autoSplit\\": true,\\n \\"maxSplitShard\\": 6,\\n \\"appendMeta\\": false,\\n \\"telemetryType\\": \\"Metrics\\",\\n \\"createTime\\": 1453949705,\\n \\"lastModifyTime\\": 1524155379,\\n \\"encrypt_conf\\": {\\n \\"enable\\": true,\\n \\"encrypt_type\\": \\"default\\",\\n \\"user_cmk_info\\": {\\n \\"cmk_key_id\\": \\"f5136b95-2420-ab31-xxxxxxxxx\\",\\n \\"arn\\": \\"acs:ram::13234:role/logsource\\",\\n \\"region_id\\": \\"cn-hangzhou\\"\\n }\\n },\\n \\"hot_ttl\\": 60,\\n \\"infrequentAccessTTL\\": 30,\\n \\"mode\\": \\"standard\\",\\n \\"productType\\": \\"aliyun\\",\\n \\"processorId\\": \\"\\",\\n \\"shardingPolicy\\": {\\n \\"shardGroup\\": {\\n \\"keys\\": [\\n \\"userId\\"\\n ],\\n \\"groupCount\\": 8\\n },\\n \\"shardHash\\": {\\n \\"keys\\": [\\n \\"instanceId\\"\\n ],\\n \\"maxHashCount\\": 2\\n },\\n \\"queryActiveTime\\": 1764659409\\n },\\n \\"resourceGroupId\\": \\"\\",\\n \\"enableModify\\": false\\n}","type":"json"}]', ], 'GetLogStoreConfig' => [ 'summary' => 'Retrieves the configuration of a Logstore.', 'path' => '/logstores/{logstore}/config', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'clientIpHeaders' => [ 'type' => 'array', 'items' => ['description' => 'A case-insensitive header key, such as `X-Forwarded-For`.', 'type' => 'string', 'example' => 'X-Forwarded-For', 'title' => ''], 'title' => '', 'description' => 'An array of header keys used to extract the client IP address when data is written to the Logstore. The keys are case-insensitive, but their order in the array is significant. For this feature to work, enable the `appendMeta` option on the Logstore. Log Service searches the request headers for these keys in the specified order and adds the first valid IP address it finds as a log tag.', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetLogStoreConfig', 'description' => '- The `Host` in the request syntax consists of the Project name and the Log Service endpoint.'."\n" ."\n" .'- An AccessKey pair is available. For more information, see [AccessKey](~~29009~~).'."\n" ."\n" .'The AccessKey of an Alibaba Cloud account has full permissions on all APIs and poses a high security risk. Use a RAM user to make API calls or perform routine operations. Grant the RAM user the required permissions to access Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" ."\n" .'- The Project name, region, and Logstore name are obtained. For more information, see [Manage Project](~~48984~~) and [Manage Logstore](~~48990~~).'."\n" ."\n" .'### Authorization'."\n" ."\n" .'To grant a RAM user or RAM role the permission to call this operation, add the following Action to a RAM permission policy.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :---------------------- | :--------------------------------------------------------------------------------- |'."\n" .'| `log:GetLogStoreConfig` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clientIpHeaders\\": [\\n \\"X-Forwarded-For\\"\\n ]\\n}","type":"json"}]', ], 'GetLogStoreMeteringMode' => [ 'summary' => 'Queries the billing mode of a Logstore.', 'path' => '/logstores/{logstore}/meteringmode', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '195981', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'projectName', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'logstoreName', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'meteringMode' => [ 'description' => 'The billing mode. Default value: ChargeByFunction. Valid values: ChargeByFunction and ChargeByDataIngest.', 'type' => 'string', 'example' => 'ChargeByFunction', 'enum' => ['ChargeByFunction', 'ChargeByDataIngest'], 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meteringMode\\": \\"ChargeByFunction\\"\\n}","type":"json"}]', 'title' => 'GetLogStoreMeteringMode', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetLogStoreMeteringMode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetLogging' => [ 'summary' => 'Queries the service log configuration of a project.', 'path' => '/logging', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The service log information.', '$ref' => '#/components/schemas/logging', 'example' => '{"loggingDetails":[{"logstore":"internal-diagnostic_log","type":"consumergroup_log"},{"logstore":"internal-diagnostic_log","type":"logtail_alarm"},{"logstore":"internal-diagnostic_log","type":"logtail_profile"},{"logstore":"internal-diagnostic_log","type":"metering"},{"logstore":"internal-diagnostic_log","type":"scheduled_sql_alert"},{"logstore":"internal-diagnostic_log","type":"logtail_status"},{"logstore":"internal-diagnostic_log","type":"etl_alert"}],"loggingProject":"java-sdk-test-project-name"}'."\n", 'title' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"loggingProject\\": \\"my-project\\",\\n \\"loggingDetails\\": [\\n {\\n \\"type\\": \\"consumergroup_log\\",\\n \\"logstore\\": \\"my-logstore\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetLogging', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], ], ], 'GetLogs' => [ 'summary' => 'Queries log data from a Logstore in the specified project.', 'path' => '/logstores/{logstore}?type=log', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '8954', 'abilityTreeNodes' => ['FEATUREslsCAO32E'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The Logstore to query.', 'type' => 'string', 'required' => true, 'example' => 'example-logstore', 'title' => ''], ], [ 'name' => 'from', 'in' => 'query', 'schema' => ['description' => 'The start of the query time range, based on the log time specified when the log data was written.'."\n" ."\n" .'- The **from** and **to** parameters define a left-closed, right-open interval \\[from, to). If **from** equals **to**, the interval is invalid and the system returns an error.'."\n" ."\n" .'- Value: a UNIX timestamp representing the number of seconds elapsed since January 1, 1970, 00:00:00 UTC.'."\n" ."\n" .'> To avoid missing data, align the query time to the minute level. If a time range is specified in the analytic statement, that time range takes precedence.'."\n" ."\n" .'To specify a time in seconds within an analytic statement, use the [from\\_unixtime function](~~63451~~) or the [to\\_unixtime function](~~63451~~) to convert the time format. Examples:'."\n" ."\n" .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\n" ."\n" .'- `* | SELECT * FROM log WHERE __time__ > to_unixtime(date_parse(\'2022-10-19 15:46:05\', \'%Y-%m-%d %H:%i:%s\')) AND __time__ < to_unixtime(now())`', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185', 'title' => ''], ], [ 'name' => 'to', 'in' => 'query', 'schema' => ['description' => 'The end of the query time range, based on the log time specified when the log data was written.'."\n" ."\n" .'- The **from** and **to** parameters define a left-closed, right-open interval \\[from, to). If **from** equals **to**, the interval is invalid and the system returns an error.'."\n" ."\n" .'- Value: a UNIX timestamp representing the number of seconds elapsed since January 1, 1970, 00:00:00 UTC.'."\n" ."\n" .'> To avoid missing data, align the query time to the minute level. If a time range is specified in the analytic statement, that time range takes precedence.'."\n" ."\n" .'To specify a time in seconds within an analytic statement, use the [from\\_unixtime function](~~63451~~) or the [to\\_unixtime function](~~63451~~) to convert the time format. Examples:'."\n" ."\n" .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\n" ."\n" .'- `* | SELECT * FROM log WHERE __time__ > to_unixtime(date_parse(\'2022-10-19 15:46:05\', \'%Y-%m-%d %H:%i:%s\')) AND __time__ < to_unixtime(now())`', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627269085', 'title' => ''], ], [ 'name' => 'query', 'in' => 'query', 'schema' => ['description' => 'The search statement or analytic statement. See [Query overview](~~43772~~) and [Analysis overview](~~53608~~). To enable the Exclusive SQL feature, add `set session parallel_sql=true;` to the analytic statement. Example: `* | set session parallel_sql=true; select count(*) as pv`. For common query and analysis issues, see [Common errors that occur when you query and analyze logs](~~61628~~).'."\n" ."\n" .'> When the query parameter contains an analytic statement (SQL statement), the `line` and `offset` parameters are ignored. Set both to 0 and use the LIMIT clause in the SQL statement for pagination. See [Page through query and analysis results](~~89994~~).', 'type' => 'string', 'required' => false, 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', 'title' => ''], ], [ 'name' => 'topic', 'in' => 'query', 'schema' => ['title' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', 'description' => 'The log topic. Default value: an empty string. See [Topic](~~48881~~).', 'type' => 'string', 'required' => false, 'example' => 'topic'], ], [ 'name' => 'line', 'in' => 'query', 'schema' => ['description' => 'Valid only when the query parameter is a search statement. Maximum number of logs to return. Valid values: 0 to 100. Default value: 100. See [Page through query and analysis results](~~89994~~).', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '0', 'example' => '100', 'default' => '100', 'title' => '', 'required' => false], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'Valid only when the query parameter is a search statement. The starting row for the query. Default value: 0. See [Page through query and analysis results](~~89994~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'default' => '0', 'title' => '', 'required' => false], ], [ 'name' => 'reverse', 'in' => 'query', 'schema' => ['description' => 'Whether to return logs in descending order of timestamp, with minute-level precision.'."\n" ."\n" .'- true: Descending order (newest first).'."\n" ."\n" .'- false (default): Ascending order (oldest first).'."\n" ."\n" .'>'."\n" ."\n" .'- When the query parameter is a search statement, the reverse parameter controls the sort order.'."\n" ."\n" .'- When the query parameter includes an analytic statement, the reverse parameter is ignored. Use the ORDER BY clause in the SQL statement instead. ORDER BY defaults to ascending (asc). Specify desc for descending order.'."\n" ."\n" .'>', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], [ 'name' => 'powerSql', 'in' => 'query', 'schema' => ['description' => 'Whether to enable the Exclusive SQL feature. See [Enable the Exclusive SQL feature](~~223777~~).'."\n" ."\n" .'- true: Enable Exclusive SQL.'."\n" ."\n" .'- false (default): Use standard SQL.'."\n" ."\n" .'Alternatively, add `set session parallel_sql=true;` to the analytic statement in the **query** parameter to enable Exclusive SQL.', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-progress' => [ 'schema' => ['title' => '查询结果的状态，包括： Complete：查询已经完成，返回结果为完整结果。 Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'type' => 'string', 'example' => 'Complete'], ], 'x-log-count' => [ 'schema' => ['title' => '当前查询结果的日志总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], ], 'x-log-processed-rows' => [ 'schema' => ['title' => '本次查询处理的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], ], 'x-log-elapsed-millisecond' => [ 'schema' => ['title' => '本次查询消耗的毫秒时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => 'The log array. Each element is a log entry.', 'type' => 'array', 'items' => ['description' => 'The log array. Each element is a log entry.', 'type' => 'object', 'example' => '[{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}, {\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}, {\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}, {\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}, {\'remote_addr\': \'198.51.100.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}]', 'title' => ''], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n]","type":"json"}]', 'title' => 'GetLogs', 'description' => '###'."\n" ."\n" .'> Simple Log Service supports scheduled SQL jobs. For details, see [Create a scheduled SQL job](~~286457~~).'."\n" ."\n" .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. Specify the project name in the Host.'."\n" ."\n" .'- Create and obtain an AccessKey pair. For details, see [AccessKey pair](~~2766629~~).'."\n" ."\n" .'Create and use a RAM user to make API calls or perform routine O\\&M. Using an Alibaba Cloud account AccessKey pair grants access to all APIs and poses a high security risk. Ensure the RAM user has the required permissions for Simple Log Service resources. For details, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- Obtain the project name, region, and Logstore name for the logs to query. See [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- Simple Log Service imposes limits on log queries. Design appropriate query and analytic statements and set a reasonable time range. See [Log query limits](~~43772~~) and [Log analysis limits](~~53608~~).'."\n" ."\n" .'- Configure indexes before querying logs. See [Create indexes](~~90732~~).'."\n" ."\n" .'- When the number of matching logs varies significantly, the API cannot predict how many calls are needed to retrieve the complete result. Check the `x-log-progress` header in each response to determine whether to repeat the call. Each repeated call consumes the same number of query capacity units (CUs).'."\n" ."\n" .'- After a log is written to a Logstore, the latency before it becomes queryable through the GetHistograms and GetLogs operations depends on the log type. Simple Log Service classifies logs into two types based on their timestamps:'."\n" ."\n" .' - Real-time data: The log timestamp falls within (-180 seconds, 900 seconds] relative to the current server time. For example, if a log is generated at UTC 2014-09-25 12:03:00 and is received by the server at UTC 2014-09-25 12:05:00, the log is classified as real-time data. This is typical in normal scenarios. Real-time data becomes queryable in about 3 seconds.'."\n" ."\n" .' - Historical data: The log timestamp falls within \\[-7 x 86,400 seconds, -180 seconds) relative to the current server time. For example, if a log is generated at UTC 2014-09-25 12:00:00 and is received by the server at UTC 2014-09-25 12:05:00, the log is classified as historical data. This is typical in data backfill scenarios.'."\n" ."\n" .'> Simple Log Service calculates the difference between the log time (the \\_\\_time\\_\\_ field) and the server receipt time (the \\_\\_tag\\_\\_: **receive\\_time** field). If the difference falls within (-180 seconds, 900 seconds], the log is real-time data. If the difference falls within \\[-7 x 86,400 seconds, -180 seconds), the log is historical data.'."\n" ."\n" .'- Simple Log Service provides Java and Python SDK examples for the GetLogs operation. See [GetLogs examples for Java](~~407683~~) and [GetLogs examples for Python](~~407684~~).'."\n" ."\n" .'### Authorization'."\n" ."\n" .'The following table describes the authorization information required for this operation. Add this information to the Action element of a RAM access policy statement to grant RAM users or RAM roles the permission to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :-------------------- | :--------------------------------------------------------------------------------- |'."\n" .'| `log:GetLogStoreLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 400 | InvalidTimeRange | Request time range is invalid. | 请求的时间区间无效。 |'."\n" .'| 400 | InvalidQueryString | Query string is invalid. | 请求的查询分析语句无效。 |'."\n" .'| 400 | InvalidOffset | Offset is invalid. | 请求的offset参数无效。 |'."\n" .'| 400 | InvalidLine | Line is invalid. | 请求的line参数无效。 |'."\n" .'| 400 | InvalidReverse | Reverse value is invalid.| Reverse参数的值无效。 |'."\n" .'| 400 | IndexConfigNotExist | Logstore without index config. | Logstore未开启索引。 |'."\n" .'| 400 | ParameterInvalid | ErrorType:OLSQueryParseError.ErrorMessage:offset is not available for pagination in sql query, please use limit x,y syntax for pagination.|当query参数中有分析语句（SQL语句）时，建议设置该接口的line参数和offset参数为0，通过SQL语句的LIMIT语法实现翻页。
query参数中的SQL语句存在问题时，您可以参见[查询与分析日志的常见报错](~~61628~~)进行排查。|'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetLogsV2' => [ 'summary' => 'Queries raw log data from a specified Logstore in a project and returns raw logs within a specified time range. The results are compressed before transmission.', 'path' => '/logstores/{logstore}/logs', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179698', 'abilityTreeNodes' => ['FEATUREslsCAO32E'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The Logstore name.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'Accept-Encoding', 'in' => 'header', 'schema' => [ 'title' => '', 'description' => 'The compression method for the response content. SDK users do not need to specify this parameter because the SDK automatically handles compression and decompression.'."\n" ."\n" .'- Java, Python, and Go currently support lz4 and gzip decompression.'."\n" ."\n" .'- php, JavaScript, and C# currently support only gzip decompression.', 'enumValueTitles' => ['lz4' => 'lz4', 'gzip' => 'gzip'], 'type' => 'string', 'required' => false, 'example' => 'lz4', 'default' => 'lz4', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'from' => ['title' => '', 'description' => 'The start time of the query. This time refers to the log time specified when log data is written.'."\n" ."\n" .'The time range defined by the from and to request parameters follows the left-closed, right-open principle. The time range includes the start time but excludes the end time. If the values of from and to are the same, the time range is invalid and the function returns an error.'."\n" .'The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185'], 'to' => ['title' => '', 'description' => 'The end time of the query. This time refers to the log time specified when log data is written.'."\n" ."\n" .'The time range defined by the from and to request parameters follows the left-closed, right-open principle. The time range includes the start time but excludes the end time. If the values of from and to are the same, the time range is invalid and the function returns an error.'."\n" .'The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185'], 'line' => ['title' => '', 'description' => 'The maximum number of logs to return. This parameter is valid only when the query parameter is a query statement (not an analytic statement). Minimum value: 0. Maximum value: 100. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '0', 'example' => '100', 'default' => '100', 'required' => false], 'offset' => ['title' => '', 'description' => 'The row from which the query starts. This parameter is valid only when the query parameter is a query statement (not an analytic statement). The value starts from 0. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'default' => '0', 'required' => false], 'reverse' => ['title' => '', 'description' => 'Specifies whether to return logs in reverse chronological order of log timestamps, accurate to the minute level. This parameter is valid only when the query parameter is a query statement (not an analytic statement).'."\n" ."\n" .'- true: Returns logs in descending order of log timestamps.'."\n" .'- false (default): Returns logs in ascending order of log timestamps.'."\n" ."\n" .'To sort results in an analytic statement, use the ORDER BY syntax. If ORDER BY is set to asc (default), logs are returned in ascending order. If ORDER BY is set to desc, logs are returned in descending order.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], 'powerSql' => ['title' => '', 'description' => 'Specifies whether to enable Dedicated SQL. Disabled by default.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], 'session' => ['description' => 'The query parameter.', 'type' => 'string', 'required' => false, 'example' => 'mode=scan', 'title' => ''], 'topic' => ['description' => 'The topic. Default value: empty string.', 'type' => 'string', 'example' => '""', 'required' => false, 'title' => ''], 'query' => ['title' => '', 'description' => 'The query statement or analytic statement. For more information, see [query overview](~~43772~~) and [analysis overview](~~53608~~).'."\n" ."\n" .'Add set session parallel_sql=true; to the analytic statement in the query parameter to use Dedicated SQL. Example: * | set session parallel_sql=true; select count(*) as pv.'."\n" ."\n" .'Note: When the query parameter contains an analytic statement (SQL statement), the line and offset parameters of this API are invalid. Set them to 0. Use the LIMIT syntax in the SQL statement for pagination. For more information, see Display query and analysis results by page.', 'type' => 'string', 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', 'required' => false], 'forward' => ['description' => 'Specifies whether to page forward or backward for scan or phrase queries.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], 'highlight' => ['description' => 'Specifies whether to enable highlighting.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], 'isAccurate' => ['description' => 'Specifies whether to enable nanosecond-precision ordering.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'content-length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'x-log-bodyrawsize' => [ 'schema' => ['title' => '返回响应内容的大小。', 'type' => 'string'], ], 'connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'content-type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'x-log-compresstype' => [ 'schema' => ['title' => '返回响应内容的压缩格式。', 'type' => 'string'], ], ], 'schema' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'meta' => [ 'description' => 'The metadata of the response.', 'type' => 'object', 'properties' => [ 'progress' => ['description' => 'Indicates whether the query results are complete. Valid values:'."\n" ."\n" .'- Complete: The query is complete and the results are complete.'."\n" .'- Incomplete: The query is complete but the results are incomplete. Repeat the request to obtain complete results.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], 'aggQuery' => ['description' => 'The SQL part after the pipe (|) in the query statement.', 'type' => 'string', 'example' => 'select *', 'title' => ''], 'whereQuery' => ['description' => 'The part before the pipe (|) in the query statement.', 'type' => 'string', 'example' => '*', 'title' => ''], 'hasSQL' => ['description' => 'Indicates whether the query is an SQL query.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'processedRows' => ['description' => 'The number of rows processed in this query.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'elapsedMillisecond' => ['description' => 'The time consumed by this query, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'cpuSec' => ['description' => 'The core-hour consumed by Dedicated SQL.', 'type' => 'number', 'format' => 'double', 'example' => '0.002', 'title' => ''], 'cpuCores' => ['description' => 'The number of CPU cores used.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'keys' => [ 'description' => 'All keys in the query results.', 'type' => 'array', 'items' => ['description' => 'key', 'type' => 'string', 'example' => 'key', 'title' => ''], 'title' => '', 'example' => '', ], 'terms' => [ 'description' => 'All terms in the query statement.', 'type' => 'array', 'items' => ['description' => 'The term.', 'type' => 'object', 'example' => '{term=*, key=}', 'title' => ''], 'title' => '', 'example' => '', ], 'limited' => ['description' => 'The limit on the number of rows. Returned when the SQL statement does not contain a LIMIT clause.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'mode' => ['description' => 'The query mode. Valid values:'."\n" .'- 0: standard query (including SQL)'."\n" .'- 1: phrase query'."\n" .'- 2: SCAN'."\n" .'- 3: SCAN SQL', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'phraseQueryInfo' => [ 'description' => 'The phrase query information.', 'type' => 'object', 'properties' => [ 'scanAll' => ['description' => 'Indicates whether all logs have been scanned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'beginOffset' => ['description' => 'The start offset of the scan results after index filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'endOffset' => ['description' => 'The end offset of the scan results after index filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'endTime' => ['description' => 'The end time of the scan results after index filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'scanBytes' => ['description' => 'The amount of data scanned during the scan, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], 'highlights' => [ 'description' => 'The highlighted content.', 'type' => 'array', 'items' => [ 'description' => 'The highlighted content.', 'items' => ['description' => '高亮日志内容', 'extendType' => 'true', '$ref' => '#/components/schemas/LogContent'], 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'count' => ['description' => 'The number of log entries returned in this query request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'processedBytes' => ['description' => 'The volume of logs processed by the query, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], 'isAccurate' => ['description' => 'Specifies whether to enable nanosecond-precision ordering.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'columnTypes' => [ 'description' => 'The column types.', 'type' => 'array', 'items' => ['description' => 'The type.', 'type' => 'string', 'example' => 'long', 'title' => ''], 'title' => '', 'example' => '', ], 'telementryType' => ['description' => 'The observable data type.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], 'title' => '', 'example' => '', ], 'data' => [ 'description' => 'The returned results.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', 'additionalProperties' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}', 'title' => ''], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query log data in a logstore', 'description' => '- Specify the compression method during use. Different programming languages implement different compression algorithms. For details, see the Accept-Encoding request parameter.'."\n" ."\n" .'- For more information, see [GetLogs](~~2771313~~).'."\n" .'### Authentication'."\n" .'The following table describes the authorization information required by this API. You can add this information to the Action element in a RAM access policy statement to grant a Resource Access Management (RAM) user or RAM role the permission to invoke this API.'."\n" .'| Action | Resource |'."\n" .'| :------------ | :------------ |'."\n" .'| `log:GetLogStoreLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |'."\n" ."\n" .'The following procedure describes how to use this API:', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meta\\": {\\n \\"progress\\": \\"Complete\\",\\n \\"aggQuery\\": \\"select *\\",\\n \\"whereQuery\\": \\"*\\",\\n \\"hasSQL\\": false,\\n \\"processedRows\\": 10000,\\n \\"elapsedMillisecond\\": 5,\\n \\"cpuSec\\": 0.002,\\n \\"cpuCores\\": 3,\\n \\"keys\\": [\\n \\"key\\"\\n ],\\n \\"terms\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"limited\\": 100,\\n \\"mode\\": 0,\\n \\"phraseQueryInfo\\": {\\n \\"scanAll\\": true,\\n \\"beginOffset\\": 0,\\n \\"endOffset\\": 0,\\n \\"endTime\\": 1\\n },\\n \\"scanBytes\\": 1024,\\n \\"highlights\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"count\\": 1,\\n \\"processedBytes\\": 10000,\\n \\"isAccurate\\": true,\\n \\"columnTypes\\": [\\n \\"long\\"\\n ],\\n \\"telementryType\\": \\"None\\"\\n },\\n \\"data\\": [\\n {\\n \\"key\\": \\"{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}\\"\\n }\\n ]\\n}","type":"json"}]', ], 'GetLogtailPipelineConfig' => [ 'summary' => 'Queries the information about a Logtail pipeline configuration.', 'path' => '/pipelineconfigs/{configName}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail pipeline configuration.', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The Logtail pipeline configuration.', '$ref' => '#/components/schemas/LogtailPipelineConfig', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"configName\\": \\"test-config\\",\\n \\"logSample\\": \\"127.0.0.1 - - [10/Jun/2022:12:36:49 +0800] \\\\\\"GET /index.html HTTP/1.1\\\\\\" 200\\",\\n \\"global\\": {\\n \\"TopicType\\": \\"custom\\",\\n \\"TopicFormat\\": \\"aaa\\",\\n \\"EnableAlwaysOnline\\": true,\\n \\"EnableTimestampNanosecond\\": true,\\n \\"UsingOldContentTag\\": true\\n },\\n \\"inputs\\": [\\n {\\n \\"Type\\": \\"input_file\\",\\n \\"FilePaths\\": [\\n \\"/home/**/*.log\\"\\n ],\\n \\"MaxDirSearchDepth\\": 10,\\n \\"Multiline\\": {\\n \\"StartPattern\\": \\"\\\\\\\\d+\\"\\n },\\n \\"TailSizeKB\\": 1024\\n }\\n ],\\n \\"processors\\": [\\n {\\n \\"Type\\": \\"processor_regex\\",\\n \\"SourceKey\\": \\"content\\",\\n \\"Regex\\": \\"(\\\\\\\\d+).*([^;])\\",\\n \\"Keys\\": [\\n \\"k1\\",\\n \\"k2\\"\\n ]\\n }\\n ],\\n \\"aggregators\\": [\\n {\\n \\"Type\\": \\"aggregator_shardhash\\",\\n \\"SourceKeys\\": [\\n \\"__source__\\"\\n ]\\n }\\n ],\\n \\"flushers\\": [\\n {\\n \\"Type\\": \\"flusher_sls\\",\\n \\"Logstore\\": \\"test_logstore\\",\\n \\"Endpoint\\": \\"cn-hangzhou-intranet.aliyuncs.com\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"FlowControlExpireTime\\": 2,\\n \\"MaxSendRate\\": 3,\\n \\"EnableShardHash\\": true,\\n \\"TelemetryType\\": \\"log\\"\\n }\\n ],\\n \\"createTime\\": 1655176807,\\n \\"lastModifyTime\\": 1655176807,\\n \\"task\\": {\\n \\"Type\\": \\"task_example\\"\\n }\\n}","type":"json"}]', 'title' => 'GetLogtailPipelineConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'description' => 'The UK (London) region is supported. Supported regions are constantly updated.', ], 'GetMLServiceResults' => [ 'summary' => 'Alibaba Cloud Simple Log Service (SLS) provides intelligent analysis for data such as logs, metrics, and traces. You can call models to obtain analysis results directly. Its main features include Named Entity Recognition (NER) for log data, anomaly detection for time series data, and root cause analysis for high-latency trace spans.', 'path' => '/ml/service/{serviceName}/analysis', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '200786', 'abilityTreeNodes' => ['FEATUREsls4A0DBM'], ], 'parameters' => [ [ 'name' => 'serviceName', 'in' => 'path', 'schema' => [ 'description' => 'The service name.', 'enumValueTitles' => ['sls_builtin_service_trace_rca' => 'The service for analyzing high-latency trace requests.', 'sls_builtin_service_log_struct' => 'The service for LogNER.', 'sls_builtin_service_metric_anomaly' => 'The service for single-dimension time series anomaly detection.'], 'type' => 'string', 'required' => false, 'example' => 'sls_builtin_service_log_struct', 'title' => '', ], ], [ 'name' => 'allowBuiltin', 'in' => 'query', 'schema' => [ 'description' => '- true: The request can use a built-in system service.'."\n" ."\n" .'- false: The request cannot use a built-in system service.', 'enumValueTitles' => ['true' => 'The request can use a built-in system service.', 'false' => 'The request cannot use a built-in system service.'], 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '', ], ], [ 'name' => 'version', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The version number of the algorithm. Different versions correspond to different algorithms.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => 'The request struct.', 'enumValueTitles' => ['others' => 'The content varies based on the value of serviceName.'], '$ref' => '#/components/schemas/MLServiceAnalysisParam', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ 'status' => [ 'description' => 'The status of the task.', 'type' => 'object', 'additionalProperties' => [ 'description' => 'By default, this parameter is empty, and tasks in all statuses are returned. Supported statuses are success, fail, and running.', 'enumValueTitles' => ['无' => 'None', 'None' => 'None'], 'type' => 'string', 'example' => '200', 'title' => '', ], 'enumValueTitles' => ['无' => 'None', 'None' => 'None'], 'title' => '', 'example' => '', ], 'data' => [ 'description' => 'The returned data.', 'type' => 'array', 'items' => [ 'description' => 'The dataset struct.', 'type' => 'object', 'additionalProperties' => ['description' => 'The returned result.', 'type' => 'string', 'example' => '{\'marker\': \'\'}', 'title' => ''], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'enumValueTitles' => ['无' => 'None', 'None' => 'None'], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": {\\n \\"key\\": \\"200\\"\\n },\\n \\"data\\": [\\n {\\n \\"key\\": \\"{\'marker\': \'\'}\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetMLServiceResults', 'description' => 'This API endpoint is available only in the China (Shanghai) and Singapore regions. The following basic permissions are required:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "Version": "1",'."\n" .' "Statement": ['."\n" .' {'."\n" .' "Action": ['."\n" .' "log:Get*"'."\n" .' ],'."\n" .' "Resource": ['."\n" .' "acs:log:*:*:mlservice/sls_builtin_*"'."\n" .' ],'."\n" .' "Effect": "Allow"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'```', 'requestParamsDescription' => 'The request parameters vary depending on the service. The details are as follows:'."\n" ."\n" .'## Named Entity Recognition for logs (sls\\_builtin\\_service\\_log\\_struct)'."\n" ."\n" .'Details of body.parameter'."\n" ."\n" .'```'."\n" .'{'."\n" .' "is_struct": "true",'."\n" .' "use_gpu": "true/false",'."\n" .' "max_fields": "1"'."\n" .'}'."\n" .'```'."\n" ."\n" .'- If is\\_struct is true, the log is in JSON format. Currently, you can only set this parameter to true.'."\n" ."\n" .'- use\\_gpu specifies whether to use GPU resources.'."\n" ."\n" .'- max\\_fields specifies the maximum number of fields to analyze when the log is in JSON format. By default, one field is analyzed.'."\n" ."\n" .'Details of body.input'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "{column_name}": "{column_value}"'."\n" .' }'."\n" .']'."\n" .'```'."\n" ."\n" .'The input is an array of JSON objects, where:'."\n" ."\n" .'- column\\_name is the name of a field in the JSON-formatted log.'."\n" ."\n" .'- column\\_value is the value of the field in the JSON-formatted log.'."\n" ."\n" .'## Time series anomaly detection (sls\\_builtin\\_service\\_metric\\_anomaly)'."\n" ."\n" .'Details of body.parameter'."\n" ."\n" .'```'."\n" .'{'."\n" .' "isOrdered": "true/false",'."\n" .' "keys": "[]",'."\n" .' "timeColumnName": "",'."\n" .' "analysisColumnNames": "[]",'."\n" .' "interval": "-1"'."\n" .'}'."\n" .'```'."\n" ."\n" .'- isOrdered specifies whether the input data is ordered. Set this parameter to true if the input time series is sorted in ascending order by time. Otherwise, set it to false.'."\n" ."\n" .'- interval specifies the interval of the time series in seconds. For example, if the series has one data point per minute, set this parameter to 60. If you are unsure of the interval, set this parameter to -1.'."\n" ."\n" .'- timeColumnName specifies the name of the time dimension in the input series.'."\n" ."\n" .'- analysisColumnNames specifies the names of the numerical feature dimensions to be analyzed in the input series. This is an array that must be serialized into a string.'."\n" ."\n" .'- keys specifies the names of all columns in the input data. This is an array that must be serialized into a string.'."\n" ."\n" .'Details of body.input'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "{column_name}": "{column_value}"'."\n" .' }'."\n" .']'."\n" .'```'."\n" ."\n" .'The input is an array, where:'."\n" ."\n" .'- column\\_name is the name of a field in the series.'."\n" ."\n" .'- column\\_value is the value of the field. If {column\\_name} is the same as {timeColumnName}, the value is a UNIX timestamp in seconds.'."\n" ."\n" .'## High-latency trace detection (sls\\_builtin\\_service\\_trace\\_rca)'."\n" ."\n" .'Details of body.parameter'."\n" ."\n" .'```'."\n" .'{'."\n" .' "project": "",'."\n" .' "logstore": "",'."\n" .' "endpoint": "",'."\n" .' "role_arn": ""'."\n" .'}'."\n" .'```'."\n" ."\n" .'- project specifies the name of the project in SLS where the trace data is stored.'."\n" ."\n" .'- logstore specifies the name of the Logstore in SLS where the trace data is stored.'."\n" ."\n" .'- endpoint specifies the endpoint of the region where the project is located. You must use an Internet endpoint. Internal endpoints in the same region cannot be accessed.'."\n" ."\n" .'- role\\_arn specifies the ARN of the role that is granted permissions to the resource. You must use the ARN of an ETLRole or AuditRole.'."\n" ."\n" .'Details of body.input'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "service": "",'."\n" .' "name": "",'."\n" .' "from_ts_sec": "",'."\n" .' "to_ts_sec": "",'."\n" .' "slo_ts_micro": "",'."\n" .' "batch_id": "",'."\n" .' "trace_ids": "[]"'."\n" .' }'."\n" .']'."\n" .'```'."\n" ."\n" .'The input is an array with a length of 1. The parameters are described as follows:'."\n" ."\n" .'- service specifies the service name for one or more TraceIDs to be diagnosed. You can retrieve this from the Logstore.'."\n" ."\n" .'- name specifies the service name for one or more TraceIDs to be diagnosed. You can retrieve this from the Logstore.'."\n" ."\n" .'- from\\_ts\\_sec specifies the start timestamp for the analysis, in seconds.'."\n" ."\n" .'- to\\_ts\\_sec specifies the end timestamp for the analysis, in seconds.'."\n" ."\n" .'- batch\\_id specifies the name for the current batch of TraceIDs to be analyzed.'."\n" ."\n" .'- trace\\_ids specifies the list of trace\\_ids for the current request. This must be a JSON-serialized string.', 'responseParamsDescription' => 'The return value varies depending on the service. The details are as follows:'."\n" ."\n" .'## Named Entity Recognition for logs (sls\\_builtin\\_service\\_log\\_struct)'."\n" ."\n" .'Details of data'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "{column_name}": "{column_value}"'."\n" .' }'."\n" .']'."\n" .'```'."\n" ."\n" .'Each JSON object in the output corresponds to a JSON object in the input log, where:'."\n" ."\n" .'- column\\_name is the name of an analyzed field in the JSON-formatted log. A maximum of max\\_fields fields are analyzed.'."\n" ."\n" .'- column\\_value is the value of the analyzed field. The NER result in the field value is enclosed in \\\\ tags, where ${ner\\_type} is the specific NER type.'."\n" ."\n" .'## Time series anomaly detection (sls\\_builtin\\_service\\_metric\\_anomaly)'."\n" ."\n" .'Details of data'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "start": "",'."\n" .' "end": "",'."\n" .' "label": ""'."\n" .' }'."\n" .']'."\n" .'```'."\n" ."\n" .'- start specifies the start time of the detected anomaly interval.'."\n" ."\n" .'- end specifies the end time of the detected anomaly interval.'."\n" ."\n" .'- label specifies the type of anomaly detected in the current interval.'."\n" ."\n" .' - SPIKE\\_UP\\_TYPE'."\n" ."\n" .' - SPIKE\\_DOWN\\_TYPE'."\n" ."\n" .' - TREND\\_UP\\_TYPE'."\n" ."\n" .' - TREND\\_DOWN\\_TYPE'."\n" ."\n" .' - MEANSHIFT\\_UPWARD\\_TYPE'."\n" ."\n" .' - MEANSHIFT\\_DOWNWARD\\_TYPE'."\n" ."\n" .'## High-latency trace detection (sls\\_builtin\\_service\\_trace\\_rca)'."\n" ."\n" .'Details of data'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "traceID": "",'."\n" .' "service": "",'."\n" .' "name": "",'."\n" .' "rootCauses": "[{}]"'."\n" .' }'."\n" .']'."\n" .'```'."\n" ."\n" .'- traceID specifies the ID of the trace that was analyzed.'."\n" ."\n" .'- service specifies the service name of the root node of the trace.'."\n" ."\n" .'- name specifies the name of the root node of the trace.'."\n" ."\n" .'- rootCauses specifies the list of spans that caused the high latency in the trace. This is a serialized string. When deserialized, the structure of this field is as follows:'."\n" ."\n" .'```'."\n" .'['."\n" .' {'."\n" .' "spanID": "",'."\n" .' "service": "",'."\n" .' "name": "",'."\n" .' "host": "xxxx",'."\n" .' "predicateDuration": 10'."\n" .' }'."\n" .']'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetMachineGroup' => [ 'summary' => 'Gets the details of a machine group.', 'path' => '/machinegroups/{machineGroup}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The response body.', '$ref' => '#/components/schemas/machineGroup', 'title' => '', 'example' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"groupName\\": \\"machineGroup-test\\",\\n \\"groupType\\": \\"“”\\",\\n \\"machineIdentifyType\\": \\"ip\\",\\n \\"groupAttribute\\": {\\n \\"groupTopic\\": \\"testtopic\\",\\n \\"externalName\\": \\"testgroup\\"\\n },\\n \\"machineList\\": [\\n \\"47.100.XX.XX\\"\\n ]\\n}","type":"json"}]', 'title' => 'GetMachineGroup', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | MachineGroupNotExist| MachineGroup groupName does not exist. | 机器组不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], ], ], 'GetMaterializedView' => [ 'path' => '/materializedviews/{name}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '294427', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'Content-Type', 'in' => 'header', 'schema' => ['type' => 'string', 'default' => 'application/json', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'returnStatus', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'name' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], 'logstore' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'originalSql' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'aggIntervalMins' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'startTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'ttl' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'enabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'status' => [ 'type' => 'object', 'properties' => [ 'lastRunTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'maxCursorTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'lastRunError' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'summary' => 'Retrieves a materialized view.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"\\",\\n \\"logstore\\": \\"\\",\\n \\"originalSql\\": \\"\\",\\n \\"aggIntervalMins\\": 0,\\n \\"startTime\\": 0,\\n \\"ttl\\": 0,\\n \\"enabled\\": false,\\n \\"status\\": {\\n \\"lastRunTime\\": 0,\\n \\"maxCursorTime\\": 0,\\n \\"lastRunError\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'GetMaterializedView', ], 'GetMaxComputeExport' => [ 'summary' => 'Queries a MaxCompute data shipping job.', 'path' => '/maxcomputeexports/{mcExportName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '203462', 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'mcExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The detailed setting of the MaxCompute data shipping job.', '$ref' => '#/components/schemas/MaxComputeExport', 'title' => '', 'example' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"MaxComputeExport\\",\\n \\"description\\": \\"MaxComputeExport\\",\\n \\"displayName\\": \\"MaxComputeExport\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\\\n\\",\\n \\"sink\\": {\\n \\"odpsEndpoint\\": \\"https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api\\",\\n \\"odpsTunnelEndpoint\\": \\"https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com\\",\\n \\"odpsProject\\": \\"demo_project\\",\\n \\"odpsTable\\": \\"demo_table\\",\\n \\"odpsRolearn\\": \\"acs:ram::xxxxxxx\\",\\n \\"odpsAccessKeyId\\": \\"axxxxxxxxxxxb\\",\\n \\"odpsAccessSecret\\": \\"aaxxxxxxxxxxxxxxxxxxxxxbb\\",\\n \\"partitionTimeFormat\\": \\"%Y_%m_%d\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"fields\\": [\\n \\"\'f1\'\\"\\n ],\\n \\"partitionColumn\\": [\\n \\"\'p1\'\\"\\n ],\\n \\"filterInvalid\\": true,\\n \\"timeFormatType\\": \\"StrfTimeFormat\\",\\n \\"bufferInterval\\": \\"1800\\"\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718390800\\n },\\n \\"createTime\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', 'title' => 'GetMaxComputeExport', 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetMetricStore' => [ 'summary' => 'Queries a Metricstore.', 'path' => '/metricstores/{name}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225685', 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ 'title' => '', 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'example' => 'my_metric_store', 'title' => ''], 'ttl' => ['description' => 'The retention period of data. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], 'shardCount' => ['description' => 'The number of shards.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'autoSplit' => ['description' => 'Indicates whether automatic sharding is enabled.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], 'maxSplitShard' => ['description' => 'The maximum number of shards that can be generated by automatic sharding.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => ''], 'mode' => ['description' => 'The type of the Metricstore. Example: standard.', 'type' => 'string', 'example' => 'standard', 'title' => ''], 'metricType' => ['description' => 'The type of metrics in the Metricstore. Example: prometheus.', 'type' => 'string', 'example' => 'prometheus', 'title' => ''], 'createTime' => ['description' => 'The time when the Metricstore was created. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1698933894', 'title' => ''], 'lastModifyTime' => ['description' => 'The time when the Metricstore was last modified. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1712023974', 'title' => ''], 'hot_ttl' => ['description' => 'The retention period of data in the hot storage layer. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], 'infrequentAccessTTL' => ['description' => 'The retention period for the Infrequent Access (IA) storage class. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], 'appendMeta' => ['type' => 'boolean', 'description' => 'Indicates whether to record the public IP address and log reception time. ', 'default' => 'false', 'title' => '', 'example' => 'false'], 'shardingPolicy' => ['description' => 'Hash write configuration ', '$ref' => '#/components/schemas/ShardingPolicy', 'title' => '', 'example' => ''], 'processorId' => ['description' => 'The ID of the write processor associated with the Metricstore ', 'title' => 'The ID of the write processor associated with the Metricstore ', 'type' => 'string', 'example' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => 'The specified metricstore xxx does not exist.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"my_metric_store\\",\\n \\"ttl\\": 7,\\n \\"shardCount\\": 2,\\n \\"autoSplit\\": true,\\n \\"maxSplitShard\\": 64,\\n \\"mode\\": \\"standard\\",\\n \\"metricType\\": \\"prometheus\\",\\n \\"createTime\\": 1698933894,\\n \\"lastModifyTime\\": 1712023974,\\n \\"hot_ttl\\": 60,\\n \\"infrequentAccessTTL\\": 30,\\n \\"appendMeta\\": false,\\n \\"shardingPolicy\\": {\\n \\"shardGroup\\": {\\n \\"keys\\": [\\n \\"userId\\"\\n ],\\n \\"groupCount\\": 8\\n },\\n \\"shardHash\\": {\\n \\"keys\\": [\\n \\"instanceId\\"\\n ],\\n \\"maxHashCount\\": 2\\n },\\n \\"queryActiveTime\\": 1764659409\\n },\\n \\"processorId\\": \\"\\"\\n}","type":"json"}]', 'title' => 'GetMetricStore', 'description' => 'A [Metricstore](~~171723~~) is used to store [metrics](~~174965~~). This operation queries only the configuration of a Metricstore. To query the metric data, see [Query and analyze data](~~174968~~) and [GetLogsV2](~~2771318~~).'."\n" ."\n" .'- You must specify an existing Metricstore.'."\n" ."\n" .'- The Host in the request syntax consists of a project name and a Simple Log Service endpoint. You must specify the project in the Host.'."\n" ."\n" .'- You must have an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has full access permissions to all API operations. This poses a high security threat. For security, we recommend that you use a RAM user for API access or routine O\\&M. Grant the RAM user the required permissions to operate Simple Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" ."\n" .'- Obtain the name and region of the project that contains the Metricstore. For more information, see [Manage projects](~~48984~~).'."\n" ."\n" .'- You can create a maximum of 200 Logstores or Metricstores in a project.'."\n" ."\n" .'- Metrics are deleted after their retention period expires.', 'changeSet' => [ ['createdAt' => '2025-12-03T01:37:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-12-02T11:55:01.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-11-24T09:35:51.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'machine', ], 'GetMetricStoreMeteringMode' => [ 'summary' => 'Queries the billing mode of a Metricstore.', 'path' => '/metricstores/{metricStore}/meteringmode', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '213243', 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'projectName', 'title' => ''], ], [ 'name' => 'metricStore', 'in' => 'path', 'schema' => ['title' => 'metricStore', 'description' => 'metricStore', 'type' => 'string', 'required' => true, 'example' => 'metricStoreName'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'meteringMode' => [ 'description' => 'The billing mode. Default value: ChargeByFunction. Valid values: ChargeByFunction and ChargeByDataIngest.', 'type' => 'string', 'example' => 'ChargeByFunction', 'enum' => ['ChargeByFunction', 'ChargeByDataIngest'], 'title' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meteringMode\\": \\"ChargeByFunction\\"\\n}","type":"json"}]', 'title' => 'GetMetricStoreMeteringMode', 'description' => 'MetricStore supports two billing modes: [pay-by-feature](~~48220~~) and [pay-by-write-traffic](~~2365756~~).'."\n" ."\n" .'- You must specify an existing MetricStore when you call this operation.'."\n" ."\n" .'- In the request syntax, Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is required. For more information, see[AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations, which is high risk. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have permissions to manage Simple Log Service resources. For more information, see[Create a RAM user and authorize the RAM user](~~47664~~).'."\n" ."\n" .'- Before you call this operation, make sure that you have obtained the project name and region of the logs. For more information, see[Manage a project](~~48984~~).'."\n" ."\n" .'- You can create up to 200 Logstores or MetricStores in a project.'."\n" ."\n" .'- When metric data reaches the retention period that you configured, the data is deleted.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetOSSExport' => [ 'summary' => 'Retrieves the specified OSS data shipping job.', 'path' => '/ossexports/{ossExportName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '203470', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the existing job.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The details of the job configuration.', '$ref' => '#/components/schemas/OSSExport', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"https://oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"bucket\\": \\"my-bucket\\",\\n \\"prefix\\": \\"prefix-demo/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"pathFormat\\": \\"%Y/%m/%d/%H/%M\\",\\n \\"pathFormatType\\": \\"time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"csv\\",\\n \\"contentDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"your log key1\\\\\\",\\\\n \\\\\\"your log key2\\\\\\",\\\\n \\\\\\"your log key3\\\\\\",\\\\n ],\\\\n \\\\\\"delimiter\\\\\\": \\\\\\" \\\\\\",\\\\n \\\\\\"header\\\\\\": true,\\\\n \\\\\\"lineFeed\\\\\\": \\\\\\"\\\\\\\\n\\\\\\",\\\\n \\\\\\"null\\\\\\": \\\\\\"-\\\\\\",\\\\n \\\\\\"quote\\\\\\": \\\\\\"\\\\\\\\\\\\\\"\\\\\\"\\\\n},\\"\\n },\\n \\"compressionType\\": \\"snappy\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718380800,\\n \\"sourceSecureTransport\\": false\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', 'title' => 'GetOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetOSSHDFSExport' => [ 'summary' => 'Retrieves the details of a specified OSS-HDFS delivery job.', 'path' => '/osshdfsexports/{ossExportName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '203478', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The detailed configuration of the job.', '$ref' => '#/components/schemas/OSSExport', 'title' => '', 'example' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"https://oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"bucket\\": \\"my-bucket\\",\\n \\"prefix\\": \\"prefix-demo/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"pathFormat\\": \\"%Y/%m/%d/%H/%M\\",\\n \\"pathFormatType\\": \\"time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"csv\\",\\n \\"contentDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"your log key1\\\\\\",\\\\n \\\\\\"your log key2\\\\\\",\\\\n \\\\\\"your log key3\\\\\\",\\\\n ],\\\\n \\\\\\"delimiter\\\\\\": \\\\\\" \\\\\\",\\\\n \\\\\\"header\\\\\\": true,\\\\n \\\\\\"lineFeed\\\\\\": \\\\\\"\\\\\\\\n\\\\\\",\\\\n \\\\\\"null\\\\\\": \\\\\\"-\\\\\\",\\\\n \\\\\\"quote\\\\\\": \\\\\\"\\\\\\\\\\\\\\"\\\\\\"\\\\n},\\"\\n },\\n \\"compressionType\\": \\"snappy\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718380800\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', 'title' => 'GetOSSHDFSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetOSSIngestion' => [ 'summary' => 'Retrieves a specified OSS import job.', 'path' => '/ossingestions/{ossIngestionName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '203101', 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'ossIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the OSS import job.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The configuration of the OSS import job.', '$ref' => '#/components/schemas/OSSIngestion', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetOSSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-oss-123456\\",\\n \\"description\\": \\"oss ingestion\\",\\n \\"displayName\\": \\"oss ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"ossbucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"never\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"restoreObjectEnabled\\": true,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"useMetaIndex\\": false,\\n \\"roleARN\\": \\"acs:ram::12345:role/aliyunlogdefaultrole\\",\\n \\"tagPackId\\": true,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"Line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', ], 'GetProject' => [ 'path' => '/', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8911', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test', 'title' => ''], ], [ 'name' => 'crossRegion', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => ['description' => 'The project details.', '$ref' => '#/components/schemas/project', 'example' => '{ "createTime": "2020-11-18 16:55:57", "description": "test", "lastModifyTime": "2020-11-18 17:07:26", "owner": "174****745", "projectName": "ali-project-test", "region": "cn-hangzhou", "status": "Normal" }', 'title' => ''], ], ], 'title' => 'Get a specified project', 'summary' => 'Queries the details of a specified project.', 'description' => '### Operation description'."\n" .'The Host in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | Description |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist| The Project does not exist : projectName | The project does not exist. |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | An internal service invocation error occurred. |'."\n" ."\n" .'For more information, see [Common error codes](~~29013~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"createTime\\": \\"2021-07-07 14:08:09\\",\\n \\"lastModifyTime\\": \\"2022-04-18 13:30:19\\",\\n \\"description\\": \\"Description of my-project\\",\\n \\"owner\\": \\"\\\\\\"\\\\\\"\\",\\n \\"projectName\\": \\"ali-test-project\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"Normal\\",\\n \\"resourceGroupId\\": \\"rg-acf******sq\\",\\n \\"dataRedundancyType\\": \\"LRS\\",\\n \\"recycleBinEnabled\\": false,\\n \\"internetEndpoint\\": \\"\\",\\n \\"internalEndpoint\\": \\"\\",\\n \\"quota\\": {\\n \\"key\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'GetProjectLogs' => [ 'summary' => 'Queries logs in a project. You can use this operation to query logs at the project level.', 'path' => '/logs', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8913', 'abilityTreeNodes' => ['FEATUREslsCAO32E'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'query', 'in' => 'query', 'schema' => ['description' => 'The standard SQL statement. In this example, the SQL statement queries the number of page views (PVs) from 2022-03-01 10:41:40 to 2022-03-01 10:56:40 in a Logstore whose name is nginx-moni.', 'type' => 'string', 'required' => true, 'example' => 'SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400', 'title' => ''], ], [ 'name' => 'powerSql', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the Dedicated SQL feature. For more information, see [Enable Dedicated SQL](~~223777~~). Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false (default): enables the Standard SQL feature.'."\n" ."\n" .'You can use the powerSql or **query** parameter to configure Dedicated SQL.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-progress' => [ 'schema' => ['title' => '查询结果的状态，包括： Complete：查询已经完成，返回结果为完整结果。 Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'type' => 'string', 'example' => 'Complete'], ], 'x-log-count' => [ 'schema' => ['title' => '当前查询结果的日志总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], ], 'x-log-processed-rows' => [ 'schema' => ['title' => '本次查询处理的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], ], 'x-log-elapsed-millisecond' => [ 'schema' => ['title' => '本次查询消耗的毫秒时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'The logs that are returned.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The log that is returned.', 'type' => 'object', 'additionalProperties' => ['description' => 'The log that is returned.', 'type' => 'string', 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', 'title' => ''], 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"key\\": \\"[ { \\\\\\"__time__\\\\\\" : 1409529660, \\\\\\"__source__\\\\\\" : \\\\\\"192.168.1.100\\\\\\", \\\\\\"Key1\\\\\\" : \\\\\\"error\\\\\\", \\\\\\"Key2\\\\\\" : \\\\\\"Value2\\\\\\" }, { \\\\\\"__time__\\\\\\" : 1409529680, \\\\\\"__source__\\\\\\" : \\\\\\"192.168.1.100\\\\\\", \\\\\\"Key3\\\\\\" : \\\\\\"error\\\\\\", \\\\\\"Key4\\\\\\" : \\\\\\"Value4\\\\\\" } ]\\"\\n }\\n]","type":"json"}]', 'title' => 'GetProjectLogs', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'- Indexes are configured before you query logs. For more information, see [Create indexes](~~90732~~).'."\n" ."\n" .'- Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" ."\n" .'- You must set query to a standard SQL statement.'."\n" ."\n" .'- You must specify a Logstore in the FROM clause of an SQL statement. A Logstore can be used as an SQL table.'."\n" ."\n" .'- You must specify a time range in an SQL statement by using the \\_\\_date\\_\\_ or \\_\\_time\\_\\_ parameter. The value of the \\_\\_date\\_\\_ parameter is a timestamp. The value of the \\_\\_time\\_\\_ parameter is an integer, and the unit of the value is seconds.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :------------------- | :-------------------------------------------------------- |'."\n" .'| `log:GetProjectLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', 'requestParamsDescription' => 'Sample requests'."\n" ."\n" .'GET /logs?query=SELECT COUNT(\\*) as pv FROM nginx-moni where **time** > 1646102500 and **time** < 1646103400\\&powerSql=false HTTP/1.1 Host:ali-test-project.ch-hangzhou.log.aliyuncs.com Content-Type:application/json', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | ParameterInvalid| Parameter is invalid. | 请求的参数错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetProjectPolicy' => [ 'summary' => 'Queries a project policy.', 'path' => '/policy', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '157642', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The policy.', 'type' => 'string', 'example' => '{ "Version": "1", "Statement": [{ "Action": ["log:PostLogStoreLogs"], "Resource": "acs:log:*:*:project/exampleproject/*", "Effect": "Deny", "Condition": { "StringNotLike": { "acs:SourceVpc": ["vpc-*"] } } }] }', 'title' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\"{ \\\\t\\\\\\"Version\\\\\\": \\\\\\"1\\\\\\", \\\\t\\\\\\"Statement\\\\\\": [{ \\\\t\\\\t\\\\\\"Action\\\\\\": [\\\\\\"log:PostLogStoreLogs\\\\\\"], \\\\t\\\\t\\\\\\"Resource\\\\\\": \\\\\\"acs:log:*:*:project/exampleproject/*\\\\\\", \\\\t\\\\t\\\\\\"Effect\\\\\\": \\\\\\"Deny\\\\\\", \\\\t\\\\t\\\\\\"Condition\\\\\\": { \\\\t\\\\t\\\\t\\\\\\"StringNotLike\\\\\\": { \\\\t\\\\t\\\\t\\\\t\\\\\\"acs:SourceVpc\\\\\\": [\\\\\\"vpc-*\\\\\\"] \\\\t\\\\t\\\\t} \\\\t\\\\t} \\\\t}] }\\"","type":"json"}]', 'title' => 'GetProjectPolicy', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetProjectPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetS3Ingestion' => [ 'summary' => 'Retrieves information about an S3 import task.', 'path' => '/s3ingestions/{s3IngestionName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '263582', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 's3IngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the S3 import task.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'The S3 import task.', '$ref' => '#/components/schemas/S3Ingestion', 'title' => '', 'example' => ''], ], ], 'title' => 'GetS3Ingestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-s3-123456\\",\\n \\"description\\": \\"s3 ingestion\\",\\n \\"displayName\\": \\"s3 ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"awsRegion\\": \\"ap-northeast-1\\",\\n \\"awsAccessKey\\": \\"AKIxxxxxxxxxxYJE\\",\\n \\"awsAccessKeySecret\\": \\"123xxxxxxxxxxfjf\\",\\n \\"bucket\\": \\"s3bucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"30m\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"awsUseSQS\\": false,\\n \\"awsSQSQueueUrl\\": \\"https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan\\",\\n \\"useAwsSQSOnly\\": false,\\n \\"tagPackId\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"endpoint\\": \\"s3.us-east-1.amazonaws.com\\",\\n \\"cloudFrontEndpoint\\": \\"dtfsb7voqy76q.cloudfront.net \\",\\n \\"cloudFrontToken\\": \\"@test-s3-access/ABS\\",\\n \\"useCloudFront\\": false,\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', ], 'GetSavedSearch' => [ 'summary' => 'Queries a saved search.', 'path' => '/savedsearches/{savedsearchName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project'], ], [ 'name' => 'savedsearchName', 'in' => 'path', 'schema' => ['description' => 'The name of the saved search.', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Length' => [ 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => ['description' => 'The response body.', '$ref' => '#/components/schemas/SavedSearch', 'example' => 'saved-search', 'title' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"savedsearchName\\": \\"savedsearch-name\\",\\n \\"searchQuery\\": \\"status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5\\",\\n \\"logstore\\": \\"aliyun-test-logstore\\",\\n \\"topic\\": \\"topic-test\\",\\n \\"displayName\\": \\"Method\\"\\n}","type":"json"}]', 'title' => 'GetSavedSearch', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- You can call the ListSavedSearch operation to query the name of a saved search.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :------------------- | :--------------------------------------------------------------------------------------- |'."\n" .'| `log:GetSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], ], ], 'GetScheduledSQL' => [ 'summary' => 'Retrieves the specified Scheduled SQL job.', 'path' => '/scheduledsqls/{scheduledSQLName}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209801', 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the existing job.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The configuration of the Scheduled SQL job.', '$ref' => '#/components/schemas/ScheduledSQL', 'title' => '', 'example' => ''], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"description\\": \\"This is a scheduled sql job\\",\\n \\"displayName\\": \\"This is a scheduled sql job\\",\\n \\"name\\": \\"test-scheduled-sql\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"script\\": \\"* | select *\\",\\n \\"sqlType\\": \\"searchQuery\\",\\n \\"destEndpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"destProject\\": \\"project-demo\\",\\n \\"sourceLogstore\\": \\"source-logstore-demo\\",\\n \\"destLogstore\\": \\"dest-logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"destRoleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"fromTimeExpr\\": \\"@m-1m\\",\\n \\"toTimeExpr\\": \\"@m\\",\\n \\"maxRunTimeInSeconds\\": 600,\\n \\"resourcePool\\": \\"enhanced\\",\\n \\"maxRetries\\": 20,\\n \\"fromTime\\": 1712592000,\\n \\"toTime\\": 0,\\n \\"dataFormat\\": \\"log2log\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714123644,\\n \\"lastModifiedTime\\": 1714123644,\\n \\"scheduleId\\": \\"e73f43732852064ad5d091914e39342f\\",\\n \\"status\\": \\"ENABLED\\"\\n}","type":"json"}]', 'title' => 'GetScheduledSQL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetSlsService' => [ 'summary' => 'Call the GetSlsService operation to retrieve the activation status of Simple Log Service. The endpoint must be China (Shanghai) or Singapore.', 'path' => '/slsservice', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '194671', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The response body.', '$ref' => '#/components/schemas/serviceStatus', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"NotExist\\",\\n \\"enabled\\": false\\n}","type":"json"}]', 'title' => 'GetSlsService', 'description' => 'This operation requires an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account grants full access to all APIs. This poses a high security threat. Create and use a RAM user for API access or routine operations and maintenance (O\\&M). The RAM user must have permissions to operate Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'GetSqlInstance' => [ 'summary' => 'Gets information about the Dedicated SQL instance of a project, such as the number of compute units (CUs) and whether the Dedicated SQL instance is enabled by default. Before you call this operation, you must create a Dedicated SQL instance by calling the CreateSqlInstance or UpdateSqlInstance operation.', 'path' => '/sqlinstance', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '215092', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'Project Name', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => 'Dedicated SQL instance', 'type' => 'array', 'items' => [ 'description' => 'Dedicated SQL instance', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The value is group1. This is an internal parameter that you can ignore.', 'type' => 'string', 'title' => '', 'example' => 'group1'], 'cu' => ['description' => 'The maximum number of CUs that the Dedicated SQL version can use. A CU is a compute core that can be used for parallel processing when the Dedicated SQL version is running.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], 'createTime' => ['description' => 'The time when the configuration for the Dedicated SQL version was created. This is a UNIX timestamp.', 'type' => 'integer', 'example' => '1710230272', 'format' => 'int32', 'title' => ''], 'updateTime' => ['description' => 'The time when the configuration for the Dedicated SQL version was updated. This is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1710230272'], 'useAsDefault' => ['description' => 'Indicates whether the Dedicated SQL version is enabled by default for the project. If this parameter is set to true, all query and analysis operations in the project, such as alerts and dashboards, use the Dedicated SQL version.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"name\\": \\"group1\\",\\n \\"cu\\": 2,\\n \\"createTime\\": 1710230272,\\n \\"updateTime\\": 1710230272,\\n \\"useAsDefault\\": true\\n }\\n]","type":"json"}]', 'title' => 'GetSqlInstance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:GetSqlInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], 'translator' => 'manual', ], 'GetStoreView' => [ 'summary' => 'Queries the configurations of a dataset by using the name of the dataset.', 'path' => '/storeviews/{name}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208676', 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The configurations of the dataset.', 'type' => 'object', 'properties' => [ 'storeType' => [ 'title' => 'Id of the request', 'description' => 'The type of the dataset.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- metricstore'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .'- logstore'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' ', 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'type' => 'string', 'example' => 'logstore', ], 'stores' => [ 'description' => 'The Logstores or Metricstores.', 'type' => 'array', 'items' => ['description' => 'The Logstore or Metricstore.', '$ref' => '#/components/schemas/StoreViewStore', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"storeType\\": \\"logstore\\",\\n \\"stores\\": [\\n {\\n \\"project\\": \\"ali-test-project\\",\\n \\"storeName\\": \\"my-logstore\\",\\n \\"query\\": \\"job: IT | select name, age, gender from log\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetStoreView', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetStoreView', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetStoreViewIndex' => [ 'path' => '/storeviews/{name}/index', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '212612', 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project'], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The index configurations of all Logstores in the dataset.', 'type' => 'object', 'properties' => [ 'indexes' => [ 'description' => 'The index configurations.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'project' => ['description' => 'The name of the project to which the Logstore belongs.', 'type' => 'string', 'example' => 'example-project', 'title' => ''], 'logstore' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'example' => 'my-logstore', 'title' => ''], 'index' => ['description' => 'The index configurations of the Logstore.', '$ref' => '#/components/schemas/index', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetStoreViewIndex', 'summary' => 'Queries the indexes of a dataset by using the name of the dataset. Only datasets of the logstore type are supported.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetStoreViewIndex', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"indexes\\": [\\n {\\n \\"project\\": \\"example-project\\",\\n \\"logstore\\": \\"my-logstore\\",\\n \\"index\\": {\\n \\"max_text_len\\": 2048,\\n \\"log_reduce_white_list\\": [\\n \\"name\\"\\n ],\\n \\"log_reduce_black_list\\": [\\n \\"time\\"\\n ],\\n \\"line\\": {\\n \\"chn\\": false,\\n \\"caseSensitive\\": true,\\n \\"token\\": [\\n \\",\\"\\n ],\\n \\"include_keys\\": [\\n \\"includeField\\"\\n ],\\n \\"exclude_keys\\": [\\n \\"excludeField\\"\\n ]\\n },\\n \\"keys\\": {\\n \\"key\\": {\\n \\"chn\\": true,\\n \\"caseSensitive\\": true,\\n \\"alias\\": \\"myAlias\\",\\n \\"type\\": \\"text\\",\\n \\"doc_value\\": true,\\n \\"index_all\\": true,\\n \\"max_depth\\": 0,\\n \\"embedding\\": \\"\\",\\n \\"vector_index\\": \\"\\",\\n \\"token\\": [\\n \\"|\\"\\n ],\\n \\"json_keys\\": {\\n \\"key\\": {\\n \\"chn\\": true,\\n \\"caseSensitive\\": true,\\n \\"token\\": [\\n \\"|\\"\\n ],\\n \\"alias\\": \\"myAlias\\",\\n \\"type\\": \\"text\\",\\n \\"doc_value\\": true\\n }\\n }\\n }\\n },\\n \\"log_reduce\\": true,\\n \\"scan_index\\": false\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'ListAgentInstanceConfigs' => [ 'summary' => 'This operation lists process-level configurations.', 'path' => '/agentinstanceconfigs', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227400', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The number of entries to skip. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. The default value is 500.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'configType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the process-level configuration.', 'enumValueTitles' => [ 'apm_biz_trace' => 'apm_biz_trace', 'apm_self_protect' => 'apm_self_protect', 'apm_convergence' => 'apm_convergence', 'apm_custom_extract' => 'apm\\\\_custom\\\\_extract', 'apm_pilot' => 'APM Pilot', 'apm_trace' => 'apm_trace', 'rum_app_config' => 'rum_app_config', 'security_rasp' => 'security\\\\_rasp', 'rum_web_config' => 'RUM Web Configuration', 'apm_biz_trace_global' => 'apm\\\\_biz\\\\_trace\\\\_global', 'apm_intacheap' => 'apm_intacheap', 'apm_user_method' => 'apm\\\\_user\\\\_method', 'apm_global' => 'apm_global', 'apm_forward_process' => 'APM Forwarding Process', ], 'type' => 'string', 'required' => false, 'example' => 'apm_trace', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'size' => ['description' => 'The number of data entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'total' => ['description' => 'The total number of data entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'configs' => ['description' => 'The process-level configurations.', '$ref' => '#/components/schemas/ListAgentInstanceConfigs', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListAgentInstanceConfigs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'description' => 'Retrieves a list of process-level configurations.', 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"size\\": 10,\\n \\"total\\": 10,\\n \\"configs\\": [\\n {\\n \\"configType\\": \\"apm_biz_trace\\",\\n \\"attributes\\": {\\n \\"key\\": \\"\\\\\\"workspace\\\\\\": \\\\\\"test-workspace\\\\\\"\\\\n\\\\\\"service\\\\\\": \\\\\\"test-service\\\\\\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'ListAiTools' => [ 'summary' => 'Lists the AI tools provided by the observability service, including Copilot capabilities for various services.', 'path' => '/ml/tool/list', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267809', 'abilityTreeNodes' => ['FEATUREslsC9CU66'], ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'fields' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the field.', 'type' => 'string', 'title' => '', 'example' => ''], 'option' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'description' => 'The valid values for the field.', 'title' => '', 'example' => '', ], 'required' => ['description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'title' => '', 'example' => ''], 'type' => ['description' => 'The type of the field.', 'type' => 'string', 'title' => '', 'example' => ''], 'example' => ['description' => 'An example of the field.', 'type' => 'string', 'title' => '', 'example' => ''], 'description' => ['description' => 'The description of the field.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The fields of the tool.', 'title' => '', 'example' => '', ], 'name' => ['description' => 'The name of the tool.', 'type' => 'string', 'title' => '', 'example' => ''], 'description' => ['description' => 'The description of the tool.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListAiTools', 'description' => 'The endpoint for this API is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"option\\": [\\n \\"\\"\\n ],\\n \\"required\\": false,\\n \\"type\\": \\"\\",\\n \\"example\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n ],\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n]","type":"json"}]', ], 'ListAlerts' => [ 'summary' => 'Lists the alert rules in a specified project.', 'path' => '/alerts', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '199870', 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of rows to return on each page for a paged query. The maximum value is 200. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The Logstore from which to obtain alert rules. The default value is empty.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of alerts in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], 'count' => ['description' => 'The number of alerts returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'results' => [ 'description' => 'The list of alert configurations.', 'type' => 'array', 'items' => ['description' => 'The alert configuration.', '$ref' => '#/components/schemas/Alert', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListAlerts', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListAlerts', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"alert-123456\\",\\n \\"displayName\\": \\"alertNameExample\\",\\n \\"description\\": \\"Alert Desc\\",\\n \\"configuration\\": {\\n \\"muteUntil\\": 1698907508,\\n \\"version\\": \\"2.0\\",\\n \\"type\\": \\"default\\",\\n \\"templateConfiguration\\": {\\n \\"id\\": \\"sls.app.ack.ip.not_enough\\",\\n \\"type\\": \\"sys\\",\\n \\"version\\": \\"1\\",\\n \\"lang\\": \\"cn\\",\\n \\"tokens\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"aonotations\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"dashboard\\": \\"DasnboardExample\\",\\n \\"threshold\\": 1,\\n \\"noDataFire\\": false,\\n \\"noDataSeverity\\": 6,\\n \\"sendResolved\\": false,\\n \\"queryList\\": [\\n {\\n \\"chartTitle\\": \\"chartExmaple\\",\\n \\"query\\": \\"* | select *\\",\\n \\"timeSpanType\\": \\"Relative\\",\\n \\"start\\": \\"-5m\\",\\n \\"end\\": \\"now\\",\\n \\"storeType\\": \\"log\\",\\n \\"project\\": \\"projectExample\\",\\n \\"store\\": \\"store Example\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"roleArn\\": \\"\\",\\n \\"dashboardId\\": \\"dashboardExample\\",\\n \\"powerSqlMode\\": \\"auto\\",\\n \\"ui\\": \\"\\"\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"key\\": \\"title\\",\\n \\"value\\": \\"example value\\"\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"key\\": \\"title\\",\\n \\"value\\": \\"example value\\"\\n }\\n ],\\n \\"conditionConfiguration\\": {\\n \\"condition\\": \\"cnt > 100\\",\\n \\"countCondition\\": \\"__count__ > 5\\"\\n },\\n \\"severityConfigurations\\": [\\n {\\n \\"severity\\": 8,\\n \\"evalCondition\\": {\\n \\"condition\\": \\"cnt > 100\\",\\n \\"countCondition\\": \\"__count__ > 5\\"\\n }\\n }\\n ],\\n \\"joinConfigurations\\": [\\n {\\n \\"type\\": \\"left_join\\",\\n \\"condition\\": \\"$0.id == $1.id\\"\\n }\\n ],\\n \\"groupConfiguration\\": {\\n \\"type\\": \\"custom\\",\\n \\"fields\\": [\\n \\"id\\"\\n ]\\n },\\n \\"policyConfiguration\\": {\\n \\"alertPolicyId\\": \\"sls.builtin.dynamic\\",\\n \\"actionPolicyId\\": \\"example_action_policy\\",\\n \\"repeatInterval\\": \\"10m\\"\\n },\\n \\"autoAnnotation\\": false,\\n \\"sinkEventStore\\": {\\n \\"enabled\\": true,\\n \\"endpoint\\": \\"cn-shanghai-intranet.log.aliyuncs.com\\",\\n \\"project\\": \\"exampleProject\\",\\n \\"eventStore\\": \\"exampleStore\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\"\\n },\\n \\"sinkCms\\": {\\n \\"enabled\\": true\\n },\\n \\"sinkAlerthub\\": {\\n \\"enabled\\": true\\n },\\n \\"tags\\": [\\n \\"host\\"\\n ]\\n },\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"createTime\\": 1695090077,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"ENABLED/DISABLED\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListAnnotationData' => [ 'summary' => 'Lists the data records in a specified dataset.', 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The starting position of the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'datasetId', 'in' => 'path', 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'data' => [ 'description' => 'The list of data records.', 'type' => 'array', 'items' => ['description' => 'The data structure.', '$ref' => '#/components/schemas/MLDataParam', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"annotationdataId\\": \\"dc74b0f569126bb310e1ba6454c351ac\\",\\n \\"dataHash\\": \\"59db060bd89468245d76416a68a510ac\\",\\n \\"datasetId\\": \\"cb8cc4eb51a85e823471cdb368fae9be\\",\\n \\"value\\": \\"xxx/xxx/xxx/\\",\\n \\"valueType\\": \\"oss\\",\\n \\"config\\": {\\n \\"key\\": \\"simulator-nginx-demo\\"\\n },\\n \\"annotations\\": {\\n \\"key\\": {\\n \\"annotatedBy\\": \\"xxxx\\",\\n \\"updateTime\\": 1694761550,\\n \\"results\\": [\\n {\\n \\"key\\": \\"SPIKE_UP_TYPE\\"\\n }\\n ]\\n }\\n },\\n \\"predictions\\": {\\n \\"key\\": {\\n \\"annotatedBy\\": \\"xxx\\",\\n \\"updateTime\\": 1694761550,\\n \\"results\\": [\\n {\\n \\"key\\": \\"SPIKE_UP_TYPE\\"\\n }\\n ]\\n }\\n },\\n \\"createTime\\": 1695094335,\\n \\"lastModifyTime\\": 1695094335\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', 'title' => 'ListAnnotationData', 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListAnnotationDataSets' => [ 'summary' => 'Returns a list of dataset structs.', 'path' => '/ml/annotationdataset', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which to start the query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'data' => [ 'description' => 'The list of data that is returned.', 'type' => 'array', 'items' => ['description' => 'The dataset struct.', '$ref' => '#/components/schemas/MLDataSetParam', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"datasetId\\": \\"d9bd488f6dd42d294495fb780858e83d\\",\\n \\"name\\": \\"sls_builtin_dataset_metric.shapeclassification.anomalydetection\\",\\n \\"description\\": \\"数据集A\\",\\n \\"dataType\\": \\"Metric\\",\\n \\"labelId\\": \\"a191ae4ca615b0ccb93c211fc8a998af\\",\\n \\"createTime\\": 1695090077,\\n \\"lastModifyTime\\": 1695090077,\\n \\"createBy\\": \\"sls-console\\",\\n \\"settingType\\": \\"Metric.ShapeClassification.AnomalyDetection\\"\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', 'title' => 'ListAnnotationDataSets', 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListAnnotationLabels' => [ 'summary' => 'Lists annotation label tables.', 'path' => '/ml/annotationlabel', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The starting line of the query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'data' => [ 'description' => 'The list of annotation label table structs.', 'type' => 'array', 'items' => ['description' => 'The annotation label table struct.', '$ref' => '#/components/schemas/MLLabelParam', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'total' => ['description' => 'The total number of entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"labelId\\": \\"abbd488f6dd42d294495fb780858e83d\\",\\n \\"name\\": \\"标签表\\",\\n \\"description\\": \\"默认表\\",\\n \\"type\\": \\"xxx\\",\\n \\"settings\\": [\\n {\\n \\"mode\\": \\"builtin\\",\\n \\"type\\": \\"Trace.RCA\\",\\n \\"config\\": \\"\\\\\\"\\\\\\"\\",\\n \\"version\\": \\"0.01\\"\\n }\\n ],\\n \\"createTime\\": 1695090077,\\n \\"lastModifyTime\\": 1695090077\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', 'title' => 'ListAnnotationLabels', 'description' => 'This API operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListAzureBlobIngestion' => [ 'path' => '/azureblobingestions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '291245', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The number of tasks to skip before returning results. Default: 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of tasks to return per page. Range: 0 to 500. Default: 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The name of the logstore. If specified, the operation returns only tasks from this logstore.', 'type' => 'string', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of tasks that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'count' => ['description' => 'The number of tasks returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'results' => [ 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/AzureBlobIngestion', 'description' => '', 'title' => '', 'example' => ''], 'description' => 'A list of Azure Blob ingestion tasks.', 'title' => '', 'example' => '', ], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListAzureBlobIngestion', 'summary' => 'Lists Azure Blob ingestion tasks.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 0,\\n \\"count\\": 0,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-azure-blob-123456\\",\\n \\"description\\": \\"azure blob ingestion\\",\\n \\"displayName\\": \\"azure blob ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"30m\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"tagPackId\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accountName\\": \\"test001\\",\\n \\"accountKey\\": \\"dGVzdGtleQ==\\",\\n \\"containerName\\": \\"test-container\\",\\n \\"endpoint\\": \\"https://your-storage.blob.core.windows.net\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListCollectionPolicies' => [ 'summary' => 'Lists the collection rules for logs from Alibaba Cloud services.', 'path' => '/collectionpolicy', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192483', 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ 'name' => 'productCode', 'in' => 'query', 'schema' => ['description' => 'The code of the Alibaba Cloud service.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''], ], [ 'name' => 'dataCode', 'in' => 'query', 'schema' => ['description' => 'The code of the log type.', 'type' => 'string', 'required' => false, 'example' => 'access_log', 'title' => ''], ], [ 'name' => 'policyName', 'in' => 'query', 'schema' => ['description' => 'The name of the collection rule.', 'type' => 'string', 'required' => false, 'example' => 'your_log_policy'."\n", 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The number of collection rules to return on each page. Default value: 50. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '50', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The row from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'default' => '0', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'instanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. Specify this parameter to query rules that match a specific instance. If you use this parameter, you must also specify productCode and dataCode.', 'type' => 'string', 'required' => false, 'example' => 'your-test-bucket1'."\n", 'title' => ''], ], [ 'name' => 'centralProject', 'in' => 'query', 'schema' => ['description' => 'The destination project for centralized data shipping. Specify this parameter to query the number of rules that are configured to ship data to this project.', 'type' => 'string', 'required' => false, 'example' => 'your-central-project1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'totalCount' => ['description' => 'The total number of collection rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'currentCount' => ['description' => 'The number of collection rules returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'data' => [ 'description' => 'The collection rules that are returned on the current page.', 'type' => 'array', 'items' => [ 'description' => 'The details of the collection rule.', 'type' => 'object', 'properties' => [ 'productCode' => ['description' => 'The code of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'oss', 'title' => ''], 'dataCode' => ['description' => 'The code of the log type.', 'type' => 'string', 'example' => 'access_log', 'title' => ''], 'policyName' => ['description' => 'The name of the collection rule.', 'type' => 'string', 'example' => 'your_log_policy', 'title' => ''], 'enabled' => ['description' => 'Indicates whether the collection rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'policyConfig' => [ 'description' => 'The configuration of the collection rule.', 'type' => 'object', 'properties' => [ 'resourceMode' => ['description' => 'The resource collection mode.', 'type' => 'string', 'example' => 'all', 'title' => ''], 'regions' => [ 'description' => 'The regions to which the instances belong.', 'type' => 'array', 'items' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'title' => '', 'example' => '', ], 'instanceIds' => [ 'description' => 'The IDs of the instances.', 'type' => 'array', 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'your-test-bucket1'."\n", 'title' => ''], 'title' => '', 'example' => '', ], 'resourceTags' => ['description' => 'The resource tags.', 'type' => 'object', 'example' => '{"tag1":"value1","tag2":"value2"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'centralizeEnabled' => ['description' => 'Indicates whether centralized data shipping is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'centralizeConfig' => [ 'description' => 'The configuration for centralized data shipping.', 'type' => 'object', 'properties' => [ 'destRegion' => ['description' => 'The destination region for centralized data shipping.', 'type' => 'string', 'example' => 'cn-beijing'."\n", 'title' => ''], 'destProject' => ['description' => 'The destination project for centralized data shipping.', 'type' => 'string', 'example' => 'your-sls-project-in-beijing'."\n", 'title' => ''], 'destLogstore' => ['description' => 'The destination Logstore for centralized data shipping.', 'type' => 'string', 'example' => 'your-sls-logstore-in-beijing'."\n", 'title' => ''], 'destTTL' => ['description' => 'The data retention period of the destination Logstore for centralized data shipping. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'resourceDirectory' => [ 'description' => 'The configuration of the resource directory. This parameter is empty if no configuration is available.', 'type' => 'object', 'properties' => [ 'accountGroupType' => ['description' => 'The mode for selecting accounts in the resource directory. Valid values: all and custom.', 'type' => 'string', 'example' => 'all,custom', 'title' => ''], 'members' => [ 'description' => 'The list of member accounts. This parameter is returned only if accountGroupType is set to custom.', 'type' => 'array', 'items' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '165***********50', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'dataConfig' => [ 'description' => 'Configurations for global log types, such as sls. This parameter is empty for other log types.', 'type' => 'object', 'properties' => [ 'dataRegion' => ['description' => 'The region where global logs are first collected. This parameter is used only for global log types, such as sls.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'dataProject' => ['description' => 'The project for global logs. This parameter is used only for global log types, such as sls. If this parameter is empty, logs are collected to the default project of the account in the region specified by dataRegion.', 'type' => 'string', 'example' => '""', 'title' => ''], ], 'title' => '', 'example' => '', ], 'internalPolicy' => ['description' => 'Indicates whether the policy is a built-in policy. Built-in policies cannot be modified or deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'policyUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the collection rule. If a resource directory administrator or delegated administrator creates the rule, this is the ID of that administrator\'s account.', 'type' => 'string', 'example' => '148***********50', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'statistics' => [ 'description' => 'Statistics returned based on the query conditions.', 'type' => 'array', 'items' => [ 'description' => 'Statistics for collection rules, grouped by productCode.', 'type' => 'object', 'properties' => [ 'productCode' => ['description' => 'The code of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'oss', 'title' => ''], 'policySourceList' => [ 'description' => 'The list of collection rule sources.', 'type' => 'array', 'items' => [ 'description' => 'The source of the collection rule.', 'type' => 'object', 'properties' => [ 'policyUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the collection rule. If a resource directory administrator or delegated administrator creates the rule, this is the ID of that administrator\'s account.', 'type' => 'string', 'example' => '148***********50', 'title' => ''], 'policyName' => ['description' => 'The name of the collection rule.', 'type' => 'string', 'example' => 'policy_name1_from148', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"currentCount\\": 1,\\n \\"data\\": [\\n {\\n \\"productCode\\": \\"oss\\",\\n \\"dataCode\\": \\"access_log\\",\\n \\"policyName\\": \\"your_log_policy\\",\\n \\"enabled\\": true,\\n \\"policyConfig\\": {\\n \\"resourceMode\\": \\"all\\",\\n \\"regions\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"instanceIds\\": [\\n \\"your-test-bucket1\\\\n\\"\\n ],\\n \\"resourceTags\\": {\\n \\"tag1\\": \\"value1\\",\\n \\"tag2\\": \\"value2\\"\\n }\\n },\\n \\"centralizeEnabled\\": false,\\n \\"centralizeConfig\\": {\\n \\"destRegion\\": \\"cn-beijing\\\\n\\",\\n \\"destProject\\": \\"your-sls-project-in-beijing\\\\n\\",\\n \\"destLogstore\\": \\"your-sls-logstore-in-beijing\\\\n\\",\\n \\"destTTL\\": 0\\n },\\n \\"resourceDirectory\\": {\\n \\"accountGroupType\\": \\"all,custom\\",\\n \\"members\\": [\\n \\"165***********50\\"\\n ]\\n },\\n \\"dataConfig\\": {\\n \\"dataRegion\\": \\"cn-hangzhou\\",\\n \\"dataProject\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"internalPolicy\\": false,\\n \\"policyUid\\": \\"148***********50\\"\\n }\\n ],\\n \\"statistics\\": [\\n {\\n \\"productCode\\": \\"oss\\",\\n \\"policySourceList\\": [\\n {\\n \\"policyUid\\": \\"148***********50\\",\\n \\"policyName\\": \\"policy_name1_from148\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListCollectionPolicies', 'description' => 'This API operation is available only at the endpoints in the following regions: China (Shanghai), Singapore, and Heyuan Automotive Compliance Cloud (cn-heyuan-acdr-1).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListConfig' => [ 'summary' => 'Queries all Logtail configurations in a project.', 'path' => '/configs', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '8980', 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstoreName', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Maximum value: 500.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'query', 'schema' => ['description' => 'The name of the Logtail configuration, which is used for fuzzy match.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'logtail-config-sample'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of Logtail configurations that are returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'total' => ['description' => 'The total number of Logtail configurations that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'configs' => [ 'description' => 'The Logtail configurations that are returned on the current page.', 'type' => 'array', 'items' => ['description' => 'The Logtail configuration that is returned.', 'type' => 'string', 'example' => 'logtail-config-sample', 'title' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 3,\\n \\"total\\": 2,\\n \\"configs\\": [\\n \\"logtail-config-sample\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListConfig', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist| The Project does not exist : projectName | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist| Logstore logstoreName does not exist. | Logstore不存在。 |'."\n" .'| 404 | ConfigNotExist|config configName does not exist. | Logtail配置不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*'], ], ], ], ], ], 'ListConsumeProcessors' => [ 'summary' => 'Retrieves a list of consume processors that match the specified parameters.', 'path' => '/consumeprocessors', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '225118', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'processorName', 'in' => 'query', 'schema' => ['description' => 'The identity of the consume processor.', 'type' => 'string', 'required' => false, 'example' => 'consume-processor-1', 'title' => ''], ], [ 'name' => 'displayName', 'in' => 'query', 'schema' => ['description' => 'The display name of the consume processor.', 'type' => 'string', 'required' => false, 'example' => 'filter-get-request', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The offset of the query. The default value is 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. The default value is 200.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of consume processors that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'count' => ['description' => 'The number of consume processors returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'processors' => [ 'description' => 'The list of consume processors.', 'type' => 'array', 'items' => ['description' => 'The information about the consume processor.', '$ref' => '#/components/schemas/ConsumeProcessor', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 20,\\n \\"count\\": 10,\\n \\"processors\\": [\\n {\\n \\"processorName\\": \\"consume-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListConsumeProcessors', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListConsumerGroup' => [ 'summary' => 'Queries all consumer groups of a Logstore.', 'path' => '/logstores/{logstore}/consumergroups', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'Project name', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['title' => 'Logstore name', 'description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The consumer groups.', 'type' => 'array', 'items' => ['description' => 'The information about the consumer group.', '$ref' => '#/components/schemas/ConsumerGroup', 'example' => 'test-consumer-group', 'title' => ''], 'example' => '[{\'\'name\'\': \'\'test-consumer-group\'\', \'\'timeout\'\': 30, \'\'order\'\': False}]', 'title' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"name\\": \\"test-consumer-group\\",\\n \\"timeout\\": 300,\\n \\"order\\": false\\n }\\n]","type":"json"}]', 'title' => 'ListConsumerGroup', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :---------------------- | :------------------------------------------------------------------------------------------------- |'."\n" .'| `log:ListConsumerGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*'], ], ], ], ], ], 'ListDashboard' => [ 'summary' => 'Queries dashboards.', 'path' => '/dashboards', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '10283', 'abilityTreeNodes' => ['FEATUREslsHU53H2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'required' => false, 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page for a paged query. The maximum value is 500. The default value is 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '500', 'title' => '', 'required' => false], ], [ 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], 'required' => false, 'description' => 'A tag.', 'title' => '', 'example' => '', ], 'required' => false, 'description' => 'The tag information.', 'title' => '', 'example' => '', ], ], [ 'name' => 'dashboardName', 'in' => 'query', 'schema' => ['description' => 'The dashboard name.', 'type' => 'string', 'required' => false, 'example' => 'dashboard-1609294922657-434834', 'title' => ''], ], [ 'name' => 'displayName', 'in' => 'query', 'schema' => ['description' => 'The display name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => 'The dashboard.', 'type' => 'object', 'properties' => [ 'dashboards' => [ 'title' => '', 'description' => 'A list of dashboard names. This corresponds to dashboardName.', 'type' => 'array', 'items' => ['description' => 'A list of dashboard names. This corresponds to dashboardName.', 'type' => 'string', 'example' => 'dashboard-1609294922657-434834', 'title' => ''], 'example' => '', ], 'dashboardItems' => [ 'description' => 'The dashboards.', 'type' => 'array', 'items' => [ 'description' => 'A dashboard.', 'type' => 'object', 'properties' => [ 'dashboardName' => ['description' => 'The dashboard ID. The ID must be unique within a project. Fuzzy queries are supported. For example, if you enter da, all dashboards whose names start with da are returned.', 'type' => 'string', 'example' => 'dashboard-1609294922657-434834', 'title' => ''], 'displayName' => ['description' => 'The display name of the dashboard.', 'type' => 'string', 'example' => 'data-ingest', 'title' => ''], 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'tablet_ai', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"dashboards\\": [\\n \\"dashboard-1609294922657-434834\\"\\n ],\\n \\"dashboardItems\\": [\\n {\\n \\"dashboardName\\": \\"dashboard-1609294922657-434834\\",\\n \\"displayName\\": \\"data-ingest\\",\\n \\"description\\": \\"tablet_ai\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListDashboard', 'description' => '### Description'."\n" ."\n" .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project name in the Host.'."\n" ."\n" .'- Create an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has the permissions to call all API operations. This is a high-risk practice. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- Identify the name and region of the project that contains the logs you want to query. For more information, see [Manage projects](~~48984~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 400 | ParameterInvalid | offset: offset is invalid. |offset参数取值无效。|'."\n" .'| 400 | ParameterInvalid | size: size is invalid. |size参数取值无效。|'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/*'], ], ], ], ], ], 'ListDomains' => [ 'summary' => 'Queries the custom domain names that are bound to projects.', 'path' => '/domains', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'Project name', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 500. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'domainName', 'in' => 'query', 'schema' => ['description' => 'The domain name that is used to match custom domain names. For example, if you set domainName to `example.com`, the matched domain names are `a.example.com` and `b.example.com`.', 'type' => 'string', 'example' => 'example.com', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => 'The information about the domain names.', 'type' => 'object', 'properties' => [ 'domains' => [ 'description' => 'The domain names.', 'type' => 'array', 'items' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], 'title' => '', 'example' => '', ], 'count' => ['description' => 'The number of domain names that are returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'total' => ['description' => 'The total number of domain names that are returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domains\\": [\\n \\"example.com\\"\\n ],\\n \\"count\\": 1,\\n \\"total\\": 1\\n}","type":"json"}]', 'title' => 'ListDomains', 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- Only one custom domain name can be bound to each project.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListDomains', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/*'], ], ], ], ], ], 'ListDownloadJobs' => [ 'summary' => 'Lists the log download jobs in a specified project.', 'path' => '/downloadjobs', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '216707', 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of log download jobs to return in a single request.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The information about all log download jobs.', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'count' => ['description' => 'The number of log download jobs returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'results' => [ 'title' => '', 'description' => 'An array that contains the list of log download jobs.', 'type' => 'array', 'items' => [ 'title' => 'DownloadJobItemType', 'description' => 'The information about a log download job.', 'type' => 'object', 'properties' => [ 'description' => ['description' => 'The description of the log download job.', 'type' => 'string', 'title' => '', 'example' => 'a download job'], 'configuration' => [ 'title' => '', 'description' => 'The download configuration.', 'type' => 'object', 'properties' => [ 'logstore' => ['description' => 'The source Logstore.', 'type' => 'string', 'title' => '', 'example' => 'ali-test-logstore'], 'fromTime' => ['description' => 'The start time of the query. This is a UNIX timestamp that is accurate to the second.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722409260'], 'toTime' => ['description' => 'The end time of the query. This is a UNIX timestamp that is accurate to the second.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722411060'], 'query' => ['description' => 'The query statement.', 'type' => 'string', 'title' => '', 'example' => '* | select *'], 'powerSql' => ['description' => 'Specifies whether to enable PowerSQL.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'allowInComplete' => ['description' => 'Specifies whether to allow the download of incomplete results.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'sink' => [ 'title' => '', 'description' => 'The sink configuration.', 'type' => 'object', 'properties' => [ 'compressionType' => ['description' => 'The compression format.', 'type' => 'string', 'title' => '', 'example' => 'none'], 'contentType' => ['description' => 'The file format of the downloaded file.', 'type' => 'string', 'title' => '', 'example' => 'csv'], 'roleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role that is used for the download.', 'type' => 'string', 'title' => '', 'example' => 'acs:ram::123456:role/aliyunlogimportossrole'], 'bucket' => ['description' => 'The destination OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'ali-test-oss-bucket'], 'prefix' => ['description' => 'The prefix of the object that is downloaded to the destination OSS bucket.', 'type' => 'string', 'example' => 'download/', 'title' => ''], 'type' => ['description' => 'The type of the sink. The value is fixed as AliyunOSS.', 'type' => 'string', 'example' => 'AliyunOSS', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'displayName' => ['description' => 'Display name', 'type' => 'string', 'title' => '', 'example' => 'download-123'], 'executionDetails' => [ 'title' => '', 'description' => 'The execution details of the job.', 'type' => 'object', 'properties' => [ 'progress' => ['description' => 'The download progress as a percentage.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], 'filePath' => ['description' => 'The URL of the downloaded file.', 'type' => 'string', 'title' => '', 'example' => 'https://sls-downloaded-xxxx.csv.gzip?Expiresxxx'], 'fileSize' => ['description' => 'The size of the downloaded file in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123456'], 'executeTime' => ['description' => 'The running time of the download.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], 'logCount' => ['description' => 'The number of downloaded log entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], 'errorMessage' => ['description' => 'The error message that is returned if the job fails.', 'type' => 'string', 'title' => '', 'example' => 'timeout'], 'checkSum' => ['description' => 'The ETag of the file.', 'type' => 'string', 'example' => 'ETASFGASDASQWDasd', 'title' => ''], 'notice' => ['description' => 'The notification message.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'example' => '', ], 'name' => ['description' => 'The name of the log download job.', 'type' => 'string', 'title' => '', 'example' => 'download-123'], 'createTime' => ['description' => 'The time when the log download job was created. This is a UNIX timestamp in seconds.', 'type' => 'string', 'example' => '1722411060', 'title' => ''], 'status' => ['description' => 'The status of the Job.', 'type' => 'string', 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR', 'title' => ''], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"description\\": \\"a download job\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"ali-test-logstore\\",\\n \\"fromTime\\": 1722409260,\\n \\"toTime\\": 1722411060,\\n \\"query\\": \\"* | select *\\",\\n \\"powerSql\\": true,\\n \\"allowInComplete\\": \\"false\\",\\n \\"sink\\": {\\n \\"compressionType\\": \\"none\\",\\n \\"contentType\\": \\"csv\\",\\n \\"roleArn\\": \\"acs:ram::123456:role/aliyunlogimportossrole\\",\\n \\"bucket\\": \\"ali-test-oss-bucket\\",\\n \\"prefix\\": \\"download/\\",\\n \\"type\\": \\"AliyunOSS\\"\\n }\\n },\\n \\"displayName\\": \\"download-123\\",\\n \\"executionDetails\\": {\\n \\"progress\\": 100,\\n \\"filePath\\": \\"https://sls-downloaded-xxxx.csv.gzip?Expiresxxx\\",\\n \\"fileSize\\": 123456,\\n \\"executeTime\\": 123,\\n \\"logCount\\": 123,\\n \\"errorMessage\\": \\"timeout\\",\\n \\"checkSum\\": \\"ETASFGASDASQWDasd\\",\\n \\"notice\\": \\"test\\"\\n },\\n \\"name\\": \\"download-123\\",\\n \\"createTime\\": \\"1722411060\\",\\n \\"status\\": \\"STARTING、RUNNING、SUCCEEDED、ERROR\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListDownloadJobs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListDownloadJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListETLs' => [ 'summary' => 'Lists the data transformation jobs in a project.', 'path' => '/etls', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '203166', 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of data transformation jobs to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The Logstore name.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of data transformation jobs in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], 'count' => ['description' => 'The number of data transformation jobs returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'results' => [ 'description' => 'A list of data transformation results.', 'type' => 'array', 'items' => ['description' => 'The data transformation configuration.', '$ref' => '#/components/schemas/ETL', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ETL\\",\\n \\"description\\": \\"ETL\\",\\n \\"displayName\\": \\"ETL\\",\\n \\"configuration\\": {\\n \\"script\\": \\"e_set(\\\\\\"key\\\\\\",\\\\\\"value\\\\\\")\\",\\n \\"lang\\": \\"SPL\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"fromTime\\": 0,\\n \\"toTime\\": 0,\\n \\"sinks\\": [\\n {\\n \\"name\\": \\"test-etljob\\",\\n \\"endpoint\\": \\"\\",\\n \\"project\\": \\"test-project\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"datasets\\": [\\n \\"__UNNAMED__\\"\\n ],\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\"\\n }\\n ],\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714274900,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"f0eb655e501a8780808d1970ef6d04c4\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListETLs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListETLs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListElasticsearchIngestions' => [ 'path' => '/elasticsearchingestions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '273942', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of Elasticsearch/OpenSearch import jobs in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], 'count' => ['description' => 'The number of Elasticsearch/OpenSearch import jobs returned in the current request.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'results' => [ 'type' => 'array', 'items' => ['description' => 'The configuration of the Elasticsearch/OpenSearch import job.', '$ref' => '#/components/schemas/ESIngestion', 'title' => '', 'example' => ''], 'description' => 'The list of Elasticsearch/OpenSearch import jobs.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListElasticsearchIngestions', 'summary' => 'Lists the Elasticsearch and OpenSearch ingestion jobs.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-es-123456\\",\\n \\"description\\": \\"es ingestion\\",\\n \\"displayName\\": \\"es ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"test-logstore\\",\\n \\"source\\": {\\n \\"BootstrapServers\\": \\"\\",\\n \\"Index\\": \\"\\",\\n \\"Username\\": \\"\\",\\n \\"Password\\": \\"\\",\\n \\"TimeFieldName\\": \\"\\",\\n \\"TimeFormat\\": \\"\\",\\n \\"TimeZone\\": \\"\\",\\n \\"Query\\": \\"\\",\\n \\"ConnectorMode\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"MaxDataDelaySec\\": 0,\\n \\"MinFragRangeSec\\": 0,\\n \\"VpcId\\": \\"\\"\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListGCSIngestions' => [ 'summary' => 'Lists Google Cloud Storage (GCS) file import jobs.', 'path' => '/gcsingestions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testproject'], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The position from which to start returning results. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of results to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'count' => ['description' => 'The number of jobs returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'results' => [ 'type' => 'array', 'items' => ['description' => 'The details of the job configuration.', '$ref' => '#/components/schemas/GCSIngestion', 'title' => '', 'example' => ''], 'description' => 'The details of the job configurations.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The schema of the response.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListGCSIngestions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 100,\\n \\"count\\": 100,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-gcs-123456\\",\\n \\"description\\": \\"gcs ingestion\\",\\n \\"displayName\\": \\"gcs ingestion\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"gcsbucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"never\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"restoreObjectEnabled\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"tagPackId\\": false,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"format\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"lastModifiedTime\\": 1714360581\\n }\\n ]\\n}","type":"json"}]', ], 'ListIngestProcessors' => [ 'summary' => 'Lists ingest processors that meet the specified conditions.', 'path' => '/ingestprocessors', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '225111', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'processorName', 'in' => 'query', 'schema' => ['description' => 'The identifier of the ingest processor.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'parse-nginx-log'], ], [ 'name' => 'displayName', 'in' => 'query', 'schema' => ['description' => 'The display name of the ingest processor.', 'type' => 'string', 'example' => 'Parse Nginx log', 'title' => '', 'required' => false], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The offset value. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'title' => '', 'required' => false], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. The default value is 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'count' => ['description' => 'The number of entries returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'processors' => [ 'description' => 'A list of ingest processors that meet the query conditions.', 'type' => 'array', 'items' => ['description' => 'The information about the ingest processor.', '$ref' => '#/components/schemas/IngestProcessor', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 5,\\n \\"processors\\": [\\n {}\\n ]\\n}","type":"json"}]', 'title' => 'ListIngestProcessors', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'ListLogStores' => [ 'summary' => 'Queries all Logstores or Logstores that match specific conditions in a project.', 'path' => '/logstores', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'required' => false, 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Maximum value: 500. Default value: 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '500', 'title' => '', 'required' => false], ], [ 'name' => 'logstoreName', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore. Fuzzy match is supported. For example, if you enter test, Logstores whose name contains test are returned.', 'type' => 'string', 'required' => false, 'example' => 'my-logstore', 'title' => ''], ], [ 'name' => 'telemetryType', 'in' => 'query', 'schema' => ['description' => 'The type of the data that you want to query. Valid values:'."\n" ."\n" .'- None: logs'."\n" ."\n" .'- Metrics: metrics', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''], ], [ 'name' => 'mode', 'in' => 'query', 'schema' => ['description' => 'The type of the Logstore. Valid values: standard and query.'."\n" ."\n" .'- **standard**: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system.'."\n" ."\n" .'- **query**: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the volume of data is large, the log retention period is long, or log analysis is not required. Log retention periods of weeks or months are considered long.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'The body of the response.', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The number of the Logstores that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], 'count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], 'logstores' => [ 'description' => 'The Logstores that meet the query conditions.', 'type' => 'array', 'items' => ['description' => 'The information about the Logstore.', 'type' => 'string', 'example' => 'test-1,test-2', 'title' => ''], 'example' => '["test-1","test-2"]', 'title' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 2,\\n \\"count\\": 2,\\n \\"logstores\\": [\\n \\"test-1,test-2\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListLogStores', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :------------------ | :------------------------------------------------------------------- |'."\n" .'| `log:ListLogStores` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/*` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListLogStores', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/*'], ], ], ], ], ], 'ListLogtailPipelineConfig' => [ 'summary' => 'Lists the names of Logtail pipeline configurations that meet specified criteria.', 'path' => '/pipelineconfigs', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191816', 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which to start the query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', 'default' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The number of pipeline configurations to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20', 'default' => '500', 'title' => ''], ], [ 'name' => 'logstoreName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'example' => 'test-logstore', 'title' => '', 'required' => false], ], [ 'name' => 'configName', 'in' => 'query', 'schema' => ['description' => 'The name of the pipeline configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'logtail-config-sample'], ], [ 'name' => 'configType', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of Logtail pipeline configurations returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'total' => ['description' => 'The total number of Logtail pipeline configurations in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'configs' => [ 'title' => '', 'description' => 'The list of Logtail pipeline configurations returned on the current page.', 'type' => 'array', 'items' => ['description' => 'The name of the Logtail pipeline configuration.', 'type' => 'string', 'title' => '', 'example' => 'test_logstore'], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 10,\\n \\"total\\": 20,\\n \\"configs\\": [\\n \\"test_logstore\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListLogtailPipelineConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListMachineGroup' => [ 'summary' => 'Queries the machine groups of a project.', 'path' => '/machinegroups', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '2000', 'title' => ''], ], [ 'name' => 'groupName', 'in' => 'query', 'schema' => ['description' => 'The name of the machine group. This parameter is used to filter machine groups. Partial match is supported.', 'type' => 'string', 'example' => 'test-machine-group', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of machine groups that are returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'total' => ['description' => 'The total number of machine groups that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'machinegroups' => [ 'title' => '', 'description' => 'The machine groups that meet the query conditions.', 'type' => 'array', 'items' => ['description' => 'The name of the machine group.', 'type' => 'string', 'example' => 'test-group', 'title' => ''], 'example' => '[ "test-machine-group-1", "test-machine-group-2" ]', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 1,\\n \\"total\\": 1,\\n \\"machinegroups\\": [\\n \\"test-group\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListMachineGroup', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 500 | InternalServerError | internal server error. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[错误码对照表](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*'], ], ], ], ], ], 'ListMachines' => [ 'summary' => 'Queries a list of machines that are connected to Simple Log Service in a specified machine group.', 'path' => '/machinegroups/{machineGroup}/machines', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-group', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Default value: 100. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '2000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => 'The machines that are returned.', 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of machines that are returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'total' => ['description' => 'The total number of machines.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'machines' => [ 'title' => '', 'description' => 'The machines that are returned.', 'type' => 'array', 'items' => ['description' => 'The information about the machine.', '$ref' => '#/components/schemas/machine', 'title' => '', 'example' => '[{"ip": "10.***.***.***", "machine-uniqueid": "", "userdefined-id": "", "lastHeartbeatTime": 1447182247},{"ip": "10.***.***.***", "machine-uniqueid": "","userdefined-id": "","lastHeartbeatTime": 1447182246}]'], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 3,\\n \\"total\\": 8,\\n \\"machines\\": [\\n {\\n \\"ip\\": \\"192.168.xx.x\\",\\n \\"machine-uniqueid\\": \\"3B70F4F1-80F7-46C4-A6C1-100****EE647\\",\\n \\"lastHeartbeatTime\\": 1447182247,\\n \\"userdefined-id\\": \\"无\\",\\n \\"host-id\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListMachines', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | MachineGroupNotExist| MachineGroup groupName does not exist. | 机器组不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListMachines', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], ], ], 'ListMaterializedView' => [ 'path' => '/materializedviews', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'abilityTreeCode' => '294478', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project that contains the materialized views.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'name', 'in' => 'query', 'schema' => ['description' => 'The name of the materialized view. Use this to query for a specific materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The number of entries to skip before returning results. This parameter is used for pagination. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The maximum number of materialized views to return per page. Default value: 100. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of materialized views returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'total' => ['description' => 'The total number of materialized views that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'materializedViews' => [ 'type' => 'array', 'items' => ['description' => 'The name of the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], 'description' => 'A list of materialized views.', 'title' => '', 'example' => '', ], ], 'description' => 'The response body.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'summary' => 'Lists the materialized views in a project.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 0,\\n \\"total\\": 0,\\n \\"materializedViews\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListMaterializedView', ], 'ListMaterializedViews' => [ 'summary' => 'Lists materialized views.', 'path' => '/materializedviews', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'abilityTreeCode' => '294661', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'name', 'in' => 'query', 'schema' => ['description' => 'The name of the materialized view. Fuzzy search is supported.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The position from which to start returning results for pagination. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of materialized views to return. The actual number of returned materialized views may be less than the specified value. If you do not specify this parameter, a system default is used.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of materialized views returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'total' => ['description' => 'The total number of materialized views that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'materializedViews' => [ 'type' => 'array', 'items' => ['description' => 'The name of a materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], 'description' => 'An array of materialized view names.', 'title' => '', 'example' => '', ], ], 'description' => 'The response body.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 0,\\n \\"total\\": 0,\\n \\"materializedViews\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListMaterializedViews', ], 'ListMaxComputeExports' => [ 'summary' => 'Lists MaxCompute delivery tasks.', 'path' => '/maxcomputeexports', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '203415', 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The position from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'my-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of MaxCompute delivery tasks in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'count' => ['description' => 'The number of MaxCompute delivery tasks that are returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'results' => [ 'description' => 'The list of MaxCompute delivery tasks.', 'type' => 'array', 'items' => ['description' => 'The details of the task configuration.', '$ref' => '#/components/schemas/MaxComputeExport', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"MaxComputeExport\\",\\n \\"description\\": \\"MaxComputeExport\\",\\n \\"displayName\\": \\"MaxComputeExport\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\\\n\\",\\n \\"sink\\": {\\n \\"odpsEndpoint\\": \\"https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api\\",\\n \\"odpsTunnelEndpoint\\": \\"https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com\\",\\n \\"odpsProject\\": \\"demo_project\\",\\n \\"odpsTable\\": \\"demo_table\\",\\n \\"odpsRolearn\\": \\"acs:ram::xxxxxxx\\",\\n \\"odpsAccessKeyId\\": \\"axxxxxxxxxxxb\\",\\n \\"odpsAccessSecret\\": \\"aaxxxxxxxxxxxxxxxxxxxxxbb\\",\\n \\"partitionTimeFormat\\": \\"%Y_%m_%d\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"fields\\": [\\n \\"\'f1\'\\"\\n ],\\n \\"partitionColumn\\": [\\n \\"\'p1\'\\"\\n ],\\n \\"filterInvalid\\": true,\\n \\"timeFormatType\\": \\"StrfTimeFormat\\",\\n \\"bufferInterval\\": \\"1800\\"\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718390800\\n },\\n \\"createTime\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListMaxComputeExports', 'description' => '- The Host consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.'."\n" ."\n" .'- Create and obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has permissions to access all APIs. This poses a high security risk. We recommend that you create and use a Resource Access Management (RAM) user for API access or daily O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- Identify the name and region of the project that contains the logs to query. For more information, see [Manage projects](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListMetricStores' => [ 'summary' => 'Queries the list of Metricstores in a project. You can use fuzzy search to query the Metricstores by Metricstore name.', 'path' => '/metricstores', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225690', 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my-project'], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The start position of the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'title' => '', 'required' => false], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '500', 'title' => '', 'required' => false], ], [ 'name' => 'mode', 'in' => 'query', 'schema' => ['description' => 'The type of the Metricstore. For example, you can set the parameter to standard to query Standard Metricstores.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'standard'], ], [ 'name' => 'name', 'in' => 'query', 'schema' => ['description' => 'The name of the Metricstore. Fuzzy search is supported. If you do not specify this parameter, all Metricstores are involved.', 'type' => 'string', 'example' => 'metric_store', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'total' => ['description' => 'The total number of queried Metricstores.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], 'metricstores' => [ 'title' => '', 'description' => 'The names of the Metricstores.', 'type' => 'array', 'items' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'example' => 'my_metric_store', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 10,\\n \\"total\\": 100,\\n \\"metricstores\\": [\\n \\"my_metric_store\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListMetricStores', 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query metric data is obtained. The information includes the name of the project to which the metric data belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'ListOSSExports' => [ 'summary' => 'Queries the OSS shipping jobs in a specified project.', 'path' => '/ossexports', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '203471', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line number from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of jobs to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. The default value is 10.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of OSS shipping jobs in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'count' => ['description' => 'The number of OSS shipping jobs returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'results' => [ 'description' => 'The list of OSS shipping jobs.', 'type' => 'array', 'items' => ['description' => 'The detailed configuration of the job.', '$ref' => '#/components/schemas/OSSExport', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"https://oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"bucket\\": \\"my-bucket\\",\\n \\"prefix\\": \\"prefix-demo/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"pathFormat\\": \\"%Y/%m/%d/%H/%M\\",\\n \\"pathFormatType\\": \\"time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"csv\\",\\n \\"contentDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"your log key1\\\\\\",\\\\n \\\\\\"your log key2\\\\\\",\\\\n \\\\\\"your log key3\\\\\\",\\\\n ],\\\\n \\\\\\"delimiter\\\\\\": \\\\\\" \\\\\\",\\\\n \\\\\\"header\\\\\\": true,\\\\n \\\\\\"lineFeed\\\\\\": \\\\\\"\\\\\\\\n\\\\\\",\\\\n \\\\\\"null\\\\\\": \\\\\\"-\\\\\\",\\\\n \\\\\\"quote\\\\\\": \\\\\\"\\\\\\\\\\\\\\"\\\\\\"\\\\n},\\"\\n },\\n \\"compressionType\\": \\"snappy\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718380800,\\n \\"sourceSecureTransport\\": false\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListOSSExports', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListOSSExports', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListOSSHDFSExports' => [ 'summary' => 'Lists the OSS-HDFS export tasks in a specified project.', 'path' => '/osshdfsexports', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '203484', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which to start the query. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of OSS-HDFS export tasks in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'count' => ['description' => 'The number of OSS-HDFS export tasks returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'results' => [ 'description' => 'The list of OSS-HDFS export tasks.', 'type' => 'array', 'items' => ['description' => 'The details of the task configuration.', '$ref' => '#/components/schemas/OSSExport', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"https://oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"bucket\\": \\"my-bucket\\",\\n \\"prefix\\": \\"prefix-demo/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"pathFormat\\": \\"%Y/%m/%d/%H/%M\\",\\n \\"pathFormatType\\": \\"time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"csv\\",\\n \\"contentDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"your log key1\\\\\\",\\\\n \\\\\\"your log key2\\\\\\",\\\\n \\\\\\"your log key3\\\\\\",\\\\n ],\\\\n \\\\\\"delimiter\\\\\\": \\\\\\" \\\\\\",\\\\n \\\\\\"header\\\\\\": true,\\\\n \\\\\\"lineFeed\\\\\\": \\\\\\"\\\\\\\\n\\\\\\",\\\\n \\\\\\"null\\\\\\": \\\\\\"-\\\\\\",\\\\n \\\\\\"quote\\\\\\": \\\\\\"\\\\\\\\\\\\\\"\\\\\\"\\\\n},\\"\\n },\\n \\"compressionType\\": \\"snappy\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718380800,\\n \\"sourceSecureTransport\\": false\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListOSSHDFSExports', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListOSSHDFSExports', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListOSSIngestions' => [ 'path' => '/ossingestions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '203123', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The number of entries to skip for pagination. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The maximum number of OSS import tasks to return in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'."\n", 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of OSS import tasks in the Project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], 'count' => ['description' => 'The number of OSS import tasks returned in this response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'results' => [ 'description' => 'A list of OSS import tasks.', 'type' => 'array', 'items' => ['description' => 'The configuration of an OSS import task.', '$ref' => '#/components/schemas/OSSIngestion', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListOSSIngestions', 'summary' => 'Lists OSS import tasks in a specified Project.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListOSSIngestions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-oss-123456\\",\\n \\"description\\": \\"oss ingestion\\",\\n \\"displayName\\": \\"oss ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"ossbucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"never\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"restoreObjectEnabled\\": true,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"useMetaIndex\\": false,\\n \\"roleARN\\": \\"acs:ram::12345:role/aliyunlogdefaultrole\\",\\n \\"tagPackId\\": true,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"Line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListProject' => [ 'path' => '/', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8912', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'projectName', 'in' => 'query', 'schema' => ['description' => 'The name of the project. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query. Default value: 100. A maximum of 500 project entries can be returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '500'], ], [ 'name' => 'resourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzf******sxby', 'title' => ''], ], [ 'name' => 'fetchQuota', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to retrieve the project quota information.', 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => '', ], ], [ 'name' => 'description', 'in' => 'query', 'schema' => ['description' => 'The project description, used for filtering.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Access-Control-Allow-Origin' => [ 'schema' => ['type' => 'string', 'example' => '*'], ], 'Connection' => [ 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], ], 'schema' => [ 'description' => 'The project list.', 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of projects returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'total' => ['description' => 'The total number of projects that meet the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], 'projects' => [ 'description' => 'The list of projects that meet the query conditions.', 'type' => 'array', 'items' => ['description' => 'The project that meets the query conditions.', '$ref' => '#/components/schemas/project', 'example' => '不涉及', 'title' => ''], 'example' => 'Not applicable', 'title' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'List project information', 'summary' => 'Lists project information that meets the specified conditions.', 'description' => '### Operation description'."\n" .'The Host consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.', 'requestParamsDescription' => 'Request example:'."\n" ."\n" .'GET /?projectName=ali-test-project&offset=0&size=10 HTTP/1.1'."\n" .'Host:ali-test-project.ap-southeast-1.log.aliyuncs.com'."\n" .'Content-Type:application/json.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | Description |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ParameterInvalid | offset : offset pair is invalid | The value of the offset parameter is invalid. |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | An internal service invocation error occurred. |'."\n" ."\n" .'For more information, see [Common error codes](~~29013~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 2,\\n \\"total\\": 11,\\n \\"projects\\": [\\n {\\n \\"createTime\\": \\"2021-07-07 14:08:09\\",\\n \\"lastModifyTime\\": \\"2022-04-18 13:30:19\\",\\n \\"description\\": \\"Description of my-project\\",\\n \\"owner\\": \\"\\\\\\"\\\\\\"\\",\\n \\"projectName\\": \\"ali-test-project\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"Normal\\",\\n \\"resourceGroupId\\": \\"rg-acf******sq\\",\\n \\"dataRedundancyType\\": \\"LRS\\",\\n \\"recycleBinEnabled\\": false,\\n \\"internetEndpoint\\": \\"\\",\\n \\"internalEndpoint\\": \\"\\",\\n \\"quota\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'ListS3Ingestions' => [ 'path' => '/s3ingestions', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '263587', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'testproject', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The starting position of the results to return. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of rows per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'count' => ['description' => 'The number of tasks returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'results' => [ 'type' => 'array', 'items' => ['description' => 'The details of the task configurations.', '$ref' => '#/components/schemas/S3Ingestion', 'title' => '', 'example' => ''], 'description' => 'The details of the task configurations.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'title' => 'ListS3Ingestions', 'summary' => 'Lists S3 import tasks.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 3,\\n \\"count\\": 3,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-s3-123456\\",\\n \\"description\\": \\"s3 ingestion\\",\\n \\"displayName\\": \\"s3 ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"awsRegion\\": \\"ap-northeast-1\\",\\n \\"awsAccessKey\\": \\"AKIxxxxxxxxxxYJE\\",\\n \\"awsAccessKeySecret\\": \\"123xxxxxxxxxxfjf\\",\\n \\"bucket\\": \\"s3bucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"30m\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"awsUseSQS\\": false,\\n \\"awsSQSQueueUrl\\": \\"https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan\\",\\n \\"useAwsSQSOnly\\": false,\\n \\"tagPackId\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"endpoint\\": \\"s3.us-east-1.amazonaws.com\\",\\n \\"cloudFrontEndpoint\\": \\"dtfsb7voqy76q.cloudfront.net \\",\\n \\"cloudFrontToken\\": \\"@test-s3-access/ABS\\",\\n \\"useCloudFront\\": false,\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'ListSavedSearch' => [ 'summary' => 'Queries a list of saved searches.', 'path' => '/savedsearches', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project'], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'required' => false, 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '500', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of saved searches that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'count' => ['description' => 'The number of saved searches returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'savedsearchItems' => [ 'description' => 'The saved searches.', 'type' => 'array', 'items' => ['description' => 'The saved search.', '$ref' => '#/components/schemas/SavedSearch', 'example' => 'test-1', 'title' => ''], 'example' => '[ "test-1", "test-2" ]', 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 4,\\n \\"count\\": 4,\\n \\"savedsearchItems\\": [\\n {\\n \\"savedsearchName\\": \\"savedsearch-name\\",\\n \\"searchQuery\\": \\"status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5\\",\\n \\"logstore\\": \\"aliyun-test-logstore\\",\\n \\"topic\\": \\"topic-test\\",\\n \\"displayName\\": \\"Method\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListSavedSearch', 'description' => '### Usage notes'."\n" ."\n" .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*'], ], ], ], ], ], 'ListScheduledSQLs' => [ 'summary' => 'Lists the Scheduled SQLs in a specified project.', 'path' => '/scheduledsqls', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '209929', 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The line from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of Scheduled SQL jobs in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], 'count' => ['description' => 'The number of Scheduled SQL jobs returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'results' => [ 'description' => 'The list of Scheduled SQL jobs.', 'type' => 'array', 'items' => ['description' => 'The configuration of the Scheduled SQL job.', '$ref' => '#/components/schemas/ScheduledSQL', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"description\\": \\"This is a scheduled sql job\\",\\n \\"displayName\\": \\"This is a scheduled sql job\\",\\n \\"name\\": \\"test-scheduled-sql\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"script\\": \\"* | select *\\",\\n \\"sqlType\\": \\"searchQuery\\",\\n \\"destEndpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"destProject\\": \\"project-demo\\",\\n \\"sourceLogstore\\": \\"source-logstore-demo\\",\\n \\"destLogstore\\": \\"dest-logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"destRoleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"fromTimeExpr\\": \\"@m-1m\\",\\n \\"toTimeExpr\\": \\"@m\\",\\n \\"maxRunTimeInSeconds\\": 600,\\n \\"resourcePool\\": \\"enhanced\\",\\n \\"maxRetries\\": 20,\\n \\"fromTime\\": 1712592000,\\n \\"toTime\\": 0,\\n \\"dataFormat\\": \\"log2log\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714123644,\\n \\"lastModifiedTime\\": 1714123644,\\n \\"scheduleId\\": \\"e73f43732852064ad5d091914e39342f\\",\\n \\"status\\": \\"ENABLED\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListScheduledSQLs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:ListScheduledSQLs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListShards' => [ 'summary' => 'Queries a list of shards in a Logstore.', 'path' => '/logstores/{logstore}/shards', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The shards in the Logstore.', 'type' => 'array', 'items' => ['description' => 'The shard struct.', '$ref' => '#/components/schemas/shard', 'title' => '', 'example' => ''], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shardID\\": 0,\\n \\"status\\": \\"readwrite\\",\\n \\"inclusiveBeginKey\\": \\"00000000000000000000000000000000\\",\\n \\"exclusiveEndKey\\": \\"8000000000000000000000000000000\\",\\n \\"serverIp\\": \\"203.0.113.10\\",\\n \\"createTime\\": 1524222931\\n }\\n]","type":"json"}]', 'title' => 'ListShards', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListShards', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], ], ], 'ListStoreViews' => [ 'summary' => 'Queries datasets in a project.', 'path' => '/storeviews', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208670', 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of datasets to return. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', 'schema' => ['description' => 'The offset of the datasets to return. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'name', 'in' => 'query', 'schema' => ['description' => 'The dataset name that is used for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'my_storeview', 'title' => ''], ], [ 'name' => 'storeType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the datasets to return. By default, datasets are not filtered by type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- metricstore'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .'- logstore'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' ', 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'type' => 'string', 'required' => false, 'example' => 'logstore', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The datasets.', 'type' => 'object', 'properties' => [ 'count' => ['description' => 'The number of returned datasets.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'total' => ['description' => 'The total number of datasets in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'storeviews' => [ 'description' => 'The dataset names.', 'type' => 'array', 'items' => ['description' => 'The dataset name.', 'type' => 'string', 'example' => 'my_storeview', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 100,\\n \\"total\\": 100,\\n \\"storeviews\\": [\\n \\"my_storeview\\"\\n ]\\n}","type":"json"}]', 'title' => 'ListStoreViews', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListStoreViews', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTagResources' => [ 'summary' => 'Queries a list of tags for one or more resources. You can query tags for resources by resource type or filter resources by tag. Each tag is a key-value pair.', 'path' => '/tags', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'resourceType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the resource. Valid values:'."\n" ."\n" .'- project'."\n" ."\n" .'- logstore'."\n" ."\n" .'- dashboard'."\n" ."\n" .'- machinegroup'."\n" ."\n" .'- logtailconfig', 'enumValueTitles' => ['project' => 'project'], 'type' => 'string', 'required' => true, 'example' => 'project', 'title' => '', ], ], [ 'name' => 'resourceId', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The IDs of the resources whose tags you want to query. You must specify at least one of resourceId and tags.', 'type' => 'array', 'items' => ['title' => 'resource id。', 'description' => 'The resource ID. In this example, a Logstore is used. projectName specifies the project name. # is used to concatenate strings. logstore specifies the Logstore name.'."\n" ."\n" .'- project: projectName'."\n" ."\n" .'- logstore: projectName#logstore'."\n" ."\n" .'- dashboard: projectName#dashboard'."\n" ."\n" .'- machinegroup: projectName#machinegroup'."\n" ."\n" .'- logtailconfig: projectName#logtailconfig', 'type' => 'string', 'example' => 'ali-test-project', 'required' => false], 'required' => false, 'maxItems' => 1, 'example' => '', ], ], [ 'name' => 'tags', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The tags that you want to use to filter resources based on exact match. Each tag is a key-value pair. You must specify at least one of resourceId and tags.'."\n" ."\n" .'You can enter up to 20 tags.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'key' => ['description' => 'The key of the tag that you want to use to filter resources. For example, if you set the key to `"test-key"`, only resources to which the key is added are returned.\\`\\`', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], 'value' => ['description' => 'The value of the tag that you want to use to filter resources. If you set the value to null, resources are filtered based only on the key of the tag.', 'type' => 'string', 'example' => 'value1', 'title' => '', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 20, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ 'nextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], 'tagResources' => [ 'title' => '', 'description' => 'The returned tags.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'resourceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'example' => 'ali-test-project', 'title' => ''], 'resourceType' => ['description' => 'The type of the resource.', 'type' => 'string', 'example' => 'project', 'title' => ''], 'tagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'key1', 'title' => ''], 'tagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'value1', 'title' => ''], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"tagResources\\": [\\n {\\n \\"resourceId\\": \\"ali-test-project\\",\\n \\"resourceType\\": \\"project\\",\\n \\"tagKey\\": \\"key1\\",\\n \\"tagValue\\": \\"value1\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'ListTagResources', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n" ."\n" .'- For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| `log:ListTagResources` | The resource format varies based on the resource type.-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], 'MergeShard' => [ 'summary' => 'Merges adjacent read/write shards.', 'path' => '/logstores/{logstore}/shards/{shard}?action=merge', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '155307', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The logstore name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ 'name' => 'shard', 'in' => 'path', 'schema' => ['description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'description' => 'The data structure of the shard.', 'type' => 'array', 'items' => ['description' => 'An array that consists of three shard elements. The first element is the shard after the merge. The other two elements are the shards before the merge.', '$ref' => '#/components/schemas/shard', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shardID\\": 0,\\n \\"status\\": \\"readwrite\\",\\n \\"inclusiveBeginKey\\": \\"00000000000000000000000000000000\\",\\n \\"exclusiveEndKey\\": \\"8000000000000000000000000000000\\",\\n \\"serverIp\\": \\"203.0.113.10\\",\\n \\"createTime\\": 1524222931\\n }\\n]","type":"json"}]', 'title' => 'MergeShard', 'description' => '### API description'."\n" ."\n" .'- The host consists of the project name and the Simple Log Service endpoint. You must specify the project in the host.'."\n" ."\n" .'- Each shard has a range, which is a left-closed, right-open MD5 interval of `[BeginKey,EndKey)`. The status of a shard can be readwrite or readonly. You can split and merge shards. For more information, see [Shards](~~28976~~).'."\n" ."\n" .'- You must have an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has access permissions for all APIs. This poses a high security threat. We recommend that you create and use a RAM user for API calls or routine O\\&M. The RAM user must have the required permissions to manage Simple Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" ."\n" .'- You must have the project name, region, and Logstore name for the logs that you want to query. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 400 | ParameterInvalid| invalid shard id.| 无效Shard ID。 |'."\n" .'| 400 | ParameterInvalid| can not merge the last shard. | 无效merge。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[错误码对照表](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:MergeShard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], ], ], 'OpenSlsService' => [ 'summary' => 'Activates Simple Log Service. You must use the endpoint for Simple Log Service only in the China (Shanghai) or Singapore region.', 'path' => '/slsservice', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '194669', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'OpenSlsService', 'description' => 'An AccessKey pair is required. For more information, see[AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations, which is high risk. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have permissions to manage Simple Log Service resources. For more information, see[Create a RAM user and authorize the RAM user](~~47664~~).', 'requestParamsDescription' => 'You must use the endpoint for Simple Log Service only in the China (Shanghai) or Singapore region.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'PullLogs' => [ 'summary' => 'Call the PullLogs operation to retrieve log data from a specified cursor position. This operation retrieves raw logs. To query or analyze logs, call the GetLogsV2 operation.', 'path' => '/logstores/{logStore}/shards/{shardId}?type=log', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238167', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], 'autoTest' => false, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'path', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logStore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'."\n"], ], [ 'name' => 'shardId', 'in' => 'path', 'schema' => ['description' => 'The ID of the shard in the Logstore.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], ], [ 'name' => 'cursor', 'in' => 'query', 'schema' => ['description' => 'The cursor that specifies the start position from which to read data.', 'type' => 'string', 'required' => true, 'example' => 'MTQ0NzMyOTQwMTEwMjEzMDkwNA', 'title' => ''], ], [ 'name' => 'count', 'in' => 'query', 'schema' => ['description' => 'The number of LogGroups to return. The value must be an integer from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'title' => '', 'example' => '1000'], ], [ 'name' => 'end_cursor', 'in' => 'query', 'schema' => ['description' => 'The cursor that specifies the end position at which to stop reading data.', 'type' => 'string', 'example' => 'MTU1NzA1NzQwMTEwMjEzMDkwCg', 'title' => '', 'required' => false], ], [ 'name' => 'query', 'in' => 'query', 'schema' => ['description' => 'The filter statement in the Structured Process Language (SPL) syntax. For more information, see [SPL instructions](~~2536530~~).', 'type' => 'string', 'example' => '* | where userId=\'123\'', 'title' => '', 'required' => false], ], [ 'name' => 'Accept-Encoding', 'in' => 'header', 'schema' => ['description' => 'The compression format of the data that the server returns. Only the lz4 format is supported.', 'type' => 'string', 'example' => 'lz4', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'x-log-count' => [ 'schema' => ['title' => '拉取到的日志组 logGroup 的数量', 'type' => 'string'], ], 'x-log-cursor' => [ 'schema' => ['title' => 'nextCursor，即下次拉取的起始 cursor', 'type' => 'string'], ], 'x-log-cursor-time' => [ 'schema' => ['title' => 'cursor 的时间戳', 'type' => 'string'], ], 'x-log-end-of-cursor' => [ 'schema' => ['title' => '是否已经拉取到末尾', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'x-log-compresstype' => [ 'schema' => ['title' => '返回体的压缩格式', 'type' => 'string'], ], 'x-log-bodyrawsize' => [ 'schema' => ['title' => '返回体压缩前大小，单位为字节', 'type' => 'string'], ], ], 'schema' => ['description' => 'The compressed data in protobuf format.', '$ref' => '#/components/schemas/LogGroupList', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogGroupList\\": [\\n {\\n \\"Topic\\": \\"topic-test\\",\\n \\"Source\\": \\"192.1.1.1\\",\\n \\"LogTags\\": [\\n {\\n \\"Key\\": \\"key-test\\",\\n \\"Value\\": \\"value-test\\"\\n }\\n ],\\n \\"LogItems\\": [\\n {\\n \\"Time\\": 1690254376,\\n \\"Contents\\": [\\n {\\n \\"Key\\": \\"key-test\\",\\n \\"Value\\": \\"value-test\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'PullLogs', 'description' => '>'."\n" ."\n" .'This operation is not supported by the OpenAPI SDK. Use the [Simple Log Service SDK](~~29063~~).'."\n" ."\n" .'>'."\n" ."\n" .'- Specify a shard to retrieve logs.'."\n" ."\n" .'- This operation supports reading data in only the [Protocol Buffer](~~29055~~) format.'."\n" ."\n" .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. Specify the project in the Host.', 'requestParamsDescription' => 'The following request headers are specific to the PullLogs operation:'."\n" ."\n" .'- Accept: application/x-protobuf'."\n" ."\n" .'- Accept-Encoding: lz4'."\n" ."\n" .'The value of Accept-Encoding can be lz4, deflate, or double quotation marks ("").'."\n" ."\n" .'**Request example:**'."\n" ."\n" .'```'."\n" .'GET /logstores/sls-test-logstore/shards/0?type=logs&cursor=MTQ0NzMyOTQwMTEwMjEzMDkwNA&count=1000 HTTP/1.1'."\n" .'Host:ali-test-project.cn-hangzhou.log.aliyuncs.com'."\n" .'Content-Type:application/json'."\n" .'```', 'responseParamsDescription' => 'The following response headers are specific to the PullLogs operation:'."\n" ."\n" .'- x-log-cursor: The cursor for the next log to be read.'."\n" ."\n" .'- x-log-end-of-cursor: The cursor of the last log that is read in the current request.'."\n" ."\n" .'- x-log-count: The number of logs returned.'."\n" ."\n" .'For information about the common response headers of Simple Log Service API operations, see [Common response headers](~~29011~~).'."\n" ."\n" .'The response body contains data that is serialized in the protobuf format. The data may be compressed.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'PutAnnotationData' => [ 'summary' => 'Stores annotation data in a dataset.', 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', 'schema' => ['description' => 'The unique identifier of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], [ 'name' => 'annotationdataId', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the data.', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'rawLog' => [ 'description' => 'The raw log data.', 'type' => 'array', 'items' => [ 'description' => 'The log data, which is a map of key-value pairs.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'The key and value of a raw log entry. Both are strings.', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "time": "1694761550",'."\n" .' "cnt": "45416",'."\n" .' "cnt2": "12454"'."\n" .' }'."\n" .']', 'title' => ''], 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'mlDataParam' => ['description' => 'The data struct.', '$ref' => '#/components/schemas/MLDataParam', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'PutAnnotationData', 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'PutConsumeProcessor' => [ 'summary' => 'Creates or updates a consume processor.', 'path' => '/consumeprocessors/{processorName}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '225103', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'processorName', 'in' => 'path', 'schema' => ['description' => 'The ID of the consume processor.', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'filter-get-request', 'title' => ''], 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Filter only GET requests', 'required' => false, 'title' => ''], 'configuration' => ['description' => 'The configuration of the consume processor.', 'required' => true, '$ref' => '#/components/schemas/ConsumeProcessorConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'PutConsumeProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'PutIngestProcessor' => [ 'summary' => 'Creates or modifies an ingest processor.', 'path' => '/ingestprocessors/{processorName}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '225106', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'processorName', 'in' => 'path', 'schema' => ['description' => 'The identifier of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'parse-nginx-log'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'displayName' => ['description' => 'The display name of the ingest processor.', 'type' => 'string', 'example' => 'Nginx log parsing', 'required' => true, 'title' => ''], 'description' => ['description' => 'The description of the ingest processor.', 'type' => 'string', 'example' => 'Extract fields from Nginx logs using regex.', 'title' => '', 'required' => false], 'configuration' => ['description' => 'The configuration of the ingest processor.', 'required' => true, '$ref' => '#/components/schemas/IngestProcessorConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'PutIngestProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'PutLogStoreConfig' => [ 'path' => '/logstores/{logstore}/config', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'clientIpHeaders' => [ 'type' => 'array', 'items' => ['description' => 'A header key, such as `X-Forwarded-For`, used to extract the client IP address. The key name is case-insensitive.', 'type' => 'string', 'required' => false, 'example' => 'X-Forwarded-For', 'title' => ''], 'title' => '', 'description' => 'Specifies a list of header keys from which to extract the client IP address during log ingestion. Simple Log Service (SLS) searches these headers in the specified order and uses the first valid IP address that it finds. The key names are case-insensitive, but their order is significant. To use this feature, you must also enable the `appendMeta` setting for the Logstore. This setting adds the extracted IP address as a log tag.', 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'description' => 'The request body.', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'PutLogStoreConfig', 'summary' => 'Updates the configuration of a Logstore.', 'description' => '- The `Host` in the request header must contain both the `Project` name and the Simple Log Service (SLS) endpoint.'."\n" ."\n" .'- This operation requires an AccessKey. For more information, see [Access Key](~~29009~~).'."\n" ."\n" .'An AccessKey for an Alibaba Cloud account grants full access to all APIs and poses a high security risk. We strongly recommend that you create and use a RAM user for API access and daily operations. The RAM user must have the necessary permissions to operate SLS resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" ."\n" .'- Identify the names of the target `Project`, `Region`, and `Logstore`. For more information, see [Manage Project](~~48984~~) and [Manage Logstore](~~48990~~).'."\n" ."\n" .'### Permissions'."\n" ."\n" .'To grant a RAM user or RAM role permission to call this operation, add the Action and Resource in the following table to a permission policy in Resource Access Management (RAM).'."\n" ."\n" .'| Actions | Resource |'."\n" .'| :---------------------- | :--------------------------------------------------------------------------------- |'."\n" .'| `log:PutLogStoreConfig` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', 'requestParamsDescription' => 'The request body must include at least one configuration parameter.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'PutLogs' => [ 'summary' => 'Writes log data to a specified logstore.', 'path' => '/logstores/{logstore}/shards/lb', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '186129', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], ], [ 'name' => 'x-log-compresstype', 'in' => 'header', 'schema' => [ 'description' => 'The compression type of the logs. Valid values: lz4 and gzip.', 'type' => 'string', 'required' => true, 'example' => 'lz4', 'default' => 'lz4', 'enum' => ['lz4'], 'title' => '', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The compressed log data in protobuf format.', '$ref' => '#/components/schemas/LogGroup', 'title' => '', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'PutLogs', 'description' => '> - The OpenAPI SDK does not support this operation. Use the [Simple Log Service (SLS) SDK](~~29063~~) instead.'."\n" ."\n" .'- The service checks the format of log data for each PutLogs request. If any log entry is invalid, the entire request fails and no logs are written.'."\n" ."\n" .'- This operation supports only log data in [protobuf format](~~29055~~). The log data is structured as a LogGroup.'."\n" ."\n" .'- Logs can be written in two modes:'."\n" ."\n" .' - LoadBalance mode: Data is automatically written to all writable shards in a logstore. This method provides high availability and is suitable for data consumption scenarios that do not require a specific order. Request syntax:'."\n" ."\n" .' ```plaintext'."\n" .' POST /logstores/logstoreName/shards/lb HTTP/1.1'."\n" .' Authorization: LOG yourAccessKeyId:yourSignature'."\n" .' Content-Type: application/x-protobuf'."\n" .' Content-Length: Content Length'."\n" .' Content-MD5: Content MD5'."\n" .' Date: GMT Date'."\n" .' Host: ProjectName.Endpoint'."\n" .' x-log-apiversion: 0.6.0'."\n" .' x-log-bodyrawsize: BodyRawSize'."\n" .' x-log-compresstype: lz4'."\n" .' x-log-signaturemethod: hmac-sha1'."\n" .' '."\n" .' ```'."\n" ."\n" .' - KeyHash mode: Add a key parameter to the URL to determine which shard receives the data. This parameter is optional. If you do not set this parameter, the system automatically switches to the load balancing mode. For example, pin a producer, such as an instance, to a specific shard based on its name hash. This ensures that data written to and consumed from the shard is strictly ordered. During merge and split operations, a key is associated with only one shard at any given time. Request syntax:'."\n" ."\n" .' ```plaintext'."\n" .' POST /logstores/logstoreName/shards/route?key=14d2f850ad6ea48e46e4547edbbb27e0'."\n" .' Authorization: LOG yourAccessKeyId:yourSignature'."\n" .' Content-Type: application/x-protobuf'."\n" .' Content-Length: Content Length'."\n" .' Content-MD5: Content MD5'."\n" .' Date: GMT Date'."\n" .' Host: ProjectName.Endpoint'."\n" .' x-log-apiversion: 0.6.0'."\n" .' x-log-bodyrawsize: BodyRawSize'."\n" .' x-log-compresstype: lz4'."\n" .' x-log-signaturemethod: hmac-sha1'."\n" .' '."\n" .' ```'."\n" ."\n" .'- The maximum size of raw logs for each PutLogs request is 10 MB. The Value of each log in a log group must not exceed 1 MB. Older SDK versions may have different limits. Upgrade to the latest SDK version.'."\n" ."\n" .'- SLS provides examples of how to use PutLogs with the Java and Python SDKs.'."\n" ."\n" .'## Protobuf data'."\n" ."\n" .'This section describes the fields for compressed log data in protobuf format. For more information, see [Data model](~~29054~~) and [Data encoding](~~29055~~).'."\n" ."\n" .'- Log'."\n" ."\n" .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" .'| ------------- | ------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Time | Integer | Yes | The time of the log. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 1970-1-1 00:00:00 UTC. |'."\n" .'| Contents | List | Yes | A list of log fields. The list must contain at least one element. For the element type, see the Content table below. |'."\n" ."\n" .'- Content'."\n" ."\n" .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" .'| ------------- | ------------- | ------------ | --------------------------------------------- |'."\n" .'| Key | String | Yes | The custom key name. |'."\n" .'| Value | String | Yes | The value that corresponds to the custom key. |'."\n" ."\n" .'- LogTag'."\n" ."\n" .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" .'| ------------- | ------------- | ------------ | --------------------------------------------- |'."\n" .'| Key | String | Yes | The custom key name. |'."\n" .'| Value | String | Yes | The value that corresponds to the custom key. |'."\n" ."\n" .'- LogGroup'."\n" ."\n" .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" .'| ------------- | ------------- | ------------ | --------------------------------------------------------------------------------------------- |'."\n" .'| Logs | List | Yes | A list of logs. For each element, see the Log table. |'."\n" .'| Topic | String | No | The topic of the logs. Use this custom field to distinguish log data with different features. |'."\n" .'| Source | String | No | The source of the logs, such as the IP address of the machine that generated the logs. |'."\n" .'| LogTags | List | Yes | A list of log tags. For each element, see the LogTag table. |', 'requestParamsDescription' => '**Request headers**'."\n" ."\n" .'For information about the common request headers of SLS APIs, see [Common request headers](~~29010~~).'."\n" ."\n" .'**Request example**'."\n" ."\n" .'```'."\n" .'POST /logstores/sls-test-logstore/shards/lb'."\n" .'{'."\n" .' "Content-Length": 118,'."\n" .' "Content-Type":"application/x-protobuf",'."\n" .' "x-log-bodyrawsize":1356,'."\n" .' "Host": "ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com",'."\n" .' "Content-MD5":"6554BD042149C844761C2C094A8FECCE",'."\n" .' "Date":"Thu, 12 Nov 2015 06:54:26 GMT",'."\n" .' "x-log-apiversion": "0.6.0",'."\n" .' "x-log-compresstype":"lz4"'."\n" .' "x-log-signaturemethod": "hmac-sha1",'."\n" .' "Authorization":"LOG yourAccessKeyId:yourSignature"'."\n" .'}'."\n" .''."\n" .'```', 'responseParamsDescription' => '**Response headers**'."\n" ."\n" .'The PutLogs operation does not have specific response headers. For information about the common response headers of SLS APIs, see [Common response headers](~~29011~~).'."\n" ."\n" .'**Response elements**'."\n" ."\n" .'An HTTP status code of 200 indicates that the request was successful. No response elements are returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'PutProjectPolicy' => [ 'summary' => 'Creates a project access policy.', 'path' => '/policy', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '157641', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'schema' => ['title' => 'A short description of struct', 'description' => 'The request parameters, which define the authorization policy.', 'type' => 'string', 'required' => false, 'example' => '{ "Version": "1", "Statement": [{ "Action": ["log:PostLogStoreLogs"], "Resource": "acs:log:*:*:project/exampleproject/*", "Effect": "Deny", "Condition": { "StringNotLike": { "acs:SourceVpc": ["vpc-*"] } } }] }'], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'PutProjectPolicy', 'description' => '###'."\n" ."\n" .'- The Host in the request syntax consists of the project name and the Simple Log Service (SLS) endpoint. You must specify the project in the Host.'."\n" ."\n" .'- You have created an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account provides full access to all API operations. This is a high security risk. We recommend that you create and use a Resource Access Management (RAM) user for API access or daily O\\&M. The RAM user must have permissions to manage SLS resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- Obtain the project name, region, and Logstore name. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).'."\n" ."\n" .'- A project policy is an authorization policy for projects in SLS. You can use a project policy to grant other users access to your specified SLS resources.'."\n" ."\n" .' - Before you configure a project policy using policy syntax, you must understand the classification of SLS actions, resources, and conditions. For more information, see [Resource Access Management](~~128139~~).'."\n" ."\n" .' - When you configure a project policy, if you grant permissions to an anonymous account (\\*) and do not specify a condition, the policy applies to all users except the project owner. If you grant permissions to an anonymous account (\\*) and specify a condition, the policy applies to all users, including the project owner.'."\n" ."\n" .' - You can add multiple project policies, but their total size cannot exceed 16 KB.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:PutProjectPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'PutProjectTransferAcceleration' => [ 'summary' => 'Enables or disables transfer acceleration.', 'path' => '/transferacceleration', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '205449', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'enabled' => ['description' => 'Specifies whether to enable transfer acceleration.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'PutProjectTransferAcceleration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'PutWebtracking' => [ 'summary' => 'Sends multiple logs to Simple Log Service in one request.', 'path' => '/logstores/{logstoreName}/track', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '9127', 'abilityTreeNodes' => ['FEATUREslsWY5SG2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstoreName', 'in' => 'path', 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ '__topic__' => ['description' => 'The topic of the logs.', 'type' => 'string', 'required' => false, 'example' => 'topic', 'title' => ''], '__source__' => ['description' => 'The source of the logs.', 'type' => 'string', 'required' => true, 'example' => 'source', 'title' => ''], '__logs__' => [ 'description' => 'The logs. Each element is a JSON object that indicates a log.'."\n" ."\n" .'> **Note**: The time in a log that is collected by using the web tracking feature is the time at which Simple Log Service receives the log. You do not need to configure the \\_\\_time\\_\\_ field for each log. If this field exists, it is overwritten by the time at which Simple Log Service receives the log.', 'type' => 'array', 'items' => [ 'description' => 'The logs.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'The log content.', 'type' => 'string', 'example' => '{ "key1": "value1", "key2": "value2" }', 'title' => ''], 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], '__tags__' => [ 'description' => 'The tags of the logs.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'The tag of the log.', 'type' => 'string', 'example' => '{ "tag1": "value1", "tag2": "value2" }', 'title' => ''], 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'PutWebtracking', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- Use this operation to collect logs from web pages or clients.'."\n" ."\n" .'- If you use web tracking to collect logs and you do not call this operation, you can send only one log to Simple Log Service in a request. For more information, see [Use web tracking to collect logs](~~31752~~).'."\n" ."\n" .'- If you want to collect a large amount of log data, you can call this operation to send multiple logs to Simple Log Service in one request.'."\n" ."\n" .'- Before you can call this operation to send logs to a Logstore, you must enable web tracking for the Logstore. For more information, see [Use web tracking to collect logs](~~31752~~).'."\n" ."\n" .'- You cannot call this operation to send the logs of multiple topics to Simple Log Service at a time.'."\n" ."\n" .'- If you call this operation, anonymous users from the Internet are granted the write permissions on the Logstore. This may generate dirty data because AccessKey pair-based authentication is not performed.', 'requestParamsDescription' => 'Only the following request headers are supported. The first two request headers are required when you call the PutWebTracking operation. For more information about the formats and descriptions of the request headers, see Common request headers.'."\n" ."\n" .'- x-log-apiversion: 0.6.0'."\n" ."\n" .'- x-log-bodyrawsize: 1234'."\n" ."\n" .'- x-log-compresstype: lz4'."\n" ."\n" .'The x-log-compresstype header is required only when you need to send compressed data. To send compressed data, you must use the LZ4 or DEFLATE algorithm. You can specify `x-log-compresstype: lz4` or `x-log-compresstype: deflate`. For more information about how to compress data, see [Data compression](~~449460~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 400 | PostBodyInvalid | Fail to parse protobuf. | Protobuffer内容不合法，无法解析。 |'."\n" .'| 400 | PostBodyInvalid | Body invalid error message. | 请求的Body不合法。 |'."\n" .'| 400 | PostBodyUncompressError | Post body uncompressed fail. | 日志内容解压失败。 |'."\n" .'| 400 | PostBodyTooLarge | Body size bodySize must little than 10485760. | 请求Body （压缩前）不能超过10MB。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'RefreshToken' => [ 'summary' => 'Refreshes an access token using a ticket. The access token is used to call console API operations.', 'path' => '/token/refresh', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ticket', 'in' => 'query', 'schema' => ['description' => 'The logon-free ticket.', 'type' => 'string', 'required' => false, 'example' => 'eyJ***************.eyJ******************.KUT****************', 'title' => ''], ], [ 'name' => 'accessTokenExpirationTime', 'in' => 'query', 'schema' => ['description' => '- The expiration time of the access token in seconds. This specifies the period during which the token is valid for accessing page API operations. The default value is 86400 seconds (one day). The value must be an integer from 0 to 86400.'."\n" ."\n" .'- The actual expiration time of the access token is the minimum value of accessTokenExpirationTime and expirationTime.'."\n" ."\n" .'- If you call this operation using Security Token Service (STS), the actual expiration time of the access token is the minimum value of accessTokenExpirationTime, expirationTime, and the STS token expiration time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'accessToken' => ['title' => 'Id of the request', 'description' => 'The access token.', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"accessToken\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', 'title' => 'RefreshToken', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'RemoveConfigFromMachineGroup' => [ 'summary' => 'Removes a Logtail configuration from a machine group.', 'path' => '/machinegroups/{machineGroup}/configs/{configName}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-group', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'test-logtail', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'RemoveConfigFromMachineGroup', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | MachineGroupNotExist| MachineGroup groupName does not exist.| 机器组不存在。 |'."\n" .'| 404 | ConfigNotExist| Config configName does not exist. | Logtail配置不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'SplitShard' => [ 'summary' => 'Splits a shard in the readwrite state.', 'path' => '/logstores/{logstore}/shards/{shard}?action=split', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'logstorename', 'title' => ''], ], [ 'name' => 'shard', 'in' => 'path', 'schema' => ['description' => 'The ID of the shard.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ 'name' => 'key', 'in' => 'query', 'schema' => ['description' => 'The position where the shard is split.', 'type' => 'string', 'example' => 'ef000000000000000000000000000000', 'title' => '', 'required' => false], ], [ 'name' => 'shardCount', 'in' => 'query', 'schema' => ['description' => 'The number of new shards that are generated after splitting.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'title' => '', 'description' => 'The shards that are returned. For example, if the shardCount parameter is set to 2, an array that consists of three shards is returned. The first shard is the original shard, and the last two shards are the new shards.', 'type' => 'array', 'items' => ['description' => 'The shard information.', '$ref' => '#/components/schemas/shard', 'title' => '', 'example' => ''], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shardID\\": 0,\\n \\"status\\": \\"readwrite\\",\\n \\"inclusiveBeginKey\\": \\"00000000000000000000000000000000\\",\\n \\"exclusiveEndKey\\": \\"8000000000000000000000000000000\\",\\n \\"serverIp\\": \\"203.0.113.10\\",\\n \\"createTime\\": 1524222931\\n }\\n]","type":"json"}]', 'title' => 'SplitShard', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- Each shard has an MD5 hash range, and each range is a left-closed, right-open interval. The interval is in the `[BeginKey,EndKey)` format. A shard can be in the readwrite or readonly state. You can split a shard and merge shards. For more information, see [Shard](~~28976~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 400 | ParameterInvalid| invalid shard id. | 无效Shard ID。 |'."\n" .'| 400 | ParameterInvalid| invalid mid hash. | 无效分裂位置参数。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[错误码对照表](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:SplitShard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], ], ], 'StartAzureBlobIngestion' => [ 'path' => '/azureblobingestions/{azureBlobIngestionName}?action=START', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '291253', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'StartAzureBlobIngestion', 'summary' => 'Starts an Azure Blob ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'StartETL' => [ 'summary' => 'Starts a data transformation task.', 'path' => '/etls/{etlName}?action=START', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203160', 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'etlName', 'in' => 'path', 'schema' => ['description' => 'The name of the data transformation task.', 'type' => 'string', 'required' => false, 'example' => 'etl-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StartETL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StartElasticsearchIngestion' => [ 'path' => '/elasticsearchingestions/{elasticsearchIngestionName}?action=START', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '287660', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'elasticsearchIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the ES/OpenSearch ingestion task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'StartElasticsearchIngestion', 'summary' => 'Starts an ES or OpenSearch ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'StartGCSIngestion' => [ 'summary' => 'Starts a GCS file import task.', 'path' => '/gcsingestions/{gcsIngestionName}?action=START', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'gcsIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the GCS import task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ingest-gcs-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The response body.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'StartGCSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', ], 'StartMaxComputeExport' => [ 'summary' => 'Starts a MaxCompute data shipping job.', 'path' => '/maxcomputeexports/{mcExportName}?action=START', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203420', 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'mcExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StartMaxComputeExport', 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StartOSSExport' => [ 'summary' => 'Starts an Object Storage Service (OSS) data shipping job.', 'path' => '/ossexports/{ossExportName}?action=START', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203474', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StartOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StartOSSHDFSExport' => [ 'summary' => 'Starts an OSS-HDFS data shipping job.', 'path' => '/osshdfsexports/{ossExportName}?action=START', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203482', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StartOSSHDFSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StartOSSIngestion' => [ 'summary' => 'Starts a specified OSS import task.', 'path' => '/ossingestions/{ossIngestionName}?action=START', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203141', 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'ossIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the OSS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StartOSSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StopAzureBlobIngestion' => [ 'path' => '/azureblobingestions/{azureBlobIngestionName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '291256', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the Azure Blob ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'StopAzureBlobIngestion', 'summary' => 'Stops an Azure Blob ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'StopETL' => [ 'summary' => 'Stops a specified data transformation task.', 'path' => '/etls/{etlName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203170', 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'etlName', 'in' => 'path', 'schema' => ['description' => 'The name of the data transformation task.', 'type' => 'string', 'required' => false, 'example' => 'etl-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StopETL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StopElasticsearchIngestion' => [ 'path' => '/elasticsearchingestions/{elasticsearchIngestionName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '287680', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'elasticsearchIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the ES/OpenSearch import job.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'StopElasticsearchIngestion', 'summary' => 'Stops an ES or OpenSearch import job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'StopGCSIngestion' => [ 'summary' => 'Stops a GCP Cloud Storage file import task.', 'path' => '/gcsingestions/{gcsIngestionName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'Name of the project.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'gcsIngestionName', 'in' => 'path', 'schema' => ['description' => 'Name of the GCS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => ['description' => 'Response body.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'StopGCSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', ], 'StopMaxComputeExport' => [ 'summary' => 'Stops a MaxCompute data shipping job.', 'path' => '/maxcomputeexports/{mcExportName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203421', 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'mcExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StopMaxComputeExport', 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StopOSSExport' => [ 'summary' => 'Stops an Object Storage Service (OSS) data shipping job.', 'path' => '/ossexports/{ossExportName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203475', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StopOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StopOSSHDFSExport' => [ 'summary' => 'Stops an OSS-HDFS data shipping job.', 'path' => '/osshdfsexports/{ossExportName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203481', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StopOSSHDFSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'StopOSSIngestion' => [ 'summary' => 'Stops the specified OSS import task.', 'path' => '/ossingestions/{ossIngestionName}?action=STOP', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '203142', 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'ossIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the OSS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'StopOSSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'SubmitAsyncSql' => [ 'summary' => 'Submits an asynchronous SQL request.', 'path' => '/asyncsql', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '292852', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'allowEmptyValue' => false, 'schema' => ['description' => 'The idempotency token for the request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'sls-demo-project'], ], [ 'name' => 'Accept', 'in' => 'header', 'schema' => ['description' => 'The data format of the response. The value must be application/x-protobuf.', 'type' => 'string', 'example' => 'application/x-protobuf', 'default' => 'application/x-protobuf', 'required' => false, 'title' => ''], ], [ 'name' => 'Accept-Encoding', 'in' => 'header', 'schema' => ['description' => 'The compression format of the response. The value can be lz4.', 'type' => 'string', 'example' => 'lz4', 'default' => 'lz4', 'required' => false, 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => ['description' => 'The format of the response parameters. The value is \\`protobuf\\`.', '$ref' => '#/components/schemas/SubmitAsyncSqlParams', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The data returned in the response body. The data is in protobuf format.', '$ref' => '#/components/schemas/AsyncSqlResponseData', 'title' => '', 'example' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SubmitAsyncSql', 'responseParamsDescription' => 'The error\\_code and error\\_message parameters are returned only when the state is FAILED.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"id\\": \\"690C4F2A16FBD65C40000484_14\\",\\n \\"state\\": \\"FINISHED\\",\\n \\"AsyncSqlMetaPB\\": {\\n \\"result_rows\\": 12000,\\n \\"processed_rows\\": 10000000,\\n \\"elapsed_milli\\": 30000,\\n \\"cpu_sec\\": 0.2,\\n \\"cpu_cores\\": 10,\\n \\"progress\\": \\"Complete\\",\\n \\"keys\\": [\\n \\"[\\\\\\"name\\\\\\", \\\\\\"age\\\\\\", \\\\\\"gender\\\\\\"]\\"\\n ]\\n },\\n \\"rows\\": [\\n [\\n \\"[\\\\\\"Jimmy\\\\\\", \\\\\\"20\\\\\\", \\\\\\"male\\\\\\"]\\"\\n ]\\n ],\\n \\"error_code\\": \\"InvalidQuery\\",\\n \\"error_message\\": \\"line 37:14: Column \'xyz\' cannot be resolved\\"\\n}","type":"json"}]', ], 'TagResources' => [ 'summary' => 'Creates and adds tags to a resource. You can add tags only to projects.', 'path' => '/tag', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'resourceType' => ['description' => 'The type of the resource. Valid values:'."\n" ."\n" .'- project'."\n" ."\n" .'- logstore'."\n" ."\n" .'- dashboard'."\n" ."\n" .'- machinegroup'."\n" ."\n" .'- logtailconfig', 'type' => 'string', 'required' => true, 'example' => 'project', 'title' => ''], 'resourceId' => [ 'title' => '', 'description' => 'The resource IDs. You can specify only one resource and add tags to the resource.', 'type' => 'array', 'items' => ['description' => 'The resource ID. In this example, a Logstore is used. projectName indicates the project name. # is used to concatenate strings. logstore indicates the Logstore name.'."\n" ."\n" .'- project: projectName'."\n" ."\n" .'- logstore: projectName#logstore'."\n" ."\n" .'- dashboard: projectName#dashboard'."\n" ."\n" .'- machinegroup: projectName#machinegroup'."\n" ."\n" .'- logtailconfig: projectName#logtailconfig', 'type' => 'string', 'example' => 'ali-test-project', 'title' => '', 'required' => false], 'required' => true, 'example' => '', ], 'tags' => [ 'title' => '', 'description' => 'The tags that you want to add to the resource. You can specify up to 20 tags in each call. Each tag is a key-value pair.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'key' => ['description' => 'The key of the tag. The key must meet the following requirements:'."\n" ."\n" .'- The key must be `1 to 128` characters in length.'."\n" ."\n" .'- The key cannot contain `http://` or `https://`.'."\n" ."\n" .'- The key cannot start with `acs:` or `aliyun`.', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], 'value' => ['description' => 'The value of the tag. The value must meet the following requirements:'."\n" ."\n" .'- The value must be `1 to 128` characters in length.'."\n" ."\n" .'- The value cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => true, 'example' => 'value1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'TagResources', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n" ."\n" .'- For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :----------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| `log:TagResources` | The resource format varies based on the resource type.-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:TagResources', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], 'UntagResources' => [ 'summary' => 'Detaches one or more tags from a resource. You can detach tags only from Simple Log Service projects. You can detach multiple or all tags from a Simple Log Service project at a time.', 'path' => '/untag', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'resourceType' => [ 'description' => 'The type of the resource. Valid values:'."\n" ."\n" .'- project'."\n" ."\n" .'- logstore'."\n" ."\n" .'- dashboard'."\n" ."\n" .'- machinegroup'."\n" ."\n" .'- logtailconfig', 'enumValueTitles' => ['project' => 'project'], 'type' => 'string', 'required' => false, 'example' => 'project', 'title' => '', ], 'resourceId' => [ 'description' => 'The resource IDs. Each time you call this operation, you can unbind tags only from a single resource. Therefore, you can enter only one resource ID.', 'type' => 'array', 'items' => ['description' => 'The resource ID. In this example, a Logstore is used. projectName indicates the project name. # is used to concatenate strings. logstore indicates the Logstore name.'."\n" ."\n" .'- project: projectName'."\n" ."\n" .'- logstore: projectName#logstore'."\n" ."\n" .'- dashboard: projectName#dashboard'."\n" ."\n" .'- machinegroup: projectName#machinegroup'."\n" ."\n" .'- logtailconfig: projectName#logtailconfig', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], 'required' => true, 'example' => 'ali-test-project', 'title' => '', ], 'all' => ['description' => 'Specifies whether to unbind all tags. Default value: false. Valid values:'."\n" ."\n" .'- false: unbinds only the tags that match the value of tags.'."\n" ."\n" .'- true: unbinds all tags that are bound to the resource.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'tags' => [ 'description' => 'The tag keys. If you set all to false, only the tags that match the value of this parameter are unbound.', 'type' => 'array', 'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UntagResources', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~) For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| `log:UntagResources` | The resource format varies based on the resource type.-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], 'UpdateAgentInstanceConfig' => [ 'path' => '/agentinstanceconfigs/{configType}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227394', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'config' => ['description' => 'The default configurations.', 'type' => 'string', 'required' => true, 'example' => '{}', 'title' => ''], 'grayConfigs' => [ 'type' => 'array', 'items' => ['description' => 'A configuration for the canary release environment.', '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', 'required' => false, 'title' => '', 'example' => ''], 'description' => 'The configurations for the canary release environment.', 'required' => false, 'title' => '', 'example' => '', ], ], 'description' => 'The request body.', 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'configType', 'in' => 'path', 'schema' => [ 'description' => 'The type of the process-level configuration.', 'enumValueTitles' => [ 'apm_biz_trace' => 'apm\\_biz\\_trace', 'apm_self_protect' => 'apm\\_self\\_protect', 'apm_convergence' => 'apm\\_convergence', 'apm_custom_extract' => 'apm\\_custom\\_extract', 'apm_pilot' => 'apm\\_pilot', 'apm_trace' => 'apm\\_trace', 'rum_app_config' => 'rum\\_app\\_config', 'rum_web_config' => 'rum\\_web\\_config', 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', 'apm_intacheap' => 'apm\\_intacheap', 'apm_user_method' => 'apm\\_user\\_method', 'apm_global' => 'apm\\_global', 'apm_forward_process' => 'apm\\_forward\\_process', ], 'type' => 'string', 'required' => true, 'example' => 'apm_biz_trace', 'title' => '', ], ], [ 'name' => 'attributes', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'The attributes that specify the scope of the process-level configuration.', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" .'"service": "test-service"', 'title' => ''], 'description' => 'The attributes that specify the scope of the process-level configuration.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateAgentInstanceConfig', 'summary' => 'Updates process-level configurations.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateAlert' => [ 'summary' => 'Updates an alert rule.', 'path' => '/alerts/{alertName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '200217', 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The new configurations of the alert rule.', 'type' => 'object', 'properties' => [ 'displayName' => ['description' => 'The display name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'this is alert', 'title' => ''], 'description' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'this is description', 'title' => ''], 'configuration' => ['description' => 'The detailed configurations of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration', 'title' => '', 'example' => ''], 'schedule' => ['description' => 'The scheduling settings of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateAnnotationDataSet' => [ 'summary' => 'Updates a dataset.', 'path' => '/ml/annotationdataset/{datasetId}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The request body.', '$ref' => '#/components/schemas/MLDataSetParam', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateAnnotationDataSet', 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'UpdateAnnotationLabel' => [ 'summary' => 'Updates a label table. You can update only the names of labels in a label set.', 'path' => '/ml/annotationlabel', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The struct of the label table.', '$ref' => '#/components/schemas/MLLabelParam', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateAnnotationLabel', 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'UpdateAzureBlobIngestion' => [ 'path' => '/azureblobingestions/{azureBlobIngestionName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '291251', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project that contains the Azure Blob ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the Azure Blob ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'description' => ['description' => 'The updated description for the Azure Blob ingestion task.', 'type' => 'string', 'title' => '', 'example' => ''], 'displayName' => ['description' => 'The updated display name for the Azure Blob ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], 'schedule' => ['description' => 'The updated ingestion schedule.', '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], 'configuration' => ['description' => 'The updated configuration for the Azure Blob ingestion task.', 'required' => true, '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', 'title' => '', 'example' => ''], ], 'description' => 'The request body that contains the updated settings for the Azure Blob ingestion task.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateAzureBlobIngestion', 'summary' => 'Updates an Azure Blob ingestion.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateConfig' => [ 'summary' => 'Modifies a Logtail configuration.', 'path' => '/configs/{configName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '9091', 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail configuration file.', 'type' => 'string', 'required' => true, 'example' => 'test-sample', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => ['description' => 'The body of the request.', '$ref' => '#/components/schemas/LogtailConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateConfig', 'description' => '### [](#)Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- After you update a Logtail configuration that is applied to a machine group, the new configuration immediately takes effect.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'- The Logtail configuration is planned out. For more information, see [Logtail configurations](~~29058~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ConfigNotExist| Config configName does not exist. | Logtail配置不存在。 |'."\n" .'| 400 | InvalidParameter| invalid config resource json. | 无效Logtail配置参数。 |'."\n" .'| 400 | BadRequest| Config resource configname does not match with request.| Logtail配置名称不符合要求。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], ], ], 'UpdateConsumerGroup' => [ 'summary' => 'Updates the attributes of a consumer group.', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'logstore-test', 'title' => ''], ], [ 'name' => 'consumerGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body. At least one of order and timeout has a value.', 'type' => 'object', 'properties' => [ 'order' => ['description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" ."\n" .'- true: If a shard is split, the data in the original shard is consumed first. Then, the data in the new shards is consumed at the same time. If shards are merged, the data in the original shards is consumed first. Then, the data in the new shard is consumed.'."\n" ."\n" .'- false: The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or shards are merged, the data in the new shard is immediately consumed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'timeout' => ['description' => 'The timeout period. If Simple Log Service does not receive heartbeats from a consumer within the timeout period, Simple Log Service deletes the consumer. Unit: seconds', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateConsumerGroup', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :------------------------ | :---------------------------------------------------------------------------------------------------------------- |'."\n" .'| `log:UpdateConsumerGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | JsonInfoInvalid| timeout is of error value type. | 参数timeout类型错误。 |'."\n" .'| 400 | ConsumerGroupNotExist | consumer group not exist. | 消费组不存在。 |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], ], ], 'UpdateDashboard' => [ 'summary' => 'Updates a dashboard.', 'path' => '/dashboards/{dashboardName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '10279', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'dashboardName', 'in' => 'path', 'schema' => ['description' => 'The name of the dashboard.', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The data structure of the dashboard.', 'type' => 'object', 'properties' => [ 'dashboardName' => ['description' => 'The name of the dashboard.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dashboard-1609294922657-434834'], 'displayName' => ['description' => 'The display name of the dashboard.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Method pv'], 'description' => ['description' => 'The description of the dashboard.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test dashboard.'], 'attribute' => [ 'title' => '', 'description' => 'The attribute values of the dashboard.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'The attribute value of the dashboard.', 'type' => 'string', 'example' => '“”', 'title' => ''], 'example' => '', ], 'charts' => [ 'title' => '', 'description' => 'The charts on the dashboard.', 'type' => 'array', 'items' => ['description' => 'The data structure of the chart.', '$ref' => '#/components/schemas/chart', 'required' => false, 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateDashboard', 'description' => '### [](#)Usage notes'."\n" ."\n" .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ], ], ], ], ], 'UpdateETL' => [ 'summary' => 'Updates the configuration of a specified data transformation task and restarts it.', 'path' => '/etls/{etlName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '203169', 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'etlName', 'in' => 'path', 'schema' => ['description' => 'The name of the data transformation task.', 'type' => 'string', 'required' => true, 'example' => 'etl-123456', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The updated configuration for the data transformation task.', 'type' => 'object', 'properties' => [ 'displayName' => ['description' => 'The display name of the data transformation task.', 'type' => 'string', 'required' => true, 'example' => 'this is update', 'title' => ''], 'description' => ['description' => 'The description of the data transformation task.', 'type' => 'string', 'required' => false, 'example' => 'this is description', 'title' => ''], 'configuration' => ['description' => 'The detailed configuration of the data transformation task.', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateETL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'UpdateElasticsearchIngestion' => [ 'path' => '/elasticsearchingestions/{elasticsearchIngestionName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '287679', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'Name of the project', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'elasticsearchIngestionName', 'in' => 'path', 'schema' => ['description' => 'Name of the ES or OpenSearch ingestion task', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'description' => ['description' => 'Description of the ES or OpenSearch ingestion task', 'type' => 'string', 'required' => false, 'example' => 'es ingestion test', 'title' => ''], 'displayName' => ['description' => 'Display name of the ES or OpenSearch ingestion task', 'type' => 'string', 'required' => true, 'example' => 'es-ingestion-test', 'title' => ''], 'schedule' => ['description' => 'Scheduling type. Leave this field empty unless you need strict scheduling. For example, to run the ingestion task every Monday at 8:00 a.m., use a cron expression', '$ref' => '#/components/schemas/Schedule', 'required' => false, 'title' => '', 'example' => ''], 'configuration' => ['description' => 'ES or OpenSearch ingestion configuration', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration', 'title' => '', 'example' => ''], ], 'description' => 'Request body', 'title' => '', 'example' => '', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateElasticsearchIngestion', 'summary' => 'Updates an ES or OpenSearch ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateGCSIngestion' => [ 'summary' => 'Updates a GCP Cloud Storage file ingestion task.', 'path' => '/gcsingestions/{gcsIngestionName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'gcsIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the GCS ingestion task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-123455', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'description' => ['description' => 'The description of the ingestion task.', 'type' => 'string', 'example' => 'Gcs import', 'required' => false, 'title' => ''], 'displayName' => ['description' => 'The display name of the ingestion task.', 'type' => 'string', 'example' => 'Gcs import', 'required' => true, 'title' => ''], 'configuration' => ['description' => 'The configuration of the ingestion task.', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration', 'title' => '', 'example' => ''], ], 'description' => 'The request body.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => ['description' => 'The response body.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateGCSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', 'translator' => 'machine', ], 'UpdateIndex' => [ 'path' => '/logstores/{logstore}/index', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '8958', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'keys' => [ 'title' => '', 'description' => 'The configuration of field indexes. A field index is a key-value pair in which the key specifies the name of the field and the value specifies the index configuration of the field.', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'title' => '', 'description' => 'The index configuration of the field.', 'type' => 'object', 'properties' => [ 'caseSensitive' => ['description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean'], 'chn' => ['description' => 'Specifies whether to include Chinese characters. This parameter is required only when **type** is set to **text**. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean'], 'type' => [ 'description' => 'The data type of the field value. Valid values: text, json, double, and long.', 'enumValueTitles' => ['double' => 'double', 'json' => 'json', 'text' => 'text', 'long' => 'long'], 'type' => 'string', ], 'alias' => ['description' => 'The alias of the field.', 'type' => 'string'], 'token' => [ 'title' => '', 'description' => 'The delimiters that are used to split text. This parameter is required only when type is set to text.', 'type' => 'array', 'items' => ['description' => 'The delimiter that is used to split text.', 'type' => 'string'], 'required' => true, ], 'doc_value' => ['description' => 'Specifies whether to turn on Enable Analytics for the field.', 'type' => 'boolean'], ], 'required' => true, ], ], 'line' => [ 'title' => '', 'description' => 'The configuration of full-text indexes.', 'type' => 'object', 'properties' => [ 'chn' => ['description' => 'Specifies whether to include Chinese characters. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean'], 'caseSensitive' => ['description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean'], 'token' => [ 'title' => '', 'description' => 'The delimiters that are used to split text.', 'type' => 'array', 'items' => ['description' => 'The delimiter that is used to split text.', 'type' => 'string'], 'required' => true, ], 'include_keys' => [ 'title' => '', 'description' => 'The included fields. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'array', 'items' => ['description' => 'The included field.', 'type' => 'string'], 'required' => false, ], 'exclude_keys' => [ 'title' => '', 'description' => 'The excluded fields. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'array', 'items' => ['description' => 'The excluded field.', 'type' => 'string'], 'required' => false, ], ], 'required' => false, ], 'ttl' => ['description' => 'The retention period of data. Unit: days. Valid values: 7, 30, and 90.', 'type' => 'integer'], 'max_text_len' => ['description' => 'The maximum length of a field value that can be retained.', 'type' => 'integer'], 'log_reduce' => ['description' => 'Specifies whether to turn on LogReduce. If you turn on LogReduce, only one of `log_reduce_white_list` and `log_reduce_black_list` takes effect.', 'type' => 'boolean'], 'log_reduce_white_list' => [ 'title' => '', 'description' => 'The fields in the whitelist that you want to use to cluster logs.', 'type' => 'array', 'items' => ['description' => 'The field in the whitelist.', 'type' => 'string'], 'required' => false, ], 'log_reduce_black_list' => [ 'title' => '', 'description' => 'The fields in the blacklist that you want to use to cluster logs.', 'type' => 'array', 'items' => ['description' => 'The field in the blacklist.', 'type' => 'string'], 'required' => false, ], ], 'required' => false, '$ref' => '#/components/schemas/index', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], 'title' => 'UpdateIndex', 'summary' => 'Updates the indexes of a Logstore.', 'description' => '### Usage notes'."\n" ."\n" .'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateIndex', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateLogStore' => [ 'summary' => 'Updates the properties of a Logstore.', 'path' => '/logstores/{logstore}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '115728', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'logstoreName' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], 'shardCount' => ['description' => 'The number of shards.'."\n" ."\n" .'> You cannot update the number of shards with this operation. To change the number of shards, call the SplitShard or MergeShards operation.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '2', 'title' => ''], 'ttl' => ['description' => 'The data retention period. Unit: days. Valid values: 1 to 3650. If you set this parameter to 3650, the data is permanently retained.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', 'title' => ''], 'encrypt_conf' => ['description' => 'The encryption configuration.', 'required' => false, '$ref' => '#/components/schemas/EncryptConf', 'title' => '', 'example' => ''], 'autoSplit' => ['description' => 'Specifies whether to automatically split a shard.'."\n" ."\n" .'- true: automatically splits a shard.'."\n" ."\n" .'- false: does not automatically split a shard.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'enable_tracking' => ['description' => 'Specifies whether to enable web tracking. Default value: false.'."\n" ."\n" .'- true: enables web tracking.'."\n" ."\n" .'- false: does not enable web tracking.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'appendMeta' => ['description' => 'Specifies whether to record public IP addresses. Default value: false.'."\n" ."\n" .'- true: records public IP addresses.'."\n" ."\n" .'- false: does not record public IP addresses.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'maxSplitShard' => ['description' => 'The maximum number of shards to which a shard can be split. The value must be an integer from 1 to 256.'."\n" ."\n" .'> This parameter is required if autoSplit is set to true.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64', 'title' => ''], 'telemetryType' => ['description' => 'The type of observable data. Valid values:'."\n" ."\n" .'- None: logs. This is the default value.'."\n" ."\n" .'- Metrics: metrics.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'None', 'title' => ''], 'hot_ttl' => ['description' => 'The retention period of data in the hot tier of the Logstore. Minimum value: 7. Unit: days. Valid values: 7 to 3000. After the retention period of the hot tier ends, the data is moved to the Infrequent Access (IA) storage class. For more information, see [Automatic Storage Tiering](~~308645~~).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '60'], 'mode' => ['description' => 'SLS provides two types of Logstores: Standard and Query.'."\n" ."\n" .'- **standard**: supports one-stop data analytics. This type of Logstore is suitable for scenarios such as real-time monitoring, interactive analysis, and building a complete observability system.'."\n" ."\n" .'- **query**: supports high-performance queries. The index traffic cost of a Query Logstore is about half that of a Standard Logstore. However, a Query Logstore does not support SQL analysis. This type of Logstore is suitable for scenarios that involve large data volumes, long retention periods of weeks or months, and no log analysis.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], 'infrequentAccessTTL' => ['description' => 'The retention period for data in the IA storage class. Data in this storage class has no minimum retention period. Data must be stored for at least 30 days before it is moved to Archive storage.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], 'shardingPolicy' => ['description' => 'The hash-based write configuration.', '$ref' => '#/components/schemas/ShardingPolicy', 'title' => '', 'required' => false, 'example' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateLogStore', 'description' => '### Usage notes'."\n" ."\n" .'- Before you update a Logstore, call the GetLogStore operation to retrieve the configuration of the Logstore. Then, modify the configuration and pass it to the UpdateLogStore operation.'."\n" ."\n" .'- The Host in the request syntax consists of a project name and a Simple Log Service (SLS) endpoint. You must specify the project in the Host.'."\n" ."\n" .'- Obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has permissions on all API operations. This poses a high security risk. We recommend that you create and use a Resource Access Management (RAM) user to make API calls or perform routine O\\&M. The RAM user must be granted the required permissions to operate SLS resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- Obtain the project name, the Logstore name, and the region where the project resides. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).'."\n" ."\n" .'### Authorization'."\n" ."\n" .'The following table describes the authorization required for this operation. To grant a RAM user or RAM role permission to call this operation, add the required action to the Action element of a RAM policy.'."\n" ."\n" .'| Action | Resource description in an authorization policy |'."\n" .'| :------------------- | :--------------------------------------------------------------------------------- |'."\n" .'| `log:UpdateLogStore` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [ ['createdAt' => '2025-12-03T01:37:07.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-12-02T11:55:07.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateLogStore', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ['conditionKey' => 'log:Encrypted', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], ], 'UpdateLogStoreEncryption' => [ 'summary' => 'Updates the encryption configuration of a Logstore. You can create encryption configurations for the Logstore and enable or disable the encryption feature.', 'path' => '/logstores/{logstore}/encryption', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '250787', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The Simple Log Service project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'enable' => ['description' => 'Specifies whether to enable the encryption feature. After you update the encryption configuration of the Logstore, you can modify only the enable parameter in subsequent update requests. You cannot modify the encryptType or userCmkInfo parameters.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], 'encryptType' => [ 'description' => 'The encryption algorithm. Valid values: default, m4, sm4\\_ecb, sm4\\_cbc, sm4\\_gcm, aes\\_ecb, aes\\_cbc, aes\\_cfb, aes\\_ofb, and aes\\_gcm.', 'type' => 'string', 'enum' => ['default', 'm4', 'sm4_ecb', 'sm4_cbc', 'sm4_gcm', 'aes_ecb', 'aes_cbc', 'aes_cfb', 'aes_ofb', 'aes_gcm'], 'title' => '', 'required' => false, 'example' => 'default', ], 'userCmkInfo' => [ 'title' => '', 'description' => 'Optional. If you use a BYOK key to encrypt logs, you must specify this parameter. If you use the service key of Simple Log Service to encrypt logs, you do not need to specify this parameter.', 'type' => 'object', 'properties' => [ 'keyId' => ['description' => 'The ID of the CMK to which the BYOK key belongs. You can create a CMK in KMS. The CMK must be in the same region as the endpoint of Simple Log Service.', 'type' => 'string', 'example' => 'f5136b95-2420-ab31-xxxxxxxxx', 'title' => '', 'required' => false], 'roleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.The value is in the acs:ram::12344\\*\\*\\*:role/xxxxx format. To use a BYOK key to encrypt logs, you must create a RAM role and grant the AliyunKMSReadOnlyAccess and AliyunKMSCryptoUserAccess permissions to the RAM role. You must grant the API caller the PassRole permission on the RAM role.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'acs:ram::12344***:role/xxxxx'], 'regionId' => ['description' => 'The region ID. Example: cn-hangzhou.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'ProjectNotExist', 'errorMessage' => 'The Project does not exist: xxxx.', 'description' => 'The log entry does not exist.'], ['errorCode' => 'LogStoreNotExist', 'errorMessage' => 'logstore xxxx does not exist.', 'description' => 'The Logstore does not exist.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateLogStoreEncryption', 'description' => '## [](#)Limits'."\n" ."\n" .'If you specify a data encryption method when you configure data encryption settings, you cannot switch to the other method after the configuration. In addition, you cannot change the encryption algorithm or the encryption type. You can only enable or disable the encryption feature by using the enable parameter. If you specify the encryption method by using the service key of Simple Log Service when you configure data encryption settings, you cannot switch to the encryption method by using Bring Your Own Key (BYOK) keys after the configuration.'."\n" ."\n" .'## [](#)Create encryption configurations'."\n" ."\n" .'### [](#)Encryption by using service keys'."\n" ."\n" .'Simple Log Service is fully responsible for data encryption and key management. No additional operations are required. When you create encryption configurations for the Logstore, you must specify the enable and encryptType parameters.'."\n" ."\n" .'### [](#byok)Encryption by using BYOK keys'."\n" ."\n" .'You must create a customer master key (CMK) in Key Management Service (KMS). Then, Simple Log Service encrypts logs by using the CMK. When you create encryption configurations for the Logstore, you must specify the enable, encryptType, and userCmkInfo parameters.'."\n" ."\n" .'## [](#)Enable or disable the encryption feature'."\n" ."\n" .'After you create encryption configurations for the Logstore, you cannot modify the encryptType or userCmkInfo parameters. However, you can enable and disable the encryption feature by using the enable parameter.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'UpdateLogStoreMeteringMode' => [ 'summary' => 'Changes the billing mode of a Logstore.', 'path' => '/logstores/{logstore}/meteringmode', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'projectName', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'logstoreName', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The body of the request.', 'type' => 'object', 'properties' => [ 'meteringMode' => [ 'description' => 'The billing mode. Valid values: ChargeByFunction and ChargeByDataIngest. Default value: ChargeByFunction. The value ChargeByFunction specifies the pay-by-feature billing mode. The value ChargeByDataIngest specifies the pay-by-ingested-data billing mode.', 'type' => 'string', 'required' => true, 'example' => 'ChargeByFunction', 'default' => 'ChargeByFunction', 'enum' => ['ChargeByDataIngest', 'ChargeByFunction', 'ChargeByDataIngest_15', 'ChargeByDataIngest_7', 'ChargeByDataIngest_3'], 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateLogStoreMeteringMode', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateLogStoreMeteringMode', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'UpdateLogStoreProcessor' => [ 'summary' => 'Updates the ingest processor for a Logstore.', 'path' => '/logstores/{logstore}/processor', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '240235', 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'processorName' => ['description' => 'The name of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'parse-nginx-log'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateLogStoreProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'UpdateLogging' => [ 'summary' => 'Updates the service log configurations of a project.', 'path' => '/logging', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'loggingProject' => ['description' => 'The name of the project to which you want to save service logs.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], 'loggingDetails' => [ 'title' => '', 'description' => 'The configurations of service logs.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'type' => [ 'description' => 'The type of service logs. Valid values:'."\n" ."\n" .'- consumergroup\\_log: the consumption delay logs of consumer groups.'."\n" ."\n" .'- logtail\\_alarm: the alert logs of Logtail.'."\n" ."\n" .'- operation\\_log: the operation logs.'."\n" ."\n" .'- logtail\\_profile: the collection logs of Logtail.'."\n" ."\n" .'- metering: the metering logs.'."\n" ."\n" .'- logtail\\_status: the status logs of Logtail.'."\n" ."\n" .'- scheduledsqlalert: the operational logs of Scheduled SQL jobs.'."\n" ."\n" .'- etl\\_alert: the operational logs of data transformation jobs.', 'type' => 'string', 'required' => true, 'example' => 'consumergroup_log', 'enum' => ['consumergroup_log', 'logtail_alarm', 'operation_log', 'logtail_profile', 'metering', 'logtail_status', 'scheduled_sql_alert', 'etl_alert'], 'title' => '', ], 'logstore' => ['description' => 'The name of the Logstore to which you want to save service logs.', 'type' => 'string', 'required' => true, 'example' => 'my-logstore', 'title' => ''], ], 'required' => false, 'example' => '', ], 'required' => true, 'example' => '', ], ], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateLogging', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], ], ], 'UpdateLogs' => [ 'path' => '/logstores/{logstore}/updatelogs', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'Request body', 'type' => 'object', 'properties' => [ 'from' => ['description' => 'The start time of the query. This time refers to the log time specified when the log data was written.'."\n" ."\n" .'The time range defined by the request parameters from and to follows the left-closed, right-open principle. That is, the time range includes the start time but does not include the end time. If the values of from and to are the same, the range is invalid and the function returns an error directly.'."\n" .'Unix timestamp format, representing the number of seconds since 1970-01-01 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185', 'title' => ''], 'to' => ['description' => 'The end time of the query. This time refers to the log time specified when the log data was written.'."\n" ."\n" .'The time range defined by the request parameters from and to follows the left-closed, right-open principle. That is, the time range includes the start time but does not include the end time. If the values of from and to are the same, the range is invalid and the function returns an error directly.'."\n" .'Unix timestamp format, representing the number of seconds since 1970-01-01 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200', 'title' => ''], 'query' => ['description' => 'Optional: A query statement used to filter the logs to be updated. For more information, see [Query overview](~~43772~~).'."\n" ."\n" .'Note: This parameter only supports query statements and does not support analysis statements such as SPL or SQL.', 'type' => 'string', 'required' => false, 'example' => 'status: 401 ', 'title' => ''], 'rowId' => ['description' => 'Optional: The value of the built-in field __rowid__ that is automatically returned in the query results.'."\n" ."\n" .'One of the two fields, rowId and query, must be specified. If both are specified, rowId takes higher priority.', 'type' => 'string', 'required' => false, 'example' => '0|1000001|638732499', 'title' => ''], 'updateMode' => ['description' => 'Optional: The value can be full or partial. The default value is partial.'."\n" .' - full —— The request body must contain all fields of the row. The server overwrites the entire old record with the new values.'."\n" .' - partial —— The request body only needs to contain the fields to be modified. Fields that are not provided retain their original values.', 'type' => 'string', 'required' => false, 'example' => 'partial', 'title' => ''], 'data' => ['description' => 'The data to be updated, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"status":"success"}', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => false, 'example' => 'ali-project-test', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'affectedRows' => ['description' => 'The number of updated log rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Update Logs', 'summary' => 'Updates log data in a specified Logstore under the specified Project.', 'description' => 'The Host consists of the Project name and the Log Service endpoint. You need to specify the Project in the Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"affectedRows\\": 10\\n}","type":"json"}]', ], 'UpdateLogtailPipelineConfig' => [ 'summary' => 'Updates a Logtail pipeline configuration.', 'path' => '/pipelineconfigs/{configName}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191814', 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', 'schema' => ['description' => 'The name of the Logtail pipeline configuration.', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The content of the Logtail pipeline configuration.', 'type' => 'object', 'properties' => [ 'configName' => ['description' => 'The name of the configuration.'."\n" ."\n" .'>'."\n" ."\n" .'The name must be the same as the value of the configName parameter in the request path.'."\n" ."\n" .'>', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], 'logSample' => ['description' => 'A sample log. Multiple logs are supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], 'global' => ['description' => 'The global configuration.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => ''], 'inputs' => [ 'title' => '', 'description' => 'The list of input plug-ins.'."\n" ."\n" .'>'."\n" ."\n" .'Currently, you can configure only one input plug-in.'."\n" ."\n" .'>', 'type' => 'array', 'items' => ['description' => 'The input plug-in.'."\n" ."\n" .'> For the parameters of the file input plug-in, see [File plug-in](~~65064~~). For the parameters of other input plug-ins, see [Processing plug-ins](~~64957~~).', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "Type": "input_file",'."\n" .' "FilePaths": ["/var/log/*.log"]'."\n" .'}'], 'required' => true, 'minItems' => 1, 'example' => '', ], 'processors' => [ 'title' => '', 'description' => 'The list of processing plug-ins.'."\n" ."\n" .'> Processing plug-ins are classified into native processing plug-ins and extension processing plug-ins. For more information, see [Processing plug-ins](~~64957~~).'."\n" ."\n" .'>'."\n" ."\n" .'> - Native plug-ins can be used only to collect text logs.'."\n" .'>'."\n" .'> - You cannot add native plug-ins and extension plug-ins at the same time.'."\n" .'>'."\n" .'> - When you use native plug-ins, the following requirements must be met:'."\n" .'>'."\n" .'> - The first processing plug-in must be a regular expression-based parsing plug-in, a separator-based parsing plug-in, a JSON-based parsing plug-in, an NGINX-based parsing plug-in, an Apache-based parsing plug-in, or an IIS-based parsing plug-in.'."\n" .'>'."\n" .'> - After the first processing plug-in, you can add only one time parsing plug-in, one filter plug-in, and multiple data masking plug-ins.'."\n" ."\n" .'>', 'type' => 'array', 'items' => ['description' => 'The processing plug-in.'."\n" ."\n" .'> For more information, see [Processing plug-ins](~~64957~~).', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "Type": "processor_parse_json_native",'."\n" .' "SourceKey": "content"'."\n" .'}'], 'required' => false, 'minItems' => 1, 'example' => '', ], 'aggregators' => [ 'title' => '', 'description' => 'The list of aggregator plug-ins.'."\n" ."\n" .'>'."\n" ."\n" .'This parameter is valid only when you use an extension processing plug-in. You can use a maximum of one aggregator plug-in.'."\n" ."\n" .'>', 'type' => 'array', 'items' => ['description' => 'The aggregator plug-in.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => ''], 'required' => false, 'minItems' => 1, 'example' => '', ], 'flushers' => [ 'title' => '', 'description' => 'The list of output plug-ins.'."\n" ."\n" .'>'."\n" ."\n" .'Currently, you can add only one SLS output plug-in.'."\n" ."\n" .'>', 'type' => 'array', 'items' => ['description' => 'The output plug-in.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" .' "Type": "flusher_sls",'."\n" .' "Logstore": "test"'."\n" .'}'], 'required' => true, 'minItems' => 1, 'example' => '', ], 'task' => ['type' => 'object', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateLogtailPipelineConfig', 'requestParamsDescription' => '## Global configuration'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------------- | -------- | ----------------------------------------------- | ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| TopicType | string | No | Empty | filepath | The type of the topic. Valid values:* filepath: extracts information from the log file path as the topic. This value is valid only when the input plug-in is input\\_file.
* machine\\_group\\_topic: uses the topic of the machine group to which the configuration is applied.
* custom: uses a custom topic. For more information, see [Log topic](~~60069~~). |'."\n" .'| TopicFormat | string | Yes, if TopicType is set to filepath or custom. | / | /var/log/(.*).log | The format of the topic. |'."\n" .'| EnableTimestampNanosecond | bool | No | false | false | Specifies whether to enable nanosecond precision for timestamps. |'."\n" .'| PipelineMetaTagKey | object | No | Empty | {"HOST_NAME":"__hostname__"} | >This parameter is supported only by LoongCollector 3.0.10 and later.> Controls the tags related to LoongCollector information. The key is the tag parameter name, and the value is the field name of the tag in the log. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. The following tags can be configured:* HOST\\_NAME: the hostname. This tag is added by default. The default value is "\\_\\_hostname\\_\\_".
* AGENT\\_TAG: the custom identifier. This tag is added by default. The default value is "\\_\\_user\\_defined\\_id\\_\\_".
* HOST\\_ID: the host ID. This tag is not added by default. The default value is "\\_\\_host\\_id\\_\\_".
* CLOUD\\_PROVIDER: This tag is not added by default. The default value is "\\_\\_cloud\\_provider\\_\\_". |'."\n" ."\n" .'## Input plug-ins'."\n" ."\n" .'### File input plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------------------------------- | --------- | ---------------------------------------------- | ----------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | input_file | The type of the plug-in. Set the value to input_file. |'."\n" .'| FilePaths | \\[string] | Yes | / | \\["/var/log/*.log"] | The list of paths to the log files to be collected. Currently, only one path is allowed. You can use the asterisk (*) and double asterisk (**) wildcard characters in the path. The double asterisk (**) wildcard character can appear only once and must be used before the filename. |'."\n" .'| MaxDirSearchDepth | uint | No | 0 | 0 | The maximum depth of the subdirectories that the double asterisk (**) wildcard character can match in a file path. This parameter is valid only when the double asterisk (**) wildcard character is used in the log path. Valid values: 0 to 1000. |'."\n" .'| ExcludeFilePaths | \\[string] | No | Empty | \\["/home/admin/*.log"] | The blacklist of file paths. The path must be an absolute path. The asterisk (*) wildcard character is supported. |'."\n" .'| ExcludeFiles | \\[string] | No | Empty | \\["app*.log", "password"] | The blacklist of filenames. The asterisk (*) wildcard character is supported. |'."\n" .'| ExcludeDirs | \\[string] | No | Empty | \\["/home/admin/dir1", "/home/admin/dir2*"] | The blacklist of directories. The path must be an absolute path. The asterisk (*) wildcard character is supported. |'."\n" .'| FileEncoding | string | No | utf8 | utf8 | The encoding format of the file. Valid values: utf8 and gbk. |'."\n" .'| TailSizeKB | uint | No | 1024 | 1024 | The starting collection position of a matched file when the configuration first takes effect, measured from the end of the file. If the file size is smaller than this value, collection starts from the beginning. Valid values: 0 to 10485760 KB. |'."\n" .'| Multiline | object | No | Empty | / | The multiline aggregation options. |'."\n" .'| Multiline.Mode | string | No | custom | custom | The multiline aggregation mode. Valid values: custom and JSON. |'."\n" .'| Multiline.StartPattern | string | Required when Multiline.Mode is set to custom. | Empty | \\d+-\\d+-\\d+.* | The regular expression for the start of a line. |'."\n" .'| EnableContainerDiscovery | bool | No | false | true | Specifies whether to enable container discovery. This parameter is valid only when Logtail runs in DaemonSet mode and the collected file path is a path within the container. |'."\n" .'| ContainerFilters | object | No | Empty | / | The container filtering options. The relationship between multiple options is "AND". This parameter is valid only when EnableContainerDiscovery is set to true. |'."\n" .'| ContainerFilters.K8sNamespaceRegex | string | No | Empty | default | For containers deployed in a Kubernetes environment, specifies the condition for the namespace of the pod to which the container to be collected belongs. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" .'| ContainerFilters.K8sPodRegex | string | No | Empty | test-pod | For containers deployed in a Kubernetes environment, specifies the condition for the name of the pod to which the container to be collected belongs. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" .'| ContainerFilters.IncludeK8sLabel | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the label condition for the pod to which the container to be collected belongs. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of a pod label, and the value is the value of the pod label. The following rules apply:* If the value in the map is empty, any pod that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a pod is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a pod is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" .'| ContainerFilters.ExcludeK8sLabel | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the label condition for the pod to which the container to be excluded from collection belongs. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of a pod label, and the value is the value of the pod label. The following rules apply:* If the value in the map is empty, any pod that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a pod is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a pod is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" .'| ContainerFilters.K8sContainerRegex | string | No | Empty | test-container | For containers deployed in a Kubernetes environment, specifies the condition for the name of the container to be collected. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" .'| ContainerFilters.IncludeEnv | map | No | Empty | / | Specifies the environment variable condition for the container to be collected. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of an environment variable, and the value is the value of the environment variable. The following rules apply:* If the value in the map is empty, any container that has an environment variable with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has an environment variable with the specified key and the variable value matches the regular expression.
- In other cases, a container is matched if it has an environment variable with the specified key and the variable value is the same as the specified value. |'."\n" .'| ContainerFilters.ExcludeEnv | map | No | Empty | / | Specifies the environment variable condition for the container to be excluded from collection. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of an environment variable, and the value is the value of the environment variable. The following rules apply:* If the value in the map is empty, any container that has an environment variable with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has an environment variable with the specified key and the variable value matches the regular expression.
- In other cases, a container is matched if it has an environment variable with the specified key and the variable value is the same as the specified value. |'."\n" .'| ContainerFilters.IncludeContainerLabel | map | No | Empty | / | Specifies the label condition for the container to be collected. The relationship between multiple conditions is "OR". If you do not add this parameter, the default value is empty, which means all containers are collected. Regular expressions are supported. The key of the map is the name of a container label, and the value is the value of the container label. The following rules apply:* If the value in the map is empty, any container that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a container is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" .'| ContainerFilters.ExcludeContainerLabel | map | No | Empty | / | Specifies the label condition for the container to be excluded from collection. The relationship between multiple conditions is "OR". If you do not add this parameter, the default value is empty, which means all containers are collected. Regular expressions are supported. The key of the map is the name of a container label, and the value is the value of the container label. The following rules apply:* If the value in the map is empty, any container that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a container is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" .'| ExternalK8sLabelTag | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the pod label-related tags to be added to the logs. The key of the map is the name of a pod label, and the value is the corresponding tag name. For example, if you add `app: k8s_label_app` to the map, and a pod has the label `app=serviceA`, this information is added to the log as a tag, which means the field `__tag__:k8s_label_app: serviceA` is added. If the pod does not have the `app` label, the empty field `__tag__:k8s_label_app: `is added. |'."\n" .'| ExternalEnvTag | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the container environment variable-related tags to be added to the logs. The key of the map is the name of an environment variable, and the value is the corresponding tag name. For example, if you add `VERSION: env_version` to the map, and a container has the environment variable `VERSION=v1.0.0`, this information is added to the log as a tag, which means the field `__tag__:env_version: v1.0.0` is added. If the container does not have the `VERSION` environment variable, the empty field `__tag__:env_version: `is added. |'."\n" .'| CollectingContainersMeta | bool | No | false | true | Specifies whether to enable container metadata preview. |'."\n" .'| AppendingLogPositionMeta | bool | No | false | false | Specifies whether to add the metadata of the file to which the log belongs to the log. The metadata includes the __tag__:__inode__ field and the __file_offset__ field. |'."\n" .'| AllowingIncludedByMultiConfigs | bool | No | false | false | Specifies whether to allow the current configuration to collect files that have been matched by other configurations. |'."\n" .'| Tags | object | No | Empty | {"FileInodeTagKey":"__inode__"} | >This parameter is supported only by LoongCollector 3.0.10 and later.> Controls the tags related to file collection. The key is the tag parameter name, and the value is the field name of the tag in the log. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. The following tags can be configured:* FileInodeTagKey: the file inode. This tag is not added by default. The default value is "\\_\\_inode\\_\\_".
* FilePathTagKey: the file path. This tag is added by default. The default value is "\\_\\_path\\_\\_".The following parameters are valid only when the EnableContainerDiscovery parameter is set to true.* K8sNamespaceTagKey: the namespace of the container where the file is located. This tag is added by default. The default value is "\\_namespace\\_".
* K8sPodNameTagKey: the name of the pod where the file is located. This tag is added by default. The default value is "\\_pod\\_name\\_".
* K8sPodUidTagKey: the UID of the pod where the file is located. This tag is added by default. The default value is "\\_pod\\_uid\\_".
* ContainerNameTagKey: the name of the container where the file is located. This tag is added by default. The default value is "\\_container\\_name\\_".
* ContainerIpTagKey: the IP address of the container where the file is located. This tag is added by default. The default value is "\\_container\\_ip\\_".
* ContainerImageNameTagKey: the image of the container where the file is located. This tag is added by default. The default value is "\\_image\\_name\\_". |'."\n" .'| FileOffsetKey | string | No | Empty | \\__file_offset__ | >This parameter is supported only by LoongCollector 3.0.10 and later.> The tag for the log\'s position in the file. This tag is not added by default. The default value is __file_offset__. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. If the EnableLogPositionMeta parameter exists at the same time as the Tags.FileInodeTagKey or FileOffsetKey parameter, the EnableLogPositionMeta parameter is ignored. |'."\n" ."\n" .'### Container stdout (legacy)'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------- | --------------------------------------------------------- | ------------ | ----------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_docker_stdout | The type of the plug-in. Set the value to service_docker_stdout. |'."\n" .'| Stdout | Boolean | No | true | true | Specifies whether to collect standard output (stdout). |'."\n" .'| Stderr | Boolean | No | true | true | Specifies whether to collect standard error (stderr). |'."\n" .'| StartLogMaxOffset | Integer | No | 128 × 1024 | 131072 | The length of historical data to be retrieved during the first collection, in bytes. We recommend a value between 131072 and 1048576. |'."\n" .'| IncludeLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The whitelist of container labels, used to specify the containers to be collected. The default value is empty, which means the standard output of all containers is collected. If you want to set a container label whitelist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a label with the specified LabelKey is matched.
- If LabelValue is not empty, only containers that have a label with the specified LabelKey=LabelValue are matched.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the container label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `io.kubernetes.container.name` and LabelValue to `^(nginx|cube)$`, containers named nginx or cube are matched.
The relationship between multiple whitelist conditions is "OR", meaning a container is matched if its label satisfies any of the whitelist conditions. |'."\n" .'| ExcludeLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The blacklist of container labels, used to exclude containers from collection. The default value is empty, which means no containers are excluded. If you want to set a container label blacklist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a label with the specified LabelKey is excluded.
- If LabelValue is not empty, only containers that have a label with the specified LabelKey=LabelValue are excluded.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the container label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `io.kubernetes.container.name` and LabelValue to `^(nginx|cube)$`, containers named nginx or cube are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its label satisfies any of the blacklist conditions. |'."\n" .'| IncludeEnv | Map, where EnvKey and EnvValue are of the String type | No | Empty | | The whitelist of environment variables, used to specify the containers to be collected. The default value is empty, which means the standard output of all containers is collected. If you want to set an environment variable whitelist, EnvKey is required, and EnvValue is optional.
- If EnvValue is empty, any container that has an environment variable with the specified EnvKey is matched.
- If EnvValue is not empty, only containers that have an environment variable with the specified EnvKey=EnvValue are matched.
By default, EnvValue is matched as a string, meaning a match occurs only if the EnvValue is identical to the environment variable\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set EnvKey to `NGINX_SERVICE_PORT` and EnvValue to \\`^(80 |'."\n" .'| ExcludeEnv | Map, where EnvKey and EnvValue are of the String type | No | Empty | | The blacklist of environment variables, used to exclude containers from collection. The default value is empty, which means no containers are excluded. If you want to set an environment variable blacklist, EnvKey is required, and EnvValue is optional.
- If EnvValue is empty, the logs of any container that has an environment variable with the specified EnvKey are excluded.
- If EnvValue is not empty, only containers that have an environment variable with the specified EnvKey=EnvValue are excluded.
By default, EnvValue is matched as a string, meaning a match occurs only if the EnvValue is identical to the environment variable\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set EnvKey to `NGINX_SERVICE_PORT` and EnvValue to `^(80|6379)$`, containers with service port 80 or 6379 are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its environment variable satisfies any of the key-value pairs. |'."\n" .'| IncludeK8sLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The whitelist of Kubernetes labels (defined in template.metadata), used to specify the containers to be collected. If you want to set a Kubernetes label whitelist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a Kubernetes label with the specified LabelKey is matched.
- If LabelValue is not empty, only containers that have a Kubernetes label with the specified LabelKey=LabelValue are matched.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the Kubernetes label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `app` and LabelValue to `^(test1|test2)$`, containers with Kubernetes labels app:test1 or app:test2 are matched.
The relationship between multiple whitelist conditions is "OR", meaning a container is matched if its Kubernetes label satisfies any of the whitelist conditions. |'."\n" .'| ExcludeK8sLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The blacklist of Kubernetes labels (defined in template.metadata), used to exclude containers from collection. If you want to set a Kubernetes label blacklist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a Kubernetes label with the specified LabelKey is excluded.
- If LabelValue is not empty, only containers that have a Kubernetes label with the specified LabelKey=LabelValue are excluded.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the Kubernetes label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `app` and LabelValue to `^(test1|test2)$`, containers with Kubernetes labels app:test1 or app:test2 are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its Kubernetes label satisfies any of the blacklist conditions. |'."\n" .'| K8sNamespaceRegex | String | No | Empty | ^(default|nginx)$ | Specifies the containers to be collected by namespace name. Regular expressions are supported. For example, if you set this to `^(default|nginx)$`, all containers in the nginx and default namespaces are matched. |'."\n" .'| K8sPodRegex | String | No | Empty | ^(nginx-log-demo.*)$ | Specifies the containers to be collected by pod name. Regular expressions are supported. For example, if you set this to `^(nginx-log-demo.*)$`, all containers in pods whose names start with nginx-log-demo are matched. |'."\n" .'| K8sContainerRegex | String | No | Empty | ^(container-test)$ | Specifies the containers to be collected by container name (Kubernetes container names are defined in spec.containers). Regular expressions are supported. For example, if you set this to `^(container-test)$`, all containers named container-test are matched. |'."\n" ."\n" .'#### Data processing parameters'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------------- | --------------------------------------------------------- | ------------ | ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| BeginLineRegex | String | No | Empty | | The regular expression to match the start of a line.
If this configuration item is empty, it indicates single-line mode.
If this expression matches the beginning of a line, that line is treated as a new log. Otherwise, the line is appended to the previous log. |'."\n" .'| BeginLineCheckLength | Integer | No | Empty | | The length to check for a line start match, in bytes.
The default value is 10 × 1024 bytes.
If the regular expression for the start of a line can be matched within the first N bytes, we recommend setting this parameter to improve line start matching efficiency. |'."\n" .'| BeginLineTimeoutMs | Integer | No | Empty | | The timeout period for matching the start of a line, in milliseconds.
The default value is 3000 milliseconds.
If no new log appears within 3000 milliseconds, the matching ends, and the last log is uploaded to Simple Log Service. |'."\n" .'| MaxLogSize | Integer | No | Empty | | The maximum length of a log**,** in bytes. The default value is 0.
The default value is 512 × 1024 bytes.
If the log length exceeds this value, the system stops searching for the start of a line and uploads the log directly. |'."\n" .'| ExternalK8sLabelTag | Map, where LabelKey and LabelValue are of the String type | No | Empty | | After setting the Kubernetes label (defined in template.metadata) log tag, iLogtail adds Kubernetes label-related fields to the logs.
For example, if you set LabelKey to app and LabelValue to `k8s_label_app`, and a pod has the label `app=serviceA`, iLogtail adds this information to the log, which means the field k8s\\_label\\_app: serviceA is added. If the pod does not have a label named app, the empty field k8s\\_label\\_app: is added. |'."\n" .'| ExternalEnvTag | Map, where EnvKey and EnvValue are of the String type | No | Empty | | After setting the container environment variable log tag, iLogtail adds container environment variable-related fields to the logs.
For example, if you set EnvKey to `VERSION` and EnvValue to `env_version`, and a container has the environment variable `VERSION=v1.0.0`, this information is added to the log as a tag, which means the field env\\_version: v1.0.0 is added. If the container does not have an environment variable named VERSION, the empty field env\\_version: is added. |'."\n" ."\n" .'#### Data processing environment variables'."\n" ."\n" .'| **Environment variable** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------------ | -------- | ------------ | ----------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| ALIYUN_LOG_ENV_TAGS | String | No | Empty | | After setting the global environment variable log tag, iLogtail adds fields related to the environment variables of the iLogtail container to the logs. Multiple environment variable names are separated by a VERTICAL LINE (|).
For example, if you set this to node\\_name|node\\_ip, and the iLogtail container exposes the relevant environment variables, this information is added to the log as a tag, which means the fields node\\_ip:172.16.0.1 and node\\_name:worknode are added. |'."\n" ."\n" .'### MySQL input plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------------- | -------- | ------------ | ----------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_mysql | The type of the plug-in. Set the value to service_mysql. |'."\n" .'| Address | string | No | 127.0.0.1:3306 | rm-*.mysql.rds.aliyuncs.com | The MySQL address. |'."\n" .'| User | string | No | root | root | The username for logging on to the MySQL database. |'."\n" .'| Password | string | No | Empty | | The password for the user to log on to the MySQL database. If you have high security requirements, set the username and password to xxx. After the collection configuration is synchronized to your machine, find the configuration in the `/usr/local/ilogtail/user_log_config.json` file and modify it. For more information, see [Modify a local configuration](~~64955~~).> If you modify this parameter in the console, the local configuration is overwritten after synchronization.> |'."\n" .'| DataBase | string | No | / | project_database | The name of the database. |'."\n" .'| DialTimeOutMs | int | No | 5000 | 5000 | The timeout period for connecting to the MySQL database, in ms. |'."\n" .'| ReadTimeOutMs | int | No | 5000 | 5000 | The timeout period for reading the MySQL query results, in ms. |'."\n" .'| StateMent | string | No | / | | The SELECT statement. When CheckPoint is set to true, the WHERE condition in the SELECT statement must include the checkpoint column (CheckPointColumn). You can use a question mark (?) as a placeholder that works with the checkpoint column. For example, set CheckPointColumn to id, CheckPointStart to 0, and StateMent to `SELECT * from ... where id > ?`. After each collection, the system saves the ID of the last data entry as a checkpoint. In the next collection, the question mark (?) in the query statement is replaced with the ID corresponding to that checkpoint. |'."\n" .'| Limit | bool | No | false | true | Specifies whether to use LIMIT for paging.* true: Use LIMIT.
* false (default): Do not use LIMIT.We recommend using LIMIT for paging. If Limit is set to true, the system automatically appends a LIMIT clause to the SELECT statement during SQL queries. |'."\n" .'| PageSize | int | No | / | 10 | The page size. This must be configured if Limit is set to true. |'."\n" .'| MaxSyncSize | int | No | 0 | 0 | The maximum number of records to synchronize at a time. The default value is 0, which means no limit. |'."\n" .'| CheckPoint | bool | No | false | true | Specifies whether to use a checkpoint.* true: Use a checkpoint.
* false (default): Do not use a checkpoint.A checkpoint can be used as the starting point for the next data collection to implement incremental data collection. |'."\n" .'| CheckPointColumn | string | No | Empty | 1 | The name of the checkpoint column. This must be configured if CheckPoint is set to true. **Warning** The values in this column must be incremental. Otherwise, data may be lost. The maximum value in each query result is used as the input for the next query. |'."\n" .'| CheckPointColumnType | string | No | Empty | int | The data type of the checkpoint column. Supported types are int and time. The internal storage for the int type is int64. The time type supports MySQL\'s date, datetime, and time types. This must be configured if CheckPoint is set to true. |'."\n" .'| CheckPointStart | string | No | Empty | | The initial value of the checkpoint column. This must be configured if CheckPoint is set to true. |'."\n" .'| CheckPointSavePerPage | bool | No | true | true | Specifies whether to save a checkpoint for each page.* true (default): Save a checkpoint for each page.
* false: Save a checkpoint after each synchronization is complete. |'."\n" .'| IntervalMs | int | No | 60000 | 60000 | The synchronization interval. The default value is 60000, in ms. |'."\n" ."\n" .'### HTTP input plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------- | -------- | ------------ | ----------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | metric_http | The type of the plug-in. Set the value to metric_http. |'."\n" .'| Address | string | Yes | / | | The list of URLs. **Important** Must start with `http` or `https`. |'."\n" .'| IntervalMs | int | Yes | / | 10 | The interval for each request, in ms. |'."\n" .'| Method | string | No | GET | GET | The name of the request method. Must be in uppercase. |'."\n" .'| Body | string | No | Empty | | The content of the HTTP Body field. |'."\n" .'| Headers | map | No | Empty | {"key":"value"} | The content of the HTTP Header, for example, `{"key":"value"}`. Replace with the actual value. |'."\n" .'| PerAddressSleepMs | int | No | 100 | 100 | The interval between requests for each URL in the Addresses list, in ms. |'."\n" .'| ResponseTimeoutMs | int | No | 5000 | 5000 | The request timeout period, in ms. |'."\n" .'| IncludeBody | bool | No | false | true | Specifies whether to collect the request Body. The default value is false. If set to true, the request Body content is stored in a key named content. |'."\n" .'| FollowRedirects | bool | No | false | false | Specifies whether to automatically handle redirection. |'."\n" .'| InsecureSkipVerify | bool | No | false | false | Specifies whether to skip HTTPS security checks. |'."\n" .'| ResponseStringMatch | string | No | / | | Performs a regular expression check on the returned Body content. The check result is stored in a key named _response_match_. If it matches, the value is yes. If it does not match, the value is no. |'."\n" ."\n" .'### Syslog input plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------ | -------- | ------------ | -------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_syslog | The type of the plug-in. Set the value to service_syslog. |'."\n" .'| Address | string | No | tcp://127.0.0.1:9999 | | Specifies the protocol, address, and port for Logtail to listen on. Logtail listens and obtains log data based on the Logtail configuration. The format is `[tcp/udp]://[` *ip* `]:[` *port* `]`. If not configured, the default is `tcp://127.0.0.1:9999`, which means it can only receive locally forwarded logs. **Note*** The listening protocol, address, and port number set in the Logtail configuration must be the same as the forwarding rule set in the rsyslog configuration file.
* If the server where Logtail is installed has multiple IP addresses that can receive logs, you can set the address to `0.0.0.0` to listen on all IP addresses of the server. |'."\n" .'| ParseProtocol | string | No | Empty | rfc3164 | Specifies the protocol used to parse logs. The default is empty, which means no parsing. The options are:* Empty: No parsing.
* rfc3164: Specifies using the RFC3164 protocol to parse logs.
* rfc5424: Specifies using the RFC5424 protocol to parse logs.
auto: Specifies that Logtail automatically selects the appropriate parsing protocol based on the log content. |'."\n" .'| IgnoreParseFailure | bool | No | true | true | Specifies the action to take after a parsing failure. If not configured, the default is `true`, which means parsing is abandoned, and the returned content field is filled directly. If set to `false`, the log is discarded upon parsing failure. |'."\n" ."\n" .'### Systemd Journal input plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------- | --------- | ------------ | ----------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_journal | The type of the plug-in. Set the value to service_journal. |'."\n" .'| JournalPaths | \\[string] | Yes | Empty | /var/log/journal | The Journal log path. We recommend configuring this as the directory where the Journal logs are located. |'."\n" .'| SeekPosition | string | No | tail | tail | The initial collection method. Can be set to head or tail.* head means collect all data.
* tail means only collect new data after the Logtail collection configuration is applied. |'."\n" .'| Kernel | bool | No | true | true | Specifies whether to collect kernel logs. |'."\n" .'| Units | \\[string] | No | Empty | "" | The list of Units to collect. The default is empty, which means all are collected. |'."\n" .'| ParseSyslogFacility | bool | No | false | false | Specifies whether to parse the facility field of syslog logs. If not configured, it is not parsed. |'."\n" .'| ParsePriority | bool | No | false | false | Specifies whether to parse the Priority field. If not configured, it is not parsed. If set to true, the mapping relationship for the Priority field is as follows. `"0": "emergency" "1": "alert" "2": "critical" "3": "error" "4": "warning" "5": "notice" "6": "informational" "7": "debug"` |'."\n" .'| UseJournalEventTime | bool | No | false | false | Specifies whether to use the field from the Journal log as the log time. If not configured, the collection time is used as the log time. Real-time log collection typically has a difference of less than 3 seconds. |'."\n" ."\n" .'### SQL Server input plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------------- | -------- | ------------ | ----------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_mssql | The type of the plug-in. Set the value to service_mssql. |'."\n" .'| Address | string | No | 127.0.0.1:1433 | rm-*.sqlserver.rds.aliyuncs.com | The SQL Server address. |'."\n" .'| User | string | No | root | root | The account name for logging on to the SQL Server database. |'."\n" .'| Password | string | No | Empty | | The password for the account to log on to the SQL Server database. If you have high security requirements, set the username and password to xxx. After the collection configuration is synchronized to your machine, find the configuration in the `/usr/local/ilogtail/user_log_config.json` file and modify it. For more information, see [Modify a local configuration](~~64955~~).> If you modify this parameter in the console, the local configuration is overwritten after synchronization.> |'."\n" .'| DataBase | string | No | / | project_database | The name of the database. |'."\n" .'| DialTimeOutMs | int | No | 5000 | 5000 | The timeout period for connecting to the SQL Server database, in ms. |'."\n" .'| ReadTimeOutMs | int | No | 5000 | 5000 | The timeout period for reading the SQL Server query results, in ms. |'."\n" .'| StateMent | string | No | / | | The SELECT statement. When CheckPoint is set to true, the WHERE condition in the SELECT statement must include the checkpoint column (CheckPointColumn). You can use a question mark (?) as a placeholder that works with the checkpoint column. For example, set CheckPointColumn to id, CheckPointStart to 0, and StateMent to `SELECT * from ... where id > ?`. After each collection, the system saves the ID of the last data entry as a checkpoint. In the next collection, the question mark (?) in the query statement is replaced with the ID corresponding to that checkpoint. |'."\n" .'| Limit | bool | No | false | true | Specifies whether to use LIMIT for paging.* true: Use LIMIT.
* false (default): Do not use LIMIT.We recommend using LIMIT for paging. If Limit is set to true, the system automatically appends a LIMIT clause to the SELECT statement during SQL queries. |'."\n" .'| PageSize | int | No | / | 10 | The page size. This must be configured if Limit is set to true. |'."\n" .'| MaxSyncSize | int | No | 0 | 0 | The maximum number of records to synchronize at a time. The default value is 0, which means no limit. |'."\n" .'| CheckPoint | bool | No | false | true | Specifies whether to use a checkpoint.* true: Use a checkpoint.
* false (default): Do not use a checkpoint.A checkpoint can be used as the starting point for the next data collection to implement incremental data collection. |'."\n" .'| CheckPointColumn | string | No | Empty | 1 | The name of the checkpoint column. This must be configured if CheckPoint is set to true. **Warning** The values in this column must be incremental. Otherwise, data may be lost. The maximum value in each query result is used as the input for the next query. |'."\n" .'| CheckPointColumnType | string | No | Empty | int | The data type of the checkpoint column. Supported types are int and time. The internal storage for the int type is int64. The time type supports SQL Server\'s date, datetime, and time types. This must be configured if CheckPoint is set to true. |'."\n" .'| CheckPointStart | string | No | Empty | | The initial value of the checkpoint column. This must be configured if CheckPoint is set to true. |'."\n" .'| CheckPointSavePerPage | bool | No | true | true | Specifies whether to save a checkpoint for each page.* true (default): Save a checkpoint for each page.
* false: Save a checkpoint after each synchronization is complete. |'."\n" .'| IntervalMs | int | No | 60000 | 60000 | The synchronization interval. The default value is 60000, in ms. |'."\n" ."\n" .'### PostgreSQL input plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------------- | -------- | ------------ | ----------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | service_pgsql | The type of the plug-in. Set the value to service_pgsql. |'."\n" .'| Address | string | No | 127.0.0.1:5432 | rm-*.pg.rds.aliyuncs.com | The PostgreSQL address. |'."\n" .'| User | string | No | root | root | The account name for logging on to the PostgreSQL database. |'."\n" .'| Password | string | No | Empty | | The password for the account to log on to the PostgreSQL database. If you have high security requirements, set the username and password to xxx. After the collection configuration is synchronized to your machine, find the configuration in the `/usr/local/ilogtail/user_log_config.json` file and modify it. For more information, see [Modify a local configuration](~~64955~~).> If you modify this parameter in the console, the local configuration is overwritten after synchronization.> |'."\n" .'| DataBase | string | No | / | project_database | The name of the PostgreSQL database. |'."\n" .'| DialTimeOutMs | int | No | 5000 | 5000 | The timeout period for connecting to the PostgreSQL database, in ms. |'."\n" .'| ReadTimeOutMs | int | No | 5000 | 5000 | The timeout period for reading the PostgreSQL query results, in ms. |'."\n" .'| StateMent | string | No | / | | The SELECT statement. When CheckPoint is set to true, the WHERE condition in the StateMent\'s SELECT statement must include the checkpoint column (CheckPointColumn parameter), and its value must be set to $1. For example, set CheckPointColumn to id and StateMent to `SELECT * from ... where id > $1` |'."\n" .'| Limit | bool | No | false | true | Specifies whether to use LIMIT for paging.* true: Use LIMIT.
* false (default): Do not use LIMIT.We recommend using LIMIT for paging. If Limit is set to true, the system automatically appends a LIMIT clause to the SELECT statement during SQL queries. |'."\n" .'| PageSize | int | No | / | 10 | The page size. This must be configured if Limit is set to true. |'."\n" .'| MaxSyncSize | int | No | 0 | 0 | The maximum number of records to synchronize at a time. The default value is 0, which means no limit. |'."\n" .'| CheckPoint | bool | No | false | true | Specifies whether to use a checkpoint.* true: Use a checkpoint.
* false (default): Do not use a checkpoint.A checkpoint can be used as the starting point for the next data collection to implement incremental data collection. |'."\n" .'| CheckPointColumn | string | No | Empty | 1 | The name of the checkpoint column. This must be configured if CheckPoint is set to true. **Warning** The values in this column must be incremental. Otherwise, data may be lost. The maximum value in each query result is used as the input for the next query. |'."\n" .'| CheckPointColumnType | string | No | Empty | int | The data type of the checkpoint column. Supported types are int and time. The internal storage for the int type is int64. The time type supports PostgreSQL\'s time types. This must be configured if CheckPoint is set to true. |'."\n" .'| CheckPointStart | string | No | Empty | | The initial value of the checkpoint column. This must be configured if CheckPoint is set to true. |'."\n" .'| CheckPointSavePerPage | bool | No | true | true | Specifies whether to save a checkpoint for each page.* true (default): Save a checkpoint for each page.
* false: Save a checkpoint after each synchronization is complete. |'."\n" .'| IntervalMs | int | No | 60000 | 60000 | The synchronization interval. The default value is 60000, in ms. |'."\n" ."\n" .'### SNMP input plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------------ | --------- | ------------ | ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Targets | \\[string] | Yes | / | 127.0.0.1 | The IP address of the target machine group. |'."\n" .'| Port | string | No | 161 | 161 | The port used by the SNMP protocol. |'."\n" .'| Community | string | No | public | public | The community name. SNMPv1 and SNMPv2 use community names for authentication. |'."\n" .'| UserName | string | No | Empty | root | The username. SNMPv3 supports authentication using a username. |'."\n" .'| AuthenticationProtocol | string | No | NoAuth | NoAuth | The authentication protocol. SNMPv3 supports authentication using an authentication protocol. |'."\n" .'| AuthenticationPassphrase | string | No | Empty | | The authentication password. The default value is empty. If you set `AuthenticationProtocol` to `MD5` or `SHA`, you need to set `AuthenticationPassphrase`. |'."\n" .'| PrivacyProtocol | string | No | NoPriv | NoPriv | The privacy protocol. SNMPv3 supports authentication using a privacy protocol. |'."\n" .'| PrivacyPassphrase | string | No | Empty | | The privacy protocol password. By default, it is the same as the authentication password. If you set `PrivacyProtocol` to `DES` or `AES`, you must set `PrivacyPassphrase`. |'."\n" .'| Timeout | int | No | 5 | 5 | The timeout period for a single query operation, in seconds. |'."\n" .'| Version | int | No | 2 | 2 | The SNMP protocol version. Valid values are `1`, `2`, and `3`. |'."\n" .'| Transport | string | No | udp | udp | The SNMP communication method. Valid values are `udp` and `tcp`. |'."\n" .'| MaxRepetitions | int | No | 0 | 0 | The number of retries after a query timeout. |'."\n" .'| Oids | \\[string] | No | Empty | 1 | The object identifiers to query in the target machine. |'."\n" .'| Fields | \\[string] | No | Empty | int | The fields to query in the target machine. This plug-in first translates the fields by looking them up in the local Management Information Base (MIB), translates them into object identifiers, and queries them together. |'."\n" .'| Tables | \\[string] | No | Empty | | The tables to query in the target machine. This plug-in first queries all fields in the table, then looks them up in the local Management Information Base (MIB), translates them into object identifiers, and queries them together. |'."\n" ."\n" .'### Script output plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------- | --------- | ------------ | ----------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | input_command | The type of the plug-in. Set the value to input_command. |'."\n" .'| ScriptType | string | Yes | Empty | shell | Specifies the type of the script content. Currently supports bash, shell, python2, and python3. |'."\n" .'| User | string | Yes | / | public | The username used to run the command. Only non-root users are supported. **Note** * Ensure that the specified username exists on the machine. We recommend configuring the least privilege, granting only rwx permissions to the necessary directories or files. |'."\n" .'| ScriptContent | string | Yes | Empty | | The script content. Supports PlainText and Base64 encrypted content, with a length within 512*1024 bytes. |'."\n" .'| ContentEncoding | string | No | PlainText | PlainText | The text format of the script content. Valid values:* PlainText (default): Plain text, not encoded.
* Base64: Base64 encoding. |'."\n" .'| LineSplitSep | string | No | Empty | | The separator for the script output content. If empty, no splitting is performed, and the entire output is returned as a single data entry. |'."\n" .'| CmdPath | string | No | Empty | /usr/bin/bash | The path to execute the script command. If empty, the default path is used. The default paths are as follows:* bash: /usr/bin/bash
* shell: /usr/bin/sh
* python2: /usr/bin/python2
* python3: /usr/bin/python3 |'."\n" .'| TimeoutMilliSeconds | int | No | 3000 | 3000 | The timeout period for executing the script, in milliseconds. |'."\n" .'| IgnoreError | bool | No | false | false | Specifies whether to ignore Error logs when the plug-in execution fails. The default value is false, which means they are not ignored. |'."\n" .'| Environments | \\[string] | No | | | The environment variables. The default is the value of os.Environ(). If Environments is set, the set environment variables are appended to os.Environ(). |'."\n" .'| IntervalMs | int | No | 5000 | 5000 | The collection trigger frequency or script execution frequency, in milliseconds. |'."\n" ."\n" .'## Native processing plug-ins'."\n" ."\n" .'### Native regular expression parsing plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------------------- | --------- | ------------ | ----------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | processor_parse_regex_native | The type of the plug-in. Set the value to processor_parse_regex_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| Regex | string | Yes | / | (\\d+-\\d+-\\d+)\\s+(.*) | The regular expression. |'."\n" .'| Keys | \\[string] | Yes | / | \\["time", "msg"] | The list of extracted fields. |'."\n" .'| KeepingSourceWhenParseFail | bool | No | false | false | Specifies whether to keep the source field when parsing fails. |'."\n" .'| KeepingSourceWhenParseSucceed | bool | No | false | false | Specifies whether to keep the source field when parsing succeeds. |'."\n" .'| RenamedSourceKey | string | No | Empty | key | The field name to store the source field when it is kept. If not filled, the name is not changed by default. |'."\n" ."\n" .'### Native JSON parsing plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------------------- | -------- | ------------ | ----------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | processor_parse_json_native | The type of the plug-in. Set the value to processor_parse_json_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| KeepingSourceWhenParseFail | bool | No | false | false | Specifies whether to keep the source field when parsing fails. |'."\n" .'| KeepingSourceWhenParseSucceed | bool | No | false | false | Specifies whether to keep the source field when parsing succeeds. |'."\n" .'| RenamedSourceKey | string | No | Empty | key | The field name to store the source field when it is kept. If not filled, the name is not changed by default. |'."\n" ."\n" .'### Native separator parsing plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------------------- | --------- | ------------ | ----------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_parse_delimiter_native | The type of the plug-in. Set the value to processor_parse_delimiter_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| Separator | string | Yes | / | , | The separator. |'."\n" .'| Quote | string | No | " | " | The quote. |'."\n" .'| Keys | \\[string] | Yes | / | \\["time", "msg"] | The list of extracted fields. |'."\n" .'| AllowingShortenedFields | bool | No | true | true | Specifies whether to allow the number of extracted fields to be less than the number of Keys. If not allowed, this scenario is treated as a parsing failure. |'."\n" .'| OverflowedFieldsTreatment | string | No | extend | extend | The behavior when the number of extracted fields is greater than the number of Keys. Valid values:* extend: Keeps the extra fields, and each extra field is added to the log as a separate field. The field name for the extra fields is \\_\\_column$i\\_\\_, where $i represents the extra field sequence number, starting from 0.
* keep: Keeps the extra fields, but adds the extra content as a single field to the log. The field name is \\_\\_column0\\_\\_.
* discard: Discards the extra fields. |'."\n" .'| KeepingSourceWhenParseFail | bool | No | false | false | Specifies whether to keep the source field when parsing fails. |'."\n" .'| KeepingSourceWhenParseSucceed | bool | No | false | false | Specifies whether to keep the source field when parsing succeeds. |'."\n" .'| RenamedSourceKey | string | No | Empty | key | The field name to store the source field when it is kept. If not filled, the name is not changed by default. |'."\n" ."\n" .'### Native Apsara parsing plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------------------- | -------- | ------------ | ----------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | processor_parse_apsara_native | The type of the plug-in. Set the value to processor_parse_apsara_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| Timezone | string | No | Empty | GMT+08:00 | The time zone of the log time. The format is GMT+HH:MM (East) or GMT-HH:MM (West). |'."\n" .'| KeepingSourceWhenParseFail | bool | No | false | false | Specifies whether to keep the source field when parsing fails. |'."\n" .'| KeepingSourceWhenParseSucceed | bool | No | false | false | Specifies whether to keep the source field when parsing succeeds. |'."\n" .'| RenamedSourceKey | string | No | Empty | key | The field name to store the source field when it is kept. If not filled, the name is not changed by default. |'."\n" ."\n" .'### Native time parsing plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------- | -------- | ------------ | ----------------- | -------------------------------- | ---------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_parse_timestamp_native | The type of the plug-in. Set the value to processor_parse_timestamp_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| SourceFormat | string | Yes | / | %Y/%m/%d %H:%M:%S | The format of the log time. For more information, see [Time formats](~~28980~~). |'."\n" .'| SourceTimezone | string | No | Empty | GMT+08:00 | The time zone of the log time. The format is GMT+HH:MM (East) or GMT-HH:MM (West). |'."\n" ."\n" .'### Native filter plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Example** | **Default value** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | processor_filter_regex_native | / | The type of the plug-in. Set the value to processor_filter_regex_native. |'."\n" .'| Include | map | Yes | / | / | The whitelist of log fields, where the key is the field name and the value is a regular expression. This indicates the condition that the content of the field specified by the key must meet for the current event to be collected. The relationship between multiple conditions is "AND". The log is collected only when all conditions are met. |'."\n" ."\n" .'### Native data masking plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------------------- | -------- | ----------------------------------------- | ----------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_desensitize_native | The type of the plug-in. Set the value to processor_desensitize_native. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| Method | string | Yes | / | const | The data masking method. Valid values: const: replaces sensitive content with a constant. md5: replaces sensitive content with its MD5 value. |'."\n" .'| ReplacingString | string | No, required when Method is set to const. | / | \\****** | The constant string used to replace sensitive content. |'."\n" .'| ContentPatternBeforeReplacedString | string | Yes | / | \'password:\' | The prefix regular expression for sensitive content. |'."\n" .'| ReplacedContentPattern | string | Yes | / | \\[^\']* | The regular expression for sensitive content. |'."\n" .'| ReplacingAll | bool | No | true | true | Specifies whether to replace all matched sensitive content. |'."\n" ."\n" .'## Extension processing plug-ins'."\n" ."\n" .'### Extract fields'."\n" ."\n" .'#### Regular expression mode'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------- | --------- | ------------ | ----------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_regex | The type of the plug-in. Set the value to processor_regex. |'."\n" .'| SourceKey | string | Yes | / | content | The name of the source field. |'."\n" .'| Regex | string | Yes | / | (\\d+-\\d+-\\d+)\\s+(.*) | The regular expression. You need to use parentheses `()` to mark the fields to be extracted. |'."\n" .'| Keys | \\[string] | Yes | / | \\["ip", "time", "method"] | Specifies field names for the extracted content, for example, ["ip", "time", "method"]. |'."\n" .'| NoKeyError | boolean | No | false | false | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| NoMatchError | boolean | No | false | false | Specifies whether the system reports an error if the regular expression you specified does not match the value of the source field.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| KeepSource | boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keep.
* false (default): Do not keep. |'."\n" .'| FullMatch | boolean | No | true | true | Specifies whether to extract only when fully matched.* true (default): The field values are extracted only if all fields you set in the Keys parameter can be matched with the value of the source field through the regular expression in the Regex parameter.
* false: Partial matches are also extracted. |'."\n" .'| KeepSourceIfParseError | boolean | true | true | false | Specifies whether to keep the source field in the parsed log if parsing fails.* true: Keep.
* false (default): Do not keep. |'."\n" ."\n" .'#### Anchor mode'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------- | ------------ | ------------ | ----------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_anchor | The type of the plug-in. Set the value to processor_anchor. |'."\n" .'| SourceKey | Anchor array | Yes | / | content | The name of the source field. |'."\n" .'| Anchors | string | Yes | / | | The list of anchor items. |'."\n" .'| Start | String | Yes | Empty | time | The starting keyword. If empty, it matches the beginning of the string. |'."\n" .'| Stop | String | Yes | Empty | \\t | The ending keyword. If empty, it matches the end of the string. |'."\n" .'| FieldName | String | Yes | Empty | time | Specifies a field name for the extracted content. |'."\n" .'| FieldType | String | Yes | Empty | string | The type of the field. Valid values are string or json. |'."\n" .'| ExpondJson | boolean | No | false | false | Specifies whether to perform JSON expansion.* true: Expand.
* false (default): Do not expand. |'."\n" .'| ExpondConnecter | String | No | \\_ | \\_ | The connector for JSON expansion. The default value is an underscore (_). |'."\n" .'| MaxExpondDepth | Int | No | 0 | 0 | The maximum depth for JSON expansion. The default value is 0, which means no limit. |'."\n" .'| NoAnchorError | Boolean | No | false | false | Specifies whether the system reports an error when an anchor item cannot be found.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Report an error.
* false (default): Do not report an error. |'."\n" ."\n" .'#### CSV mode'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------- | ------------ | ------------ | ----------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | processor_csv | The type of the plug-in. Set the value to processor_csv. |'."\n" .'| SourceKey | String | Yes | / | csv | The name of the source field. |'."\n" .'| SplitKeys | String array | Yes | / | \\["date", "ip", "content"] | Specifies field names for the extracted content, for example, ["date", "ip", "content"]. **Important** If the number of fields to be split is less than the number of fields in the SplitKeys parameter, the extra fields in the SplitKeys parameter are ignored. |'."\n" .'| PreserveOthers | Boolean | No | false | false | Specifies whether to keep the excess part if the number of fields to be split is greater than the number of fields in the SplitKeys parameter.* true: Keep.
* false (default): Do not keep. |'."\n" .'| ExpandOthers | Boolean | No | false | false | Specifies whether to parse the excess part.* true: Parse. You can parse the excess part through the ExpandOthers parameter and then specify the naming prefix for the excess fields through the ExpandKeyPrefix parameter. \\*
* false (default): Do not parse. If you set PreserveOthers to true and ExpandOthers to false, the content of the excess part is stored in the \\_decode\\_preserve\\_ field.**Note** If the content of the extra fields contains non-standard content, you need to normalize it according to the CSV format before storing it. |'."\n" .'| ExpandKeyPrefix | String | No | | | The naming prefix for the excess fields. For example, if configured as `expand_`, the field names will be expand_1, expand_2. |'."\n" .'| TrimLeadingSpace | Boolean | No | false | false | Specifies whether to ignore leading spaces in field values.* true: Ignore.
* false (default): Do not ignore. |'."\n" .'| SplitSep | String | No | , | , | The separator. The default value is a comma (,). |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keep.
* false (default): Do not keep. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" ."\n" .'#### Single-character separator mode'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------- | ------------ | ------------ | ----------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_split_char | The type of the plug-in. Set the value to processor_split_char. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| SplitSep | String | Yes | | | The separator. Must be a single character. Can be set to an invisible character, such as \\u0001. |'."\n" .'| SplitKeys | String array | Yes | | \\["ip", "time", "method"] | Specifies field names for the extracted content, for example, ["ip", "time", "method"]. |'."\n" .'| PreserveOthers | Boolean | No | false | false | Specifies whether to keep the excess part if the number of fields to be split is greater than the number of fields in the SplitKeys parameter.* true: Keep.
* false (default): Do not keep. |'."\n" .'| QuoteFlag | Boolean | No | false | false | Specifies whether to use a quote.* true: Use.
* false (default): Do not use. |'."\n" .'| Quote | String | No | / | \\u0001 | The quote. Must be a single character. Can be an invisible character, such as \\u0001. Valid only when QuoteFlag is set to true. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| NoMatchError | Boolean | No | false | false | Specifies whether the system reports an error if the separator you specified does not match the separator in the log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keep.
* false (default): Do not keep. |'."\n" ."\n" .'#### Multi-character separator mode'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| --------------- | ------------ | ------------ | ----------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_split_string | The type of the plug-in. Set the value to processor_split_string. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| SplitSep | String | Yes | | | The separator. Must be a single character. Can be set to an invisible character, such as \\u0001\\u0002. |'."\n" .'| SplitKeys | String array | Yes | | \\["key1","key2"] | Specifies field names for the extracted content, for example, ["key1","key2"].**Note** If the number of fields to be split is less than the number of fields in the SplitKeys parameter, the extra fields in the SplitKeys parameter are ignored. |'."\n" .'| PreserveOthers | Boolean | No | false | false | Specifies whether to keep the excess part if the number of fields to be split is greater than the number of fields in the SplitKeys parameter.* true: Keep.
* false (default): Do not keep. |'."\n" .'| ExpandOthers | Boolean | No | false | false | Specifies whether to use a quote.* true: Use.
* false (default): Do not use. |'."\n" .'| ExpandKeyPrefix | String | No | / | expand_ | The naming prefix for the excess part. For example, if configured as expand_, the field names will be expand_1, expand_2. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| NoMatchError | Boolean | No | false | false | Specifies whether the system reports an error if the separator you specified does not match the separator in the log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keep.
* false (default): Do not keep. |'."\n" ."\n" .'#### Key-value pair mode'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------------- | -------- | ------------ | ----------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_split_key_value | The type of the plug-in. Set the value to processor_split_key_value. |'."\n" .'| SourceKey | string | Yes | | | The name of the source field. |'."\n" .'| Delimiter | string | No | \\t | \\t | The separator between key-value pairs. The default value is a tab character `\\t`. |'."\n" .'| Separator | string | No | : | : | The separator between the key and value in a single key-value pair. The default value is a colon (:). |'."\n" .'| KeepSource | Boolean | No | false | false | Specifies whether to keep the source field in the parsed log.* true: Keep.
* false (default): Do not keep. |'."\n" .'| ErrIfSourceKeyNotFound | Boolean | No | true | false | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true (default): Report an error.
* false: Do not report an error. |'."\n" .'| DiscardWhenSeparatorNotFound | Boolean | No | false | false | Specifies whether to discard the key-value pair if no matching separator is found.* true: Discard.
* false (default): Do not discard. |'."\n" .'| ErrIfSeparatorNotFound | Boolean | No | true | false | Specifies whether the system reports an error when the specified separator does not exist.* true (default): Report an error.
* false: Do not report an error. |'."\n" .'| ErrIfKeyIsEmpty | Boolean | No | true | false | Specifies whether the system reports an error when the key after separation is empty.* true (default): Report an error.
* false: Do not report an error. |'."\n" .'| Quote | String | No | | | The quote. When set, if a value is enclosed in quotes, the value within the quotes is extracted. Multi-character quotes are supported. By default, the quote function is not enabled. **Important** * If the quote is a double quote (""), you need to add an escape character, which is a backslash (\\\\). When a backslash (\\\\) is used with a quote inside the quotes, the backslash (\\\\) is output as part of the value. |'."\n" ."\n" .'#### Grok mode'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------- | ------------ | ------------ | ----------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_grok | The type of the plug-in. Set the value to processor_grok. |'."\n" .'| CustomPatternDir | String array | No | | | The directory where the custom Grok pattern files are located. The processor_grok plug-in reads all files in the directory. If this parameter is not added, no custom Grok pattern files are imported. **Important** After updating a custom Grok pattern file, you need to restart Logtail for it to take effect. |'."\n" .'| CustomPatterns | Map | No | | | The custom GROK pattern, where the key is the rule name and the value is the Grok expression. For default supported expressions, see [processor_grok](https://github.com/alibaba/ilogtail/blob/main/plugins/processor/grok/processor_grok_default_patterns.go). If the expression you need is not in the link, enter a custom Grok expression in Match. If this parameter is not added, no custom GROK patterns are used. |'."\n" .'| SourceKey | String | No | content | content | The name of the source field. The default value is the content field. |'."\n" .'| Match | String array | Yes | | | The array of Grok expressions. The processor_grok plug-in matches the log against the list of expressions configured here from top to bottom and returns the first successfully matched extraction result. **Note** Configuring multiple Grok expressions may affect performance. We recommend no more than 5. |'."\n" .'| TimeoutMilliSeconds | Long | No | | 0 | The maximum attempt time for extracting fields with a Grok expression, in milliseconds. If this parameter is not added or is set to 0, it means there is no timeout. |'."\n" .'| IgnoreParseFailure | Boolean | No | true | true | Specifies whether to ignore logs that fail to be parsed.* true (default): Ignore.
* false: Delete. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field after successful parsing.* true (default): Keep.
* false: Discard. |'."\n" .'| NoKeyError | Boolean | No | false | true | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| NoMatchError | Boolean | No | true | true | Specifies whether the system reports an error when none of the expressions set in the Match parameter match the log.* true (default): Report an error.
* false: Do not report an error. |'."\n" .'| TimeoutError | Boolean | No | true | true | Specifies whether the system reports an error on a match timeout.* true (default): Report an error.
* false: Do not report an error. |'."\n" ."\n" .'### Add fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_add_fields | The type of the plug-in. Set the value to processor_add_fields. |'."\n" .'| Fields | Map | Yes | | | The field names and values to be added. Key-value pair format. Supports adding multiple. |'."\n" .'| IgnoreIfExist | Boolean | No | false | false | Specifies whether to ignore duplicate fields if a field with the same name exists.* true: Ignore.
* false (default): Do not ignore. |'."\n" ."\n" .'### Drop fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | ------------ | ------------ | ----------------- | -------------- | --------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_drop | The type of the plug-in. Set the value to processor_drop. |'."\n" .'| DropKeys | String array | Yes | | | Specifies the fields to be dropped. Multiple can be configured. |'."\n" ."\n" .'### Rename fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | ------------ | ------------ | ----------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | processor_rename | The type of the plug-in. Set the value to processor_rename. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether the system reports an error if the source field you specified is not in the log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| SourceKeys | String array | Yes | | | The source fields to be renamed. |'."\n" .'| DestKeys | String array | Yes | | | The fields after renaming. |'."\n" ."\n" .'### Pack fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------- | ------------ | ------------ | ----------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_packjson | The type of the plug-in. Set the value to processor_packjson. |'."\n" .'| SourceKeys | String array | Yes | | | The source fields to be packed. |'."\n" .'| DestKey | String | No | | | The field after packing. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field in the parsed log.* true (default): Keep.
* false: Discard. |'."\n" .'| AlarmIfIncomplete | Boolean | No | true | true | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true (default): Keep.
* false: Discard. |'."\n" ."\n" .'### Expand JSON fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------- | -------- | ------------ | ----------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_json | The type of the plug-in. Set the value to processor_json. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field to be expanded. |'."\n" .'| NoKeyError | Boolean | No | true | true | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true (default): Report an error.
* false: Do not report an error. |'."\n" .'| ExpandDepth | Int | No | 0 | 1 | The depth of JSON expansion. The default value is 0, which means no limit. 1 indicates the current level, and so on. |'."\n" .'| ExpandConnector | String | No | \\_ | \\_ | The connector for JSON expansion. The default value is an underscore (_). |'."\n" .'| Prefix | String | No | | | The prefix to be added to the field names during JSON expansion. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field in the parsed log.* true (default): Keep.
* false: Discard. |'."\n" .'| UseSourceKeyAsPrefix | Boolean | No | | | Specifies whether to use the source field name as a prefix for all expanded JSON field names. |'."\n" .'| KeepSourceIfParseError | Boolean | No | true | true | Specifies whether to keep the source log if parsing fails.* true (default): Keep.
* false: Discard. |'."\n" .'| ExpandArray | Boolean | No | false | false | Specifies whether to expand array types. This parameter is supported by Logtail 1.8.0 and later.* false (default): Do not expand.
* true: Expand. For example, `{"k":["1","2"]}` is expanded to `{"k[0]":"1","k[1]":"2"}`. |'."\n" ."\n" .'### Filter logs'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | ----------- | ------------ | ----------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_filter_regex | The type of the plug-in. Set the value to processor_filter_regex. |'."\n" .'| Include | JSON Object | No | | | The Key is the log field, and the Value is the regular expression that the field value must match. The relationship between key-value pairs is AND. If the value of a log field matches the corresponding regular expression, the log is collected. |'."\n" .'| Exclude | JSON Object | No | | | The Key is the log field, and the Value is the regular expression that the field value must match. The relationship between key-value pairs is OR. If the value of any field in the log matches the corresponding regular expression, the log is discarded. |'."\n" ."\n" .'### Extract log time'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| -------------- | -------- | ------------ | ----------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_gotime | The type of the plug-in. Set the value to processor_gotime. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| SourceFormat | String | Yes | | | The format of the source time. |'."\n" .'| SourceLocation | Int | Yes | | | The time zone of the source time. If the parameter value is empty, it indicates the time zone of the host or container where Logtail is located. |'."\n" .'| DestKey | String | Yes | | | The destination field after parsing. |'."\n" .'| DestFormat | String | Yes | | | The time format after parsing. |'."\n" .'| DestLocation | Int | No | | | The time zone after parsing. If the parameter value is empty, it indicates the local time zone. |'."\n" .'| SetTime | Boolean | No | true | true | Specifies whether to set the parsed time as the log time.* true (default): Yes.
* false: No. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field in the parsed log.* true (default): Keep.
* false: Do not keep. |'."\n" .'| NoKeyError | Boolean | No | true | true | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true (default): Report an error.
* false: Do not report an error. |'."\n" .'| AlarmIfFail | Boolean | No | true | true | Specifies whether the system reports an error if it fails to extract the log time.* true (default): Report an error.
* false: Do not report an error. |'."\n" ."\n" .'### Convert IP addresses'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_geoip | The type of the plug-in. Set the value to processor_geoip. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field to be converted for the IP address. |'."\n" .'| DBPath | String | Yes | | /user/data/GeoLite2-City_20180102/GeoLite2-City.mmdb | The full path of the GeoIP database. For example, /user/data/GeoLite2-City_20180102/GeoLite2-City.mmdb. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether the system reports an error if the source field name you specified is not in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" .'| NoMatchError | Boolean | No | true | true | Specifies whether the system reports an error if the IP address is invalid or not found in the database.* true (default): Report an error.
* false: Do not report an error. |'."\n" .'| KeepSource | Boolean | No | true | true | Specifies whether to keep the source field in the parsed log.* true (default): Keep.
* false: Do not keep. |'."\n" .'| Language | String | No | zh-CN | zh-CN | The language attribute. The default value is zh-CN. **Important** Make sure your GeoIP database contains the corresponding language. |'."\n" ."\n" .'### Data masking'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ----------------- | -------- | ------------ | ----------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_desensitize | The type of the plug-in. Set the value to processor_desensitize. |'."\n" .'| **SourceKey** | String | Yes | | | The name of the log field. |'."\n" .'| **Method** | String | Yes | | const | The data masking method. Valid values:* **const**: Replaces sensitive content with a string. You can specify the target string with the **ReplaceString** parameter.
* **md5**: Replaces sensitive content with its corresponding MD5 value. |'."\n" .'| **Match** | String | No | full | full | Specifies the method for extracting sensitive content. Valid values:* **full (default)**: Extracts all, which means replacing all content in the target field value.
* **regex**: Uses a regular expression to extract sensitive content. |'."\n" .'| **ReplaceString** | String | No | | | The string used to replace sensitive content. Required when **Method** is set to **const**. |'."\n" .'| **RegexBegin** | String | No | | | The regular expression to match the prefix of sensitive content. Required when **Match** is set to **regex**. |'."\n" .'| **RegexContent** | String | No | | | The regular expression to match sensitive content. Required when **Match** is set to **regex**. |'."\n" ."\n" .'### Map field values'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_dict_map | The type of the plug-in. Set the value to processor_dict_map. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| MapDict | Map | No | | | The mapping dictionary. If the mapping dictionary is small, you can set it directly with this parameter. You do not need to provide a local CSV dictionary file. **Important** When you set the DictFilePath parameter, the configuration in the MapDict parameter does not take effect. |'."\n" .'| DictFilePath | String | No | | | A dictionary file in CSV format. The separator for this CSV file is a comma (,), and field references are indicated by double quotes ("). |'."\n" .'| DestKey | String | No | | | The name of the field after mapping. |'."\n" .'| HandleMissing | Boolean | No | false | false | Specifies whether the system processes the target field if it is missing from the raw log.* true: Process. The system fills it with the value from the Missing parameter.
* false (default): Do not process. |'."\n" .'| Missing | String | No | Unknown | Unknown | When processing a missing target field in the raw log, sets the corresponding fill value. The default value is `Unknown`. This parameter takes effect when HandleMissing is configured as true. |'."\n" .'| MaxDictSize | Int | No | 1000 | 1000 | The maximum size of the mapping dictionary. The default value is 1000, which means up to 1000 mapping rules can be stored. To limit the plug-in\'s memory usage on the server, you can reduce this value. |'."\n" .'| Mode | String | No | overwrite | overwrite | The processing method when the mapped field already exists in the raw log.* overwrite (default): Overwrites the original field.
* fill: Does not overwrite the original field. |'."\n" ."\n" .'### Encrypt fields'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------- | ------------ | ------------ | -------------------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_encrypt | The type of the plug-in. Set the value to processor_encrypt. |'."\n" .'| SourceKey | String array | Yes | | | The name of the source field. |'."\n" .'| EncryptionParameters | Object | Yes | | | The key-related configuration. |'."\n" .'| Key | String | Yes | | | Sets the key. Must be 64 hexadecimal characters. |'."\n" .'| IV | String | No | 00000000000000000000000000000000 | | Sets the initial vector for encryption. Must be 32 hexadecimal characters. The default value is `00000000000000000000000000000000`. |'."\n" .'| KeyFilePath | Boolean | No | | | The file path to read the encryption parameters from. If not configured, it reads from **Logtail Configuration - Input Configuration - File Path**. |'."\n" .'| KeepSourceValueIfError | String | No | false | false | Specifies whether the system keeps the value of the source field if encryption fails.* true: Keep.
* false (default): Do not keep.If encryption fails, the field value is replaced with `ENCRYPT_ERROR`. |'."\n" ."\n" .'### Replace strings'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_string_replace | The type of the plug-in. Set the value to processor_string_replace. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| Method | String | Yes | | | Specifies the matching method. Valid values:* `const`: Replaces with a string.
* `regex`: Replaces using a regular expression.
* `unquote`: Removes escape characters. |'."\n" .'| Match | String | No | | | Enter the content to match.* When `Method` is set to `const`, enter the string that matches the content to be replaced. If multiple strings match, all are replaced.
* When `Method` is set to `regex`, enter the regular expression that matches the content to be replaced. If multiple strings match, all are replaced. You can also use regex grouping to match a specific group.
* When `Method` is set to `unquote`, you do not need to configure this parameter. |'."\n" .'| ReplaceString | String | No | | | The string for replacement. The default value is "".* When `Method` is set to `const`, enter the string to replace the original content.
* When `Method` is set to `regex`, enter the string to replace the original content. Supports replacement based on regex groups.
* When `Method` is set to `unquote`, you do not need to configure this parameter. |'."\n" .'| DestKey | String | No | | | Specifies a new field for the replaced content. By default, no new field is added. |'."\n" ."\n" .'### Encode and decode data'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_base64_encoding | The type of the plug-in. Set the value to processor_base64_encoding. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| NewKey | String | Yes | | | The name of the result field after encoding. |'."\n" .'| NoKeyError | Boolean | No | false | false | Specifies whether the system reports an error if the source field you specified is not in the raw log.* true: Report an error.
* false (default): Do not report an error. |'."\n" ."\n" .'### Convert logs to metrics'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------------ | --------- | ------------ | ----------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_log_to_sls_metric | The type of the plug-in. Set the value to processor_log_to_sls_metric. |'."\n" .'| MetricTimeKey | String | No | | | Specifies the time field in the log, which maps to the `__time_nano__` field in the time series data. By default, the value of the `__time__` field in the log is extracted. Ensure that the specified field is a valid, properly formatted timestamp. Currently supports Unix timestamps in seconds (10 digits), milliseconds (13 digits), microseconds (16 digits), and nanoseconds (19 digits). |'."\n" .'| MetricLabelKeys | \\[]String | Yes | | | Specifies the Key list for the `__labels__` field. The Key must follow the regular expression `^[a-zA-Z_][a-zA-Z0-9_]*$`. The Value cannot contain a vertical line (|) or `#$#`. For more information, see [Time series data (Metric)](~~171773~~). Adding the `__labels__` field in the MetricLabelKeys parameter is not supported. If the source field contains a `__labels__ `field, its value is appended to the new `__labels__` field. |'."\n" .'| MetricValues | Map | Yes | | | Used to specify the Metric name and Metric value. The Metric name corresponds to the `__name__` field and must follow the regular expression `^[a-zA-Z_:][a-zA-Z0-9_:]*$`. The Metric value corresponds to the `__value__` field and must be of Double type. For more information, see [Time series data (Metric)](~~171773~~) . |'."\n" .'| CustomMetricLabels | Map | No | | | The custom `__labels__` field. The Key must follow the regular expression `^[a-zA-Z_][a-zA-Z0-9_]*$`, and the Value cannot contain a vertical line (|) or `#$#`. For more information, see [Time series data (Metric)](~~171773~~). |'."\n" .'| IgnoreError | Boolean | No | | | Specifies whether to output an Error log when there are no matching logs. The default value is false, which means no output. |'."\n" ."\n" .'### Convert logs to traces'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ---------------------- | -------- | ------------ | ----------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Type | string | Yes | / | processor_otel_trace | The type of the plug-in. Set the value to processor_otel_trace. |'."\n" .'| SourceKey | String | Yes | | | The name of the source field. |'."\n" .'| Format | String | Yes | | json | The format after conversion. Valid values: protobuf, json, protojson. |'."\n" .'| NoKeyError | Boolean | No | false | true | Specifies whether to report an error when the corresponding source field is not in the log. The default value is false. |'."\n" .'| TraceIDNeedDecode | Boolean | No | | | Specifies whether to perform Base64 decoding on the TraceID. The default value is false. When Format is set to protojson, if the TraceID has been Base64 encoded, you need to set TraceIDNeedDecode to true. Otherwise, the conversion will fail. |'."\n" .'| SpanIDNeedDecode | Boolean | No | | | Specifies whether to perform Base64 decoding on the SpanID. The default value is false. When Format is set to protojson, if the SpanID has been Base64 encoded, you need to set SpanIDNeedDecode to true. Otherwise, the conversion will fail. |'."\n" .'| ParentSpanIDNeedDecode | Boolean | No | | | Specifies whether to perform Base64 decoding on the ParentSpanID. The default value is false. When Format is set to protojson, if the ParentSpanID has been Base64 encoded, you need to set ParentSpanIDNeedDecode to true. Otherwise, the conversion will fail. |'."\n" ."\n" .'## Output plug-ins'."\n" ."\n" .'### SLS output plug-in'."\n" ."\n" .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" .'| ------------- | -------- | ------------ | ----------------- | ------------- | ------------------------------------------------------ |'."\n" .'| Type | string | Yes | / | flusher_sls | The type of the plug-in. Set the value to flusher_sls. |'."\n" .'| Logstore | stirng | Yes | / | test-logstore | The name of the Logstore. |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateMachineGroup' => [ 'summary' => 'Modifies the configuration of a machine group.', 'path' => '/machinegroups/{groupName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'groupName', 'in' => 'path', 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-group', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'groupName' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group', 'title' => ''], 'machineIdentifyType' => ['description' => 'The identifier type of the machine group. Valid values:'."\n" ."\n" .'- ip: The machine group uses IP addresses as identifiers.'."\n" ."\n" .'- userdefined: The machine group uses custom identifiers.', 'type' => 'string', 'required' => true, 'example' => 'userdefined', 'default' => 'ip', 'title' => ''], 'groupType' => ['description' => 'The type of the machine group. Set the value to an empty string.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '""'], 'groupAttribute' => [ 'title' => '', 'description' => 'The attribute of the machine group. This parameter is empty by default.', 'type' => 'object', 'properties' => [ 'groupTopic' => ['description' => 'The topic of the machine group. This parameter is empty by default.', 'type' => 'string', 'required' => false, 'example' => 'testtopic2', 'title' => ''], 'externalName' => ['description' => 'The identifier of the external management system on which the machine group depends. This parameter is empty by default.', 'type' => 'string', 'required' => false, 'example' => 'testgroup2', 'title' => ''], ], 'required' => false, 'example' => '', ], 'machineList' => [ 'title' => '', 'description' => 'The identifiers of the machines in the machine group.'."\n" ."\n" .'- If you set machineIdentifyType to ip, enter the IP addresses of the machines.'."\n" ."\n" .'- If you set machineIdentifyType to userdefined, enter a custom identifier.', 'type' => 'array', 'items' => ['description' => 'The identifier of the machine. Set the value to an IP address or a custom identifier.', 'type' => 'string', 'example' => '192.168.xx.xx', 'title' => '', 'required' => false], 'required' => true, 'example' => '[uu_id_1，uu_id_2]', ], ], 'required' => true, 'example' => 'ali-test-project', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateMachineGroup', 'description' => 'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | InvalidParameter| invalid group resource json | Project不存在。 |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" .'| 404 | MachineGroupNotExist | MachineGroup groupName does not exist. | 无效机器组参数。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], ], ], 'UpdateMachineGroupMachine' => [ 'summary' => 'Modifies the machines in a machine group. You can add machine to or remove machines from the machine group.', 'path' => '/machinegroups/{machineGroup}/machines', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-group', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The machines to be added or removed.', 'type' => 'array', 'items' => ['description' => 'The machine ID. The value can be an IP address or a custom ID.', 'type' => 'string', 'example' => '192.168.xx.x', 'title' => '', 'required' => false], 'required' => true, 'example' => '', ], ], [ 'name' => 'action', 'in' => 'query', 'schema' => [ 'description' => 'The operation on the machine. Valid values: add and delete. A value of add specifies to add the machine to the machine group. A value of delete specifies to remove the machine from the machine group.', 'type' => 'string', 'required' => false, 'example' => 'add', 'default' => 'add', 'enum' => ['add', 'delete'], 'title' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateMachineGroupMachine', 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateMachineGroupMachine', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateMaterializedView' => [ 'summary' => 'Updates a materialized view.', 'path' => '/materializedviews/{name}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'abilityTreeCode' => '294422', 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project that contains the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the materialized view to update.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'originalSql' => ['description' => 'The new SQL query for the materialized view. Updating the query rebuilds the view.', 'type' => 'string', 'title' => '', 'example' => ''], 'aggIntervalMins' => ['description' => 'The refresh interval of the materialized view, in minutes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'ttl' => ['description' => 'The data retention period (TTL) of the materialized view, in days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], 'enable' => ['description' => 'Specifies whether to automatically refresh the materialized view.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], 'description' => 'The request body.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateMaterializedView', ], 'UpdateMaxComputeExport' => [ 'summary' => 'Updates a MaxCompute data shipping job.', 'path' => '/maxcomputeexports/{mcExportName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '203412', 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'mcExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the MaxCompute data shipping job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The body parameters.', 'type' => 'object', 'properties' => [ 'displayName' => ['description' => 'The display name of the MaxCompute data shipping job.', 'type' => 'string', 'required' => true, 'example' => 'my-mc-job', 'title' => ''], 'description' => ['description' => 'The description of the MaxCompute data shipping job.', 'type' => 'string', 'example' => 'Update MaxCompute delivery task', 'required' => false, 'title' => ''], 'configuration' => ['description' => 'The setting of the MaxCompute data shipping job.', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateMaxComputeExport', 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'UpdateMetricStore' => [ 'summary' => 'Updates the configuration of an existing Metricstore. A Metricstore is used to store metrics.', 'path' => '/metricstores/{name}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225678', 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'ttl' => ['description' => 'The data retention period. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => '', 'required' => false], 'autoSplit' => ['description' => 'Specifies whether to enable automatic sharding.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'true'], 'maxSplitShard' => ['description' => 'The maximum number of shards for automatic sharding. This parameter is valid only when autoSplit is set to true.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => '', 'required' => false], 'mode' => ['description' => 'The type of the Metricstore.', 'type' => 'string', 'default' => 'standard', 'title' => '', 'required' => false, 'example' => 'standard'], 'hot_ttl' => ['description' => 'The retention period of data in the hot storage layer. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => ''], 'infrequentAccessTTL' => ['description' => 'The retention period for the IA storage class. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => ''], 'appendMeta' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], 'shardingPolicy' => ['$ref' => '#/components/schemas/ShardingPolicy', 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => 'The specified metricstore xxx does not exist.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateMetricStore', 'description' => 'A [Metricstore](~~171723~~) is used to store [metrics](~~174965~~).'."\n" ."\n" .'- The Metricstore that you want to update must already exist.'."\n" ."\n" .'- The Host in the request syntax consists of a project name and a Simple Log Service endpoint. You must specify a project in the Host.'."\n" ."\n" .'- You must have an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has full permissions for all API operations, which poses a security risk. We recommend that you use a RAM user to call API operations or perform routine operations and maintenance (O\\&M). The RAM user must be granted only the permissions required to access Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" .'- You must know the name and region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'- You can create a maximum of 200 Logstores or Metricstores in a project.'."\n" ."\n" .'- Metrics are deleted after their retention period expires.', 'changeSet' => [ ['createdAt' => '2025-12-03T01:37:06.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-12-02T11:55:05.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-11-24T09:35:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateMetricStoreMeteringMode' => [ 'summary' => 'Updates the billing mode of a specified Metricstore.', 'path' => '/metricstores/{metricStore}/meteringmode', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '213244', 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'projectName', 'title' => ''], ], [ 'name' => 'metricStore', 'in' => 'path', 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'example' => 'metricStoreName', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'meteringMode' => [ 'description' => 'The billing mode to which you want to switch. Valid values: ChargeByFunction and ChargeByDataIngest. ChargeByFunction specifies the [pay-by-feature](~~48220~~) mode. ChargeByDataIngest specifies the [pay-by-ingested-data](~~2365756~~) mode.', 'type' => 'string', 'required' => true, 'example' => 'ChargeByFunction', 'default' => 'ChargeByFunction', 'enum' => ['ChargeByDataIngest', 'ChargeByFunction'], 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateMetricStoreMeteringMode', 'description' => 'A Metricstore supports two billing modes: [Pay-by-feature](~~48220~~) and [Pay-by-ingested-data](~~2365756~~).'."\n" ."\n" .'- Specify an existing Metricstore.'."\n" ."\n" .'- The Host in the request syntax consists of a project name and a Simple Log Service endpoint. You must specify the project in the Host.'."\n" ."\n" .'- Obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair that belongs to an Alibaba Cloud account has permissions for all API operations, which poses a high security threat. We recommend that you use a RAM user to call API operations or perform routine operations and maintenance (O\\&M). The RAM user must be granted the required permissions to manage Simple Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" ."\n" .'- Obtain the name and region of the project. For more information, see [Manage projects](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'UpdateMetricStoreProcessor' => [ 'summary' => 'Updates the ingest processor that is associated with a Metricstore.', 'path' => '/metricstores/{metricstore}/processor', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '240240', 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'metricstore', 'in' => 'path', 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-metricstore'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'processorName' => ['description' => 'The identifier of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'filter-metrics'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateMetricStoreProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], 'UpdateOSSExport' => [ 'summary' => 'Updates an Object Storage Service (OSS) data shipping job.', 'path' => '/ossexports/{ossExportName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '203473', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configurations of the job.', 'type' => 'object', 'properties' => [ 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => false, 'example' => 'my-oss-job'."\n", 'title' => ''], 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Update OSS delivery task', 'required' => false, 'title' => ''], 'configuration' => ['description' => 'The configuration details of the job.', '$ref' => '#/components/schemas/OSSExportConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'UpdateOSSHDFSExport' => [ 'summary' => 'Updates an OSS-HDFS data shipping job.', 'path' => '/osshdfsexports/{ossExportName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '203477', 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configurations of the job.', 'type' => 'object', 'properties' => [ 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'my-oss-hdfs-job'."\n", 'title' => ''], 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Update OSS-HDFS delivery task', 'required' => false, 'title' => ''], 'configuration' => ['description' => 'The configuration details of the job.', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateOSSHDFSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'UpdateOSSIngestion' => [ 'summary' => 'Updates the specified OSS import task.', 'path' => '/ossingestions/{ossIngestionName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '203139', 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'ossIngestionName', 'in' => 'path', 'schema' => ['description' => 'The name of the OSS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123455', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'description' => ['description' => 'The description of the OSS import task.', 'type' => 'string', 'example' => 'OSS import', 'required' => false, 'title' => ''], 'displayName' => ['description' => 'The display name of the OSS import task.', 'type' => 'string', 'example' => 'OSS import', 'required' => true, 'title' => ''], 'schedule' => ['description' => 'The schedule of the task. This parameter is optional. To run the task at a fixed time, such as 08:00 every Monday, use a cron expression.', '$ref' => '#/components/schemas/Schedule', 'required' => false, 'title' => '', 'example' => ''], 'configuration' => ['description' => 'The configuration of the OSS import task.', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateOSSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'manual', ], 'UpdateProject' => [ 'summary' => 'Updates project information.', 'path' => '/', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '8870', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'description' => ['title' => 'Project description', 'description' => 'The description of the project. The default value is an empty string.', 'type' => 'string', 'required' => true, 'example' => 'Description of my-project-test'], 'recycleBinEnabled' => [ 'description' => 'Specifies whether to enable the recycle bin.', 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-project-test'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Length' => [ 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Access-Control-Allow-Origin' => [ 'schema' => ['type' => 'string', 'example' => '*'], ], 'Date' => [ 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateProject', 'description' => '### Usage notes'."\n" ."\n" .'- The Host parameter consists of a project name and a Simple Log Service endpoint. You must specify a project in the Host parameter.'."\n" ."\n" .'- Make sure that you have an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'An AccessKey pair for an Alibaba Cloud account has permissions on all API operations, which poses a high security risk. For security, we recommend that you create and use a Resource Access Management (RAM) user to make API calls or perform routine O\\&M. The RAM user must have permissions to operate on Simple Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" ."\n" .'### Authorization resources'."\n" ."\n" .'The following table describes the authorization information for this operation. Add this information to the Action element of a RAM policy statement to grant a RAM user or RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| ------------------- | --------------------------------------------------------- |'."\n" .'| `log:UpdateProject` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', 'requestParamsDescription' => 'Sample request'."\n" ."\n" .'PUT / HTTP/1.1 Host:ali-project-test.cn-hangzhou.log.aliyuncs.com Content-Type: application/json'."\n" ."\n" .'{ "description" : "Description of my-project-test", "recycleBinEnabled": true }', 'responseParamsDescription' => 'Sample response'."\n" ."\n" .'HTTP/1.1 200 OK', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist| The Project does not exist : projectName | Project不存在。 |'."\n" .'| 404 | ParameterInvalid| The body is not valid json string. | 无效的参数。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], 'UpdateSavedSearch' => [ 'summary' => 'Updates a saved search.', 'path' => '/savedsearches/{savedsearchName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'savedsearchName', 'in' => 'path', 'schema' => ['description' => 'The name of the saved search that you want to update.', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'savedsearchName' => ['description' => 'The name of the saved search. The name must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name', 'title' => ''], 'searchQuery' => ['description' => 'The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the Search statement|Analytic statement format. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).', 'type' => 'string', 'required' => true, 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time', 'title' => ''], 'logstore' => ['description' => 'The name of the Logstore to which the saved search belongs.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore', 'title' => ''], 'topic' => ['description' => 'The topic of the logs.', 'type' => 'string', 'required' => false, 'example' => 'theme', 'title' => ''], 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'displayname', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateSavedSearch', 'description' => '### Usage notes'."\n" ."\n" .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" .'- Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :---------------------- | :--------------------------------------------------------------------------------------- |'."\n" .'| `log:UpdateSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], ], ], 'UpdateScheduledSQL' => [ 'summary' => 'Updates the specified scheduled SQL task.', 'path' => '/scheduledsqls/{scheduledSQLName}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '209793', 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', 'schema' => ['description' => 'The unique name of an existing task.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configuration of the scheduled SQL task.', 'type' => 'object', 'properties' => [ 'displayName' => ['description' => 'The display name of the task.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-scheduled-sql', 'title' => ''], 'description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'Update scheduled SQL task', 'required' => false, 'title' => ''], 'schedule' => ['description' => 'The scheduling configuration of the task.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], 'configuration' => ['description' => 'The configuration of the task.', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateScheduledSQL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'manual', ], 'UpdateSqlInstance' => [ 'summary' => 'When you use Standard SQL to analyze large amounts of data, a single query may not scan all logs within a specific time range, which can result in incomplete data. Although adding shards improves read and write performance, this improvement applies only to new data. To analyze more data in a single query, enable Dedicated SQL and add more compute resources.', 'path' => '/sqlinstance', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '212425', 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project in which to enable Dedicated SQL.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ 'cu' => ['description' => 'The number of Compute Units (CUs). A CU is a compute core that can be used for parallel processing when Dedicated SQL is running.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '2'], 'useAsDefault' => ['description' => 'Specifies whether to enable Dedicated SQL for the project by default. If this parameter is set to true, all query and analysis operations in the project, such as alerts and dashboards, use Dedicated SQL.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateSqlInstance', 'description' => '**Before you call this operation, make sure that you understand the billing methods and [pricing](~~223777~~) for Dedicated SQL.**', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateSqlInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], 'UpdateStoreView' => [ 'summary' => 'Updates the configurations of a dataset.', 'path' => '/storeviews/{name}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '208677', 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The configurations of the dataset.', 'type' => 'object', 'properties' => [ 'storeType' => [ 'description' => 'The type of the dataset.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- metricstore'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .'- logstore'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' ', 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'type' => 'string', 'required' => true, 'example' => 'logstore', 'title' => '', ], 'stores' => [ 'description' => 'The Logstores or Metricstores.', 'type' => 'array', 'items' => ['description' => 'The Logstore or Metricstore.', 'required' => true, '$ref' => '#/components/schemas/StoreViewStore', 'title' => '', 'example' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateStoreView', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateStoreView', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpsertCollectionPolicy' => [ 'summary' => 'Creates a log collection policy for a cloud service. This way, logs can be automatically collected from the service.', 'path' => '/collectionpolicy', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192469', 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The body of the request.', 'type' => 'object', 'properties' => [ 'policyName' => ['description' => 'The name must meet the following requirements:'."\n" ."\n" .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" ."\n" .'- The name must start with a letter.'."\n" ."\n" .'- The name must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 63, 'minLength' => 3, 'example' => 'your_log_policy', 'title' => ''], 'productCode' => ['description' => 'The code of the service.', 'type' => 'string', 'required' => true, 'example' => 'oss', 'title' => ''], 'dataCode' => ['description' => 'The code of the log type.', 'type' => 'string', 'required' => true, 'example' => 'access_log', 'title' => ''], 'enabled' => ['description' => 'Specifies whether to enable the policy.', 'type' => 'boolean', 'required' => true, 'default' => 'false', 'example' => 'true', 'title' => ''], 'policyConfig' => [ 'description' => 'The configurations of the policy.', 'type' => 'object', 'properties' => [ 'resourceMode' => [ 'description' => 'The resource collection mode. Valid values: all, attributeMode, and instanceMode. The value all specifies that logs of all instances within your account are collected to the default logstore. The value attributeMode specifies that logs are collected based on the regions of instances and resource tags. The value instanceMode specifies that logs are collected based on instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'all', 'default' => 'all', 'enum' => ['all', 'instanceMode', 'attributeMode'], 'title' => '', ], 'resourceTags' => ['description' => 'The resource tags. This parameter takes effect only when resourceMode is set to attributeMode. If you leave this parameter empty, resource tag-based filtering is not performed. The system considers that all instances are matched. If you specify a value for this parameter, logs of instances that use the specified resource tags are collected. Logs are collected from an instance only if the resource tags and region of the instance match the specified conditions.', 'type' => 'object', 'required' => false, 'example' => '{"tag1":"value1",“tag2":"value2"}', 'title' => ''], 'regions' => [ 'description' => 'The regions of the instances. This parameter takes effect only when resourceMode is set to attributeMode. Wildcard characters are supported. If you leave this parameter empty, region-based filtering is not performed. The system considers that all instances are matched. If you specify a value for this parameter, logs of instances that reside in the specified regions are collected. Logs are collected from an instance only if the resource tags and region of the instance match the specified conditions.', 'type' => 'array', 'items' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'instanceIds' => [ 'description' => 'The IDs of the instances. This parameter takes effect only when resourceMode is set to instanceMode. Logs are collected only from instances that use the specified IDs.', 'type' => 'array', 'items' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'your-test-bucket1', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], 'centralizeEnabled' => ['description' => 'Specifies whether to enable centralized storage. Default value: false.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], 'centralizeConfig' => [ 'description' => 'The configurations of centralized storage.', 'type' => 'object', 'properties' => [ 'destRegion' => ['description' => 'The destination region for centralized storage.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], 'destProject' => ['description' => 'The destination project for centralized storage. Make sure that the region of the destination project is consistent with the region specified by destRegion.', 'type' => 'string', 'required' => false, 'example' => 'your-sls-project-in-beijing', 'title' => ''], 'destLogstore' => ['description' => 'The destination logstore for centralized storage. Make sure that the region of the destination logstore is consistent with the region specified by destRegion and the destination logstore belongs to the destination project specified by destProject.', 'type' => 'string', 'required' => false, 'example' => 'your-sls-logstore-in-beijing', 'title' => ''], 'destTTL' => ['description' => 'The data retention period for centralized storage. Unit: days. This parameter takes effect only when you use an existing logstore for centralized storage.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'your-sls-logstore-ttl', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'dataConfig' => [ 'description' => 'The data configurations. The configuration is returned only for global logs. For example, if productCode is set to sls, the configuration is returned.', 'type' => 'object', 'properties' => [ 'dataRegion' => ['description' => 'The region for storing the global logs that are collected for the first time.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'resourceDirectory' => [ 'description' => 'The configurations of the resource directory. The account must have activated the resource directory and be a management account or a delegated administrator of the resource directory.', 'type' => 'object', 'properties' => [ 'accountGroupType' => ['description' => 'The mode of the resource directory. Valid values: all and custom.', 'type' => 'string', 'required' => false, 'example' => 'all,custom', 'title' => ''], 'members' => [ 'description' => 'The members. If accountGroupType is set to custom, the members are returned.', 'type' => 'array', 'items' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => '165***********50', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpsertCollectionPolicy', 'description' => 'You must use the Simple Log Service endpoint for the China (Shanghai) or Singapore region to call the operation.', 'responseParamsDescription' => 'For more information about error codes, see [Manage collection rules in the new version of Log Audit Service](~~2835059~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], ], 'endpoints' => [ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-qingdao.log.aliyuncs.com', 'endpoint' => 'cn-qingdao.log.aliyuncs.com', 'vpc' => 'cn-qingdao-internal.log.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-beijing.log.aliyuncs.com', 'endpoint' => 'cn-beijing.log.aliyuncs.com', 'vpc' => 'cn-beijing-internal.log.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-zhangjiakou.log.aliyuncs.com', 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com', 'vpc' => 'cn-zhangjiakou-internal.log.aliyuncs.com'], ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-huhehaote.log.aliyuncs.com', 'endpoint' => 'cn-huhehaote.log.aliyuncs.com', 'vpc' => 'cn-huhehaote-internal.log.aliyuncs.com'], ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-wulanchabu.log.aliyuncs.com', 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com', 'vpc' => 'cn-wulanchabu-internal.log.aliyuncs.com'], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hangzhou.log.aliyuncs.com', 'endpoint' => 'cn-hangzhou.log.aliyuncs.com', 'vpc' => 'cn-hangzhou-internal.log.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shanghai.log.aliyuncs.com', 'endpoint' => 'cn-shanghai.log.aliyuncs.com', 'vpc' => 'cn-shanghai-internal.log.aliyuncs.com'], ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-nanjing.log.aliyuncs.com', 'endpoint' => 'cn-nanjing.log.aliyuncs.com', 'vpc' => 'cn-nanjing-internal.log.aliyuncs.com'], ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-fuzhou.log.aliyuncs.com', 'endpoint' => 'cn-fuzhou.log.aliyuncs.com', 'vpc' => 'cn-fuzhou-internal.log.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shenzhen.log.aliyuncs.com', 'endpoint' => 'cn-shenzhen.log.aliyuncs.com', 'vpc' => 'cn-shenzhen-internal.log.aliyuncs.com'], ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-heyuan.log.aliyuncs.com', 'endpoint' => 'cn-heyuan.log.aliyuncs.com', 'vpc' => 'cn-heyuan-internal.log.aliyuncs.com'], ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-guangzhou.log.aliyuncs.com', 'endpoint' => 'cn-guangzhou.log.aliyuncs.com', 'vpc' => 'cn-guangzhou-internal.log.aliyuncs.com'], ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-chengdu.log.aliyuncs.com', 'endpoint' => 'cn-chengdu.log.aliyuncs.com', 'vpc' => 'cn-chengdu-internal.log.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hongkong.log.aliyuncs.com', 'endpoint' => 'cn-hongkong.log.aliyuncs.com', 'vpc' => 'cn-hongkong-internal.log.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-northeast-1.log.aliyuncs.com', 'endpoint' => 'ap-northeast-1.log.aliyuncs.com', 'vpc' => 'ap-northeast-1-internal.log.aliyuncs.com'], ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-northeast-2.log.aliyuncs.com', 'endpoint' => 'ap-northeast-2.log.aliyuncs.com', 'vpc' => 'ap-northeast-2-internal.log.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-1.log.aliyuncs.com', 'endpoint' => 'ap-southeast-1.log.aliyuncs.com', 'vpc' => 'ap-southeast-1-internal.log.aliyuncs.com'], ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-2.log.aliyuncs.com', 'endpoint' => 'ap-southeast-2.log.aliyuncs.com', 'vpc' => 'ap-southeast-2-internal.log.aliyuncs.com'], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-3.log.aliyuncs.com', 'endpoint' => 'ap-southeast-3.log.aliyuncs.com', 'vpc' => 'ap-southeast-3-internal.log.aliyuncs.com'], ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-5.log.aliyuncs.com', 'endpoint' => 'ap-southeast-5.log.aliyuncs.com', 'vpc' => 'ap-southeast-5-internal.log.aliyuncs.com'], ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-6.log.aliyuncs.com', 'endpoint' => 'ap-southeast-6.log.aliyuncs.com', 'vpc' => 'ap-southeast-6-internal.log.aliyuncs.com'], ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-7.log.aliyuncs.com', 'endpoint' => 'ap-southeast-7.log.aliyuncs.com', 'vpc' => 'ap-southeast-7-internal.log.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-east-1.log.aliyuncs.com', 'endpoint' => 'us-east-1.log.aliyuncs.com', 'vpc' => 'us-east-1-internal.log.aliyuncs.com'], ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-west-1.log.aliyuncs.com', 'endpoint' => 'us-west-1.log.aliyuncs.com', 'vpc' => 'us-west-1-internal.log.aliyuncs.com'], ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'eu-west-1.log.aliyuncs.com', 'endpoint' => 'eu-west-1.log.aliyuncs.com', 'vpc' => 'eu-west-1-internal.log.aliyuncs.com'], ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'eu-central-1.log.aliyuncs.com', 'endpoint' => 'eu-central-1.log.aliyuncs.com', 'vpc' => 'eu-central-1-internal.log.aliyuncs.com'], ['regionId' => 'us-southeast-1', 'regionName' => 'US（Atlanta）', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-southeast-1.log.aliyuncs.com', 'endpoint' => 'us-southeast-1.log.aliyuncs.com', 'vpc' => 'us-southeast-1-internal.log.aliyuncs.com'], ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'ap-south-1.log.aliyuncs.com', 'endpoint' => 'ap-south-1.log.aliyuncs.com', 'vpc' => 'ap-south-1-internal.log.aliyuncs.com'], ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'me-east-1.log.aliyuncs.com', 'endpoint' => 'me-east-1.log.aliyuncs.com', 'vpc' => 'me-east-1-internal.log.aliyuncs.com'], ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'me-central-1.log.aliyuncs.com', 'endpoint' => 'me-central-1.log.aliyuncs.com', 'vpc' => 'me-central-1-internal.log.aliyuncs.com'], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-hangzhou-finance.log.aliyuncs.com', 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com', 'vpc' => 'cn-hangzhou-finance-internal.log.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-shanghai-finance-1.log.aliyuncs.com', 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com', 'vpc' => 'cn-shanghai-finance-1-internal.log.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-shenzhen-finance-1.log.aliyuncs.com', 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com', 'vpc' => 'cn-shenzhen-finance-1-internal.log.aliyuncs.com'], ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-beijing-finance-1.log.aliyuncs.com', 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com', 'vpc' => 'cn-beijing-finance-1-internal.log.aliyuncs.com'], ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', 'vpc' => 'cn-heyuan-acdr-1-internal.log.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'AccessDenied', 'message' => '%s.', 'http_code' => 400, 'description' => 'Unauthorized'], ['code' => 'AlertNotExist', 'message' => '%s.', 'http_code' => 404, 'description' => 'Alert does not exist'], ['code' => 'AlreadyExist', 'message' => 'App already exist.', 'http_code' => 400, 'description' => 'Application already exists'], ['code' => 'AppNotExist', 'message' => 'The App not exist.', 'http_code' => 400, 'description' => 'Application does not exist'], ['code' => 'AuthorizationRequired', 'message' => 'Authorization Required', 'http_code' => 401, 'description' => ''], ['code' => 'ClientError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Internal service exception'], ['code' => 'ConfigServiceNotEnabled', 'message' => '%s.', 'http_code' => 400, 'description' => 'Configuration service is not enabled'], ['code' => 'CreateError', 'message' => 'Create app failed.', 'http_code' => 400, 'description' => 'Failed to create application'], ['code' => 'CreateFailed', 'message' => 'Create app failed.', 'http_code' => 400, 'description' => 'Failed to create application'], ['code' => 'CreateOrderError', 'message' => '%s.', 'http_code' => 200, 'description' => 'Create Order Error'], ['code' => 'CreateOrderFailed', 'message' => 'Failed to create an order.', 'http_code' => 500, 'description' => ''], ['code' => 'CreateProjectFailed', 'message' => 'Failed to create the project: %s.', 'http_code' => 400, 'description' => 'Failed to create project'], ['code' => 'DashboardError', 'message' => 'Failed to create or update the dashboard: %s.', 'http_code' => 400, 'description' => 'Failed to create or update dashboard'], ['code' => 'DeleteFailed', 'message' => 'Delete app failed.', 'http_code' => 400, 'description' => 'Failed to delete application'], ['code' => 'DescribeUserBusinessStatusFailed', 'message' => 'Failed to describe user business status.', 'http_code' => 500, 'description' => ''], ['code' => 'EntityNotExist.Role', 'message' => '%s.', 'http_code' => 400, 'description' => 'Role does not exist'], ['code' => 'EtlMetaAlreadyExist', 'message' => '%s.', 'http_code' => 400, 'description' => 'Meta already exists'], ['code' => 'EventBridgeNotEnabled', 'message' => '%s.', 'http_code' => 400, 'description' => 'Service not enabled'], ['code' => 'ExceedQuota', 'message' => 'The %s quota exceed.', 'http_code' => 400, 'description' => 'Quota exceed'], ['code' => 'ExceedQuota', 'message' => '%s.', 'http_code' => 400, 'description' => 'Quota exceed'], ['code' => 'FLOWLOG_INSTANCE_NOT_FOUND', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid Instance'], ['code' => 'GetAlertHistoriesError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Failed to get alert history'], ['code' => 'GetAppFailed', 'message' => 'Get app failed.', 'http_code' => 400, 'description' => 'Failed to get application'], ['code' => 'GetConfigError', 'message' => 'Failed to get configuration information.', 'http_code' => 500, 'description' => ''], ['code' => 'GetProjectFailed', 'message' => 'Failed to get project.', 'http_code' => 400, 'description' => 'Failed to get project'], ['code' => 'GetProjectFailed', 'message' => 'Failed to get project: %s.', 'http_code' => 400, 'description' => 'Failed to get project'], ['code' => 'GetSpecificationsFailed', 'message' => 'Failed to get specifications of commodity.', 'http_code' => 500, 'description' => ''], ['code' => 'GetSpecificationsFailed', 'message' => '%s.', 'http_code' => 500, 'description' => 'Failed to get commodity'], ['code' => 'IncorrectStatus.LoadBalancer', 'message' => '%s.', 'http_code' => 400, 'description' => 'Incorrect status'], ['code' => 'IndexError', 'message' => 'Failed to create or update index.', 'http_code' => 400, 'description' => 'Failed to create or update index'], ['code' => 'IndexError', 'message' => 'Failed to create or update index: %s.', 'http_code' => 400, 'description' => 'Failed to create or update index'], ['code' => 'InputParaError', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'InputParaError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Input parameter error'], ['code' => 'InternalException', 'message' => 'Internal service upexpected exception', 'http_code' => 400, 'description' => ''], ['code' => 'InternalException', 'message' => 'Internal service upexpected exception.', 'http_code' => 400, 'description' => 'Internal service exception'], ['code' => 'InvalidAppName', 'message' => 'The appName is invalid.', 'http_code' => 400, 'description' => 'Invalid application name'], ['code' => 'InvalidDataType', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid data type'], ['code' => 'InvalidDisplayName', 'message' => 'Display name length exceeds limit.', 'http_code' => 400, 'description' => 'Display name exceeds length'], ['code' => 'InvalidInstance', 'message' => 'The instance is invalid.', 'http_code' => 400, 'description' => 'Invalid Instance'], ['code' => 'InvalidInstance', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid Instance'], ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The instance does not exist.', 'http_code' => 400, 'description' => 'Instance does not exist'], ['code' => 'InvalidLang', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid language'], ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid: %s', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid: %s.', 'http_code' => 400, 'description' => 'Illegal parameter'], ['code' => 'InvalidRAM', 'message' => 'Permission denied.', 'http_code' => 400, 'description' => 'Authentication not passed'], ['code' => 'InvalidRegion', 'message' => 'The region is invalid.', 'http_code' => 400, 'description' => 'Invalid Region'], ['code' => 'InvalidVpcId.NotFound', 'message' => 'The vpdId does not exist.', 'http_code' => 400, 'description' => 'VpcId does not exist'], ['code' => 'JobAlreadyExist', 'message' => 'The job already exists.', 'http_code' => 400, 'description' => 'Task already exists'], ['code' => 'JobError', 'message' => 'Failed to create or update the job.', 'http_code' => 400, 'description' => 'Job failed'], ['code' => 'JobError', 'message' => 'Failed to create or update the job: %s.', 'http_code' => 400, 'description' => 'Job failed'], ['code' => 'LogstoreError', 'message' => 'Failed to create or update the logstore.', 'http_code' => 400, 'description' => 'Logstore creation or update failed'], ['code' => 'LogstoreError', 'message' => 'Failed to create or update the logstore: %s.', 'http_code' => 400, 'description' => 'Logstore create or update failed'], ['code' => 'LogStoreNotExist', 'message' => 'logstore xxxx does not exist.', 'http_code' => 404, 'description' => 'The Logstore does not exist.'], ['code' => 'LogstoreProductTypeConflict', 'message' => 'The product type doesn\'t match : %s.', 'http_code' => 400, 'description' => 'Logstore type mismatch'], ['code' => 'LogstoreProductTypeConflict', 'message' => '%s.', 'http_code' => 400, 'description' => 'Logstore type mismatch'], ['code' => 'MetricStoreAlreadyExist', 'message' => 'The specified metricstore xxx already exists.', 'http_code' => 400, 'description' => 'The specified metricstore xxx already exists.'], ['code' => 'MetricStoreNotExist', 'message' => 'The specified metricstore xxx does not exist.', 'http_code' => 404, 'description' => 'The specified metricstore xxx does not exist.'], ['code' => 'ParameterInvalid', 'message' => '%s.', 'http_code' => 400, 'description' => 'Parameter invalid'], ['code' => 'ParamMissing', 'message' => 'The app name is required.', 'http_code' => 400, 'description' => 'Illegal parameter'], ['code' => 'ParamsIsNull', 'message' => '%s.', 'http_code' => 400, 'description' => 'Parameter is empty'], ['code' => 'PermissionDenied', 'message' => 'You are not authorized to activate Log Service.', 'http_code' => 400, 'description' => ''], ['code' => 'PermissionDenied', 'message' => '%s.', 'http_code' => 401, 'description' => 'No permission'], ['code' => 'PostBodyInvalid', 'message' => 'Loggroup contains zero logs.', 'http_code' => 400, 'description' => 'There are no logs in the LogGroup.'], ['code' => 'PostBodyInvalid', 'message' => 'Fail to parse protobuf.', 'http_code' => 400, 'description' => 'Protobuffer content is illegal and cannot be parsed.'], ['code' => 'PostBodyTooLarge', 'message' => 'Body size must little than 10485760.', 'http_code' => 413, 'description' => 'Body size must little than 10485760.'], ['code' => 'PostBodyUncompressError', 'message' => 'Post body uncompressed fail.', 'http_code' => 400, 'description' => 'Post body uncompressed fail.'], ['code' => 'ProductDataCollectionNoExist', 'message' => 'failed to find product data collection for this instance', 'http_code' => 400, 'description' => 'The collection configuration for this instance is not found.'], ['code' => 'ProductDataCollectionNoExist', 'message' => 'Failed to find product data collection for this instance.', 'http_code' => 400, 'description' => 'Failed to find product data collection for this instance'], ['code' => 'ProjectExist', 'message' => '%s.', 'http_code' => 400, 'description' => 'Item already exists'], ['code' => 'ProjectForbidden', 'message' => '%s.', 'http_code' => 400, 'description' => 'Project is forbidden'], ['code' => 'ProjectNotExist', 'message' => '%s.', 'http_code' => 400, 'description' => 'Project does not exist'], ['code' => 'ProjectNotExist', 'message' => 'The Project does not exist: xxxx.', 'http_code' => 404, 'description' => 'The log entry does not exist.'], ['code' => 'ProjectRegionInvalid', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid Region'], ['code' => 'RequestError', 'message' => 'Internal Error.', 'http_code' => 400, 'description' => 'Internal service exception'], ['code' => 'ResourceCreating', 'message' => '%s.', 'http_code' => 400, 'description' => 'Failed to create resource'], ['code' => 'ResourceNotExist', 'message' => '%s.', 'http_code' => 404, 'description' => 'Resource does not exist'], ['code' => 'ResourceRecordNotExist', 'message' => 'The resource record is not found because CloudLens has not been enabled.', 'http_code' => 400, 'description' => 'The resource record is not found because CloudLens has not been enabled.'."\n"], ['code' => 'ResourceRecordNotExist', 'message' => '%s.', 'http_code' => 400, 'description' => 'Resource record does not exist'], ['code' => 'SavedSearchError', 'message' => '%s.', 'http_code' => 400, 'description' => 'SavedSearch create or update failed'], ['code' => 'Service.Status.Illeagal', 'message' => '%s.', 'http_code' => 400, 'description' => 'Illegal service status'], ['code' => 'SetAlertCenterResourceError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Failed to set alarm resource'], ['code' => 'ShardNotExist', 'message' => 'shard xxx is not exist.', 'http_code' => 404, 'description' => 'Shard does not exist.'], ['code' => 'Unauthorized', 'message' => 'The AccessKeyId is unauthorized.', 'http_code' => null, 'description' => 'The specified AccessKey ID is unauthorized.'], ['code' => 'UnAuthorized', 'message' => '%s.', 'http_code' => 401, 'description' => 'Unauthorized'], ['code' => 'Unauthorized', 'message' => 'Unauthorized: %s.', 'http_code' => 401, 'description' => 'Unauthorized'], ['code' => 'UnRegisterProduct', 'message' => '%s.', 'http_code' => 400, 'description' => 'Cloud product not registered'], ['code' => 'UpdateFailed', 'message' => 'Update app failed.', 'http_code' => 400, 'description' => 'Failed to update application'], ['code' => 'VerifyInstanceFailed', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid Instance'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'UpdateMetricStore'], ['description' => 'Response parameters changed', 'api' => 'GetMetricStore'], ['description' => 'Request parameters changed', 'api' => 'CreateMetricStore'], ['description' => 'Request parameters changed', 'api' => 'UpdateLogStore'], ['description' => 'Request parameters changed', 'api' => 'CreateLogStore'], ], 'createdAt' => '2025-12-03T01:37:06.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'UpdateMetricStore'], ['description' => 'OpenAPI offline', 'api' => 'GetMetricStore'], ['description' => 'OpenAPI offline', 'api' => 'UpdateLogStore'], ['description' => 'OpenAPI offline', 'api' => 'CreateMetricStore'], ['description' => 'OpenAPI offline', 'api' => 'CreateLogStore'], ['description' => 'OpenAPI offline', 'api' => 'GetMetricStore'], ['description' => 'OpenAPI offline', 'api' => 'UpdateMetricStore'], ['description' => 'OpenAPI offline', 'api' => 'CreateMetricStore'], ['description' => 'OpenAPI offline', 'api' => 'UpdateLogStore'], ['description' => 'OpenAPI offline', 'api' => 'CreateLogStore'], ], 'createdAt' => '2025-12-02T07:21:18.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CreateIndexString'], ['description' => 'OpenAPI offline', 'api' => 'UpdateIndexString'], ['description' => 'OpenAPI offline', 'api' => 'GetIndexString'], ], 'createdAt' => '2025-12-01T08:34:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CreateIndexString'], ['description' => 'OpenAPI offline', 'api' => 'UpdateIndexString'], ['description' => 'OpenAPI offline', 'api' => 'GetIndexString'], ], 'createdAt' => '2025-12-01T08:34:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetMetricStore'], ['description' => 'Request parameters changed', 'api' => 'CreateMetricStore'], ['description' => 'Request parameters changed', 'api' => 'UpdateMetricStore'], ], 'createdAt' => '2025-11-24T09:35:51.000Z', 'description' => '', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ], ], 'ram' => [ 'productCode' => 'SLS', 'productName' => 'Simple Log Service', 'ramCodes' => ['log'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [ [ 'name' => 'log:TLSVersion', 'schema' => [ 'type' => 'String', 'description' => 'Version of TLS', 'enums' => ['TLSv1', 'TLSv1.1', 'TLSv1.2', 'TLSv1.3'], ], ], [ 'name' => 'log:Encrypted', 'schema' => [ 'type' => 'Boolean', 'description' => 'Whether to specify encryption configuration when creating or modifying a Logstore', 'enums' => ['true', 'false'], ], ], ], 'ramActions' => [ [ 'apiName' => 'DeleteMachineGroup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], [ 'apiName' => 'ListOSSIngestions', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListOSSIngestions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteConsumerGroup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], [ 'apiName' => 'DeleteSavedSearch', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], [ 'apiName' => 'CreateDomain', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateDomain', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], ], ], ], [ 'apiName' => 'GetLogging', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], [ 'apiName' => 'CreateConsumerGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], [ 'apiName' => 'GetStoreView', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetStoreView', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetLogStoreMeteringMode', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetLogStoreMeteringMode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteIndex', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteIndex', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], [ 'apiName' => 'ListOSSHDFSExports', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListOSSHDFSExports', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateAlert', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateLogStore', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateLogStore', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ['conditionKey' => 'log:Encrypted', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], [ 'apiName' => 'ListStoreViews', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListStoreViews', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListMachines', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListMachines', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], [ 'apiName' => 'DeleteProject', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}'], ], ], ], [ 'apiName' => 'UpdateLogging', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], [ 'apiName' => 'ListScheduledSQLs', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:ListScheduledSQLs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCursor', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetCursorOrData', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], [ 'apiName' => 'DeleteDashboard', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateLogStore', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateLogStore', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ['conditionKey' => 'log:Encrypted', 'validationType' => 'conditional'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}'], ], ], ], [ 'apiName' => 'UpdateConsumerGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], [ 'apiName' => 'UpdateIndex', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateIndex', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], [ 'apiName' => 'GetAppliedMachineGroups', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetAppliedMachineGroups', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], [ 'apiName' => 'ConsumerGroupUpdateCheckPoint', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:ConsumerGroupUpdateCheckPoint', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateLogtailPipelineConfig', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteConfig', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetLogStore', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetLogStore', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], [ 'apiName' => 'UpdateConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], [ 'apiName' => 'ListLogtailPipelineConfig', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCursorTime', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetCursorOrData', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], [ 'apiName' => 'DeleteDomain', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteDomain', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], ], ], ], [ 'apiName' => 'ListConfig', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*'], ], ], ], [ 'apiName' => 'GetETL', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetETL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateSavedSearch', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], [ 'apiName' => 'DisableScheduledSQL', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:DisableScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetSqlInstance', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:GetSqlInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'GetSavedSearch', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], [ 'apiName' => 'CreateMetricStore', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateMetricStore', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#name}'], ], ], ], [ 'apiName' => 'GetDashboard', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ], ], ], [ 'apiName' => 'EnableAlert', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:EnableAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateSqlInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateSqlInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'ListDownloadJobs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListDownloadJobs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetScheduledSQL', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateStoreView', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateStoreView', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListProject', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/*'], ], ], ], [ 'apiName' => 'CreateStoreView', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateStoreView', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetIndex', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetIndex', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], [ 'apiName' => 'ListConsumerGroup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*'], ], ], ], [ 'apiName' => 'UpdateAlert', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDashboard', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ], ], ], [ 'apiName' => 'UntagResources', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'CreateScheduledSQL', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListAlerts', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListAlerts', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Alert', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/alert/*'], ], ], ], [ 'apiName' => 'GetMachineGroup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], [ 'apiName' => 'CreateLogging', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], [ 'apiName' => 'ListMachineGroup', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*'], ], ], ], [ 'apiName' => 'DeleteScheduledSQL', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteScheduledSQL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListShards', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListShards', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], [ 'apiName' => 'UpdateMachineGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], [ 'apiName' => 'CreateConfig', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], [ 'apiName' => 'UpdateSavedSearch', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], [ 'apiName' => 'UpdateLogStoreMeteringMode', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateLogStoreMeteringMode', 'authLevel' => 'operate', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'DeleteAlert', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], [ 'apiName' => 'TagResources', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:TagResources', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'UpdateScheduledSQL', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetLogtailPipelineConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateMachineGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], [ 'apiName' => 'ListDomains', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListDomains', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/*'], ], ], ], [ 'apiName' => 'MergeShard', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:MergeShard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], [ 'apiName' => 'GetStoreViewIndex', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetStoreViewIndex', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetProject', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'DeleteStoreView', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteStoreView', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateSqlInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateSqlInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'DeleteLogging', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteLogging', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], [ 'apiName' => 'CreateDashboard', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteLogStore', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteLogStore', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], [ 'apiName' => 'CreateIndex', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateIndex', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], [ 'apiName' => 'UpdateLogtailPipelineConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateProject', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'ConsumerGroupHeartBeat', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:ConsumerGroupHeartBeat', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateProject', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateProject', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#projectName}'], ], ], ], [ 'apiName' => 'DisableAlert', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:DisableAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListLogStores', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListLogStores', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/*'], ], ], ], [ 'apiName' => 'UpdateMachineGroupMachine', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:UpdateMachineGroupMachine', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteProjectPolicy', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'log:DeleteProjectPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDashboard', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListDashboard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/*'], ], ], ], [ 'apiName' => 'EnableScheduledSQL', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'log:EnableScheduledSQL', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PutProjectPolicy', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:PutProjectPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ApplyConfigToMachineGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:ApplyConfigToGroup', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], [ 'apiName' => 'GetProjectPolicy', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetProjectPolicy', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListSavedSearch', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*'], ], ], ], [ 'apiName' => 'SplitShard', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'log:SplitShard', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], [ 'apiName' => 'ListETLs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListETLs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListOSSExports', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'log:ListOSSExports', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTagResources', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], [ 'apiName' => 'GetAlert', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetAlert', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAppliedConfigs', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'log:GetAppliedConfigs', 'authLevel' => 'resource', 'actionConditions' => [ ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ['validationType' => 'always', 'resourceType' => 'AzureBlobIngestion', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/azureblobingestion/*'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ['validationType' => 'always', 'resourceType' => 'AzureBlobIngestion', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/azureblobingestion/{#azureBlobIngestionName}'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ['validationType' => 'always', 'resourceType' => 'MaterializedView', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/materializedview/*'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ['validationType' => 'always', 'resourceType' => 'ConsumeProcessor', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/consumeprocessor/{#processorName}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], ['validationType' => 'always', 'resourceType' => 'AgentInstanceConfig', 'arn' => 'acs:log:{#regionId}:{#accountId}:agentinstanceconfig/*'], ['validationType' => 'always', 'resourceType' => 'IngestProcessor', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/ingestprocessor/{#processorName}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ['validationType' => 'always', 'resourceType' => 'Service', 'arn' => 'acs:log::{#AccountId}:service'], ['validationType' => 'always', 'resourceType' => 'ESIngestion', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/elasticsearchingestion/*'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{l#ogstoreName}/consumergroup/{#ConsumerGroup}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}//dashboard/{#DashboardName}'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}'], ['validationType' => 'always', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#name}'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName}'], ['validationType' => 'always', 'resourceType' => 'IngestProcessor', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/ingestprocessor/*'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => ' acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ['validationType' => 'always', 'resourceType' => 'CollectionPolicy', 'arn' => 'acs:log::{#accountId}:collectionpolicy/*'], ['validationType' => 'always', 'resourceType' => 'S3Ingestion', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/s3ingestion/*'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*'], ['validationType' => 'always', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/*'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ['validationType' => 'always', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#metricstore}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/*'], ['validationType' => 'always', 'resourceType' => 'CollectionPolicy', 'arn' => 'acs:log::{#accountId}:collectionpolicy/{#policyName}'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*'], ['validationType' => 'always', 'resourceType' => 'Region', 'arn' => 'acs:log:{#regionId}:{#accountId}:*'], ['validationType' => 'always', 'resourceType' => 'Alert', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/alert/*'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#Region}:{#AccountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ['validationType' => 'always', 'resourceType' => 'Ticket', 'arn' => 'acs:log::{#accountId}:ticket/*'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/*'], ['validationType' => 'always', 'resourceType' => 'AgentInstanceConfig', 'arn' => 'acs:log:{#regionId}:{#accountId}:agentinstanceconfig/{#configType}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => ' acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ['validationType' => 'always', 'resourceType' => 'ConsumeProcessor', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/consumeprocessor/*'], ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/*'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{MachineGroup}'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/*'], ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*'], ], ], ];