From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/zh_cn/sls/2020-12-30/api-docs.php | 37095 +++++++++---------------------- 1 file changed, 10691 insertions(+), 26404 deletions(-) (limited to 'data/zh_cn/sls/2020-12-30/api-docs.php') diff --git a/data/zh_cn/sls/2020-12-30/api-docs.php b/data/zh_cn/sls/2020-12-30/api-docs.php index 6c04b61..c72a42b 100644 --- a/data/zh_cn/sls/2020-12-30/api-docs.php +++ b/data/zh_cn/sls/2020-12-30/api-docs.php @@ -1,438 +1,205 @@ '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'Sls', - 'version' => '2020-12-30', - ], + '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', + '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' => '日志库', - 'id' => 154782, + 'id' => 425618, ], [ - 'children' => [ - 'ListMetricStores', - 'CreateMetricStore', - 'DeleteMetricStore', - 'UpdateMetricStore', - 'UpdateMetricStoreMeteringMode', - 'GetMetricStore', - 'GetMetricStoreMeteringMode', - ], + 'children' => ['ListMetricStores', 'CreateMetricStore', 'DeleteMetricStore', 'UpdateMetricStore', 'UpdateMetricStoreMeteringMode', 'GetMetricStore', 'GetMetricStoreMeteringMode'], 'type' => 'directory', 'title' => '时序库', - 'id' => 154947, + 'id' => 425619, ], [ - 'children' => [ - 'CreateStoreView', - 'DeleteStoreView', - 'UpdateStoreView', - 'GetStoreView', - 'GetStoreViewIndex', - 'ListStoreViews', - ], + 'children' => ['CreateStoreView', 'DeleteStoreView', 'UpdateStoreView', 'GetStoreView', 'GetStoreViewIndex', 'ListStoreViews'], 'type' => 'directory', 'title' => '数据集', - 'id' => 154940, + 'id' => 425620, ], [ - 'children' => [ - 'CreateMachineGroup', - 'DeleteMachineGroup', - 'RemoveConfigFromMachineGroup', - 'ApplyConfigToMachineGroup', - 'UpdateMachineGroup', - 'UpdateMachineGroupMachine', - 'ListMachineGroup', - 'ListMachines', - 'GetMachineGroup', - 'GetAppliedConfigs', - 'GetAppliedMachineGroups', - ], + 'children' => ['CreateMachineGroup', 'DeleteMachineGroup', 'RemoveConfigFromMachineGroup', 'ApplyConfigToMachineGroup', 'UpdateMachineGroup', 'UpdateMachineGroupMachine', 'ListMachineGroup', 'ListMachines', 'GetMachineGroup', 'GetAppliedConfigs', 'GetAppliedMachineGroups'], 'type' => 'directory', 'title' => '机器组', - 'id' => 154807, + 'id' => 425621, ], [ - 'children' => [ - 'CreateConfig', - 'CreateLogtailPipelineConfig', - 'DeleteConfig', - 'DeleteLogtailPipelineConfig', - 'UpdateConfig', - 'UpdateLogtailPipelineConfig', - 'GetConfig', - 'ListConfig', - 'GetLogtailPipelineConfig', - 'ListLogtailPipelineConfig', - ], + 'children' => ['CreateConfig', 'CreateLogtailPipelineConfig', 'DeleteConfig', 'DeleteLogtailPipelineConfig', 'UpdateConfig', 'UpdateLogtailPipelineConfig', 'GetConfig', 'ListConfig', 'GetLogtailPipelineConfig', 'ListLogtailPipelineConfig'], 'type' => 'directory', 'title' => '采集配置', - 'id' => 154819, + 'id' => 425622, ], [ - 'children' => [ - 'CreateDashboard', - 'DeleteDashboard', - 'UpdateDashboard', - 'GetDashboard', - 'ListDashboard', - ], + 'children' => ['CreateDashboard', 'DeleteDashboard', 'UpdateDashboard', 'GetDashboard', 'ListDashboard'], 'type' => 'directory', 'title' => '仪表盘', - 'id' => 154869, + 'id' => 425623, ], [ - 'children' => [ - 'CreateConsumerGroup', - 'DeleteConsumerGroup', - 'ConsumerGroupUpdateCheckPoint', - 'UpdateConsumerGroup', - 'ConsumerGroupHeartBeat', - 'ListConsumerGroup', - 'GetCheckPoint', - ], + 'children' => ['CreateConsumerGroup', 'DeleteConsumerGroup', 'ConsumerGroupUpdateCheckPoint', 'UpdateConsumerGroup', 'ConsumerGroupHeartBeat', 'ListConsumerGroup', 'GetCheckPoint'], 'type' => 'directory', 'title' => '消费组', - 'id' => 154830, + 'id' => 425624, ], [ - 'children' => [ - 'CreateSavedSearch', - 'DeleteSavedSearch', - 'UpdateSavedSearch', - 'ListSavedSearch', - 'GetSavedSearch', - ], + 'children' => ['CreateSavedSearch', 'DeleteSavedSearch', 'UpdateSavedSearch', 'ListSavedSearch', 'GetSavedSearch'], 'type' => 'directory', 'title' => '快速查询', - 'id' => 154838, + 'id' => 425625, ], [ - 'children' => [ - 'CreateAlert', - 'DeleteAlert', - 'UpdateAlert', - 'EnableAlert', - 'DisableAlert', - 'GetAlert', - 'ListAlerts', - ], + 'children' => ['CreateAlert', 'DeleteAlert', 'UpdateAlert', 'EnableAlert', 'DisableAlert', 'GetAlert'], 'type' => 'directory', 'title' => '告警', - 'id' => 154898, + 'id' => 425626, ], [ 'children' => [ [ - 'children' => [ - 'StopAzureBlobIngestion', - 'StartAzureBlobIngestion', - 'DeleteAzureBlobIngestion', - 'UpdateAzureBlobIngestion', - 'ListAzureBlobIngestion', - 'CreateAzureBlobIngestion', - 'GetAzureBlobIngestion', - ], + 'children' => ['UpdateGCSIngestion', 'StopGCSIngestion', 'StartGCSIngestion', 'ListGCSIngestions', 'GetGCSIngestion', 'CreateGCSIngestion'], 'type' => 'directory', - 'title' => 'AzureBlob导入', - 'id' => 385165, + 'title' => 'GCS导入', + 'id' => 425628, ], [ - 'children' => [ - 'ListS3Ingestions', - 'GetS3Ingestion', - 'DeleteS3Ingestion', - 'CreateS3Ingestion', - ], + 'children' => ['UpdateElasticsearchIngestion', 'StopElasticsearchIngestion', 'StartElasticsearchIngestion', 'CreateElasticsearchIngestion', 'ListElasticsearchIngestions', 'GetElasticsearchIngestion', 'DeleteElasticsearchIngestion'], + 'type' => 'directory', + 'title' => 'Elasticsearch导入', + 'id' => 425629, + ], + [ + 'children' => ['CreateS3Ingestion', 'ListS3Ingestions', 'GetS3Ingestion', 'DeleteS3Ingestion'], 'type' => 'directory', 'title' => 'S3导入', - 'id' => 200740, + 'id' => 425630, ], [ - 'children' => [ - 'CreateOSSIngestion', - 'GetOSSIngestion', - 'ListOSSIngestions', - 'StopOSSIngestion', - 'StartOSSIngestion', - 'UpdateOSSIngestion', - 'DeleteOSSIngestion', - ], + 'children' => ['StopAzureBlobIngestion', 'StartAzureBlobIngestion', 'DeleteAzureBlobIngestion', 'UpdateAzureBlobIngestion', 'ListAzureBlobIngestion', 'CreateAzureBlobIngestion', 'GetAzureBlobIngestion'], + 'type' => 'directory', + 'title' => 'AzureBlob导入', + 'id' => 425632, + ], + [ + 'children' => ['CreateOSSIngestion', 'GetOSSIngestion', 'ListOSSIngestions', 'StopOSSIngestion', 'StartOSSIngestion', 'UpdateOSSIngestion', 'DeleteOSSIngestion'], 'type' => 'directory', 'title' => 'OSS导入', - 'id' => 200748, + 'id' => 425633, ], ], 'type' => 'directory', 'title' => '数据导入', - 'id' => 154906, + 'id' => 425627, ], [ - 'children' => [ - 'CreateOSSExport', - 'CreateOSSHDFSExport', - 'DeleteOSSExport', - 'DeleteOSSHDFSExport', - 'UpdateOSSExport', - 'StartOSSExport', - 'StopOSSExport', - 'GetOSSExport', - 'UpdateOSSHDFSExport', - 'StartOSSHDFSExport', - 'StopOSSHDFSExport', - 'ListOSSExports', - 'GetOSSHDFSExport', - 'ListOSSHDFSExports', - ], + 'children' => ['CreateOSSExport', 'CreateOSSHDFSExport', 'DeleteOSSExport', 'DeleteOSSHDFSExport', 'UpdateOSSExport', 'StartOSSExport', 'StopOSSExport', 'GetOSSExport', 'UpdateOSSHDFSExport', 'StartOSSHDFSExport', 'StopOSSHDFSExport', 'ListOSSExports', 'GetOSSHDFSExport', 'ListOSSHDFSExports'], 'type' => 'directory', 'title' => '日志投递', - 'id' => 154844, + 'id' => 425634, ], [ - 'children' => [ - 'CreateETL', - 'DeleteETL', - 'UpdateETL', - 'StartETL', - 'StopETL', - 'ListETLs', - 'GetETL', - ], + 'children' => ['CreateETL', 'DeleteETL', 'UpdateETL', 'StartETL', 'StopETL', 'ListETLs', 'GetETL'], 'type' => 'directory', 'title' => '数据加工', - 'id' => 154922, + 'id' => 425635, ], [ - 'children' => [ - 'CreateScheduledSQL', - 'DeleteScheduledSQL', - 'UpdateScheduledSQL', - 'EnableScheduledSQL', - 'DisableScheduledSQL', - 'ListScheduledSQLs', - 'GetScheduledSQL', - ], + 'children' => ['CreateScheduledSQL', 'DeleteScheduledSQL', 'UpdateScheduledSQL', 'EnableScheduledSQL', 'DisableScheduledSQL', 'ListScheduledSQLs', 'GetScheduledSQL'], 'type' => 'directory', 'title' => '定时SQL', - 'id' => 154914, + 'id' => 425636, ], [ - 'children' => [ - 'CreateDownloadJob', - 'DeleteDownloadJob', - 'GetDownloadJob', - 'ListDownloadJobs', - ], + 'children' => ['CreateDownloadJob', 'DeleteDownloadJob', 'GetDownloadJob', 'ListDownloadJobs'], 'type' => 'directory', 'title' => '日志下载', - 'id' => 174476, + 'id' => 425637, ], [ - 'children' => [ - 'PutIngestProcessor', - 'GetIngestProcessor', - 'ListIngestProcessors', - 'DeleteIngestProcessor', - 'UpdateLogStoreProcessor', - 'UpdateMetricStoreProcessor', - ], + 'children' => ['PutIngestProcessor', 'GetIngestProcessor', 'ListIngestProcessors', 'DeleteIngestProcessor', 'UpdateLogStoreProcessor', 'UpdateMetricStoreProcessor'], 'type' => 'directory', 'title' => '写入处理器', - 'id' => 154973, + 'id' => 425638, ], [ - 'children' => [ - 'PutConsumeProcessor', - 'GetConsumeProcessor', - 'ListConsumeProcessors', - 'DeleteConsumeProcessor', - ], + 'children' => ['PutConsumeProcessor', 'GetConsumeProcessor', 'ListConsumeProcessors', 'DeleteConsumeProcessor'], 'type' => 'directory', 'title' => '消费处理器', - 'id' => 154980, + 'id' => 425639, ], [ - 'children' => [ - 'ListAiTools', - 'CallAiTools', - 'CreateAnnotationLabel', - 'PutAnnotationData', - 'CreateAnnotationDataSet', - 'DeleteAnnotationLabel', - 'DeleteAnnotationData', - 'DeleteAnnotationDataSet', - 'UpdateAnnotationLabel', - 'UpdateAnnotationDataSet', - 'GetAnnotationLabel', - 'ListAnnotationLabels', - 'GetAnnotationData', - 'ListAnnotationData', - 'GetAnnotationDataSet', - 'ListAnnotationDataSets', - 'GetMLServiceResults', - ], + 'children' => ['ListAiTools', 'CallAiTools', 'CreateAnnotationLabel', 'PutAnnotationData', 'CreateAnnotationDataSet', 'DeleteAnnotationLabel', 'DeleteAnnotationData', 'DeleteAnnotationDataSet', 'UpdateAnnotationLabel', 'UpdateAnnotationDataSet', 'GetAnnotationLabel', 'ListAnnotationLabels', 'GetAnnotationData', 'ListAnnotationData', 'GetAnnotationDataSet', 'ListAnnotationDataSets', 'GetMLServiceResults'], 'type' => 'directory', 'title' => '机器学习', - 'id' => 154875, - ], - [ - 'children' => [ - 'TagResources', - 'UntagResources', - 'ListTagResources', - ], - 'type' => 'directory', - 'title' => '标签', - 'id' => 154859, + 'id' => 425640, ], [ - 'children' => [ - 'PutProjectPolicy', - 'DeleteProjectPolicy', - 'GetProjectPolicy', - ], + 'children' => ['PutProjectPolicy', 'DeleteProjectPolicy', 'GetProjectPolicy'], 'type' => 'directory', 'title' => '授权策略', - 'id' => 154863, - ], - [ - 'children' => [ - 'ChangeResourceGroup', - ], - 'type' => 'directory', - 'title' => '资源组', - 'id' => 154867, + 'id' => 425645, ], [ - 'children' => [ - 'UpsertCollectionPolicy', - 'DeleteCollectionPolicy', - 'ListCollectionPolicies', - 'GetCollectionPolicy', - ], + 'children' => ['UpsertCollectionPolicy', 'DeleteCollectionPolicy', 'ListCollectionPolicies', 'GetCollectionPolicy'], 'type' => 'directory', 'title' => '云产品采集规则', - 'id' => 154893, + 'id' => 425647, ], [ - 'children' => [ - 'CreateSqlInstance', - 'UpdateSqlInstance', - 'GetSqlInstance', - ], + 'children' => ['CreateSqlInstance', 'UpdateSqlInstance', 'GetSqlInstance'], 'type' => 'directory', 'title' => 'SQL独享实例', - 'id' => 154936, + 'id' => 425648, ], [ - 'children' => [ - 'OpenSlsService', - 'GetSlsService', - ], + 'children' => ['OpenSlsService'], 'type' => 'directory', 'title' => '服务开通', - 'id' => 154930, + 'id' => 425649, ], [ - 'children' => [ - 'CreateTicket', - 'RefreshToken', - ], + 'children' => ['RefreshToken'], 'type' => 'directory', 'title' => '控制台内嵌', - 'id' => 154933, + 'id' => 425650, ], [ - 'children' => [ - 'CreateAgentInstanceConfig', - 'DeleteAgentInstanceConfig', - 'GetAgentInstanceConfig', - 'ListAgentInstanceConfigs', - 'UpdateAgentInstanceConfig', - ], + 'children' => ['CreateAgentInstanceConfig', 'DeleteAgentInstanceConfig', 'GetAgentInstanceConfig', 'ListAgentInstanceConfigs', 'UpdateAgentInstanceConfig'], 'type' => 'directory', 'title' => '进程级配置', - 'id' => 376860, + 'id' => 425651, + ], + [ + 'children' => ['GetMaxComputeExport', 'CreateMaxComputeExport', 'DeleteMaxComputeExport', 'ListMaxComputeExports', 'StartMaxComputeExport', 'StopMaxComputeExport', 'UpdateMaxComputeExport'], + 'type' => 'directory', + 'title' => 'MaxCompute 投递', + 'id' => 446797, + ], + [ + 'children' => ['UntagResources', 'TagResources', 'ListTagResources'], + 'type' => 'directory', + 'title' => '标签', + 'id' => 446810, + ], + [ + 'children' => ['CreateProject', 'DeleteProject', 'GetProject', 'ListProject', 'UpdateProject', 'GetProjectLogs'], + 'type' => 'directory', + 'title' => '项目', + 'id' => 446811, ], [ 'children' => [ - 'DescribeRegions', - 'GetMaxComputeExport', - 'CreateMaxComputeExport', - 'DeleteMaxComputeExport', - 'ListMaxComputeExports', - 'StartMaxComputeExport', - 'StopMaxComputeExport', - 'UpdateMaxComputeExport', - 'CreateDomain', - 'CreateLogging', - 'CreateProject', - 'DeleteDomain', - 'DeleteLogging', - 'DeleteProject', - 'GetLogging', - 'GetProject', - 'GetProjectLogs', - 'ListDatasets', - 'ListDomains', - 'ListProject', - 'PutProjectTransferAcceleration', - 'UpdateLogging', - 'UpdateProject', - 'AddMemories', - 'CreateDataset', - 'CreateMemoryStore', - 'DeleteDataset', - 'DeleteMemories', - 'DeleteMemory', - 'DeleteMemoryStore', - 'ExecuteQuery', - 'GetDataset', - 'GetMemories', - 'GetMemory', - 'GetMemoryHistory', - 'GetMemoryStore', - 'ListMemoryStores', - 'SearchMemories', - 'UpdateDataset', - 'UpdateMemory', - 'UpdateMemoryStore', + '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' => '其他', - 'id' => 154960, + 'id' => 425652, ], ], 'components' => [ @@ -442,18 +209,8 @@ 'description' => '进程级配置（灰度配置）', 'type' => 'object', 'properties' => [ - 'condition' => [ - 'title' => 'condition', - 'description' => '匹配规则', - 'type' => 'string', - 'example' => 'appVersion="1.0.0"', - ], - 'content' => [ - 'title' => 'content', - 'description' => '灰度配置内容', - 'type' => 'string', - 'example' => '{"enable":true}', - ], + 'condition' => ['title' => 'condition', 'description' => '匹配规则', 'type' => 'string', 'example' => 'appVersion="1.0.0"'], + 'content' => ['title' => 'content', 'description' => '灰度配置内容', 'type' => 'string', 'example' => '{"enable":true}'], ], ], 'Alert' => [ @@ -461,58 +218,14 @@ 'description' => '告警规则响应结果', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '告警规则ID', - 'description' => '告警规则ID', - 'type' => 'string', - 'required' => true, - 'example' => 'alert-123456', - ], - 'displayName' => [ - 'title' => '告警规则名称', - 'description' => '告警规则名称', - 'type' => 'string', - 'required' => true, - 'example' => 'alertNameExample', - ], - 'description' => [ - 'title' => '告警规则描述', - 'description' => '告警规则描述', - 'type' => 'string', - 'example' => 'Alert Desc', - ], - 'configuration' => [ - 'title' => '告警规则配置', - 'description' => '告警规则配置', - 'required' => true, - '$ref' => '#/components/schemas/AlertConfiguration', - ], - 'schedule' => [ - 'title' => '调度配置', - 'description' => '调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'description' => '最近一次修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714274900', - ], - 'status' => [ - 'title' => '告警状态', - 'description' => '告警状态', - 'type' => 'string', - 'example' => 'ENABLED/DISABLED', - ], + 'name' => ['title' => '告警规则ID', 'description' => '告警规则ID', 'type' => 'string', 'required' => true, 'example' => 'alert-123456'], + 'displayName' => ['title' => '告警规则名称', 'description' => '告警规则名称', 'type' => 'string', 'required' => true, 'example' => 'alertNameExample'], + 'description' => ['title' => '告警规则描述', 'description' => '告警规则描述', 'type' => 'string', 'example' => 'Alert Desc'], + 'configuration' => ['title' => '告警规则配置', 'description' => '告警规则配置', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration'], + 'schedule' => ['title' => '调度配置', 'description' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274900'], + 'status' => ['title' => '告警状态', 'description' => '告警状态', 'type' => 'string', 'example' => 'ENABLED/DISABLED'], ], ], 'AlertConfiguration' => [ @@ -520,162 +233,59 @@ 'description' => '告警配置', 'type' => 'object', 'properties' => [ - 'muteUntil' => [ - 'title' => '临时关闭时间', - 'description' => '临时关闭时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1698907508', - ], - 'version' => [ - 'title' => '版本', - 'description' => '版本', - 'type' => 'string', - 'required' => true, - 'example' => '2.0', - 'default' => '2.0', - ], - 'type' => [ - 'title' => '告警规则类型', - 'description' => '告警规则类型', - 'type' => 'string', - 'example' => 'default', - ], - 'templateConfiguration' => [ - 'title' => '告警模板配置', - 'description' => '告警模板配置', - '$ref' => '#/components/schemas/TemplateConfiguration', - ], - 'dashboard' => [ - 'title' => '告警绑定的dashboardId', - 'description' => '告警绑定的dashboardId', - 'type' => 'string', - 'example' => 'DasnboardExample', - ], - 'threshold' => [ - 'title' => '连续触发阈值', - 'description' => '连续触发阈值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'noDataFire' => [ - 'title' => '是否开启无数据告警', - 'description' => '是否开启无数据告警', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'noDataSeverity' => [ - 'title' => '无数据告警严重度', - 'description' => '无数据告警严重度', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'sendResolved' => [ - 'title' => '是否发送恢复告警', - 'description' => '是否发送恢复告警', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'muteUntil' => ['title' => '临时关闭时间', 'description' => '临时关闭时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1698907508'], + 'version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'required' => true, 'example' => '2.0', 'default' => '2.0'], + 'type' => ['title' => '告警规则类型', 'description' => '告警规则类型', 'type' => 'string', 'example' => 'default'], + 'templateConfiguration' => ['title' => '告警模板配置', 'description' => '告警模板配置', '$ref' => '#/components/schemas/TemplateConfiguration'], + 'dashboard' => ['title' => '告警绑定的dashboardId', 'description' => '告警绑定的dashboardId', 'type' => 'string', 'example' => 'DasnboardExample'], + 'threshold' => ['title' => '连续触发阈值', 'description' => '连续触发阈值', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'noDataFire' => ['title' => '是否开启无数据告警', 'description' => '是否开启无数据告警', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'noDataSeverity' => ['title' => '无数据告警严重度', 'description' => '无数据告警严重度', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'sendResolved' => ['title' => '是否发送恢复告警', 'description' => '是否发送恢复告警', 'type' => 'boolean', 'required' => true, 'example' => 'false'], 'queryList' => [ 'title' => '查询语句列表', 'description' => '查询语句列表', 'type' => 'array', - 'items' => [ - 'description' => '查询语句列表', - '$ref' => '#/components/schemas/AlertQuery', - ], + 'items' => ['description' => '查询语句列表', '$ref' => '#/components/schemas/AlertQuery'], 'required' => true, ], 'annotations' => [ 'title' => '告警标注', 'description' => '告警标注', 'type' => 'array', - 'items' => [ - 'description' => '标注信息', - '$ref' => '#/components/schemas/AlertTag', - ], + 'items' => ['description' => '标注信息', '$ref' => '#/components/schemas/AlertTag'], ], 'labels' => [ 'title' => '告警标签', 'description' => '告警标签', 'type' => 'array', - 'items' => [ - 'description' => '告警标签', - '$ref' => '#/components/schemas/AlertTag', - ], - ], - 'conditionConfiguration' => [ - 'title' => '告警触发条件', - 'description' => '告警触发条件', - '$ref' => '#/components/schemas/ConditionConfiguration', + 'items' => ['description' => '告警标签', '$ref' => '#/components/schemas/AlertTag'], ], + 'conditionConfiguration' => ['title' => '告警触发条件', 'description' => '告警触发条件', '$ref' => '#/components/schemas/ConditionConfiguration'], 'severityConfigurations' => [ 'title' => '告警严重度配置', 'description' => '告警严重度配置', 'type' => 'array', - 'items' => [ - 'description' => '告警严重度配置', - '$ref' => '#/components/schemas/SeverityConfiguration', - ], + 'items' => ['description' => '告警严重度配置', '$ref' => '#/components/schemas/SeverityConfiguration'], 'required' => true, ], 'joinConfigurations' => [ 'title' => '告警查询分析语句集合操作配置', 'description' => '告警查询分析语句集合操作配置', 'type' => 'array', - 'items' => [ - 'description' => '告警查询分析语句集合操作配置', - '$ref' => '#/components/schemas/JoinConfiguration', - ], - ], - 'groupConfiguration' => [ - 'title' => '分组评估配置', - 'description' => '分组评估配置', - 'required' => true, - '$ref' => '#/components/schemas/GroupConfiguration', - ], - 'policyConfiguration' => [ - 'title' => 'SLS告警通知服务配置', - 'description' => 'SLS告警通知服务配置', - '$ref' => '#/components/schemas/PolicyConfiguration', - ], - 'autoAnnotation' => [ - 'title' => '是否开启自动标注', - 'description' => '是否开启自动标注', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'sinkEventStore' => [ - 'title' => '发送给EventStore配置', - 'description' => '发送给EventStore配置', - '$ref' => '#/components/schemas/SinkEventStoreConfiguration', - ], - 'sinkCms' => [ - 'title' => '发送给云监控配置', - 'description' => '发送给云监控配置', - '$ref' => '#/components/schemas/SinkCmsConfiguration', - ], - 'sinkAlerthub' => [ - 'title' => '发送给SLS告警管理服务配置', - 'description' => '发送给SLS告警管理服务配置', - 'required' => false, - '$ref' => '#/components/schemas/SinkAlerthubConfiguration', - ], + 'items' => ['description' => '告警查询分析语句集合操作配置', '$ref' => '#/components/schemas/JoinConfiguration'], + ], + 'groupConfiguration' => ['title' => '分组评估配置', 'description' => '分组评估配置', 'required' => true, '$ref' => '#/components/schemas/GroupConfiguration'], + 'policyConfiguration' => ['title' => 'SLS告警通知服务配置', 'description' => 'SLS告警通知服务配置', '$ref' => '#/components/schemas/PolicyConfiguration'], + 'autoAnnotation' => ['title' => '是否开启自动标注', 'description' => '是否开启自动标注', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'sinkEventStore' => ['title' => '发送给EventStore配置', 'description' => '发送给EventStore配置', '$ref' => '#/components/schemas/SinkEventStoreConfiguration'], + 'sinkCms' => ['title' => '发送给云监控配置', 'description' => '发送给云监控配置', '$ref' => '#/components/schemas/SinkCmsConfiguration'], + 'sinkAlerthub' => ['title' => '发送给SLS告警管理服务配置', 'description' => '发送给SLS告警管理服务配置', 'required' => false, '$ref' => '#/components/schemas/SinkAlerthubConfiguration'], 'tags' => [ 'title' => '告警自定义标签', 'description' => '告警自定义标签', 'type' => 'array', - 'items' => [ - 'description' => '标签信息。', - 'type' => 'string', - 'example' => 'host', - ], + 'items' => ['description' => '标签信息。', 'type' => 'string', 'example' => 'host'], ], ], ], @@ -685,103 +295,19 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'chartTitle' => [ - 'title' => '图表名称', - 'description' => '图表名称', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'chartExmaple', - ], - 'query' => [ - 'title' => '查询分析语句', - 'description' => '查询分析语句', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '* | select *', - ], - 'timeSpanType' => [ - 'title' => '时间片类型', - 'description' => '时间片类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Relative', - ], - 'start' => [ - 'title' => '开始时间', - 'description' => '开始时间', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '-5m', - ], - 'end' => [ - 'title' => '结束时间', - 'description' => '结束时间', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'now', - ], - 'storeType' => [ - 'title' => 'store类型', - 'description' => 'store类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'log', - ], - 'project' => [ - 'title' => '项目名称', - 'description' => '项目名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'projectExample', - ], - 'store' => [ - 'title' => 'store名称', - 'description' => 'store名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'store Example', - ], - 'region' => [ - 'title' => '区域', - 'description' => '区域', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'roleArn' => [ - 'title' => '角色ARN', - 'description' => '角色ARN', - 'visibility' => 'Public', - 'type' => 'string', - ], - 'dashboardId' => [ - 'title' => '仪表盘ID', - 'description' => '仪表盘ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dashboardExample', - ], - 'powerSqlMode' => [ - 'title' => '是否开启独享SQL', - 'description' => '是否开启独享SQL', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'auto', - ], - 'ui' => [ - 'title' => '特定场景告警前端使用', - 'description' => '特定场景告警前端使用', - 'visibility' => 'Public', - 'type' => 'string', - ], + 'chartTitle' => ['title' => '图表名称', 'description' => '图表名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'chartExmaple'], + 'query' => ['title' => '查询分析语句', 'description' => '查询分析语句', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | select *'], + 'timeSpanType' => ['title' => '时间片类型', 'description' => '时间片类型', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'Relative'], + 'start' => ['title' => '开始时间', 'description' => '开始时间', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '-5m'], + 'end' => ['title' => '结束时间', 'description' => '结束时间', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'now'], + 'storeType' => ['title' => 'store类型', 'description' => 'store类型', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'log'], + 'project' => ['title' => '项目名称', 'description' => '项目名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'projectExample'], + 'store' => ['title' => 'store名称', 'description' => 'store名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'store Example'], + 'region' => ['title' => '区域', 'description' => '区域', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + 'roleArn' => ['title' => '角色ARN', 'description' => '角色ARN', 'visibility' => 'Public', 'type' => 'string'], + 'dashboardId' => ['title' => '仪表盘ID', 'description' => '仪表盘ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dashboardExample'], + 'powerSqlMode' => ['title' => '是否开启独享SQL', 'description' => '是否开启独享SQL', 'visibility' => 'Public', 'type' => 'string', 'example' => 'auto'], + 'ui' => ['title' => '特定场景告警前端使用', 'description' => '特定场景告警前端使用', 'visibility' => 'Public', 'type' => 'string'], ], ], 'AlertTag' => [ @@ -790,20 +316,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '键名', - 'description' => '键名', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'title', - ], - 'value' => [ - 'title' => '值', - 'description' => '值', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'example value', - ], + 'key' => ['title' => '键名', 'description' => '键名', 'visibility' => 'Public', 'type' => 'string', 'example' => 'title'], + 'value' => ['title' => '值', 'description' => '值', 'visibility' => 'Public', 'type' => 'string', 'example' => 'example value'], ], ], 'AsyncSqlResponseData' => [ @@ -811,88 +325,32 @@ 'description' => '异步SQL返回的数据结构', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '异步SQL的ID', - 'description' => '异步SQL的ID', - 'type' => 'string', - 'required' => true, - 'example' => '690C4F2A16FBD65C40000484_14', - ], - 'state' => [ - 'title' => '异步SQL的当前执行状态，可以为以下三个状态: ● RUNNING ● FINISHED ● FAILED ● CANCELLED 其中，RUNNING是临时状态, 表示SQL还在执行过程中。仅当状态为FINISHED时，才表示请求执行成功，可以读取结果了。', - 'description' => '异步SQL的当前执行状态，可以为以下三个状态: '."\n" - .'- RUNNING'."\n" - .'- FINISHED'."\n" - .'- FAILED'."\n" - .'- CANCELLED'."\n" - ."\n" - .'其中，RUNNING是临时状态, 表示SQL还在执行过程中。仅当状态为FINISHED时，才表示请求执行成功，可以读取结果了。另外，只有状态为FAILED时，返回结果中的error_code和error_message才有意义。', - 'type' => 'string', - 'required' => true, - 'example' => 'FINISHED', - ], + 'id' => ['title' => '异步SQL的ID', 'description' => '异步SQL的ID', 'type' => 'string', 'required' => true, 'example' => '690C4F2A16FBD65C40000484_14'], + 'state' => ['title' => '异步SQL的当前执行状态，可以为以下三个状态: ● RUNNING ● FINISHED ● FAILED ● CANCELLED 其中，RUNNING是临时状态, 表示SQL还在执行过程中。仅当状态为FINISHED时，才表示请求执行成功，可以读取结果了。', 'description' => '异步SQL的当前执行状态，可以为以下三个状态: '."\n" + .'- RUNNING'."\n" + .'- FINISHED'."\n" + .'- FAILED'."\n" + .'- CANCELLED'."\n" + ."\n" + .'其中，RUNNING是临时状态, 表示SQL还在执行过程中。仅当状态为FINISHED时，才表示请求执行成功，可以读取结果了。另外，只有状态为FAILED时，返回结果中的error_code和error_message才有意义。', 'type' => 'string', 'required' => true, 'example' => 'FINISHED'], 'AsyncSqlMetaPB' => [ 'title' => 'SQL相关的meta信息', 'description' => 'SQL相关的meta信息', 'type' => 'object', 'properties' => [ - 'result_rows' => [ - 'title' => '结果总行数。读取结果是，offset值不应该超过这个值。', - 'description' => '结果总行数。读取结果是，offset值不应该超过这个值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12000', - ], - 'processed_rows' => [ - 'title' => '处理的原始数据行数', - 'description' => '处理的原始数据行数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000000', - ], - 'elapsed_milli' => [ - 'title' => 'SQL执行时间（毫秒）', - 'description' => 'SQL执行时间（毫秒）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30000', - ], - 'cpu_sec' => [ - 'title' => '消耗的cpu总时间（秒）', - 'description' => '消耗的cpu总时间（秒）', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.2', - ], - 'cpu_cores' => [ - 'title' => '使用了多少个cpu core', - 'description' => '使用了多少个cpu core', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'progress' => [ - 'title' => 'SQL结果是否精确，它可以为以下两个值: ● Complete (表示结果精确) ● Incomplete (表示结果不精确)', - 'description' => 'SQL结果是否精确，它可以为以下两个值: '."\n" - .'- Complete (表示结果精确)'."\n" - .'- Incomplete (表示结果不精确)', - 'type' => 'string', - 'example' => 'Complete', - ], + 'result_rows' => ['title' => '结果总行数。读取结果是，offset值不应该超过这个值。', 'description' => '结果总行数。读取结果是，offset值不应该超过这个值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12000'], + 'processed_rows' => ['title' => '处理的原始数据行数', 'description' => '处理的原始数据行数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000000'], + 'elapsed_milli' => ['title' => 'SQL执行时间（毫秒）', 'description' => 'SQL执行时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30000'], + 'cpu_sec' => ['title' => '消耗的cpu总时间（秒）', 'description' => '消耗的cpu总时间（秒）', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.2'], + 'cpu_cores' => ['title' => '使用了多少个cpu core', 'description' => '使用了多少个cpu core', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + 'progress' => ['title' => 'SQL结果是否精确，它可以为以下两个值: ● Complete (表示结果精确) ● Incomplete (表示结果不精确)', 'description' => 'SQL结果是否精确，它可以为以下两个值: '."\n" + .'- Complete (表示结果精确)'."\n" + .'- Incomplete (表示结果不精确)', 'type' => 'string', 'example' => 'Complete'], 'keys' => [ 'title' => 'SQL结果对应的column名称，这里的keys和select中的字段是一一对应的。', 'description' => 'SQL结果对应的column名称，这里的keys和select中的字段是一一对应的。', 'type' => 'array', - 'items' => [ - 'description' => 'column名称', - 'type' => 'string', - 'example' => '["name", "age", "gender"]', - ], + 'items' => ['description' => 'column名称', 'type' => 'string', 'example' => '["name", "age", "gender"]'], ], ], 'required' => false, @@ -904,25 +362,28 @@ 'items' => [ 'description' => '某行结果', 'type' => 'array', - 'items' => [ - 'description' => '某列结果', - 'type' => 'string', - 'example' => '["Jimmy", "20", "male"]', - ], + 'items' => ['description' => '某列结果', 'type' => 'string', 'example' => '["Jimmy", "20", "male"]'], ], ], - 'error_code' => [ - 'title' => 'SQL执行失败后，error_code中包含了具体的错误码', - 'description' => 'SQL执行失败后，error_code中包含了具体的错误码', - 'type' => 'string', - 'example' => 'InvalidQuery', - ], - 'error_message' => [ - 'title' => 'SQL执行失败后，error_message中包含了具体的错误信息', - 'description' => 'SQL执行失败后，error_message中包含了具体的错误信息', - 'type' => 'string', - 'example' => 'line 37:14: Column \'xyz\' cannot be resolved', - ], + 'error_code' => ['title' => 'SQL执行失败后，error_code中包含了具体的错误码', 'description' => 'SQL执行失败后，error_code中包含了具体的错误码', 'type' => 'string', 'example' => 'InvalidQuery'], + 'error_message' => ['title' => 'SQL执行失败后，error_message中包含了具体的错误信息', 'description' => 'SQL执行失败后，error_message中包含了具体的错误信息', 'type' => 'string', 'example' => 'line 37:14: Column \'xyz\' cannot be resolved'], + ], + ], + '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' => [ @@ -930,14 +391,8 @@ 'description' => 'S3导入配置', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'type' => 'string', - 'example' => 'myLogstore', - ], - 'source' => [ - '$ref' => '#/components/schemas/AzureBlobIngestionConfigurationSource', - ], + 'logstore' => ['title' => 'logstore', 'type' => 'string', 'example' => 'myLogstore'], + 'source' => ['$ref' => '#/components/schemas/AzureBlobIngestionConfigurationSource'], ], ], 'AzureBlobIngestionConfigurationSource' => [ @@ -945,126 +400,33 @@ 'description' => 'Azure blob导入配置', 'type' => 'object', 'properties' => [ - 'compressionCodec' => [ - 'title' => '压缩类型：none,snappy,gzip', - 'description' => '压缩类型：none,snappy,gzip', - 'type' => 'string', - 'required' => true, - 'example' => 'none', - ], - 'encoding' => [ - 'title' => '编码类型', - 'description' => '编码类型', - 'type' => 'string', - 'required' => true, - 'example' => 'UTF-8', - ], - 'interval' => [ - 'title' => '检查新文件周期', - 'description' => '检查新文件周期', - 'type' => 'string', + 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => '压缩类型：none,snappy,gzip', 'type' => 'string', 'required' => true, 'example' => 'none'], + 'encoding' => ['title' => '编码类型', 'description' => '编码类型', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], + 'interval' => ['title' => '检查新文件周期', 'description' => '检查新文件周期', 'type' => 'string', 'required' => true, 'example' => '30m'], + 'pattern' => ['title' => '文件路径正则过滤', 'description' => '文件路径正则过滤', 'type' => 'string', 'example' => '.*'], + 'prefix' => ['title' => '文件路径前缀过滤', 'description' => '文件路径前缀过滤', 'type' => 'string', 'example' => 'prefix'], + 'tagPackId' => ['title' => '支持上下文浏览', 'description' => '支持上下文浏览', 'type' => 'boolean', 'example' => 'false'], + 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => '某个时间点后修改过的文件', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274081'], + 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => '某个时间点前修改过的文件', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'timeField' => ['title' => '提取时间字段', 'description' => '提取时间字段', 'type' => 'string', 'example' => '__time__'], + 'timeFormat' => ['title' => '时间字段格式', 'description' => '时间字段格式', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], + 'timePattern' => ['title' => '提取时间正则', 'description' => '提取时间正则', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], + 'timeZone' => ['title' => '时间字段分区', 'description' => '时间字段分区', 'type' => 'string', 'example' => 'GMT+08:00'], + 'processorId' => ['title' => '写入处理器ID', 'description' => '写入处理器ID', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + 'accountName' => ['title' => '账户名', 'description' => '账户名', 'type' => 'string', 'required' => true, 'example' => 'test001'], + 'accountKey' => ['title' => '账户密钥', 'description' => '账户密钥', 'type' => 'string', 'required' => true, 'example' => 'dGVzdGtleQ=='], + 'containerName' => ['title' => '容器名', 'description' => '容器名', 'type' => 'string', 'required' => true, 'example' => 'test-container'], + 'endpoint' => ['description' => '服务入口Endpoint。', 'type' => 'string', 'required' => false, 'example' => 'https://your-storage.blob.core.windows.net'], + 'format' => [ + 'title' => '格式', + 'description' => '格式', + 'type' => 'object', 'required' => true, - 'example' => '30m', - ], - 'pattern' => [ - 'title' => '文件路径正则过滤', - 'description' => '文件路径正则过滤', - 'type' => 'string', - 'example' => '.*', - ], - 'prefix' => [ - 'title' => '文件路径前缀过滤', - 'description' => '文件路径前缀过滤', - 'type' => 'string', - 'example' => 'prefix', - ], - 'tagPackId' => [ - 'title' => '支持上下文浏览', - 'description' => '支持上下文浏览', - 'type' => 'boolean', - 'example' => 'false', + 'additionalProperties' => ['description' => '数据格式', 'type' => 'any', 'example' => '{"type": "line"}'], ], - 'startTime' => [ - 'title' => '某个时间点后修改过的文件', - 'description' => '某个时间点后修改过的文件', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714274081', - ], - 'endTime' => [ - 'title' => '某个时间点前修改过的文件', - 'description' => '某个时间点前修改过的文件', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - ], - 'timeField' => [ - 'title' => '提取时间字段', - 'description' => '提取时间字段', - 'type' => 'string', - 'example' => '__time__', - ], - 'timeFormat' => [ - 'title' => '时间字段格式', - 'description' => '时间字段格式', - 'type' => 'string', - 'example' => 'yyyy-MM-dd HH:mm:ss', - ], - 'timePattern' => [ - 'title' => '提取时间正则', - 'description' => '提取时间正则', - 'type' => 'string', - 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+', - ], - 'timeZone' => [ - 'title' => '时间字段分区', - 'description' => '时间字段分区', - 'type' => 'string', - 'example' => 'GMT+08:00', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'description' => '写入处理器ID', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - ], - 'accountName' => [ - 'title' => '账户名', - 'description' => '账户名', - 'type' => 'string', - 'required' => true, - 'example' => 'test001', - ], - 'accountKey' => [ - 'title' => '账户密钥', - 'description' => '账户密钥', - 'type' => 'string', - 'required' => true, - 'example' => 'dGVzdGtleQ==', - ], - 'containerName' => [ - 'title' => '容器名', - 'description' => '容器名', - 'type' => 'string', - 'required' => true, - 'example' => 'test-container', - ], - 'endpoint' => [ - 'description' => '服务入口Endpoint。', - 'type' => 'string', - 'required' => false, - 'example' => 'https://your-storage.blob.core.windows.net', - ], - 'format' => [ - 'title' => '格式', - 'description' => '格式', - 'type' => 'object', - 'required' => true, - 'additionalProperties' => [ - 'description' => '数据格式', - 'type' => 'any', - 'example' => '{"type": "line"}', - ], + 'advancedParameters' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'any'], ], ], ], @@ -1074,44 +436,11 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'title' => [ - 'title' => '图表标题。支持大小写英文字母、数字、下划线_、连字符-，连字符与下划线不能作为名称开头与结尾，长度必须在[2,64] 之间。', - 'description' => '图表标题。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-chart', - ], - 'type' => [ - 'title' => '图表的类型。', - 'description' => '图表类型。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'linepro', - ], - 'search' => [ - 'title' => '查询配置', - 'description' => '查询配置。', - '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' => '图表的显示配置。', - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - ], - 'action' => [ - 'title' => 'action', - 'description' => 'action', - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - ], + 'title' => ['title' => '图表标题。支持大小写英文字母、数字、下划线_、连字符-，连字符与下划线不能作为名称开头与结尾，长度必须在[2,64] 之间。', 'description' => '图表标题。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-chart'], + 'type' => ['title' => '图表的类型。', 'description' => '图表类型。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'linepro'], + 'search' => ['title' => '查询配置', 'description' => '查询配置。', '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' => '图表的显示配置。', 'visibility' => 'Public', 'type' => 'object', 'required' => true], + 'action' => ['title' => 'action', 'description' => 'action', 'visibility' => 'Public', 'type' => 'object', 'required' => true], ], ], 'ConditionConfiguration' => [ @@ -1120,20 +449,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'condition' => [ - 'title' => '评估表达式', - 'description' => '评估表达式', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cnt > 100', - ], - 'countCondition' => [ - 'title' => '满足评估表达式的结果条数', - 'description' => '满足评估表达式的结果条数', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '__count__ > 5', - ], + 'condition' => ['title' => '评估表达式', 'description' => '评估表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cnt > 100'], + 'countCondition' => ['title' => '满足评估表达式的结果条数', 'description' => '满足评估表达式的结果条数', 'visibility' => 'Public', 'type' => 'string', 'example' => '__count__ > 5'], ], ], 'ConsumeProcessor' => [ @@ -1142,52 +459,12 @@ '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', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717171200', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717171200', - ], + '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'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1717171200'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1717171200'], ], ], 'ConsumeProcessorConfiguration' => [ @@ -1196,14 +473,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'spl' => [ - 'title' => 'SPL语句', - 'description' => 'SPL语句', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '* | project content', - ], + 'spl' => ['title' => 'SPL语句', 'description' => 'SPL语句', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | project content'], ], ], 'ConsumerGroup' => [ @@ -1212,31 +482,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '消费者名称。', - 'description' => '消费组名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test-consumer-group', - ], - 'timeout' => [ - 'title' => '消费超时时长，单位为秒', - 'description' => '超时时间。在超时时间段内没有收到心跳，消费者将被删除。单位：秒。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'order' => [ - 'title' => '是否有序消费', - 'description' => '是否按顺序消费。'."\n" - ."\n" - .'- true：在Shard中按顺序消费。Shard分裂后，先消费原Shard中数据，然后同时消费由该Shard分裂的Shard中数据。Shard合并后，先消费原Shard中数据，然后消费由原Shard合并后的新Shard中数据。'."\n" - .'- false：不按顺序消费。即所有同时开始消费，Shard分裂或者合并后产生的新Shard，也会立即消费。', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], + 'name' => ['title' => '消费者名称。', 'description' => '消费组名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test-consumer-group'], + 'timeout' => ['title' => '消费超时时长，单位为秒', 'description' => '超时时间。在超时时间段内没有收到心跳，消费者将被删除。单位：秒。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'order' => ['title' => '是否有序消费', 'description' => '是否按顺序消费。'."\n" + ."\n" + .'- true：在Shard中按顺序消费。Shard分裂后，先消费原Shard中数据，然后同时消费由该Shard分裂的Shard中数据。Shard合并后，先消费原Shard中数据，然后消费由原Shard合并后的新Shard中数据。'."\n" + .'- false：不按顺序消费。即所有同时开始消费，Shard分裂或者合并后产生的新Shard，也会立即消费。', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'], ], ], 'dashboard' => [ @@ -1245,53 +496,22 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'dashboardName' => [ - 'title' => '仪表盘ID。同一个Project下，仪表盘ID唯一，不可重复。', - 'description' => '仪表盘的内部显示名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], - 'displayName' => [ - 'title' => '仪表盘的展示名称。', - 'description' => '仪表盘的展示名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-alert', - ], - 'description' => [ - 'title' => '描述信息。', - 'description' => '仪表盘的描述信息。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a dashboard', - ], + 'dashboardName' => ['title' => '仪表盘ID。同一个Project下，仪表盘ID唯一，不可重复。', 'description' => '仪表盘的内部显示名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], + 'displayName' => ['title' => '仪表盘的展示名称。', 'description' => '仪表盘的展示名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-alert'], + 'description' => ['title' => '描述信息。', 'description' => '仪表盘的描述信息。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'this is a dashboard'], 'attribute' => [ 'title' => '属性值，可用于修改仪表盘的布局等属性，例如 "type": "free" 自由布局， "type":"grid" 网格布局。', 'description' => '仪表盘的属性值。', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '仪表盘的属性值。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'yyy', - ], + 'additionalProperties' => ['description' => '仪表盘的属性值。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'yyy'], ], 'charts' => [ 'title' => '仪表盘内包含的图表。', 'description' => '仪表盘包含的图表。', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '图表的数据结构。', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/chart', - ], + 'items' => ['description' => '图表的数据结构。', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/chart'], 'required' => true, ], ], @@ -1300,39 +520,13 @@ 'title' => '软删除任务', 'type' => 'object', 'properties' => [ - 'progress' => [ - 'title' => '进度', - 'type' => 'integer', - 'format' => 'int32', - ], - 'taskId' => [ - 'title' => 'id', - 'type' => 'string', - 'required' => false, - ], - 'query' => [ - 'title' => '使用的query', - 'type' => 'string', - ], - 'errorCode' => [ - 'title' => '出错时的errorCode', - 'type' => 'integer', - 'format' => 'int32', - ], - 'from' => [ - 'title' => '起始时间', - 'type' => 'integer', - 'format' => 'int32', - ], - 'to' => [ - 'title' => '结束时间', - 'type' => 'integer', - 'format' => 'int32', - ], - 'errorMessage' => [ - 'title' => '出错时的errorMessage', - 'type' => 'string', - ], + 'progress' => ['title' => '进度', 'type' => 'integer', 'format' => 'int32'], + 'taskId' => ['title' => 'id', 'type' => 'string', 'required' => false], + 'query' => ['title' => '使用的query', 'type' => 'string'], + 'errorCode' => ['title' => '出错时的errorCode', 'type' => 'integer', 'format' => 'int32'], + 'from' => ['title' => '起始时间', 'type' => 'integer', 'format' => 'int32'], + 'to' => ['title' => '结束时间', 'type' => 'integer', 'format' => 'int32'], + 'errorMessage' => ['title' => '出错时的errorMessage', 'type' => 'string'], ], 'description' => '软删除任务', ], @@ -1342,45 +536,21 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enable' => [ - 'title' => 'enable', - 'description' => '是否启用数据加密。'."\n" - ."\n" - .'- true：是'."\n" - .'- false：否', - 'visibility' => 'Public', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'true', - ], + 'enable' => ['title' => 'enable', 'description' => '是否启用数据加密。'."\n" + ."\n" + .'- true：是'."\n" + .'- false：否', 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'true'], 'encrypt_type' => [ 'title' => '加密算法，只支持default和m4。当 enable 为 true 时，此项必选。', 'description' => '加密算法类型，支持 default、m4、sm4_ecb、sm4_cbc、sm4_gcm、aes_ecb、aes_cbc、aes_cfb、aes_ofb、aes_gcm。当enable为true时，此项必选。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, - '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', - ], + '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'], 'example' => 'default', 'default' => 'default', ], - 'user_cmk_info' => [ - 'description' => '可选字段。如果设置该字段，则表示使用自带密钥（BYOK），否则使用日志服务的服务密钥。', - 'visibility' => 'Public', - 'example' => ' { "cmk_key_id" : "f5136b95-2420-ab31-xxxxxxxxx" "arn" : "acs:ram::13234:role/logsource" "region_id" : "cn-hangzhou" }', - '$ref' => '#/components/schemas/EncryptUserCmkConf', - ], + 'user_cmk_info' => ['description' => '可选字段。如果设置该字段，则表示使用自带密钥（BYOK），否则使用日志服务的服务密钥。', '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' => [ @@ -1389,85 +559,24 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'cmk_key_id' => [ - 'title' => 'cmk_key_id', - 'description' => 'BYOK的主密钥ID。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'f5136b95-2420-ab31-xxxxxxxxx', - ], - 'arn' => [ - 'title' => 'arn', - 'description' => 'RAM角色的ARN。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::13234:role/logsource', - ], - 'region_id' => [ - 'title' => 'region_id', - 'description' => '主密钥所在的地域ID。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'cmk_key_id' => ['title' => 'cmk_key_id', 'description' => 'BYOK的主密钥ID。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'f5136b95-2420-ab31-xxxxxxxxx'], + 'arn' => ['title' => 'arn', 'description' => 'RAM角色的ARN。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logsource'], + 'region_id' => ['title' => 'region_id', 'description' => '主密钥所在的地域ID。', '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' => [ - 'title' => 'job description', - 'type' => 'string', - 'example' => 'es ingestion', - ], - 'displayName' => [ - 'title' => 'job displayName', - 'type' => 'string', - 'required' => true, - 'example' => 'es ingestion', - ], - 'schedule' => [ - 'title' => '调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'title' => 'es导入配置', - 'required' => true, - '$ref' => '#/components/schemas/ESIngestionConfiguration', - ], - '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', - ], + 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-es-123456'], + 'description' => ['title' => 'job description', 'type' => 'string', 'example' => 'es ingestion'], + 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'es ingestion'], + 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['title' => 'es导入配置', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration'], + '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'], ], 'description' => 'es ingestion job', ], @@ -1476,122 +585,29 @@ 'description' => 'es导入配置', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'description' => 'logstore', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'source' => [ - 'description' => '来源', - 'required' => true, - '$ref' => '#/components/schemas/ESIngestionConfigurationSource', - ], + 'logstore' => ['title' => 'logstore', 'description' => 'logstore', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'source' => ['description' => '来源', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfigurationSource'], ], ], 'ESIngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'description' => 'es导入资源配置', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'BootstrapServers' => [ - 'title' => '服务实例URL', - 'description' => '服务实例URL', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - ], - 'Index' => [ - 'title' => 'ES索引列表', - 'description' => 'ES索引列表', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - ], - 'Username' => [ - 'title' => 'ES用户名称', - 'description' => 'ES用户名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - ], - 'Password' => [ - 'title' => 'ES用户密码', - 'description' => 'ES用户密码', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - ], - 'TimeFieldName' => [ - 'title' => '时间字段', - 'description' => '时间字段', - 'visibility' => 'Public', - 'type' => 'string', - ], - 'TimeFormat' => [ - 'title' => '时间字段格式', - 'description' => '时间字段格式', - 'visibility' => 'Public', - 'type' => 'string', - ], - 'TimeZone' => [ - 'title' => '时间字段时区', - 'description' => '时间字段时区', - 'visibility' => 'Public', - 'type' => 'string', - ], - 'Query' => [ - 'title' => 'ES查询', - 'description' => 'ES查询', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - ], - 'ConnectorMode' => [ - 'title' => '导入模式', - 'description' => '导入模式', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - ], - 'StartTime' => [ - 'title' => '起始时间', - 'description' => '起始时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'description' => '结束时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - ], - 'MaxDataDelaySec' => [ - 'title' => '数据最大延迟秒数', - 'description' => '数据最大延迟秒数', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], - 'MinFragRangeSec' => [ - 'title' => '检查新数据周期（秒）', - 'description' => '检查新数据周期（秒）', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], - 'VpcId' => [ - 'title' => 'VPC实例ID', - 'description' => 'VPC实例ID', - 'visibility' => 'Public', - 'type' => 'string', - ], + 'BootstrapServers' => ['title' => '服务实例URL', 'description' => '服务实例URL', 'type' => 'string', 'required' => true], + 'Index' => ['title' => 'ES索引列表', 'description' => 'ES索引列表', 'type' => 'string', 'required' => true], + 'Username' => ['title' => 'ES用户名称', 'description' => 'ES用户名称', 'type' => 'string', 'required' => false], + 'Password' => ['title' => 'ES用户密码', 'description' => 'ES用户密码', 'type' => 'string', 'required' => false], + 'TimeFieldName' => ['title' => '时间字段', 'description' => '时间字段', 'type' => 'string'], + 'TimeFormat' => ['title' => '时间字段格式', 'description' => '时间字段格式', 'type' => 'string'], + 'TimeZone' => ['title' => '时间字段时区', 'description' => '时间字段时区', 'type' => 'string'], + 'Query' => ['title' => 'ES查询', 'description' => 'ES查询', 'type' => 'string', 'required' => true], + 'ConnectorMode' => ['title' => '导入模式', 'description' => '导入模式', 'type' => 'string', 'required' => true], + 'StartTime' => ['title' => '起始时间', 'description' => '起始时间', 'type' => 'integer', 'format' => 'int64'], + 'EndTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'integer', 'format' => 'int64'], + 'MaxDataDelaySec' => ['title' => '数据最大延迟秒数', 'description' => '数据最大延迟秒数', 'type' => 'integer', 'format' => 'int64', 'required' => true], + 'MinFragRangeSec' => ['title' => '检查新数据周期（秒）', 'description' => '检查新数据周期（秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true], + 'VpcId' => ['title' => 'VPC实例ID', 'description' => 'VPC实例ID', 'type' => 'string'], ], ], 'ETL' => [ @@ -1600,75 +616,21 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '任务名称', - 'description' => 'job name', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'etl-20240426', - ], - 'description' => [ - 'title' => '任务描述', - 'description' => 'job description', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '加工作业', - ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => 'job displayName', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'etljob', - ], - 'configuration' => [ - 'title' => '数据加工配置', - 'description' => '数据加工配置', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/ETLConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1714274900', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'description' => '最近一次修改时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1714274900', - ], - 'status' => [ - 'title' => '加工状态', - 'description' => '加工状态，表示返回加工任务的状态，取值包括：'."\n" - .'1. RUNNING：运行中'."\n" - .'2. STOPPING: 停止中'."\n" - .'3. STOPPED: 已停止'."\n" - .'4. SUCCEEDED: 运行成功'."\n" - .'5. FAILED: 运行失败'."\n" - .'6. STARTING：启动中'."\n" - .'7. RESTARTING：重启中', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'scheduleId' => [ - 'title' => '调度ID', - 'description' => '调度ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'f0eb655e501a8780808d1970ef6d04c4', - ], + 'name' => ['title' => '任务名称', 'description' => 'job name', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'etl-20240426'], + 'description' => ['title' => '任务描述', 'description' => 'job description', 'visibility' => 'Public', 'type' => 'string', 'example' => '加工作业'], + 'displayName' => ['title' => '显示名称', 'description' => 'job displayName', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'etljob'], + 'configuration' => ['title' => '数据加工配置', 'description' => '数据加工配置', 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1714274900'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => '最近一次修改时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1714274900'], + 'status' => ['title' => '加工状态', 'description' => '加工状态，表示返回加工任务的状态，取值包括：'."\n" + .'1. RUNNING：运行中'."\n" + .'2. STOPPING: 停止中'."\n" + .'3. STOPPED: 已停止'."\n" + .'4. SUCCEEDED: 运行成功'."\n" + .'5. FAILED: 运行失败'."\n" + .'6. STARTING：启动中'."\n" + .'7. RESTARTING：重启中', 'visibility' => 'Public', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '调度ID', 'description' => '调度ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'f0eb655e501a8780808d1970ef6d04c4'], ], ], 'ETLConfiguration' => [ @@ -1677,166 +639,46 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'script' => [ - 'title' => '加工脚本', - 'description' => '加工脚本', + 'script' => ['title' => '加工脚本', 'description' => '加工脚本', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | extend key=\'value\''], + 'lang' => ['title' => '数据加工语法类型', 'description' => '数据加工语法类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SPL'], + 'logstore' => ['title' => '源Logstore名称', 'description' => '源Logstore名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'roleArn' => ['title' => '授权读取源Logstore的角色ARN', 'description' => '授权读取源Logstore的角色ARN', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logtarget'], + 'accessKeyId' => ['title' => '授权读取源Logstore的AccessKey ID，必填。使用角色授权时，填入空字符串', 'description' => '授权读取源Logstore的AccessKey ID，必填。使用角色授权时，填入空字符串', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => true, 'required' => false], + 'accessKeySecret' => ['title' => '授权读取源Logstore的AccessKey Secret，必填。使用角色授权时，填入空字符串。', 'description' => '授权读取源Logstore的AccessKey Secret，必填。使用角色授权时，填入空字符串。', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => true, 'required' => false], + 'fromTime' => ['title' => '加工时间起点时间戳（精确到秒），必填。从源Logstore中最早接收到的第一条日志开始消费时，填入0', 'description' => '加工时间起点时间戳（精确到秒），必填。从源Logstore中最早接收到的第一条日志开始消费时，填入0', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], + 'toTime' => ['title' => '加工时间结束时间戳（精确到秒），必填。持续消费至手动停止时，填入0', 'description' => '加工时间结束时间戳（精确到秒），必填。持续消费至手动停止时，填入0', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], + 'sinks' => [ + 'title' => '加工结果输出目标列表', + 'description' => '加工结果输出目标列表', 'visibility' => 'Public', - 'type' => 'string', + 'type' => 'array', + 'items' => ['visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/ETLConfigurationSink'], 'required' => true, - 'example' => '* | extend key=\'value\'', ], - 'lang' => [ - 'title' => '数据加工语法类型', - 'description' => '数据加工语法类型', + 'parameters' => ['title' => '高级参数配置', 'description' => '高级参数配置', 'visibility' => 'Public', 'type' => 'object', 'example' => 'config.vpc.vpc_id.test1：vpc-uf6mskb0b****n9yj'], + ], + ], + 'ETLConfigurationSink' => [ + 'title' => 'A short description of struct', + 'description' => 'ETLSinkObject', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '输出目标名称', 'description' => '输出目标名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-etljob'], + 'endpoint' => ['title' => '目标Project所在区域的endpoint', 'description' => '目标Project所在区域的endpoint', 'visibility' => 'Public', 'type' => 'string'], + 'project' => ['title' => '目标Project名称', 'description' => '目标Project名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-project'], + 'logstore' => ['title' => '目标Logstore名称', 'description' => '目标Logstore名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'datasets' => [ + 'title' => '写入结果集', + 'description' => '写入结果集', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPL', - ], - 'logstore' => [ - 'title' => '源Logstore名称', - 'description' => '源Logstore名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'roleArn' => [ - 'title' => '授权读取源Logstore的角色ARN', - 'description' => '授权读取源Logstore的角色ARN', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::13234:role/logtarget', - ], - 'accessKeyId' => [ - 'title' => '授权读取源Logstore的AccessKey ID，必填。使用角色授权时，填入空字符串', - 'description' => '授权读取源Logstore的AccessKey ID，必填。使用角色授权时，填入空字符串', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - ], - 'accessKeySecret' => [ - 'title' => '授权读取源Logstore的AccessKey Secret，必填。使用角色授权时，填入空字符串。', - 'description' => '授权读取源Logstore的AccessKey Secret，必填。使用角色授权时，填入空字符串。', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - ], - 'fromTime' => [ - 'title' => '加工时间起点时间戳（精确到秒），必填。从源Logstore中最早接收到的第一条日志开始消费时，填入0', - 'description' => '加工时间起点时间戳（精确到秒），必填。从源Logstore中最早接收到的第一条日志开始消费时，填入0', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - 'toTime' => [ - 'title' => '加工时间结束时间戳（精确到秒），必填。持续消费至手动停止时，填入0', - 'description' => '加工时间结束时间戳（精确到秒），必填。持续消费至手动停止时，填入0', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - 'sinks' => [ - 'title' => '加工结果输出目标列表', - 'description' => '加工结果输出目标列表', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ETLConfigurationSink', - ], - 'required' => true, - ], - 'parameters' => [ - 'title' => '高级参数配置', - 'description' => '高级参数配置', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => 'config.vpc.vpc_id.test1：vpc-uf6mskb0b****n9yj', - ], - ], - ], - 'ETLConfigurationSink' => [ - 'title' => 'A short description of struct', - 'description' => 'ETLSinkObject', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '输出目标名称', - 'description' => '输出目标名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-etljob', - ], - 'endpoint' => [ - 'title' => '目标Project所在区域的endpoint', - 'description' => '目标Project所在区域的endpoint', - 'visibility' => 'Public', - 'type' => 'string', - ], - 'project' => [ - 'title' => '目标Project名称', - 'description' => '目标Project名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], - 'logstore' => [ - 'title' => '目标Logstore名称', - 'description' => '目标Logstore名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'datasets' => [ - 'title' => '写入结果集', - 'description' => '写入结果集', - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '__UNNAMED__', - 'extendType' => 'true', - ], - 'minItems' => 1, - ], - 'roleArn' => [ - 'title' => '授权写入目标Logstore的角色ARN', - 'description' => '授权写入目标Logstore的角色ARN', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::13234:role/logtarget', - ], - 'accessKeyId' => [ - 'title' => '授权写入目标Logstore的AccessKey ID', - 'description' => '授权写入目标Logstore的AccessKey ID', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - ], - 'accessKeySecret' => [ - 'title' => '授权写入目标Logstore的AccessKey Secret', - 'description' => '授权写入目标Logstore的AccessKey Secret', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, + 'type' => 'array', + 'items' => ['visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '__UNNAMED__', 'extendType' => 'true'], + 'minItems' => 1, ], + 'roleArn' => ['title' => '授权写入目标Logstore的角色ARN', 'description' => '授权写入目标Logstore的角色ARN', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logtarget'], + 'accessKeyId' => ['title' => '授权写入目标Logstore的AccessKey ID', 'description' => '授权写入目标Logstore的AccessKey ID', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => true, 'required' => false], + 'accessKeySecret' => ['title' => '授权写入目标Logstore的AccessKey Secret', 'description' => '授权写入目标Logstore的AccessKey Secret', 'visibility' => 'Public', 'type' => 'string', 'deprecated' => true, 'required' => false], ], ], 'etlJob' => [ @@ -1845,28 +687,14 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'etlJobName' => [ - 'title' => '任务名称', - 'description' => '数据加工任务名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'etl-name', - ], + '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', - ], + 'logstoreName' => ['title' => 'logstore 名称', 'description' => 'Logstore名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], ], 'required' => true, ], @@ -1876,48 +704,11 @@ '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', - ], + '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, ], @@ -1927,109 +718,27 @@ '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', - ], + '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', - ], + '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', - ], + '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, ], @@ -2041,44 +750,11 @@ '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', - ], + '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' => [ @@ -2087,57 +763,79 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'externalStoreName' => [ - 'title' => '外部存储的名称。', - 'description' => '外部存储名称，在同一Project中名称不能重复，且和Logstore名称不能重复。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'rds_store', - ], - 'storeType' => [ - 'title' => '类型。可选 rds-vpc 或者 oss', - 'description' => '存储类型。固定取值为rds-vpc，表示VPC下的RDS MySQL数据库。', - 'visibility' => 'Public', - 'type' => 'string', + 'externalStoreName' => ['title' => '外部存储的名称。', 'description' => '外部存储名称，在同一Project中名称不能重复，且和Logstore名称不能重复。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'rds_store'], + 'storeType' => ['title' => '类型。可选 rds-vpc 或者 oss', 'description' => '存储类型。固定取值为rds-vpc，表示VPC下的RDS MySQL数据库。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'rds-vpc'], + 'parameter' => ['title' => '参数', 'description' => '外部存储的配置参数。', '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', + 'description' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '导入任务名称', 'description' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-123456'], + 'description' => ['title' => 'job description', 'description' => 'job description', 'type' => 'string', 'example' => 'gcs ingestion'], + 'displayName' => ['title' => 'job displayName', 'description' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'gcs ingestion'], + 'configuration' => ['title' => 'gcs导入配置', 'description' => 'gcs导入配置', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'status' => ['title' => '导入状态', 'description' => '导入状态', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], + 'lastModifiedTime' => ['description' => '最后一次修改的时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360581'], + ], + ], + 'GCSIngestionConfiguration' => [ + 'description' => 'gcs导入配置', + 'type' => 'object', + 'properties' => [ + 'logstore' => ['title' => 'logstore', 'description' => 'logstore', 'type' => 'string', 'required' => true, 'example' => 'myLogstore'], + 'source' => ['description' => '来源', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfigurationSource'], + ], + ], + 'GCSIngestionConfigurationSource' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'endpoint' => ['title' => 'gcs endpoint', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-hangzhou.aliyuncs.com'], + 'bucket' => ['title' => 'gcs bucket', 'type' => 'string', 'required' => true, 'example' => 'gcsbucket'], + 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'type' => 'string', 'required' => true, 'example' => 'none'], + 'encoding' => ['title' => '编码类型', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], + 'interval' => ['title' => '检查新文件周期', 'type' => 'string', 'required' => true, 'example' => 'never'], + 'pattern' => ['title' => '文件路径正则过滤', 'type' => 'string', 'example' => '.*'], + 'prefix' => ['title' => '文件路径前缀过滤', 'type' => 'string', 'example' => 'prefix'], + 'restoreObjectEnabled' => ['title' => '导入归档文件', 'type' => 'boolean', 'required' => false, 'default' => 'true'], + 'startTime' => ['title' => '某个时间点后修改过的文件', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274081'], + 'endTime' => ['title' => '某个时间点前修改过的文件', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'timeField' => ['title' => '提取时间字段', 'type' => 'string', 'example' => '__time__'], + 'timeFormat' => ['title' => '时间字段格式', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], + 'timePattern' => ['title' => '提取时间正则', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], + 'timeZone' => ['title' => '时间字段分区', 'type' => 'string', 'example' => 'GMT+08:00'], + 'tagPackId' => ['title' => '启动上下文检索', 'type' => 'boolean', 'default' => 'true'], + 'processorId' => ['title' => '写入处理器id', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + 'accessKeyId' => ['type' => 'string', 'required' => true], + 'accessKeySecret' => ['type' => 'string', 'required' => true], + 'format' => [ + 'title' => '格式', + 'type' => 'object', 'required' => true, - 'example' => 'rds-vpc', + 'additionalProperties' => ['type' => 'any'], ], - 'parameter' => [ - 'title' => '参数', - 'description' => '外部存储的配置参数。', - 'visibility' => 'Public', + 'advancedParameters' => [ '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" }', + 'additionalProperties' => ['type' => 'any'], ], ], ], 'GroupConfiguration' => [ - 'title' => '告警分组评估配置', + 'title' => '告警分组评估配置.', 'description' => '告警分组评估配置', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => '分组评估类型', - 'description' => '分组评估类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'custom', - ], + 'type' => ['title' => '分组评估类型', 'description' => '分组评估类型', 'type' => 'string', 'required' => true, 'example' => 'custom'], 'fields' => [ 'title' => '分组评估字段', 'description' => '分组评估字段', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'id', - 'extendType' => 'true', - ], + 'items' => ['type' => 'string', 'example' => 'id', 'description' => ''], ], ], ], @@ -2147,155 +845,144 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'from' => [ - 'title' => '开始', - 'description' => '子时间区间的开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1409529600', - ], - 'to' => [ - 'title' => '结束', - 'description' => '子时间区间的结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1409569200', - ], - 'count' => [ - 'title' => 'count', - 'description' => '该子时间区间内查询到的日志条数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'progress' => [ - 'title' => 'progress', - 'description' => '当前查询结果在该子时间区间内的结果是否完整。'."\n" - ."\n" - .'- Complete：查询已经完成，返回结果为完整结果。'."\n" - .'- Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Complete', - ], + 'from' => ['title' => '开始', 'description' => '子时间区间的开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1409529600'], + 'to' => ['title' => '结束', 'description' => '子时间区间的结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1409569200'], + 'count' => ['title' => 'count', 'description' => '该子时间区间内查询到的日志条数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'progress' => ['title' => 'progress', 'description' => '当前查询结果在该子时间区间内的结果是否完整。'."\n" + ."\n" + .'- Complete：查询已经完成，返回结果为完整结果。'."\n" + .'- Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Complete'], ], ], 'index' => [ 'title' => '日志索引', - 'description' => '索引配置数据结构。', + 'description' => '索引配置数据结构。'."\n" + ."\n" + .'场景 1 (只开启全文索引）:'."\n" + .'```'."\n" + .'{'."\n" + .' "line": {'."\n" + .' "chn": false,'."\n" + .' "caseSensitive": false,'."\n" + .' "token":[","," ","\'","\\"",";","=","(",")","[","]","{","}","?","@","<","&","/",":","\\n","\\t","\\r"]'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'场景 2 （开启全文索引与字段索引）：'."\n" + .'```'."\n" + .'{'."\n" + .' "keys": {'."\n" + .' "region": {'."\n" + .' "doc_value": true,'."\n" + .' "alias": "",'."\n" + .' "type": "text",'."\n" + .' "caseSensitive": false,'."\n" + .' "chn": false,'."\n" + .' "token": [","," ","\'","\\"",";","=","(",")","[","]","{","}","?","@","<","&","/",":","\\n","\\t","\\r"]'."\n" + .' },'."\n" + .' "end_time": {'."\n" + .' "doc_value": true,'."\n" + .' "alias": "",'."\n" + .' "type": "long"'."\n" + .' },'."\n" + .' "request_time": {'."\n" + .' "doc_value": true,'."\n" + .' "alias": "",'."\n" + .' "type": "double"'."\n" + .' }'."\n" + .' },'."\n" + .' "line": {'."\n" + .' "caseSensitive": false,'."\n" + .' "chn": true'."\n" + .' }'."\n" + .'}'."\n" + .'```', 'type' => 'object', 'properties' => [ - 'max_text_len' => [ - 'title' => '统计字段最大长度', - 'description' => '日志服务默认字段值的最大长度为2048字节，即2 KB。如果您需要修改字段值的最大长度，可设置统计字段（text）最大长度，取值范围为64~16384字节。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', - ], + 'max_text_len' => ['title' => '统计字段最大长度', 'description' => '日志服务默认字段值的最大长度为2048字节，即2 KB。如果您需要修改字段值的最大长度，可设置统计字段（text）最大长度，取值范围为64~16384字节。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048'], 'log_reduce_white_list' => [ 'title' => '日志聚类的聚类字段过滤白名单，仅当日志聚类开启时有效', 'description' => '日志聚类的聚类字段过滤白名单，仅当日志聚类开启时有效。', 'type' => 'array', - 'items' => [ - 'description' => '白名单字段。', - 'type' => 'string', - 'example' => 'name', - ], + 'items' => ['description' => '白名单字段。', 'type' => 'string', 'example' => 'name'], ], 'log_reduce_black_list' => [ 'title' => '日志聚类的聚类字段过滤黑名单，仅当日志聚类开启时有效', 'description' => '日志聚类的聚类字段过滤黑名单，仅当日志聚类开启时有效。', 'type' => 'array', - 'items' => [ - 'description' => '黑名单字段。', - 'type' => 'string', - 'example' => 'time', - ], + 'items' => ['description' => '黑名单字段。', 'type' => 'string', 'example' => 'time'], ], 'line' => [ 'title' => '全文索引', - 'description' => '全文索引配置。该参数和keys必须至少指定一个。', + 'description' => '全文索引配置。全文索引、字段索引、扫描索引至少需要存在一个。'."\n" + .'全文索引示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "chn": false,'."\n" + .' "caseSensitive": false,'."\n" + .' "token":[","," ","\'","\\"",";","=","(",")","[","]","{","}","?","@","<","&","/",":","\\n","\\t","\\r"]'."\n" + .'}'."\n" + .'```', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'title' => '包含中文', - 'description' => '是否包含中文。'."\n" - ."\n" - .'- true：包含中文。'."\n" - .'- false（默认值）：不包含中文。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'caseSensitive' => [ - 'title' => '大小写敏感', - 'description' => '是否大小写敏感。'."\n" - ."\n" - .'- true：大小写敏感。'."\n" - .'- false（默认值）：大小写不敏感。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'chn' => ['title' => '包含中文', 'description' => '是否包含中文。默认值为 false，开启包含中文后，写入能力可能会有一定下降。', 'type' => 'boolean', 'example' => 'false'], + 'caseSensitive' => ['title' => '大小写敏感', 'description' => '是否大小写敏感。默认值为 false。', 'type' => 'boolean', 'example' => 'true'], 'token' => [ 'title' => '分词符', 'description' => '分词符列表。可以设置一个分词参数，指定这个字段按照哪一种方式分词。', 'type' => 'array', - 'items' => [ - 'description' => '分词符。例如 "," "." "\\r" "\\n" 等。', - 'type' => 'string', - 'example' => ',', - ], + 'items' => ['description' => '分词符。例如 "," "." "\\r" "\\n" 等。', 'type' => 'string', 'example' => ','], 'required' => true, ], 'include_keys' => [ 'title' => '包含的字段列表，不能与exclude_keys同时指定。', 'description' => '包含的字段列表，不能与exclude_keys同时指定。', 'type' => 'array', - 'items' => [ - 'description' => '包含字段列表。', - 'type' => 'string', - 'example' => 'includeField', - ], + 'items' => ['description' => '包含字段列表。', 'type' => 'string', 'example' => 'includeField'], ], 'exclude_keys' => [ 'title' => '排除的字段列表，不能与include_keys同时指定。', 'description' => '排除的字段列表，不能与include_keys同时指定。', 'type' => 'array', - 'items' => [ - 'description' => '排除字段列表。', - 'type' => 'string', - 'example' => 'excludeField', - ], + 'items' => ['description' => '排除字段列表。', 'type' => 'string', 'example' => 'excludeField'], ], ], ], 'keys' => [ 'title' => '字段索引', - 'description' => '字段索引配置，key为字段名称，value为字段索引配置。该参数和line必须至少指定一个。', + 'description' => '字段索引配置，key为字段名称，value为字段索引配置。全文索引、字段索引、扫描索引至少需要存在一个。'."\n" + .'字段索引示例：'."\n" + .'```'."\n" + .'{'."\n" + .' "region": {'."\n" + .' "doc_value": true,'."\n" + .' "alias": "",'."\n" + .' "type": "text",'."\n" + .' "caseSensitive": false,'."\n" + .' "chn": false,'."\n" + .' "token": [","," ","\'","\\"",";","=","(",")","[","]","{","}","?","@","<","&","/",":","\\n","\\t","\\r"]'."\n" + .' },'."\n" + .' "end_time": {'."\n" + .' "doc_value": true,'."\n" + .' "alias": "",'."\n" + .' "type": "long"'."\n" + .' },'."\n" + .' "request_time": {'."\n" + .' "doc_value": true,'."\n" + .' "alias": "",'."\n" + .' "type": "double"'."\n" + .' }'."\n" + .' }'."\n" + .'```', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '字段索引配置，key为字段名称，value为字段索引配置。', - '$ref' => '#/components/schemas/IndexKey', - ], - ], - 'log_reduce' => [ - 'title' => '是否开启日志聚类', - 'description' => '是否开启日志聚类。开启后白名单与黑名单至多生效其中一个。'."\n" - ."\n" - .'- true：开启日志聚类。'."\n" - .'- false（默认值）：不开启日志聚类。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'scan_index' => [ - 'title' => '是否开启扫描索引', - 'description' => '是否开启扫描索引', - 'type' => 'boolean', - 'example' => 'false', - 'default' => 'false', + 'additionalProperties' => ['description' => '字段索引配置，key为字段名称，value为字段索引配置。', '$ref' => '#/components/schemas/IndexKey'], ], + 'log_reduce' => ['title' => '是否开启日志聚类', 'description' => '是否开启日志聚类。开启后白名单与黑名单至多生效其中一个。'."\n" + ."\n" + .'- true：开启日志聚类。'."\n" + .'- false（默认值）：不开启日志聚类。', 'type' => 'boolean', 'example' => 'true'], + 'scan_index' => ['title' => '是否开启扫描索引', 'description' => '是否开启扫描索引。全文索引、字段索引、扫描索引至少需要存在一个。', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], ], ], 'IndexJsonKey' => [ @@ -2304,54 +991,18 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'title' => '是否包含中文', - 'description' => '是否包含中文', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'caseSensitive' => [ - 'title' => '大小写敏感', - 'description' => '大小写敏感', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], + 'chn' => ['title' => '是否包含中文', 'description' => '是否包含中文', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], + 'caseSensitive' => ['title' => '大小写敏感', 'description' => '大小写敏感', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], 'token' => [ 'title' => '分词符', 'description' => '分词符', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '|', - 'extendType' => 'true', - ], - ], - 'alias' => [ - 'title' => '别名', - 'description' => '别名', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myAlias', - ], - 'type' => [ - 'title' => '字段类型', - 'description' => '字段类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'text', - ], - 'doc_value' => [ - 'title' => '开启统计', - 'description' => '开启统计', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', + 'items' => ['visibility' => 'Public', 'type' => 'string', 'example' => '|', 'extendType' => 'true'], ], + 'alias' => ['title' => '别名', 'description' => '别名', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myAlias'], + 'type' => ['title' => '字段类型', 'description' => '字段类型', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'text'], + 'doc_value' => ['title' => '开启统计', 'description' => '开启统计', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], ], ], 'IndexKey' => [ @@ -2359,74 +1010,26 @@ 'description' => '索引Key', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'title' => '是否包含中文', - 'description' => '是否包含中文', - 'type' => 'boolean', - 'example' => 'true', - ], - 'caseSensitive' => [ - 'title' => '大小写敏感', - 'description' => '大小写敏感', - 'type' => 'boolean', - 'example' => 'true', - ], - 'alias' => [ - 'title' => '别名', - 'description' => '别名', - 'type' => 'string', - 'example' => 'myAlias', - ], - 'type' => [ - 'title' => '字段类型', - 'description' => '字段类型', - 'type' => 'string', - 'required' => true, - 'example' => 'text', - ], - 'doc_value' => [ - 'title' => '开启统计', - 'description' => '开启统计', - 'type' => 'boolean', - 'example' => 'true', - ], - 'index_all' => [ - 'title' => '是否对Json内所有文本字段自动索引', - 'description' => '是否对Json内所有文本字段自动索引', - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'max_depth' => [ - 'title' => '最大深度', - 'description' => '最大深度', - 'type' => 'integer', - 'format' => 'int64', - ], - 'embedding' => [ - 'type' => 'string', - ], - 'vector_index' => [ - 'type' => 'string', - ], + 'chn' => ['title' => '是否包含中文', 'description' => '是否包含中文', 'type' => 'boolean', 'example' => 'true'], + 'caseSensitive' => ['title' => '大小写敏感', 'description' => '大小写敏感', 'type' => 'boolean', 'example' => 'true'], + 'alias' => ['title' => '别名', 'description' => '别名', 'type' => 'string', 'example' => 'myAlias'], + 'type' => ['title' => '字段类型', 'description' => '字段类型', 'type' => 'string', 'required' => true, 'example' => 'text'], + 'doc_value' => ['title' => '开启统计', 'description' => '开启统计', 'type' => 'boolean', 'example' => 'true'], + 'index_all' => ['title' => '是否对Json内所有文本字段自动索引', 'description' => '是否对Json内所有文本字段自动索引', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'], + 'max_depth' => ['title' => '最大深度', 'description' => '最大深度', 'type' => 'integer', 'format' => 'int64'], + 'embedding' => ['type' => 'string'], + 'vector_index' => ['type' => 'string'], 'token' => [ 'title' => '分词符', 'description' => '分词符', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => '|', - 'description' => '', - ], + 'items' => ['type' => 'string', 'example' => '|', 'description' => ''], ], 'json_keys' => [ 'title' => 'json key', 'description' => 'json key', 'type' => 'object', - 'additionalProperties' => [ - '$ref' => '#/components/schemas/IndexJsonKey', - 'description' => '', - ], + 'additionalProperties' => ['$ref' => '#/components/schemas/IndexJsonKey', 'description' => ''], ], ], ], @@ -2436,52 +1039,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'processorName' => [ - 'title' => '写入处理器标识。', - 'description' => '写入处理器标识。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-processor-1', - ], - 'displayName' => [ - 'title' => '写入处理器展示名称。', - 'description' => '写入处理器展示名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '字段过滤处理', - ], - 'description' => [ - 'title' => '写入处理器描述。', - 'description' => '写入处理器描述。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '过滤content字段', - ], - 'configuration' => [ - 'title' => '写入处理器配置详情。', - 'description' => '写入处理器配置详情。', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/IngestProcessorConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间。', - 'description' => '创建时间。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717171200', - ], - 'updateTime' => [ - 'title' => '更新时间。', - 'description' => '更新时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717171200', - ], + 'processorName' => ['title' => '写入处理器标识。', 'description' => '写入处理器标识。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ingest-processor-1'], + 'displayName' => ['title' => '写入处理器展示名称。', 'description' => '写入处理器展示名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '字段过滤处理'], + 'description' => ['title' => '写入处理器描述。', 'description' => '写入处理器描述。', 'visibility' => 'Public', 'type' => 'string', 'example' => '过滤content字段'], + 'configuration' => ['title' => '写入处理器配置详情。', 'description' => '写入处理器配置详情。', 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/IngestProcessorConfiguration'], + 'createTime' => ['title' => '创建时间。', 'description' => '创建时间。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1717171200'], + 'updateTime' => ['title' => '更新时间。', 'description' => '更新时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1717171200'], ], ], 'IngestProcessorConfiguration' => [ @@ -2490,14 +1053,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'spl' => [ - 'title' => 'SPL语句。', - 'description' => 'SPL语句。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '* | project content', - ], + 'spl' => ['title' => 'SPL语句。', 'description' => 'SPL语句。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | project content'], 'parseFail' => [ 'title' => 'SPL处理失败的行为。keep 为保留原始数据，drop 为丢弃原始数据。', 'description' => 'SPL处理失败的行为。可选值如下：'."\n" @@ -2505,10 +1061,7 @@ .'- keep：保留原始数据。', 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'drop' => '丢弃原始数据', - 'keep' => '保留原始数据', - ], + 'enumValueTitles' => ['drop' => '丢弃原始数据', 'keep' => '保留原始数据'], 'example' => 'keep', ], ], @@ -2519,80 +1072,23 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => '集合操作类型', - 'description' => '集合操作类型', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'left_join', - ], - 'condition' => [ - 'title' => '集合操作条件', - 'description' => '集合操作条件', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '$0.id == $1.id', - ], + 'type' => ['title' => '集合操作类型', 'description' => '集合操作类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'left_join'], + 'condition' => ['title' => '集合操作条件', 'description' => '集合操作条件', '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' => [ - 'title' => 'job description', - 'type' => 'string', - 'example' => 'kafka ingestion', - ], - 'displayName' => [ - 'title' => 'job displayName', - 'type' => 'string', - 'required' => true, - 'example' => 'kafka ingestion', - ], - 'schedule' => [ - 'title' => '调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'title' => 'kafka导入配置', - 'required' => true, - '$ref' => '#/components/schemas/KafkaIngestionConfiguration', - ], - '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', - ], + 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-kafka-123456'], + 'description' => ['title' => 'job description', 'type' => 'string', 'example' => 'kafka ingestion'], + 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'kafka ingestion'], + 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['title' => 'kafka导入配置', 'required' => true, '$ref' => '#/components/schemas/KafkaIngestionConfiguration'], + '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'], ], 'description' => 'A short description of struct', ], @@ -2601,16 +1097,8 @@ 'description' => 'kafka导入源配置', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'type' => 'string', - 'required' => true, - 'example' => 'logstore', - ], - 'source' => [ - 'required' => true, - '$ref' => '#/components/schemas/KafkaIngestionConfigurationSource', - ], + 'logstore' => ['title' => 'logstore', 'type' => 'string', 'required' => true, 'example' => 'logstore'], + 'source' => ['required' => true, '$ref' => '#/components/schemas/KafkaIngestionConfigurationSource'], ], ], 'KafkaIngestionConfigurationSource' => [ @@ -2618,96 +1106,30 @@ 'description' => 'kafka导入源配置', 'type' => 'object', 'properties' => [ - 'bootstrapServers' => [ - 'title' => '服务地址', - 'type' => 'string', - 'required' => true, - 'example' => '192.168.1.28:9092', - ], - 'topics' => [ - 'title' => 'Topic列表', - 'type' => 'string', - 'required' => true, - 'example' => 'topic1,topic2', - ], - 'fromPosition' => [ - 'title' => '起始位置', - 'type' => 'string', - 'required' => true, - 'example' => 'earliest,latest', - ], - 'consumerGroup' => [ - 'title' => '消费组', - 'type' => 'string', - 'example' => 'consumer', - ], - 'valueType' => [ - 'title' => '数据格式', - 'type' => 'string', - 'required' => true, - 'example' => 'text,json', - ], - 'encoding' => [ - 'title' => '编码格式', - 'type' => 'string', - 'required' => true, - 'example' => 'UTF-8', - ], - 'parseArray' => [ - 'title' => '解析数组元素', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'vpcId' => [ - 'title' => 'vpcId', - 'type' => 'string', - 'required' => false, - ], - 'timeField' => [ - 'title' => '时间字段', - 'type' => 'string', - 'example' => '__time__', - ], - 'timePattern' => [ - 'title' => '提取时间正则', - 'type' => 'string', - 'example' => '\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}', - ], - 'timeFormat' => [ - 'title' => '时间字段格式', - 'type' => 'string', - 'example' => 'epoch', - ], - 'timeZone' => [ - 'title' => '时区', - 'type' => 'string', - 'example' => '+0800', - ], - 'defaultTimeSource' => [ - 'title' => '默认时间来源', - 'type' => 'string', - 'example' => 'system,kafka', - ], - 'enableSlsContext' => [ - 'title' => '日志上下文', - 'type' => 'boolean', - 'example' => 'true', - ], - 'nameResolutions' => [ - 'title' => '私网域名解析', - 'type' => 'string', - 'example' => '{"hostname": "192.168.1.28"}', - ], - 'communication' => [ - 'title' => '通信协议', - 'type' => 'string', - 'example' => '{ "protocol":"SASL_PLAINTEXT", "sasl":{ "mechanism":"PLAIN", "username":"用户名", "password":"密码" } }', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', + 'topics' => ['title' => 'Topic列表', 'type' => 'string', 'required' => true, 'example' => 'topic1,topic2'], + 'fromPosition' => ['title' => '起始位置', 'type' => 'string', 'required' => true, 'example' => 'earliest,latest'], + 'consumerGroup' => ['title' => '消费组', 'type' => 'string', 'example' => 'consumer'], + 'valueType' => ['title' => '数据格式', 'type' => 'string', 'required' => true, 'example' => 'text,json'], + 'encoding' => ['title' => '编码格式', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], + 'parseArray' => ['title' => '解析数组元素', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'vpcId' => ['title' => 'vpcId', 'type' => 'string', 'required' => false], + 'timeField' => ['title' => '时间字段', 'type' => 'string', 'example' => '__time__'], + 'timePattern' => ['title' => '提取时间正则', 'type' => 'string', 'example' => '\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}'], + 'timeFormat' => ['title' => '时间字段格式', 'type' => 'string', 'example' => 'epoch'], + 'timeZone' => ['title' => '时区', 'type' => 'string', 'example' => '+0800'], + 'defaultTimeSource' => ['title' => '默认时间来源', 'type' => 'string', 'example' => 'system,kafka'], + 'enableSlsContext' => ['title' => '日志上下文', 'type' => 'boolean', 'example' => 'true'], + 'nameResolutions' => ['title' => '私网域名解析', 'type' => 'string', 'example' => '{"hostname": "192.168.1.28"}'], + 'communication' => ['title' => '通信协议', 'type' => 'string', 'example' => '{ "protocol":"SASL_PLAINTEXT", "sasl":{ "mechanism":"PLAIN", "username":"用户名", "password":"密码" } }'], + 'processorId' => ['title' => '写入处理器ID', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + 'enableVpcNat' => ['title' => '是否使用vpc-nat', 'type' => 'boolean'], + 'securityGroups' => ['title' => '安全组', 'type' => 'string'], + 'vswitchId' => ['title' => 'Vswitch Id', 'type' => 'string'], + 'bootstrapServers' => ['title' => '服务地址', 'type' => 'string', 'required' => true, 'example' => '192.168.1.28:9092'], + 'format' => [ + 'title' => '格式', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any'], ], ], ], @@ -2719,22 +1141,13 @@ 'description' => '进程级配置', 'type' => 'object', 'properties' => [ - 'configType' => [ - 'title' => '进程级配置类型', - 'description' => '进程级配置类型', - 'type' => 'string', - 'example' => 'apm_biz_trace', - ], + 'configType' => ['title' => '进程级配置类型', 'description' => '进程级配置类型', 'type' => 'string', 'example' => 'apm_biz_trace'], 'attributes' => [ 'title' => '进程级配置归属', 'description' => '进程级配置归属', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '进程级配置归属', - 'type' => 'string', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - ], + 'additionalProperties' => ['description' => '进程级配置归属', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"'], 'example' => '{"workspace": "test-workspace","service": "test-service"}', ], ], @@ -2746,22 +1159,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '自定义Key名称。', - 'description' => '自定义Key名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'key-test', - ], - 'Value' => [ - 'title' => '自定义Key对应的值。', - 'description' => '自定义Key对应的值。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'value-test', - ], + 'Key' => ['title' => '自定义Key名称。', 'description' => '自定义Key名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'key-test'], + 'Value' => ['title' => '自定义Key对应的值。', 'description' => '自定义Key对应的值。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'value-test'], ], ], 'logging' => [ @@ -2770,14 +1169,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'loggingProject' => [ - 'title' => 'project 名称。', - 'description' => '服务日志要保存到的Project名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'loggingProject' => ['title' => 'project 名称。', 'description' => '服务日志要保存到的Project名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-project'], 'loggingDetails' => [ 'title' => 'logging 配置项', 'description' => '服务日志配置列表。', @@ -2804,25 +1196,9 @@ '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' => 'Logstore名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', + 'enum' => ['consumergroup_log', 'logtail_alarm', 'operation_log', 'logtail_profile', 'metering', 'logtail_status', 'scheduled_sql_alert', 'etl_alert'], ], + 'logstore' => ['title' => 'logstore 名称。', 'description' => 'Logstore名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], ], 'extendType' => 'true', ], @@ -2835,37 +1211,20 @@ 'description' => '日志组', 'type' => 'object', 'properties' => [ - 'Topic' => [ - 'title' => '日志主题，用户自定义字段，用于区分不同特征的日志数据。', - 'description' => '日志主题，用户自定义字段，用于区分不同特征的日志数据。', - 'type' => 'string', - 'required' => false, - 'example' => 'topic-test', - ], - 'Source' => [ - 'title' => '日志的来源。例如产生该日志的机器的IP地址。', - 'description' => '日志的来源。例如产生该日志的机器的IP地址。', - 'type' => 'string', - 'example' => '192.1.1.1', - ], + 'Topic' => ['title' => '日志主题，用户自定义字段，用于区分不同特征的日志数据。', 'description' => '日志主题，用户自定义字段，用于区分不同特征的日志数据。', 'type' => 'string', 'required' => false, 'example' => 'topic-test'], + 'Source' => ['title' => '日志的来源。例如产生该日志的机器的IP地址。', 'description' => '日志的来源。例如产生该日志的机器的IP地址。', 'type' => 'string', 'example' => '192.1.1.1'], 'LogTags' => [ 'title' => '日志的标签列表', 'description' => '日志的标签列表', 'type' => 'array', - 'items' => [ - 'description' => '日志的标签', - '$ref' => '#/components/schemas/LogTag', - ], + 'items' => ['description' => '日志的标签', '$ref' => '#/components/schemas/LogTag'], 'required' => false, ], 'LogItems' => [ 'title' => '日志列表', 'description' => '日志列表', 'type' => 'array', - 'items' => [ - 'description' => '日志', - '$ref' => '#/components/schemas/LogItem', - ], + 'items' => ['description' => '日志', '$ref' => '#/components/schemas/LogItem'], 'required' => true, ], ], @@ -2878,9 +1237,7 @@ 'LogGroupList' => [ 'title' => 'logGroup 列表', 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/LogGroup', - ], + 'items' => ['$ref' => '#/components/schemas/LogGroup'], 'required' => true, ], ], @@ -2889,28 +1246,14 @@ 'LogItem' => [ 'title' => '日志', 'description' => '日志', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Time' => [ - 'title' => '日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => '日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1690254376', - ], + 'Time' => ['title' => '日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => '日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1690254376'], 'Contents' => [ 'title' => '日志字段列表。', 'description' => '日志字段列表。', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/LogContent', - ], + 'items' => ['$ref' => '#/components/schemas/LogContent', 'description' => ''], 'required' => true, ], ], @@ -2920,133 +1263,40 @@ 'description' => '日志库Logstore数据结构。', 'type' => 'object', 'properties' => [ - 'logstoreName' => [ - 'title' => 'logstore 的名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - 'ttl' => [ - 'title' => '数据保存的天数。', - 'description' => '数据的保存时间，单位为天。取值范围为1~3650。如果配置为3650，表示永久保存。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'shardCount' => [ - 'title' => 'shard 数量。', - 'description' => 'Shard分区个数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'enable_tracking' => [ - 'title' => 'WebTracking功能支持快速采集各种浏览器以及iOS/Android/APP访问信息，默认关闭', - 'description' => '是否开启WebTracking功能。默认值为false。'."\n" - ."\n" - .'- true：开启WebTracking。'."\n" - .'- false：不开启WebTracking。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'autoSplit' => [ - 'title' => '是否开启 shard 自动分裂。当写入数据量超过已有分区（Shard）写入服务能力且持续5分钟以上时，开启自动分裂功能可自动根据数据量增加分区数量', - 'description' => '是否自动分裂Shard。'."\n" - ."\n" - .'- true：自动分裂Shard。'."\n" - .'- false：不自动分裂Shard。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'maxSplitShard' => [ - 'title' => '最大 shard 数量。', - 'description' => '自动分裂时最大的Shard个数，最小值是1，最大值是64。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'appendMeta' => [ - 'title' => '接收日志后，自动添加客户端外网IP和日志到达时间', - 'description' => '是否记录外网IP地址功能。默认值为false。'."\n" - ."\n" - .'- true：记录外网IP地址。'."\n" - .'- false：不记录外网IP地址。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'telemetryType' => [ - 'title' => 'telemetryType', - 'description' => '要查询的日志类型。取值：'."\n" - ."\n" - .'- Metrics：时序存储。'."\n" - .'- None：非时序存储。', - 'type' => 'string', - 'example' => 'Metrics', - ], - 'createTime' => [ - 'title' => '创建时间。', - 'description' => '日志库创建时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1453949705', - ], - 'lastModifyTime' => [ - 'title' => '最后修改时间。', - 'description' => '日志库最后一次更新时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1524155379', - ], - 'encrypt_conf' => [ - 'title' => '加密配置', - 'description' => '数据加密配置。', - '$ref' => '#/components/schemas/EncryptConf', - ], - 'hot_ttl' => [ - 'title' => '必须在 (30, ttl) 之间', - 'description' => '数据在Logstore热存储层中的存储时间，最少为30天。单位：天。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'infrequentAccessTTL' => [ - 'title' => '低频存储时间', - 'description' => '低频存储时间', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'mode' => [ - 'title' => '[ standard | query ]', - 'description' => '日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。'."\n" - ."\n" - .'- **standard**：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。'."\n" - .'- **query**：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。', - 'type' => 'string', - 'example' => 'standard', - ], - 'productType' => [ - 'title' => '日志所属产品类型', - 'description' => '日志所属产品类型。', - 'type' => 'string', - 'example' => 'aliyun', - ], - 'processorId' => [ - 'title' => 'IngestProcessor ID', - 'description' => 'IngestProcessor ID', - 'type' => 'string', - ], - 'shardingPolicy' => [ - 'title' => '哈希写入配置', - '$ref' => '#/components/schemas/ShardingPolicy', - ], - 'resourceGroupId' => [ - 'title' => '资源组', - 'type' => 'string', - ], + 'logstoreName' => ['title' => 'logstore 的名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], + 'ttl' => ['title' => '数据保存的天数。', 'description' => '数据的保存时间，单位为天。取值范围为1~3650。如果配置为3650，表示永久保存。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'shardCount' => ['title' => 'shard 数量。', 'description' => 'Shard分区个数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], + 'enable_tracking' => ['title' => 'WebTracking功能支持快速采集各种浏览器以及iOS/Android/APP访问信息，默认关闭', 'description' => '是否开启WebTracking功能。默认值为false。'."\n" + ."\n" + .'- true：开启WebTracking。'."\n" + .'- false：不开启WebTracking。', 'type' => 'boolean', 'example' => 'false'], + 'autoSplit' => ['title' => '是否开启 shard 自动分裂。当写入数据量超过已有分区（Shard）写入服务能力且持续5分钟以上时，开启自动分裂功能可自动根据数据量增加分区数量', 'description' => '是否自动分裂Shard。'."\n" + ."\n" + .'- true：自动分裂Shard。'."\n" + .'- false：不自动分裂Shard。', 'type' => 'boolean', 'example' => 'true'], + 'maxSplitShard' => ['title' => '最大 shard 数量。', 'description' => '自动分裂时最大的Shard个数，最小值是1，最大值是64。', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'appendMeta' => ['title' => '接收日志后，自动添加客户端外网IP和日志到达时间', 'description' => '是否记录外网IP地址功能。默认值为false。'."\n" + ."\n" + .'- true：记录外网IP地址。'."\n" + .'- false：不记录外网IP地址。', 'type' => 'boolean', 'example' => 'false'], + 'telemetryType' => ['title' => 'telemetryType', 'description' => '要查询的日志类型。取值：'."\n" + ."\n" + .'- Metrics：时序存储。'."\n" + .'- None：非时序存储。', 'type' => 'string', 'example' => 'Metrics'], + 'createTime' => ['title' => '创建时间。', 'description' => '日志库创建时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1453949705'], + 'lastModifyTime' => ['title' => '最后修改时间。', 'description' => '日志库最后一次更新时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1524155379'], + 'encrypt_conf' => ['title' => '加密配置', 'description' => '数据加密配置。', '$ref' => '#/components/schemas/EncryptConf'], + 'hot_ttl' => ['title' => '必须在 (30, ttl) 之间', 'description' => '数据在Logstore热存储层中的存储时间，最少为30天。单位：天。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'infrequentAccessTTL' => ['title' => '低频存储时间', 'description' => '低频存储时间', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'mode' => ['title' => '[ standard | query ]', 'description' => '日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。'."\n" + ."\n" + .'- **standard**：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。'."\n" + .'- **query**：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。', 'type' => 'string', 'example' => 'standard'], + 'productType' => ['title' => '日志所属产品类型', 'description' => '日志所属产品类型。', 'type' => 'string', 'example' => 'aliyun'], + 'processorId' => ['title' => 'IngestProcessor ID', 'description' => 'IngestProcessor ID', 'type' => 'string'], + 'shardingPolicy' => ['title' => '哈希写入配置', '$ref' => '#/components/schemas/ShardingPolicy'], + 'resourceGroupId' => ['title' => '资源组', 'type' => 'string'], + 'enableModify' => ['type' => 'boolean'], ], ], 'LogTag' => [ @@ -3055,22 +1305,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '自定义Key名称。', - 'description' => '自定义Key名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'key-test', - ], - 'Value' => [ - 'title' => '自定义Key对应的值。', - 'description' => '自定义Key对应的值。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'value-test', - ], + 'Key' => ['title' => '自定义Key名称。', 'description' => '自定义Key名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'key-test'], + 'Value' => ['title' => '自定义Key对应的值。', 'description' => '自定义Key对应的值。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'value-test'], ], ], 'LogtailConfig' => [ @@ -3079,106 +1315,32 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'configName' => [ - 'title' => 'logtail 配置的名称。', - 'description' => ' '."\n" - .'Logtail配置的名称，在其所属Project内必须唯一。创建Logtail配置成功后，无法修改其名称。命名规则如下：'."\n" - .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'- 必须以小写字母或者数字开头和结尾。'."\n" - .'- 长度必须在2~128字符之间。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - ], - 'logSample' => [ - 'title' => '日志样例，可以用于自动生成正则捕获字段。', - 'description' => '日志样例。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world', - ], - 'inputType' => [ - 'title' => 'logtail 读取日志的输入类型。', - 'description' => '日志输入的方式。可选值如下：'."\n" - .'- **plugin**：通过Logtail插件采集MySQL Binlog等日志。'."\n" - .'- **file**：通过固定模式（正则模式、分隔符模式等）采集文本文件中的日志。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'file', - ], - 'inputDetail' => [ - 'title' => 'logtail 输入的详细配置。', - 'description' => '日志输入的相关配置。更多信息，请参见[inputDetail参数说明](~~29058~~)。', - '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' => '日志输出的方式，只支持LogService，即只支持将数据上传到日志服务。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'LogService', - ], + 'configName' => ['title' => 'logtail 配置的名称。', 'description' => ' '."\n" + .'Logtail配置的名称，在其所属Project内必须唯一。创建Logtail配置成功后，无法修改其名称。命名规则如下：'."\n" + .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'- 必须以小写字母或者数字开头和结尾。'."\n" + .'- 长度必须在2~128字符之间。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-config'], + 'logSample' => ['title' => '日志样例，可以用于自动生成正则捕获字段。', 'description' => '日志样例。', 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], + 'inputType' => ['title' => 'logtail 读取日志的输入类型。', 'description' => '日志输入的方式。可选值如下：'."\n" + .'- **plugin**：通过Logtail插件采集MySQL Binlog等日志。'."\n" + .'- **file**：通过固定模式（正则模式、分隔符模式等）采集文本文件中的日志。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'file'], + 'inputDetail' => ['title' => 'logtail 输入的详细配置。', 'description' => '日志输入的相关配置。更多信息，请参见[inputDetail参数说明](~~29058~~)。', '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' => '日志输出的方式，只支持LogService，即只支持将数据上传到日志服务。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'LogService'], 'outputDetail' => [ 'title' => 'logtail 输出的详细配置。', 'description' => '日志输出的相关配置。更多信息，请参见[outputDetail参数说明](~~29058~~)。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'endpoint' => [ - 'title' => '日志项目的 endpoint。', - 'description' => '服务入口。更多信息，请参见[服务入口](~~29008~~)。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com', - ], - 'logstoreName' => [ - 'title' => '输出的目标 logstore 名称。', - 'description' => 'Logstore名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'region' => [ - 'title' => '地域。', - 'description' => '地域ID。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'telemetryType' => [ - 'title' => '目标 Logstore 的可观测数据类型。', - 'description' => '目标 Logstore 的可观测数据类型。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'logs', - ], + 'endpoint' => ['title' => '日志项目的 endpoint。', 'description' => '服务入口。更多信息，请参见[服务入口](~~29008~~)。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com'], + 'logstoreName' => ['title' => '输出的目标 logstore 名称。', 'description' => 'Logstore名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'region' => ['title' => '地域。', 'description' => '地域ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'telemetryType' => ['title' => '目标 Logstore 的可观测数据类型。', 'description' => '目标 Logstore 的可观测数据类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'logs'], ], 'required' => true, ], - 'createTime' => [ - 'title' => '创建时间，unix 时间戳。', - 'description' => 'Logtail配置创建时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], - 'lastModifyTime' => [ - 'title' => '最后一次修改时间，unix 时间戳。', - 'description' => 'Logtail配置最后一次更新时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], + 'createTime' => ['title' => '创建时间，unix 时间戳。', 'description' => 'Logtail配置创建时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], + 'lastModifyTime' => ['title' => '最后一次修改时间，unix 时间戳。', 'description' => 'Logtail配置最后一次更新时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], ], ], 'LogtailPipelineConfig' => [ @@ -3187,40 +1349,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'configName' => [ - 'title' => '配置名称', - 'description' => '配置名称', - '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' => '日志样例', - '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' => '全局信息', - 'visibility' => 'Public', - 'type' => 'object', - ], + 'configName' => ['title' => '配置名称', 'description' => '配置名称', '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' => '日志样例', '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' => '全局信息', 'visibility' => 'Public', 'type' => 'object'], 'inputs' => [ 'title' => '输入插件', 'description' => '输入插件', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '输入插件', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "Type": "input_file", "FilePaths": ["/var/log/*.log"] }', - 'extendType' => 'true', - ], + 'items' => ['description' => '输入插件', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "input_file", "FilePaths": ["/var/log/*.log"] }', 'extendType' => 'true'], 'required' => true, 'minItems' => 1, ], @@ -3229,13 +1366,7 @@ 'description' => '处理插件', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '处理插件', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "Type": "processor_parse_json_native", "SourceKey": "content" }', - 'extendType' => 'true', - ], + 'items' => ['description' => '处理插件', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "processor_parse_json_native", "SourceKey": "content" }', 'extendType' => 'true'], 'minItems' => 1, ], 'aggregators' => [ @@ -3243,12 +1374,7 @@ 'description' => '聚合插件', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '聚合插件', - 'visibility' => 'Public', - 'type' => 'object', - 'extendType' => 'true', - ], + 'items' => ['description' => '聚合插件', 'visibility' => 'Public', 'type' => 'object', 'extendType' => 'true'], 'minItems' => 1, ], 'flushers' => [ @@ -3256,39 +1382,13 @@ 'description' => '输出插件', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '输出插件', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "Type": "flusher_sls", "Project": "test_project", "Logstore": "test", "Region": "cn-hangzhou", "Endpoint": "cn-hangzhou-intranet.log.aliyuncs.com", "TelemetryType": "log" }', - 'extendType' => 'true', - ], + 'items' => ['description' => '输出插件', 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "flusher_sls", "Project": "test_project", "Logstore": "test", "Region": "cn-hangzhou", "Endpoint": "cn-hangzhou-intranet.log.aliyuncs.com", "TelemetryType": "log" }', 'extendType' => 'true'], 'required' => true, 'minItems' => 1, ], - 'createTime' => [ - 'title' => '创建时间，UNIX时间戳', - 'description' => '创建时间，UNIX时间戳', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], - 'lastModifyTime' => [ - 'title' => '最后修改时间，UNIX时间戳', - 'description' => '最后修改时间，UNIX时间戳', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], - 'task' => [ - 'title' => '任务配置', - 'description' => '任务配置', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{"Type": "task_example"}', - ], + 'createTime' => ['title' => '创建时间，UNIX时间戳', 'description' => '创建时间，UNIX时间戳', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], + 'lastModifyTime' => ['title' => '最后修改时间，UNIX时间戳', 'description' => '最后修改时间，UNIX时间戳', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], + 'task' => ['title' => '任务配置', 'description' => '任务配置', 'visibility' => 'Public', 'type' => 'object', 'example' => '{"Type": "task_example"}'], ], ], 'machine' => [ @@ -3297,45 +1397,11 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ip' => [ - 'title' => '机器 ip 地址。', - 'description' => '机器的IP地址。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.x', - ], - 'machine-uniqueid' => [ - 'title' => '机器的唯一标识。', - 'description' => '机器的唯一标识。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '3B70F4F1-80F7-46C4-A6C1-100****EE647', - ], - 'lastHeartbeatTime' => [ - 'title' => '最后一次心跳时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => '最后一次心跳时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1447182247', - ], - 'userdefined-id' => [ - 'title' => '机器的用户自定义标识。', - 'description' => '机器的用户自定义标识，当机器组标识类型为用户自定义类型时有效。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '无', - ], - 'host-id' => [ - 'title' => '机器的主机id。', - 'description' => '机器的主机ID。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - ], + 'ip' => ['title' => '机器 ip 地址。', 'description' => '机器的IP地址。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.x'], + 'machine-uniqueid' => ['title' => '机器的唯一标识。', 'description' => '机器的唯一标识。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '3B70F4F1-80F7-46C4-A6C1-100****EE647'], + 'lastHeartbeatTime' => ['title' => '最后一次心跳时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => '最后一次心跳时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1447182247'], + 'userdefined-id' => ['title' => '机器的用户自定义标识。', 'description' => '机器的用户自定义标识，当机器组标识类型为用户自定义类型时有效。', 'visibility' => 'Public', 'type' => 'string', 'example' => '无'], + 'host-id' => ['title' => '机器的主机id。', 'description' => '机器的主机ID。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test'], ], ], 'machineGroup' => [ @@ -3344,55 +1410,20 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'machineGroup-test', - ], - 'groupType' => [ - 'title' => '机器组种类。目前固定为空字符串。', - 'description' => '机器组类型，目前固定为空字符串。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '“”', - ], - 'machineIdentifyType' => [ - 'title' => '机器组标识种类，支持 IP 标识或者用户自定义标识，即 ip 、userdefined 、 host-id。', - 'description' => '机器标识类型。'."\n" - ."\n" - .'- ip：IP地址机器组。'."\n" - .'- userdefined：用户自定义标识机器组。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ip', - ], + 'groupName' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'machineGroup-test'], + 'groupType' => ['title' => '机器组种类。目前固定为空字符串。', 'description' => '机器组类型，目前固定为空字符串。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '“”'], + 'machineIdentifyType' => ['title' => '机器组标识种类，支持 IP 标识或者用户自定义标识，即 ip 、userdefined 、 host-id。', 'description' => '机器标识类型。'."\n" + ."\n" + .'- ip：IP地址机器组。'."\n" + .'- userdefined：用户自定义标识机器组。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ip'], 'groupAttribute' => [ 'title' => '机器组属性。', 'description' => '机器组的属性。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'groupTopic' => [ - 'title' => '机器组的日志主题。', - 'description' => '机器组的日志主题。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'testtopic', - ], - 'externalName' => [ - 'title' => '机器组所依赖的外部管理系统标识。', - 'description' => '机器组所依赖的外部管理系统标识。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup', - ], + 'groupTopic' => ['title' => '机器组的日志主题。', 'description' => '机器组的日志主题。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'testtopic'], + 'externalName' => ['title' => '机器组所依赖的外部管理系统标识。', 'description' => '机器组所依赖的外部管理系统标识。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'testgroup'], ], ], 'machineList' => [ @@ -3400,13 +1431,7 @@ 'description' => '机器列表。', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '机器的IP地址或自定义标识。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '47.100.XX.XX', - 'extendType' => 'true', - ], + 'items' => ['description' => '机器的IP地址或自定义标识。', 'visibility' => 'Public', 'type' => 'string', 'example' => '47.100.XX.XX', 'extendType' => 'true'], 'required' => true, ], ], @@ -3417,252 +1442,67 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '任务名称', - 'description' => 'job name', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxComputeExport', - ], - 'description' => [ - 'title' => '任务描述', - 'description' => 'job description', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MaxComputeExport', - ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => 'job displayName', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxComputeExport', - ], - 'configuration' => [ - 'title' => 'MaxCompute投递配置', - 'description' => 'MC投递配置', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/MaxComputeExportConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718787534'."\n", - ], - 'lastModifiedTime' => [ - 'title' => '修改时间', - 'description' => '最近一次修改时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718787681'."\n", - ], - 'status' => [ - 'title' => 'MaxCompute投递任务状态', - 'description' => '投递任务状态', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - ], + 'name' => ['title' => '任务名称', 'description' => 'job name', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'MaxComputeExport'], + 'description' => ['title' => '任务描述', 'description' => 'job description', 'visibility' => 'Public', 'type' => 'string', 'example' => 'MaxComputeExport'], + 'displayName' => ['title' => '显示名称', 'description' => 'job displayName', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'MaxComputeExport'], + 'configuration' => ['title' => 'MaxCompute投递配置', 'description' => 'MC投递配置', 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1718787534'."\n"], + 'lastModifiedTime' => ['title' => '修改时间', 'description' => '最近一次修改时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1718787681'."\n"], + 'status' => ['title' => 'MaxCompute投递任务状态', 'description' => '投递任务状态', 'visibility' => 'Public', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => '任务ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], ], 'MaxComputeExportConfiguration' => [ 'title' => 'MaxCompute投递配置', 'description' => 'MaxComputeExportConfiguration', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'Logstore名称', - 'description' => 'Logstore名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - 'roleArn' => [ - 'title' => '角色roleArn', - 'description' => '读SLS RAM角色roleArn，请填写您自己的角色roleArn', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'."\n", - ], - 'sink' => [ - 'title' => '投递配MaxCompute置', - 'description' => '投递MaxCompute配置', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/MaxComputeExportConfigurationSink', - ], - 'fromTime' => [ - 'title' => '开始时间', - 'description' => '时间范围开始，值设为1则表示将从日志库中第一条数据开始', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1718380800'."\n", - ], - 'toTime' => [ - 'title' => '结束时间', - 'description' => '时间范围结束，值设为0则表示任务会一直运行，除非任务被手动停止。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1718390800', - ], + 'logstore' => ['title' => 'Logstore名称', 'description' => 'Logstore名称', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], + 'roleArn' => ['title' => '角色roleArn', 'description' => '读SLS RAM角色roleArn，请填写您自己的角色roleArn', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'."\n"], + 'sink' => ['title' => '投递配MaxCompute置', 'description' => '投递MaxCompute配置', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfigurationSink'], + 'fromTime' => ['title' => '开始时间', 'description' => '时间范围开始，值设为1则表示将从日志库中第一条数据开始', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1718380800'."\n"], + 'toTime' => ['title' => '结束时间', 'description' => '时间范围结束，值设为0则表示任务会一直运行，除非任务被手动停止。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1718390800'], ], ], 'MaxComputeExportConfigurationSink' => [ 'title' => 'MaxCompute投递配置', 'description' => 'MaxComputeExportConfigurationSink', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'odpsEndpoint' => [ - 'title' => 'MaxCompute Endpoint', - 'description' => 'MaxCompute Endpoint'."\n" - .'- ⚠️注意：仅支持同地域的Endpoint', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api', - ], - 'odpsTunnelEndpoint' => [ - 'title' => 'Tunnel Endpoint', - 'description' => 'MaxCompute Tunnel Endpoint'."\n" - .'- ⚠️注意：仅支持同地域的Tunnel Endpoint', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com', - ], - 'odpsProject' => [ - 'title' => 'MaxCompute项目名', - 'description' => 'MaxCompute项目名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'demo_project', - ], - 'odpsTable' => [ - 'title' => 'MaxCompute表名', - 'description' => 'MaxCompute表名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'demo_table', - ], - 'odpsRolearn' => [ - 'title' => '写MaxCompute ram角色', - 'description' => '写MaxCompute ram角色', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::xxxxxxx', - ], - 'odpsAccessKeyId' => [ - 'title' => '写数据ak id', - 'description' => '写数据ak id', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'example' => 'axxxxxxxxxxxb', - ], - 'odpsAccessSecret' => [ - 'title' => '写数据ak secret', - 'description' => '写数据ak secret', - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'example' => 'aaxxxxxxxxxxxxxxxxxxxxxbb', - ], - 'partitionTimeFormat' => [ - 'title' => '时间分区格式', - 'description' => '时间分区格式', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '%Y_%m_%d', - ], - 'timeZone' => [ - 'title' => '时区', - 'description' => '时间分区', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '+0800', - ], + 'odpsEndpoint' => ['title' => 'MaxCompute Endpoint', 'description' => 'MaxCompute Endpoint'."\n" + .'- ⚠️注意：仅支持同地域的Endpoint', 'type' => 'string', 'required' => true, 'example' => 'https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api'], + 'odpsTunnelEndpoint' => ['title' => 'Tunnel Endpoint', 'description' => 'MaxCompute Tunnel Endpoint'."\n" + .'- ⚠️注意：仅支持同地域的Tunnel Endpoint', 'type' => 'string', 'required' => false, 'example' => 'https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com'], + 'odpsProject' => ['title' => 'MaxCompute项目名', 'description' => 'MaxCompute项目名称', 'type' => 'string', 'required' => true, 'example' => 'demo_project'], + 'odpsTable' => ['title' => 'MaxCompute表名', 'description' => 'MaxCompute表名称', 'type' => 'string', 'required' => true, 'example' => 'demo_table'], + 'odpsRolearn' => ['title' => '写MaxCompute ram角色', 'description' => '写MaxCompute ram角色', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::xxxxxxx'], + 'odpsAccessKeyId' => ['title' => '写数据ak id', 'description' => '写数据ak id', 'type' => 'string', 'deprecated' => true, 'example' => 'axxxxxxxxxxxb'], + 'odpsAccessSecret' => ['title' => '写数据ak secret', 'description' => '写数据ak secret', 'type' => 'string', 'deprecated' => true, 'example' => 'aaxxxxxxxxxxxxxxxxxxxxxbb'], + 'partitionTimeFormat' => ['title' => '时间分区格式', 'description' => '时间分区格式', 'type' => 'string', 'required' => true, 'example' => '%Y_%m_%d'], + 'timeZone' => ['title' => '时区', 'description' => '时间分区', 'type' => 'string', 'required' => true, 'example' => '+0800'], 'fields' => [ 'title' => 'MaxCompute普通列', 'description' => '需要投递的字段', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'SLS日志字段', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '\'f1\'', - 'extendType' => 'true', - ], + 'items' => ['description' => 'SLS日志字段', 'type' => 'string', 'example' => '\'f1\''], 'required' => true, ], 'partitionColumn' => [ 'title' => 'MaxCompute分区列', 'description' => '需要投递的分区字段', - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'SLS日志字段或系统保留字段__partition_time__作为分区', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '\'p1\'', - 'extendType' => 'true', - ], + 'items' => ['description' => 'SLS日志字段或系统保留字段__partition_time__作为分区', 'type' => 'string', 'example' => '\'p1\''], 'required' => true, ], - 'filterInvalid' => [ - 'title' => '过滤无效内容', - 'description' => '是否过滤无效内容'."\n" - .'- true（默认值）'."\n" - .'- false', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'timeFormatType' => [ - 'title' => '分区时间类型', - 'description' => '分区时间类型，支持如下两种：'."\n" - .'- StrfTimeFormat（默认值）'."\n" - .'- JavaSimpleDateFormat', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'StrfTimeFormat', - ], - 'bufferInterval' => [ - 'title' => '计算投递时间分区时的最小时间粒度', - 'description' => '计算投递时间分区时的最小时间粒度（单位：秒）'."\n" - .'- 1800（默认值）'."\n" - .'- 3600', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1800', - ], + 'filterInvalid' => ['title' => '过滤无效内容', 'description' => '是否过滤无效内容'."\n" + .'- true（默认值）'."\n" + .'- false', 'type' => 'boolean', 'example' => 'true'], + 'timeFormatType' => ['title' => '分区时间类型', 'description' => '分区时间类型，支持如下两种：'."\n" + .'- StrfTimeFormat（默认值）'."\n" + .'- JavaSimpleDateFormat', 'type' => 'string', 'example' => 'StrfTimeFormat'], + 'bufferInterval' => ['title' => '计算投递时间分区时的最小时间粒度', 'description' => '计算投递时间分区时的最小时间粒度（单位：秒）'."\n" + .'- 1800（默认值）'."\n" + .'- 3600', 'type' => 'string', 'example' => '1800'], ], ], 'MLDataParam' => [ @@ -3671,57 +1511,17 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'annotationdataId' => [ - 'title' => '数据的唯一标识', - 'description' => '数据的唯一标识', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dc74b0f569126bb310e1ba6454c351ac', - 'backendName' => 'annotationdataId', - ], - 'dataHash' => [ - 'title' => '数据内容的hash值', - 'description' => '数据内容的hash值', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '59db060bd89468245d76416a68a510ac', - 'backendName' => 'dataHash', - ], - 'datasetId' => [ - 'title' => '关联的数据集的id', - 'description' => '关联的数据集的id', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - 'backendName' => 'datasetId', - ], - 'value' => [ - 'title' => '数据来源', - 'description' => '数据来源', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xxx/xxx/xxx/', - 'backendName' => 'value', - ], - 'valueType' => [ - 'title' => '数据来源格式', - 'description' => '数据来源格式', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss', - 'backendName' => 'valueType', - ], + 'annotationdataId' => ['title' => '数据的唯一标识', 'description' => '数据的唯一标识', 'visibility' => 'Public', 'type' => 'string', 'example' => 'dc74b0f569126bb310e1ba6454c351ac', 'backendName' => 'annotationdataId'], + 'dataHash' => ['title' => '数据内容的hash值', 'description' => '数据内容的hash值', 'visibility' => 'Public', 'type' => 'string', 'example' => '59db060bd89468245d76416a68a510ac', 'backendName' => 'dataHash'], + 'datasetId' => ['title' => '关联的数据集的id', 'description' => '关联的数据集的id', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'backendName' => 'datasetId'], + 'value' => ['title' => '数据来源', 'description' => '数据来源', 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxx/xxx/xxx/', 'backendName' => 'value'], + 'valueType' => ['title' => '数据来源格式', 'description' => '数据来源格式', 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss', 'backendName' => 'valueType'], 'config' => [ 'title' => '数据的配置信息', 'description' => '数据的配置信息', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '配置信息。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'simulator-nginx-demo', - ], + 'additionalProperties' => ['description' => '配置信息。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'simulator-nginx-demo'], 'backendName' => 'config', ], 'annotations' => [ @@ -3734,23 +1534,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'annotatedBy' => [ - 'title' => '标注人', - 'description' => '标注人的aliuid', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xxxx', - 'backendName' => 'annotatedBy', - ], - 'updateTime' => [ - 'title' => '更新的时间', - 'description' => '更新的时间戳', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1694761550', - 'backendName' => 'updateTime', - ], + 'annotatedBy' => ['title' => '标注人', 'description' => '标注人的aliuid', 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxxx', 'backendName' => 'annotatedBy'], + 'updateTime' => ['title' => '更新的时间', 'description' => '更新的时间戳', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1694761550', 'backendName' => 'updateTime'], 'results' => [ 'title' => '标注的结果', 'description' => '标注结果', @@ -3760,12 +1545,7 @@ 'description' => '标注结果', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '标注结果', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPIKE_UP_TYPE', - ], + 'additionalProperties' => ['description' => '标注结果', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SPIKE_UP_TYPE'], 'extendType' => 'true', ], 'backendName' => 'results', @@ -3784,23 +1564,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'annotatedBy' => [ - 'title' => '标注人', - 'description' => '标注', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xxx', - 'backendName' => 'annotatedBy', - ], - 'updateTime' => [ - 'title' => '更新的时间', - 'description' => '更新时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1694761550', - 'backendName' => 'updateTime', - ], + 'annotatedBy' => ['title' => '标注人', 'description' => '标注', 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxx', 'backendName' => 'annotatedBy'], + 'updateTime' => ['title' => '更新的时间', 'description' => '更新时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1694761550', 'backendName' => 'updateTime'], 'results' => [ 'title' => '模型预览结果', 'description' => '结果', @@ -3810,12 +1575,7 @@ 'description' => '模型预览结果', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '模型预览结果', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPIKE_UP_TYPE', - ], + 'additionalProperties' => ['description' => '模型预览结果', 'visibility' => 'Public', 'type' => 'string', 'example' => 'SPIKE_UP_TYPE'], 'extendType' => 'true', ], 'backendName' => 'results', @@ -3824,22 +1584,8 @@ ], 'backendName' => 'predictions', ], - 'createTime' => [ - 'title' => '创建的时间', - 'description' => '创建的时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695094335', - ], - 'lastModifyTime' => [ - 'title' => '最后一次修改的时间', - 'description' => '最后一次修改的时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695094335', - ], + 'createTime' => ['title' => '创建的时间', 'description' => '创建的时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695094335'], + 'lastModifyTime' => ['title' => '最后一次修改的时间', 'description' => '最后一次修改的时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695094335'], ], ], 'MLDataSetParam' => [ @@ -3848,71 +1594,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'datasetId' => [ - 'title' => '数据集的唯一标识', - 'description' => '数据集的唯一标识', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'd9bd488f6dd42d294495fb780858e83d', - ], - 'name' => [ - 'title' => '数据集的名称', - 'description' => '数据集的名称', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sls_builtin_dataset_metric.shapeclassification.anomalydetection', - ], - 'description' => [ - 'title' => '数据集的描述', - 'description' => '数据集的描述', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '数据集A', - ], - 'dataType' => [ - 'title' => '数据类型', - 'description' => '数据类型', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Metric', - ], - 'labelId' => [ - 'title' => '数据集对应的标签系统id', - 'description' => '数据集对应的标签系统id', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'a191ae4ca615b0ccb93c211fc8a998af', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], - 'lastModifyTime' => [ - 'title' => '最终修改时间', - 'description' => '最终修改时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], - 'createBy' => [ - 'title' => '创建的对象', - 'description' => '创建的对象', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sls-console', - ], - 'settingType' => [ - 'title' => 'label表配置类型', - 'description' => 'label表配置类型', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Metric.ShapeClassification.AnomalyDetection', - ], + 'datasetId' => ['title' => '数据集的唯一标识', 'description' => '数据集的唯一标识', 'visibility' => 'Public', 'type' => 'string', 'example' => 'd9bd488f6dd42d294495fb780858e83d'], + 'name' => ['title' => '数据集的名称', 'description' => '数据集的名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls_builtin_dataset_metric.shapeclassification.anomalydetection'], + 'description' => ['title' => '数据集的描述', 'description' => '数据集的描述', 'visibility' => 'Public', 'type' => 'string', 'example' => '数据集A'], + 'dataType' => ['title' => '数据类型', 'description' => '数据类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Metric'], + 'labelId' => ['title' => '数据集对应的标签系统id', 'description' => '数据集对应的标签系统id', 'visibility' => 'Public', 'type' => 'string', 'example' => 'a191ae4ca615b0ccb93c211fc8a998af'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], + 'lastModifyTime' => ['title' => '最终修改时间', 'description' => '最终修改时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], + 'createBy' => ['title' => '创建的对象', 'description' => '创建的对象', 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls-console'], + 'settingType' => ['title' => 'label表配置类型', 'description' => 'label表配置类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Metric.ShapeClassification.AnomalyDetection'], ], ], 'MLLabelParam' => [ @@ -3921,38 +1611,10 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'labelId' => [ - 'title' => '标签表的唯一标识', - 'description' => '标签表的唯一标识', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'abbd488f6dd42d294495fb780858e83d', - ], - 'name' => [ - 'title' => '标签表的名称', - 'description' => '标签表的名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '标签表', - ], - 'description' => [ - 'title' => '标签表的描述信息', - 'description' => '标签表的描述信息', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '默认表', - ], - 'type' => [ - 'title' => '标签表的类型', - 'description' => '标签表的类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'labelId' => ['title' => '标签表的唯一标识', 'description' => '标签表的唯一标识', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'abbd488f6dd42d294495fb780858e83d'], + 'name' => ['title' => '标签表的名称', 'description' => '标签表的名称', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '标签表'], + 'description' => ['title' => '标签表的描述信息', 'description' => '标签表的描述信息', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '默认表'], + 'type' => ['title' => '标签表的类型', 'description' => '标签表的类型', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'settings' => [ 'title' => '标签表的配置', 'description' => '标签表的配置', @@ -3963,54 +1625,16 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'mode' => [ - 'title' => '配置的模式', - 'description' => '配置的模式', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'builtin', - ], - 'type' => [ - 'title' => '配置的任务类型', - 'description' => '配置的任务类型', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Trace.RCA', - ], - 'config' => [ - 'title' => '配置的具体信息', - 'description' => '配置的具体信息', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - ], - 'version' => [ - 'title' => '配置的版本号', - 'description' => '配置的版本号', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.01', - ], + 'mode' => ['title' => '配置的模式', 'description' => '配置的模式', 'visibility' => 'Public', 'type' => 'string', 'example' => 'builtin'], + 'type' => ['title' => '配置的任务类型', 'description' => '配置的任务类型', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Trace.RCA'], + 'config' => ['title' => '配置的具体信息', 'description' => '配置的具体信息', 'visibility' => 'Public', 'type' => 'string', 'example' => '""'], + 'version' => ['title' => '配置的版本号', 'description' => '配置的版本号', 'visibility' => 'Public', 'type' => 'string', 'example' => '0.01'], ], 'extendType' => 'true', ], ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], - 'lastModifyTime' => [ - 'title' => '最后修改时间', - 'description' => '最后修改时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], + 'lastModifyTime' => ['title' => '最后修改时间', 'description' => '最后修改时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], ], 'required' => false, ], @@ -4025,12 +1649,7 @@ 'description' => 'parameter', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'parameter', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'parameter', - ], + 'additionalProperties' => ['description' => 'parameter', 'visibility' => 'Public', 'type' => 'string', 'example' => 'parameter'], ], 'input' => [ 'title' => 'input', @@ -4041,12 +1660,7 @@ 'description' => 'input', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'input', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'data', - ], + 'additionalProperties' => ['description' => 'input', 'visibility' => 'Public', 'type' => 'string', 'example' => 'data'], 'extendType' => 'true', ], ], @@ -4056,76 +1670,27 @@ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '微服务名称', - 'type' => 'string', - 'example' => 'service_name', - ], - 'description' => [ - 'title' => '微服务描述', - 'type' => 'string', - 'example' => '某某服务', - ], - 'serviceType' => [ - 'title' => '微服务类型', - 'type' => 'string', - 'example' => 'sls_builtin', - ], - 'status' => [ - 'title' => '微服务状态', - 'type' => 'string', - 'example' => 'running', - ], - 'updateTimestamp' => [ - 'title' => '微服务更新时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], + 'name' => ['title' => '微服务名称', 'type' => 'string', 'example' => 'service_name'], + 'description' => ['title' => '微服务描述', 'type' => 'string', 'example' => '某某服务'], + 'serviceType' => ['title' => '微服务类型', 'type' => 'string', 'example' => 'sls_builtin'], + 'status' => ['title' => '微服务状态', 'type' => 'string', 'example' => 'running'], + 'updateTimestamp' => ['title' => '微服务更新时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], 'model' => [ 'title' => '微服务依赖的模型配置', 'type' => 'object', 'properties' => [ - 'modelResourceId' => [ - 'title' => '模型资源ID', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'modelResourceType' => [ - 'title' => '模型资源类型', - 'type' => 'string', - 'example' => 'xxx_type', - ], + 'modelResourceId' => ['title' => '模型资源ID', 'type' => 'string', 'example' => 'xxxx'], + 'modelResourceType' => ['title' => '模型资源类型', 'type' => 'string', 'example' => 'xxx_type'], ], ], 'resource' => [ 'title' => '微服务资源配置', 'type' => 'object', 'properties' => [ - 'cpuLimit' => [ - 'title' => '所需要CPU资源上限', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'memoryLimit' => [ - 'title' => '所需要内存资源上限', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'replica' => [ - 'title' => '微服务的副本数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'gpu' => [ - 'title' => '需要的GPU显存大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'cpuLimit' => ['title' => '所需要CPU资源上限', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'memoryLimit' => ['title' => '所需要内存资源上限', 'type' => 'integer', 'format' => 'int32', 'example' => '64'], + 'replica' => ['title' => '微服务的副本数', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'gpu' => ['title' => '需要的GPU显存大小', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], ], @@ -4137,409 +1702,147 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '任务名称', - 'description' => 'OSS投递名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456', - ], - 'description' => [ - 'title' => '任务描述', - 'description' => 'OSS投递描述', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'my-oss-job', - ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => 'OSS投递任务显示名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-oss-job', - ], - 'configuration' => [ - 'title' => 'OSS投递配置', - 'description' => 'Oss Export Configuration', - 'visibility' => 'Public', - 'required' => false, - '$ref' => '#/components/schemas/OSSExportConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1718787534', - ], - 'lastModifiedTime' => [ - 'title' => '修改时间', - 'description' => '最后一次修改的时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1718787681', - ], - 'status' => [ - 'title' => 'OSS投递任务状态', - 'description' => '投递任务的状态', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - ], + 'name' => ['title' => '任务名称', 'description' => 'OSS投递名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'], + 'description' => ['title' => '任务描述', 'description' => 'OSS投递描述', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'my-oss-job'], + 'displayName' => ['title' => '显示名称', 'description' => 'OSS投递任务显示名称', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-oss-job'], + 'configuration' => ['title' => 'OSS投递配置', 'description' => 'Oss Export Configuration', 'visibility' => 'Public', 'required' => false, '$ref' => '#/components/schemas/OSSExportConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718787534'], + 'lastModifiedTime' => ['title' => '修改时间', 'description' => '最后一次修改的时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718787681'], + 'status' => ['title' => 'OSS投递任务状态', 'description' => '投递任务的状态', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => '任务ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], 'required' => true, ], 'OSSExportConfiguration' => [ 'title' => 'OSS投递配置', 'description' => 'OSSExportConfiguration', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'Logstore名称', - 'description' => 'Logstore名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'my-logstore', - ], - 'roleArn' => [ - 'title' => '角色roleArn', - 'description' => '读SLS RAM角色roleArn，请填写您自己的角色roleArn', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole', - ], + 'logstore' => ['title' => 'Logstore名称', 'description' => 'Logstore名称', 'type' => 'string', 'required' => false, 'example' => 'my-logstore'], + 'roleArn' => ['title' => '角色roleArn', 'description' => '读SLS RAM角色roleArn，请填写您自己的角色roleArn', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'], 'sink' => [ 'title' => '投递OSS配置', 'description' => '投递OSS配置', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'endpoint' => [ - 'title' => 'OSS Endpoint', - 'description' => '- OSS Endpoint，只能是OSS内网Endpoint，仅支持同地域。详情请参见[OSS访问域名和数据中心](~~31837~~)，值为`http://+OSS Endpoint`。'."\n" - .'- OSS-HDFS Endpoint，只能是OSS-HDFS内网Endpoint，仅支持同地域。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'https://oss-cn-hangzhou-internal.aliyuncs.com', - ], - 'bucket' => [ - 'title' => 'OSS Bucket', - 'description' => 'OSS Bucket', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-bucket', - ], - 'prefix' => [ - 'title' => '文件前缀', - 'description' => 'OSS文件前缀', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'prefix-demo/', - ], - 'suffix' => [ - 'title' => '文件后缀', - 'description' => 'OSS文件后缀', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '.json', - ], - 'roleArn' => [ - 'title' => '写角色roleArn', - 'description' => '写OSS RAM角色roleArn，请填写您自己的角色roleArn', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole', - ], - 'pathFormat' => [ - 'title' => '分区格式', - 'description' => '分区格式，详情参见[分区格式](~~371934~~)。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '%Y/%m/%d/%H/%M', - ], - 'pathFormatType' => [ - 'title' => '分区格式类型', - 'description' => '分区格式类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'time', - ], - 'timeZone' => [ - 'title' => '时区', - 'description' => '时区，详情参见[时区列表](~~375323~~)。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '+0800', - ], - 'contentType' => [ - 'title' => '存储格式', - 'description' => 'OSS文件存储支持4种格式，如：json、parquet、csv、orc', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'csv', - ], + 'endpoint' => ['title' => 'OSS Endpoint', 'description' => '- OSS Endpoint，只能是OSS内网Endpoint，仅支持同地域。详情请参见[OSS访问域名和数据中心](~~31837~~)，值为`http://+OSS Endpoint`。'."\n" + .'- OSS-HDFS Endpoint，只能是OSS-HDFS内网Endpoint，仅支持同地域。', 'type' => 'string', 'required' => true, 'example' => 'https://oss-cn-hangzhou-internal.aliyuncs.com'], + 'bucket' => ['title' => 'OSS Bucket', 'description' => 'OSS Bucket', 'type' => 'string', 'required' => true, 'example' => 'my-bucket'], + 'prefix' => ['title' => '文件前缀', 'description' => 'OSS文件前缀', 'type' => 'string', 'required' => false, 'example' => 'prefix-demo/'], + 'suffix' => ['title' => '文件后缀', 'description' => 'OSS文件后缀', 'type' => 'string', 'required' => false, 'example' => '.json'], + 'roleArn' => ['title' => '写角色roleArn', 'description' => '写OSS RAM角色roleArn，请填写您自己的角色roleArn', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'], + 'pathFormat' => ['title' => '分区格式', 'description' => '分区格式，详情参见[分区格式](~~371934~~)。', 'type' => 'string', 'required' => true, 'example' => '%Y/%m/%d/%H/%M'], + 'pathFormatType' => ['title' => '分区格式类型', 'description' => '分区格式类型', 'type' => 'string', 'required' => true, 'example' => 'time'], + 'timeZone' => ['title' => '时区', 'description' => '时区，详情参见[时区列表](~~375323~~)。', 'type' => 'string', 'required' => false, 'example' => '+0800'], + 'contentType' => ['title' => '存储格式', 'description' => 'OSS文件存储支持4种格式，如：json、parquet、csv、orc', 'type' => 'string', 'required' => false, 'example' => 'csv'], 'contentDetail' => [ 'title' => '内容详情', 'description' => 'OSS文件内容详情，注意：该参数值为JSON格式并且应受contentType参数值的不同进行更新。', - 'visibility' => 'Public', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'description' => '**contentType值为JSON时，contentDetail值的详细参数：**'."\n" - .'- enableTag'."\n" - .' - 是否必填：是'."\n" - .' - 类型：布尔'."\n" - .' - 描述：是否投递 tag字段'."\n" - .' - 值：'."\n" - .' - true'."\n" - .' - 描述：投递 tag字段'."\n" - .' - 示例：{"enableTag": true}'."\n" - .' - false'."\n" - .' - 描述：不投递 tag字段'."\n" - .' - 示例：{"enableTag": false}'."\n" - ."\n" - .'**contentType值为csv时，contentDetail值的详细参数：**'."\n" - .'- columns'."\n" - .' - 是否必填：是'."\n" - .' - 类型：数组'."\n" - .' - 描述：源日志库中日志的key'."\n" - .' - 示例：{"columns":["a", "b", "c", "d"]}'."\n" - .'- delimiter'."\n" - .' - 是否必填：是'."\n" - .' - 类型：字符串'."\n" - .' - 描述：内容间分隔符'."\n" - .' - 值：","、"|"、" " 或 "\\t"'."\n" - .'- header'."\n" - .' - 是否必填：是'."\n" - .' - 类型：布尔'."\n" - .' - 描述：是否将字段名称写入CSV文件（第一行）'."\n" - .' - 值：'."\n" - .' - true'."\n" - .' - false'."\n" - .'- lineFeed'."\n" - .' - 是否必填：否'."\n" - .' - 类型：字符串'."\n" - .' - 描述：自定义换行符'."\n" - .' - 值："\\t"、"\\n" 或 ""'."\n" - .' - 默认值："\\n"'."\n" - .'- null'."\n" - .' - 是否必填：否'."\n" - .' - 类型：字符串'."\n" - .' - 描述：自定义无效字段的填充值'."\n" - .' - 默认值：""'."\n" - .'- quote'."\n" - .' - 是否必填：是'."\n" - .' - 类型：字符串'."\n" - .' - 描述：自定义转义符'."\n" - .' - 值：`"\\""`、"\'" 或 ""'."\n" - .' 完整示例：{"null": "-", "header": false, "lineFeed": "\\n", "quote": "", "delimiter": ",", "columns": ["a", "b", "c", "d"]}'."\n" - ."\n" - .'**contentType值为parquet时，contentDetail值的详细参数：**'."\n" - .'- columns'."\n" - .' - 是否必填：是'."\n" - .' - 类型：数组'."\n" - .' - 描述：源日志库中日志的key'."\n" - .' - 示例：{"columns": [{"name": "a", "type": "string"}, {"name": "b", "type": "string"}, {"name": "c", "type": "string"},{"name": "d", "type": "string"}]}'."\n" - ."\n" - .'**contentType值为orc时，contentDetail值的详细参数：**'."\n" - .'- columns'."\n" - .' - 是否必填：是'."\n" - .' - 类型：数组'."\n" - .' - 描述：源日志库中日志的key'."\n" - .' - 示例：{"columns": [{"name": "a", "type": "string"}, {"name": "b", "type": "string"}, {"name": "c", "type": "string"},{"name": "d", "type": "string"}]}', - 'visibility' => 'Public', - '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" - .'},', - ], - ], - 'compressionType' => [ - 'title' => '压缩类型', - 'description' => '支持4种压缩类型，如：snappy、gzip、zstd、none', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'snappy', - ], - 'bufferInterval' => [ - 'title' => '投递时间', - 'description' => '投递时间，取值范围为300~900，单位为秒。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], - 'bufferSize' => [ - 'title' => '投递大小', - 'description' => '投递的文件大小，取值范围为5~256，单位为MB。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '256', - ], - 'delaySec' => [ - 'title' => '废弃', - 'description' => '延迟投递时间'."\n" - .'> - 该字段废弃使用。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '123', - ], - 'delaySeconds' => [ - 'title' => '延迟投递', - 'description' => '延迟投递时间，设置的时间不能超过目标Logstore的数据保存时间。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '900', - ], + 'additionalProperties' => ['description' => '**contentType值为JSON时，contentDetail值的详细参数：**'."\n" + .'- enableTag'."\n" + .' - 是否必填：是'."\n" + .' - 类型：布尔'."\n" + .' - 描述：是否投递 tag字段'."\n" + .' - 值：'."\n" + .' - true'."\n" + .' - 描述：投递 tag字段'."\n" + .' - 示例：{"enableTag": true}'."\n" + .' - false'."\n" + .' - 描述：不投递 tag字段'."\n" + .' - 示例：{"enableTag": false}'."\n" + ."\n" + .'**contentType值为csv时，contentDetail值的详细参数：**'."\n" + .'- columns'."\n" + .' - 是否必填：是'."\n" + .' - 类型：数组'."\n" + .' - 描述：源日志库中日志的key'."\n" + .' - 示例：{"columns":["a", "b", "c", "d"]}'."\n" + .'- delimiter'."\n" + .' - 是否必填：是'."\n" + .' - 类型：字符串'."\n" + .' - 描述：内容间分隔符'."\n" + .' - 值：","、"|"、" " 或 "\\t"'."\n" + .'- header'."\n" + .' - 是否必填：是'."\n" + .' - 类型：布尔'."\n" + .' - 描述：是否将字段名称写入CSV文件（第一行）'."\n" + .' - 值：'."\n" + .' - true'."\n" + .' - false'."\n" + .'- lineFeed'."\n" + .' - 是否必填：否'."\n" + .' - 类型：字符串'."\n" + .' - 描述：自定义换行符'."\n" + .' - 值："\\t"、"\\n" 或 ""'."\n" + .' - 默认值："\\n"'."\n" + .'- null'."\n" + .' - 是否必填：否'."\n" + .' - 类型：字符串'."\n" + .' - 描述：自定义无效字段的填充值'."\n" + .' - 默认值：""'."\n" + .'- quote'."\n" + .' - 是否必填：是'."\n" + .' - 类型：字符串'."\n" + .' - 描述：自定义转义符'."\n" + .' - 值：`"\\""`、"\'" 或 ""'."\n" + .' 完整示例：{"null": "-", "header": false, "lineFeed": "\\n", "quote": "", "delimiter": ",", "columns": ["a", "b", "c", "d"]}'."\n" + ."\n" + .'**contentType值为parquet时，contentDetail值的详细参数：**'."\n" + .'- columns'."\n" + .' - 是否必填：是'."\n" + .' - 类型：数组'."\n" + .' - 描述：源日志库中日志的key'."\n" + .' - 示例：{"columns": [{"name": "a", "type": "string"}, {"name": "b", "type": "string"}, {"name": "c", "type": "string"},{"name": "d", "type": "string"}]}'."\n" + ."\n" + .'**contentType值为orc时，contentDetail值的详细参数：**'."\n" + .'- columns'."\n" + .' - 是否必填：是'."\n" + .' - 类型：数组'."\n" + .' - 描述：源日志库中日志的key'."\n" + .' - 示例：{"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" + .'},'], + ], + 'compressionType' => ['title' => '压缩类型', 'description' => '支持4种压缩类型，如：snappy、gzip、zstd、none', 'type' => 'string', 'required' => false, 'example' => 'snappy'], + 'bufferInterval' => ['title' => '投递时间', 'description' => '投递时间，取值范围为300~900，单位为秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'], + 'bufferSize' => ['title' => '投递大小', 'description' => '投递的文件大小，取值范围为5~256，单位为MB。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '256'], + 'delaySec' => ['title' => '废弃', 'description' => '延迟投递时间'."\n" + .'> - 该字段废弃使用。', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '123'], + 'delaySeconds' => ['title' => '延迟投递', 'description' => '延迟投递时间，设置的时间不能超过目标Logstore的数据保存时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900'], ], 'required' => false, ], - 'fromTime' => [ - 'title' => '时间范围开始', - 'description' => '时间范围开始，值设为1则表示将从日志库中第一条数据开始', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1718380800', - ], - 'toTime' => [ - 'title' => '时间范围结束', - 'description' => '时间范围结束，值设为0则表示任务会一直运行，除非任务被手动停止。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1718380800', - ], + 'fromTime' => ['title' => '时间范围开始', 'description' => '时间范围开始，值设为1则表示将从日志库中第一条数据开始', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718380800'], + 'toTime' => ['title' => '时间范围结束', 'description' => '时间范围结束，值设为0则表示任务会一直运行，除非任务被手动停止。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718380800'], + 'sourceSecureTransport' => ['type' => 'boolean', 'default' => 'false'], ], 'required' => false, ], 'OSSIngestion' => [ 'title' => 'oss ingestion job', 'description' => 'oss ingestion job', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '导入任务名称', - 'description' => '导入任务名称', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123456', - ], - 'description' => [ - 'title' => 'job description', - 'description' => 'job description', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss ingestion', - ], - 'displayName' => [ - 'title' => 'job displayName', - 'description' => 'job displayName', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'oss ingestion', - ], - 'schedule' => [ - 'title' => '调度配置', - 'description' => '调度配置', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'title' => 'oss导入配置', - 'description' => 'oss导入配置', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/OSSIngestionConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'description' => '最近一次修改时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - ], - 'status' => [ - 'title' => '导入状态', - 'description' => '导入状态', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - ], - 'processorId' => [ - 'title' => '写入处理器Id', - 'description' => '写入处理器Id', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - ], + 'name' => ['title' => '导入任务名称', 'description' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456'], + 'description' => ['title' => 'job description', 'description' => 'job description', 'type' => 'string', 'example' => 'oss ingestion'], + 'displayName' => ['title' => 'job displayName', 'description' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'oss ingestion'], + 'schedule' => ['title' => '调度配置', 'description' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['title' => 'oss导入配置', 'description' => 'oss导入配置', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'status' => ['title' => '导入状态', 'description' => '导入状态', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], ], 'OSSIngestionConfiguration' => [ @@ -4548,345 +1851,120 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'description' => 'logstore', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'myLogstore', - ], - 'source' => [ - 'description' => 'OSS导入配置', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/OSSIngestionConfigurationSource', - ], + 'logstore' => ['title' => 'logstore', 'description' => 'logstore', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'myLogstore'], + 'source' => ['description' => 'OSS导入配置', 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfigurationSource'], ], ], 'OSSIngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'description' => 'OSS导入配置', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'endpoint' => [ - 'title' => 'oss endpoint', - 'description' => 'oss endpoint', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'oss-cn-hangzhou.aliyuncs.com', - ], - 'bucket' => [ - 'title' => 'oss bucket', - 'description' => 'oss bucket', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ossbucket', - ], - 'compressionCodec' => [ - 'title' => '压缩类型：none,snappy,gzip', - 'description' => '压缩类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'none', - ], - 'encoding' => [ - 'title' => '编码类型', - 'description' => '编码类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'UTF-8', - ], + 'endpoint' => ['title' => 'oss endpoint', 'description' => 'oss endpoint', 'type' => 'string', 'required' => true, 'example' => 'oss-cn-hangzhou.aliyuncs.com'], + 'bucket' => ['title' => 'oss bucket', 'description' => 'oss bucket', 'type' => 'string', 'required' => true, 'example' => 'ossbucket'], + 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => '压缩类型', 'type' => 'string', 'required' => true, 'example' => 'none'], + 'encoding' => ['title' => '编码类型', 'description' => '编码类型', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], + 'interval' => ['title' => '检查新文件周期', 'description' => '检查新文件周期', 'type' => 'string', 'required' => true, 'example' => 'never'], + 'pattern' => ['title' => '文件路径正则过滤', 'description' => '文件路径正则过滤', 'type' => 'string', 'example' => '.*'], + 'prefix' => ['title' => '文件路径前缀过滤', 'description' => '文件路径前缀过滤', 'type' => 'string', 'example' => 'prefix'], + 'restoreObjectEnabled' => ['title' => '导入归档文件', 'description' => '导入归档文件', 'type' => 'boolean', 'example' => 'true'], + 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => '某个时间点后修改过的文件', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274081'], + 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => '某个时间点前修改过的文件', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'timeField' => ['title' => '提取时间字段', 'description' => '提取时间字段', 'type' => 'string', 'example' => '__time__'], + 'timeFormat' => ['title' => '时间字段格式', 'description' => '时间字段格式', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], + 'timePattern' => ['title' => '提取时间正则', 'description' => '提取时间正则', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], + 'timeZone' => ['title' => '时间字段分区', 'description' => '时间字段分区', 'type' => 'string', 'example' => 'GMT+08:00'], + 'useMetaIndex' => ['title' => '使用OSS元数据索引', 'description' => '使用OSS元数据索引', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'roleARN' => ['title' => 'roleArn', 'description' => 'roleArn', 'type' => 'string', 'example' => 'acs:ram::12345:role/aliyunlogdefaultrole'], + 'tagPackId' => ['title' => '启动上下文检索', 'description' => '启动上下文检索', 'type' => 'boolean', 'example' => 'true'], + 'processorId' => ['title' => '写入处理器id', 'description' => '写入处理器id', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], 'format' => [ 'title' => '格式', 'description' => '格式', - 'visibility' => 'Public', 'type' => 'object', 'required' => true, - 'additionalProperties' => [ - 'description' => 'OSS数据格式。'."\n" - .'- 单行文本日志：`{"type":"Line"}`'."\n" - .'- CSV：'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "type": "CSV",'."\n" - .' "fieldDelimiter": ",", //分隔符'."\n" - .' "quoteChar": "\\"", //引号'."\n" - .' "escapeChar": "\\\\", //转义符'."\n" - .' "firstRowAsHeader": true, //首行是否作为字段名称'."\n" - .' "maxLines": 1, //日志最大跨行数'."\n" - .' "skipLeadingRows": 0 //跳过行数'."\n" - .'}'."\n" - ."\n" - .'```'."\n" - .'- 单行JSON：`{"type": "JSON"}`'."\n" - .'- 跨行文本日志：'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "type": "Multiline",'."\n" - .' "match": "after", //正字匹配位置'."\n" - .' "pattern": "\\\\d+", //正则表达式'."\n" - .' "maxLines": 10 //最大行数'."\n" - .'}'."\n" - .'```'."\n" - .'- ORC：`{"type": "ORC"}`'."\n" - .'- Parquet：`{"type": "Parquet"}`'."\n" - .'- 阿里云OSS访问日志：`{"type": "ossAccessLog"}`'."\n" - .'- 阿里云CDN下载日志：`{"type": "cdnDownloadedLog"}`', - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '{"type": "Line"}', - ], - ], - 'interval' => [ - 'title' => '检查新文件周期', - 'description' => '检查新文件周期', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'never', - ], - 'pattern' => [ - 'title' => '文件路径正则过滤', - 'description' => '文件路径正则过滤', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '.*', + 'additionalProperties' => ['description' => 'OSS数据格式。'."\n" + .'- 单行文本日志：`{"type":"Line"}`'."\n" + .'- CSV：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "type": "CSV",'."\n" + .' "fieldDelimiter": ",", //分隔符'."\n" + .' "quoteChar": "\\"", //引号'."\n" + .' "escapeChar": "\\\\", //转义符'."\n" + .' "firstRowAsHeader": true, //首行是否作为字段名称'."\n" + .' "maxLines": 1, //日志最大跨行数'."\n" + .' "skipLeadingRows": 0 //跳过行数'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + .'- 单行JSON：`{"type": "JSON"}`'."\n" + .'- 跨行文本日志：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "type": "Multiline",'."\n" + .' "match": "after", //正字匹配位置'."\n" + .' "pattern": "\\\\d+", //正则表达式'."\n" + .' "maxLines": 10 //最大行数'."\n" + .'}'."\n" + .'```'."\n" + .'- ORC：`{"type": "ORC"}`'."\n" + .'- Parquet：`{"type": "Parquet"}`'."\n" + .'- 阿里云OSS访问日志：`{"type": "ossAccessLog"}`'."\n" + .'- 阿里云CDN下载日志：`{"type": "cdnDownloadedLog"}`', 'type' => 'any', 'example' => '{"type": "Line"}'], + ], + 'advancedParameters' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'any'], ], - 'prefix' => [ - 'title' => '文件路径前缀过滤', - 'description' => '文件路径前缀过滤', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'prefix', - ], - 'restoreObjectEnabled' => [ - 'title' => '导入归档文件', - 'description' => '导入归档文件', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'startTime' => [ - 'title' => '某个时间点后修改过的文件', - 'description' => '某个时间点后修改过的文件', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714274081', - ], - 'endTime' => [ - 'title' => '某个时间点前修改过的文件', - 'description' => '某个时间点前修改过的文件', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - ], - 'timeField' => [ - 'title' => '提取时间字段', - 'description' => '提取时间字段', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '__time__', - ], - 'timeFormat' => [ - 'title' => '时间字段格式', - 'description' => '时间字段格式', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'yyyy-MM-dd HH:mm:ss', - ], - 'timePattern' => [ - 'title' => '提取时间正则', - 'description' => '提取时间正则', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+', - ], - 'timeZone' => [ - 'title' => '时间字段分区', - 'description' => '时间字段分区', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GMT+08:00', - ], - 'useMetaIndex' => [ - 'title' => '使用OSS元数据索引', - 'description' => '使用OSS元数据索引', - 'visibility' => 'Public', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'roleARN' => [ - 'title' => 'roleArn', - 'description' => 'roleArn', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ram::12345:role/aliyunlogdefaultrole', - ], - 'tagPackId' => [ - 'title' => '启动上下文检索', - 'description' => '启动上下文检索', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'processorId' => [ - 'title' => '写入处理器id', - 'description' => '写入处理器id', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - ], - ], - ], - 'PolicyConfiguration' => [ - 'title' => '告警通知策略配置', - 'description' => '告警通知策略配置', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'alertPolicyId' => [ - 'title' => '告警策略', - 'description' => '告警策略', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sls.builtin.dynamic', - ], - 'actionPolicyId' => [ - 'title' => '行动策略', - 'description' => '行动策略', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'example_action_policy', - ], - 'repeatInterval' => [ - 'title' => '重复等待时间', - 'description' => '重复等待时间', - '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', - ], - ], - ], - 'project' => [ - 'title' => 'A short description of struct', - 'description' => '日志项目Project数据结构。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建Project的时间。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2021-07-07 14:08:09', - ], - 'lastModifyTime' => [ - 'title' => '最后更新时间', - 'description' => '最后一次更新Project时间。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2022-04-18 13:30:19', - ], - 'description' => [ - 'title' => '描述', - 'description' => 'Project描述信息。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Description of my-project', - ], - 'owner' => [ - 'title' => 'project owner', - 'description' => 'Project所属得阿里云账号。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - ], - 'projectName' => [ - 'title' => 'Project名称', - 'description' => 'Project名称，作为Host的一部分。Project名称在阿里云地域内全局唯一，创建后不可修改。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - 'region' => [ - 'title' => '所在区域', - 'description' => 'Project所属地域。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'status' => [ - 'title' => '状态', - 'description' => 'Project状态。'."\n" - ."\n" - .'- Normal：正常'."\n" - .'- Disable：禁用', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Normal', - ], - 'resourceGroupId' => [ - 'title' => '资源组Id', - 'description' => 'Project所属的资源组ID。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rg-acf******sq', - ], - 'dataRedundancyType' => [ - 'title' => '数据冗余类型', - 'description' => '数据冗余类型', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'LRS', - ], - 'quota' => [ - 'title' => 'project quota', - 'description' => 'project quota', - 'visibility' => 'Public', - 'type' => 'object', - 'additionalProperties' => [ - 'visibility' => 'Public', - 'type' => 'any', - ], - ], - 'recycleBinEnabled' => [ - 'title' => '是否打开回收站', - 'description' => '是否打开回收站', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'location' => [ - 'title' => 'project 所在的具体地域', - 'description' => 'project 所在的具体地域', - 'visibility' => 'Public', - 'type' => 'string', + ], + ], + 'PolicyConfiguration' => [ + 'title' => '告警通知策略配置', + 'description' => '告警通知策略配置', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'alertPolicyId' => ['title' => '告警策略', 'description' => '告警策略', 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls.builtin.dynamic'], + 'actionPolicyId' => ['title' => '行动策略', 'description' => '行动策略', 'visibility' => 'Public', 'type' => 'string', 'example' => 'example_action_policy'], + 'repeatInterval' => ['title' => '重复等待时间', 'description' => '重复等待时间', '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'], + ], + ], + 'project' => [ + 'title' => 'A short description of struct', + 'description' => '日志项目Project数据结构。', + 'type' => 'object', + 'properties' => [ + 'createTime' => ['title' => '创建时间', 'description' => '创建Project的时间。', 'type' => 'string', 'example' => '2021-07-07 14:08:09'], + 'lastModifyTime' => ['title' => '最后更新时间', 'description' => '最后一次更新Project时间。', 'type' => 'string', 'example' => '2022-04-18 13:30:19'], + 'description' => ['title' => '描述', 'description' => 'Project描述信息。', 'type' => 'string', 'required' => true, 'example' => 'Description of my-project'], + 'owner' => ['title' => 'project owner', 'description' => 'Project所属得阿里云账号。', 'type' => 'string', 'example' => '""'], + 'projectName' => ['title' => 'Project名称', 'description' => 'Project名称，作为Host的一部分。Project名称在阿里云地域内全局唯一，创建后不可修改。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + 'region' => ['title' => '所在区域', 'description' => 'Project所属地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'status' => ['title' => '状态', 'description' => 'Project状态。'."\n" + ."\n" + .'- Normal：正常'."\n" + .'- Disable：禁用', 'type' => 'string', 'example' => 'Normal'], + 'resourceGroupId' => ['title' => '资源组Id', 'description' => 'Project所属的资源组ID。', 'type' => 'string', 'example' => 'rg-acf******sq'], + 'dataRedundancyType' => ['title' => '数据冗余类型', 'description' => '数据冗余类型', 'type' => 'string', 'example' => 'LRS'], + 'recycleBinEnabled' => ['title' => '是否打开回收站', 'description' => '是否打开回收站', 'type' => 'boolean', 'example' => 'false'], + 'internetEndpoint' => ['title' => '公网访问接入地址', 'type' => 'string'], + 'internalEndpoint' => ['title' => '内网访问接入地址', 'type' => 'string'], + 'quota' => [ + 'title' => 'project quota', + 'description' => 'project quota', + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => ''], ], ], ], @@ -4895,110 +1973,28 @@ 'description' => 'Project信息', 'type' => 'object', 'properties' => [ - 'projectName' => [ - 'title' => 'Project名称', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - 'description' => [ - 'title' => 'Project描述', - 'description' => 'Project描述', - 'type' => 'string', - 'required' => true, - 'example' => '描述信息', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1714360481', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新时间', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1710230272', - ], - 'region' => [ - 'title' => '所在Region', - 'description' => '所在Region', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'description' => '资源组ID', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acf******sq', - ], + 'projectName' => ['title' => 'Project名称', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + 'description' => ['title' => 'Project描述', 'description' => 'Project描述', 'type' => 'string', 'required' => true, 'example' => '描述信息'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1714360481'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710230272'], + 'region' => ['title' => '所在Region', 'description' => '所在Region', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + 'resourceGroupId' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'required' => true, 'example' => 'rg-acf******sq'], ], ], 'S3Ingestion' => [ 'title' => 's3 ingestion job', + 'description' => 's3 ingestion job', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-s3-123456', - ], - 'description' => [ - 'title' => 'job description', - 'type' => 'string', - 'example' => 's3 ingestion', - ], - 'displayName' => [ - 'title' => 'job displayName', - 'type' => 'string', - 'required' => true, - 'example' => 's3 ingestion', - ], - 'schedule' => [ - 'title' => '调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'title' => 's3导入配置', - 'required' => true, - '$ref' => '#/components/schemas/S3IngestionConfigurationSource', - ], - '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', - ], + 'name' => ['title' => '导入任务名称', 'description' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-s3-123456'], + 'description' => ['title' => 'job description', 'description' => 'job description', 'type' => 'string', 'example' => 's3 ingestion'], + 'displayName' => ['title' => 'job displayName', 'description' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 's3 ingestion'], + 'schedule' => ['title' => '调度配置', 'description' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'status' => ['title' => '导入状态', 'description' => '导入状态', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], + 'configuration' => ['title' => 's3导入配置', 'description' => 's3导入配置', 'required' => true, '$ref' => '#/components/schemas/S3IngestionConfiguration'], ], ], 'S3IngestionConfiguration' => [ @@ -5006,192 +2002,49 @@ 'description' => 'S3导入配置', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'description' => 'logstore', - 'type' => 'string', - 'example' => 'myLogstore', - ], - 'source' => [ - 'description' => '来源', - '$ref' => '#/components/schemas/S3IngestionConfigurationSource', - ], + 'logstore' => ['title' => 'logstore', 'description' => 'logstore', 'type' => 'string', 'example' => 'myLogstore'], + 'source' => ['description' => '来源', '$ref' => '#/components/schemas/S3IngestionConfigurationSource'], ], ], 'S3IngestionConfigurationSource' => [ 'title' => 'A short description of struct', 'description' => 'S3导入配置', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'awsRegion' => [ - 'title' => 's3 region', - 'description' => 's3 region', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ap-northeast-1', - ], - 'awsAccessKey' => [ - 'title' => 'aws access key', - 'description' => 'aws access key', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'AKIxxxxxxxxxxYJE', - ], - 'awsAccessKeySecret' => [ - 'title' => 'aws access key secret', - 'description' => 'aws access key secret', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '123xxxxxxxxxxfjf', - ], - 'bucket' => [ - 'title' => 's3 bucket', - 'description' => 's3 bucket', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 's3bucket', - ], - 'compressionCodec' => [ - 'title' => '压缩类型：none,snappy,gzip', - 'description' => '压缩类型：none,snappy,gzip', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'none', - ], - 'encoding' => [ - 'title' => '编码类型', - 'description' => '编码类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'UTF-8', - ], + 'awsRegion' => ['title' => 's3 region', 'description' => 's3 region', 'type' => 'string', 'required' => true, 'example' => 'ap-northeast-1'], + 'awsAccessKey' => ['title' => 'aws access key', 'description' => 'aws access key', 'type' => 'string', 'required' => true, 'example' => 'AKIxxxxxxxxxxYJE'], + 'awsAccessKeySecret' => ['title' => 'aws access key secret', 'description' => 'aws access key secret', 'type' => 'string', 'required' => true, 'example' => '123xxxxxxxxxxfjf'], + 'bucket' => ['title' => 's3 bucket', 'description' => 's3 bucket', 'type' => 'string', 'required' => true, 'example' => 's3bucket'], + 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => '压缩类型：none,snappy,gzip', 'type' => 'string', 'required' => true, 'example' => 'none'], + 'encoding' => ['title' => '编码类型', 'description' => '编码类型', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], + 'interval' => ['title' => '检查新文件周期', 'description' => '检查新文件周期', 'type' => 'string', 'required' => true, 'example' => '30m'], + 'pattern' => ['title' => '文件路径正则过滤', 'description' => '文件路径正则过滤', 'type' => 'string', 'example' => '.*'], + 'prefix' => ['title' => '文件路径前缀过滤', 'description' => '文件路径前缀过滤', 'type' => 'string', 'example' => 'prefix'], + 'awsUseSQS' => ['title' => '使用sqs', 'description' => '使用sqs', 'type' => 'boolean', 'example' => 'false'], + 'awsSQSQueueUrl' => ['title' => 'sqs queue url', 'description' => 'sqs queue url', 'type' => 'string', 'example' => 'https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan'], + 'useAwsSQSOnly' => ['title' => '仅使用sqs获取新文件', 'description' => '仅使用sqs获取新文件', 'type' => 'boolean', 'example' => 'false'], + 'tagPackId' => ['title' => '支持上下文浏览', 'description' => '支持上下文浏览', 'type' => 'boolean', 'example' => 'false'], + 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => '某个时间点后修改过的文件', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274081'], + 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => '某个时间点前修改过的文件', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'timeField' => ['title' => '提取时间字段', 'description' => '提取时间字段', 'type' => 'string', 'example' => '__time__'], + 'timeFormat' => ['title' => '时间字段格式', 'description' => '时间字段格式', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], + 'timePattern' => ['title' => '提取时间正则', 'description' => '提取时间正则', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], + 'timeZone' => ['title' => '时间字段分区', 'description' => '时间字段分区', 'type' => 'string', 'example' => 'GMT+08:00'], + 'processorId' => ['title' => '写入处理器ID', 'description' => '写入处理器ID', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + 'endpoint' => ['title' => 's3 endpoint', 'description' => 's3 endpoint', 'type' => 'string', 'example' => 's3.us-east-1.amazonaws.com'], + 'cloudFrontEndpoint' => ['description' => 'cloudFront endpoint', 'type' => 'string', 'example' => 'dtfsb7voqy76q.cloudfront.net '], + 'cloudFrontToken' => ['description' => 'token', 'type' => 'string', 'example' => '@test-s3-access/ABS'], + 'useCloudFront' => ['title' => '使用CloudFront', 'description' => '使用CloudFront', 'type' => 'boolean'], 'format' => [ 'title' => '格式', 'description' => '格式', - 'visibility' => 'Public', 'type' => 'object', 'required' => true, - 'additionalProperties' => [ - 'description' => '格式', - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '{"type": "line"}', - ], - ], - 'interval' => [ - 'title' => '检查新文件周期', - 'description' => '检查新文件周期', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '30m', - ], - 'pattern' => [ - 'title' => '文件路径正则过滤', - 'description' => '文件路径正则过滤', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '.*', + 'additionalProperties' => ['description' => '格式', 'type' => 'any', 'example' => '{"type": "line"}'], ], - 'prefix' => [ - 'title' => '文件路径前缀过滤', - 'description' => '文件路径前缀过滤', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'prefix', - ], - 'awsUseSQS' => [ - 'title' => '使用sqs', - 'description' => '使用sqs', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'awsSQSQueueUrl' => [ - 'title' => 'sqs queue url', - 'description' => 'sqs queue url', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan', - ], - 'useAwsSQSOnly' => [ - 'title' => '仅使用sqs获取新文件', - 'description' => '仅使用sqs获取新文件', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'tagPackId' => [ - 'title' => '支持上下文浏览', - 'description' => '支持上下文浏览', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'startTime' => [ - 'title' => '某个时间点后修改过的文件', - 'description' => '某个时间点后修改过的文件', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714274081', - ], - 'endTime' => [ - 'title' => '某个时间点前修改过的文件', - 'description' => '某个时间点前修改过的文件', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - ], - 'timeField' => [ - 'title' => '提取时间字段', - 'description' => '提取时间字段', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '__time__', - ], - 'timeFormat' => [ - 'title' => '时间字段格式', - 'description' => '时间字段格式', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'yyyy-MM-dd HH:mm:ss', - ], - 'timePattern' => [ - 'title' => '提取时间正则', - 'description' => '提取时间正则', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+', - ], - 'timeZone' => [ - 'title' => '时间字段分区', - 'description' => '时间字段分区', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GMT+08:00', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'description' => '写入处理器ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - ], - 'endpoint' => [ - 'title' => 's3 endpoint', - 'description' => 's3 endpoint', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 's3.us-east-1.amazonaws.com', + 'advancedParameters' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'any'], ], ], ], @@ -5201,46 +2054,11 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'savedsearchName' => [ - 'sdkPropertyName' => 'savedsearchName', - 'title' => 'savedsearchName', - 'description' => '快速查询名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'savedsearch-name', - ], - 'searchQuery' => [ - 'title' => 'searchQuery', - 'description' => '查询语句或者分析语句。', - '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' => 'Logstore名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - ], - 'topic' => [ - 'title' => 'topic', - 'description' => '日志主题。默认值为空字符串（""）。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'topic-test', - ], - 'displayName' => [ - 'title' => 'displayName', - 'description' => '快速查询显示名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Method', - ], + 'savedsearchName' => ['sdkPropertyName' => 'savedsearchName', 'title' => 'savedsearchName', 'description' => '快速查询名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name'], + 'searchQuery' => ['title' => 'searchQuery', 'description' => '查询语句或者分析语句。', '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' => 'Logstore名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore'], + 'topic' => ['title' => 'topic', 'description' => '日志主题。默认值为空字符串（""）。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'topic-test'], + 'displayName' => ['title' => 'displayName', 'description' => '快速查询显示名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'Method'], ], ], 'Schedule' => [ @@ -5253,42 +2071,13 @@ 'type' => 'string', 'required' => true, 'example' => 'FixedRate', - 'enum' => [ - 'FixedRate', - 'Cron', - ], - ], - 'cronExpression' => [ - 'title' => 'Cron情况下：cron表达式', - 'type' => 'string', - 'required' => false, - 'example' => '0/5 * * * *', - ], - 'runImmediately' => [ - 'title' => '定时任务是否立即执行', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'timeZone' => [ - 'title' => 'Cron表达式所在时区，默认为空，表示东八区', - 'type' => 'string', - 'required' => false, - 'example' => '+0800', - ], - 'delay' => [ - 'title' => '定时类任务延迟执行（单位是秒：s）', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - 'interval' => [ - 'title' => 'FixedRate情况下：固定间隔', - 'type' => 'string', - 'required' => false, - 'example' => '60s', + 'enum' => ['FixedRate', 'Cron'], ], + 'cronExpression' => ['title' => 'Cron情况下：cron表达式', 'type' => 'string', 'required' => false, 'example' => '0/5 * * * *'], + 'runImmediately' => ['title' => '定时任务是否立即执行', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'timeZone' => ['title' => 'Cron表达式所在时区，默认为空，表示东八区', 'type' => 'string', 'required' => false, 'example' => '+0800'], + 'delay' => ['title' => '定时类任务延迟执行（单位是秒：s）', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + 'interval' => ['title' => 'FixedRate情况下：固定间隔', 'type' => 'string', 'required' => false, 'example' => '60s'], ], 'required' => false, ], @@ -5298,74 +2087,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '定时sql任务描述', - 'description' => 'Job Description', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a scheduled sql job', - ], - 'displayName' => [ - 'title' => '定时sql显示名称', - 'description' => 'Job DisplayName', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a scheduled sql job', - ], - 'name' => [ - 'title' => '定时sql任务名称', - 'description' => 'Scheduled SQL name', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-scheduled-sql', - ], - 'schedule' => [ - 'title' => '调度配置', - 'description' => '调度配置', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'title' => '定时sql配置', - 'description' => '定时sql配置', - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/ScheduledSQLConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714123644', - ], - 'lastModifiedTime' => [ - 'title' => '最近修改时间', - 'description' => '最近修改时间', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714123644', - ], - 'scheduleId' => [ - 'title' => '调度ID', - 'description' => '调度ID', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'e73f43732852064ad5d091914e39342f', - ], - 'status' => [ - 'title' => '定时SQL状态', - 'description' => '定时SQL状态', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ENABLED', - ], + 'description' => ['title' => '定时sql任务描述', 'description' => 'Job Description', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'This is a scheduled sql job'], + 'displayName' => ['title' => '定时sql显示名称', 'description' => 'Job DisplayName', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'This is a scheduled sql job'], + 'name' => ['title' => '定时sql任务名称', 'description' => 'Scheduled SQL name', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-scheduled-sql'], + 'schedule' => ['title' => '调度配置', 'description' => '调度配置', 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['title' => '定时sql配置', 'description' => '定时sql配置', 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1714123644'], + 'lastModifiedTime' => ['title' => '最近修改时间', 'description' => '最近修改时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1714123644'], + 'scheduleId' => ['title' => '调度ID', 'description' => '调度ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'e73f43732852064ad5d091914e39342f'], + 'status' => ['title' => '定时SQL状态', 'description' => '定时SQL状态', 'visibility' => 'Public', 'type' => 'string', 'example' => 'ENABLED'], ], 'required' => false, ], @@ -5375,156 +2105,33 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'script' => [ - 'title' => 'SQL代码', - 'description' => '定时SQL分析语句', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '* | select *', - ], - 'sqlType' => [ - 'title' => 'SQL类型', - 'description' => 'SQL类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'searchQuery', - ], - 'destEndpoint' => [ - 'title' => '目标Region', - 'description' => '目标Endpoint', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com', - ], - 'destProject' => [ - 'title' => '目标Project', - 'description' => '目标Project', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'project-demo', - ], - 'sourceLogstore' => [ - 'title' => '源库', - 'description' => '源库', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'source-logstore-demo', - ], - 'destLogstore' => [ - 'title' => '目标库', - 'description' => '目标库', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'dest-logstore-demo', - ], - 'roleArn' => [ - 'title' => '角色ARN', - 'description' => '执行SQL授权角色ARN', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::123456789:role/aliyunlogetlrole', - ], - 'destRoleArn' => [ - 'title' => '写角色ARN', - 'description' => '写目标授权角色ARN', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::123456789:role/aliyunlogetlrole', - ], - 'fromTimeExpr' => [ - 'title' => 'SQL时间窗口开始', - 'description' => 'SQL时间窗口开始', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '@m-1m', - ], - 'toTimeExpr' => [ - 'title' => 'SQL时间窗口结束', - 'description' => 'SQL时间窗口结束', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '@m', - ], - 'maxRunTimeInSeconds' => [ - 'title' => 'SQL超时最长时间', - 'description' => 'SQL超时最长时间，单位：秒，取值范围60~1800。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '600', - ], - 'resourcePool' => [ - 'title' => 'resourcePool', - 'description' => '资源池类型（enhanced表示增强型）', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'enhanced', - ], - 'maxRetries' => [ - 'title' => 'SQL超时最大次数', - 'description' => 'SQL超时最大次数，取值范围1～100。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], - 'fromTime' => [ - 'title' => '调度时间范围开始', - 'description' => '开始时间。更多信息请参见[从Logstore到MetricStore'."\n" - .'](~~286459~~)。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1712592000', - ], - 'toTime' => [ - 'title' => '调度时间范围结束', - 'description' => '结束时间。更多信息请参见[从Logstore到MetricStore'."\n" - .'](~~286459~~)。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - 'dataFormat' => [ - 'title' => '定时sql写入模式', - 'description' => '支持三种配置：log2log、log2metric、metric2metric。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'log2log', - ], - 'parameters' => [ - 'title' => 'parameters', - 'description' => 'SQL配置。更多信息请参见[从Logstore到MetricStore'."\n" - .'](~~286459~~)。', - '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" - .'}', - ], + 'script' => ['title' => 'SQL代码', 'description' => '定时SQL分析语句', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | select *'], + 'sqlType' => ['title' => 'SQL类型', 'description' => 'SQL类型', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'searchQuery'], + 'destEndpoint' => ['title' => '目标Region', 'description' => '目标Endpoint', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com'], + 'destProject' => ['title' => '目标Project', 'description' => '目标Project', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'project-demo'], + 'sourceLogstore' => ['title' => '源库', 'description' => '源库', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'source-logstore-demo'], + 'destLogstore' => ['title' => '目标库', 'description' => '目标库', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'dest-logstore-demo'], + 'roleArn' => ['title' => '角色ARN', 'description' => '执行SQL授权角色ARN', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], + 'destRoleArn' => ['title' => '写角色ARN', 'description' => '写目标授权角色ARN', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], + 'fromTimeExpr' => ['title' => 'SQL时间窗口开始', 'description' => 'SQL时间窗口开始', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '@m-1m'], + 'toTimeExpr' => ['title' => 'SQL时间窗口结束', 'description' => 'SQL时间窗口结束', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '@m'], + 'maxRunTimeInSeconds' => ['title' => 'SQL超时最长时间', 'description' => 'SQL超时最长时间，单位：秒，取值范围60~1800。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '600'], + 'resourcePool' => ['title' => 'resourcePool', 'description' => '资源池类型（enhanced表示增强型）', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'enhanced'], + 'maxRetries' => ['title' => 'SQL超时最大次数', 'description' => 'SQL超时最大次数，取值范围1～100。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], + 'fromTime' => ['title' => '调度时间范围开始', 'description' => '开始时间。更多信息请参见[从Logstore到MetricStore'."\n" + .'](~~286459~~)。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1712592000'], + 'toTime' => ['title' => '调度时间范围结束', 'description' => '结束时间。更多信息请参见[从Logstore到MetricStore'."\n" + .'](~~286459~~)。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], + 'dataFormat' => ['title' => '定时sql写入模式', 'description' => '支持三种配置：log2log、log2metric、metric2metric。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'log2log'], + 'parameters' => ['title' => 'parameters', 'description' => 'SQL配置。更多信息请参见[从Logstore到MetricStore'."\n" + .'](~~286459~~)。', '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, ], @@ -5542,21 +2149,10 @@ .'- Closed：已欠费禁用。', 'visibility' => 'Public', 'type' => 'string', - 'enumValueTitles' => [ - 'Opened' => 'Opened', - 'NotExist' => 'NotExist', - 'Opening' => 'Opening', - 'Closed' => 'Closed', - ], + 'enumValueTitles' => ['Opened' => 'Opened', 'NotExist' => 'NotExist', 'Opening' => 'Opening', 'Closed' => 'Closed'], 'example' => 'NotExist', ], - 'enabled' => [ - 'title' => '是否开通', - 'description' => '是否开通', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], + 'enabled' => ['title' => '是否开通', 'description' => '是否开通', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'], ], ], 'SeverityConfiguration' => [ @@ -5565,20 +2161,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'severity' => [ - 'title' => '告警严重度数值', - 'description' => '告警严重度数值', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'evalCondition' => [ - 'title' => '触发条件配置', - 'description' => '触发条件配置', - 'visibility' => 'Public', - '$ref' => '#/components/schemas/ConditionConfiguration', - ], + 'severity' => ['title' => '告警严重度数值', 'description' => '告警严重度数值', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'evalCondition' => ['title' => '触发条件配置', 'description' => '触发条件配置', 'visibility' => 'Public', '$ref' => '#/components/schemas/ConditionConfiguration'], ], ], 'shard' => [ @@ -5587,53 +2171,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'shardID' => [ - 'title' => 'shard id', - 'description' => 'shard id', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'status' => [ - 'title' => 'shard 的读写状态，readwrite 或者 readonly。', - 'description' => 'Shard状态。创建Shard时，所有Shard状态均为readwrite状态。执行分裂或合并操作后，Shard状态变更为readonly，并生成新的readwrite状态的Shard。Shard状态不影响其数据读取的性能。readwrite状态的Shard可保证数据写入性能，readonly状态的Shard不提供数据写入服务。取值包括：'."\n" - ."\n" - .'- readwrite（读写）'."\n" - .'- readonly（只读）'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'readwrite', - ], - 'inclusiveBeginKey' => [ - 'title' => '指定Shard范围的起始值，Shard范围中包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', - 'description' => 'Shard起始的Key值，在Shard MD5范围中包含该值。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '00000000000000000000000000000000', - ], - 'exclusiveEndKey' => [ - 'title' => '指定Shard范围的结束值，Shard范围中不包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', - 'description' => '分区结束的Key值。', - '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' => '分区的创建时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1524222931', - ], + 'shardID' => ['title' => 'shard id', 'description' => 'shard id', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'status' => ['title' => 'shard 的读写状态，readwrite 或者 readonly。', 'description' => 'Shard状态。创建Shard时，所有Shard状态均为readwrite状态。执行分裂或合并操作后，Shard状态变更为readonly，并生成新的readwrite状态的Shard。Shard状态不影响其数据读取的性能。readwrite状态的Shard可保证数据写入性能，readonly状态的Shard不提供数据写入服务。取值包括：'."\n" + ."\n" + .'- readwrite（读写）'."\n" + .'- readonly（只读）'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'readwrite'], + 'inclusiveBeginKey' => ['title' => '指定Shard范围的起始值，Shard范围中包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', 'description' => 'Shard起始的Key值，在Shard MD5范围中包含该值。', 'visibility' => 'Public', 'type' => 'string', 'example' => '00000000000000000000000000000000'], + 'exclusiveEndKey' => ['title' => '指定Shard范围的结束值，Shard范围中不包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', 'description' => '分区结束的Key值。', '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' => '分区的创建时间。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1524222931'], ], ], 'ShardingPolicy' => [ @@ -5648,19 +2194,10 @@ 'keys' => [ 'title' => '用于计算哈希的键，大小写敏感，顺序敏感，键不能重复。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'userId', - ], - 'required' => true, - ], - 'groupCount' => [ - 'title' => 'ShardGroup 分组个数，必须为 2 的幂次，小于 shard 个数，通常为 4-32 个。', - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['type' => 'string', 'example' => 'userId'], 'required' => true, - 'example' => '8', ], + 'groupCount' => ['title' => 'ShardGroup 分组个数，必须为 2 的幂次，小于 shard 个数，通常为 4-32 个。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8'], ], ], 'shardHash' => [ @@ -5670,10 +2207,7 @@ 'keys' => [ 'title' => '用于计算哈希的键，大小写敏感，顺序敏感，键不能重复。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'instanceId', - ], + 'items' => ['type' => 'string', 'example' => 'instanceId'], 'required' => true, ], 'maxHashCount' => [ @@ -5683,21 +2217,12 @@ 'required' => true, 'example' => '2', 'default' => '2', - 'enum' => [ - '1', - '2', - '4', - ], + 'enum' => ['1', '2', '4'], ], ], 'required' => true, ], - 'queryActiveTime' => [ - 'title' => '查询生效时间，Unix Timestamp', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1764659409', - ], + 'queryActiveTime' => ['title' => '查询生效时间，Unix Timestamp', 'type' => 'integer', 'format' => 'int64', 'example' => '1764659409'], ], ], 'SinkAlerthubConfiguration' => [ @@ -5706,13 +2231,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'title' => '是否开启', - 'description' => '是否开启', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], + 'enabled' => ['title' => '是否开启', 'description' => '是否开启', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], ], 'required' => false, ], @@ -5722,13 +2241,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'title' => '是否开启', - 'description' => '是否开启', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], + 'enabled' => ['title' => '是否开启', 'description' => '是否开启', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], ], ], 'SinkEventStoreConfiguration' => [ @@ -5737,41 +2250,11 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'title' => '是否开启', - 'description' => '是否开启', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'endpoint' => [ - 'title' => 'endpoint', - 'description' => 'endpoint', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-shanghai-intranet.log.aliyuncs.com', - ], - 'project' => [ - 'title' => '项目名称', - 'description' => '项目名称', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'exampleProject', - ], - 'eventStore' => [ - 'title' => '事件库名称', - 'description' => '事件库名称', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'exampleStore', - ], - 'roleArn' => [ - 'title' => '角色', - 'description' => '角色', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ram::123456789:role/aliyunlogetlrole', - ], + 'enabled' => ['title' => '是否开启', 'description' => '是否开启', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], + 'endpoint' => ['title' => 'endpoint', 'description' => 'endpoint', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai-intranet.log.aliyuncs.com'], + 'project' => ['title' => '项目名称', 'description' => '项目名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'exampleProject'], + 'eventStore' => ['title' => '事件库名称', 'description' => '事件库名称', 'visibility' => 'Public', 'type' => 'string', 'example' => 'exampleStore'], + 'roleArn' => ['title' => '角色', 'description' => '角色', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], ], ], 'StoreViewStore' => [ @@ -5779,26 +2262,9 @@ 'description' => 'StoreView store', 'type' => 'object', 'properties' => [ - 'project' => [ - 'title' => 'Project 名称', - 'description' => 'Project 名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - 'storeName' => [ - 'title' => 'LogStore 或 MetricStore 名称', - 'description' => 'LogStore 或 MetricStore 名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - 'query' => [ - 'title' => '查询过滤语句', - 'description' => '查询过滤语句', - 'type' => 'string', - 'example' => 'job: IT | select name, age, gender from log', - ], + 'project' => ['title' => 'Project 名称', 'description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + 'storeName' => ['title' => 'LogStore 或 MetricStore 名称', 'description' => 'LogStore 或 MetricStore 名称', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], + 'query' => ['title' => '查询过滤语句', 'description' => '查询过滤语句', 'type' => 'string', 'example' => 'job: IT | select name, age, gender from log'], ], ], 'SubmitAsyncSqlParams' => [ @@ -5806,54 +2272,17 @@ 'description' => '提交异步SQL的参数', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore的名称', - 'description' => 'logstore的名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'query' => [ - 'title' => '待执行的SQL内容', - 'description' => '待执行的SQL内容', - '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' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268100', - ], - 'to' => [ - 'title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', - 'description' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268200', - ], + 'logstore' => ['title' => 'logstore的名称', 'description' => 'logstore的名称', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'query' => ['title' => '待执行的SQL内容', 'description' => '待执行的SQL内容', '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' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268100'], + 'to' => ['title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', 'description' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200'], 'extensions' => [ 'title' => '扩展项', 'description' => '扩展项', 'type' => 'object', 'properties' => [ - 'maxRunTime' => [ - 'title' => '允许请求执行的最大时间（单位毫秒），当前设置的允许最大执行时间不得超过600000（即10分钟），默认值为600000', - 'description' => '允许请求执行的最大时间（单位毫秒），当前设置的允许最大执行时间不得超过600000（即10分钟），默认值为600000', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000', - ], - 'powerSql' => [ - 'title' => '是否开启增强SQL，默认为false', - 'description' => '是否开启增强SQL，默认为false', - 'type' => 'boolean', - 'example' => 'true', - ], + 'maxRunTime' => ['title' => '允许请求执行的最大时间（单位毫秒），当前设置的允许最大执行时间不得超过600000（即10分钟），默认值为600000', 'description' => '允许请求执行的最大时间（单位毫秒），当前设置的允许最大执行时间不得超过600000（即10分钟），默认值为600000', 'type' => 'integer', 'format' => 'int64', 'example' => '30000'], + 'powerSql' => ['title' => '是否开启增强SQL，默认为false', 'description' => '是否开启增强SQL，默认为false', 'type' => 'boolean', 'example' => 'true'], ], ], ], @@ -5864,49 +2293,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '模板ID', - 'description' => '模板ID', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'sls.app.ack.ip.not_enough', - ], - 'type' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'sys', - ], - 'version' => [ - 'title' => '模板版本', - 'description' => '模板版本', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - ], - 'lang' => [ - 'title' => '模板语言', - 'description' => '模板语言', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn', - ], - 'tokens' => [ - 'title' => '模板携带的token', - 'description' => '模板携带的token', - 'visibility' => 'Public', - 'type' => 'object', - 'required' => false, - ], - 'aonotations' => [ - 'title' => '模板标注', - 'description' => '模板标注', - 'visibility' => 'Public', - 'type' => 'object', - ], + 'id' => ['title' => '模板ID', 'description' => '模板ID', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'sls.app.ack.ip.not_enough'], + 'type' => ['title' => '模板类型', 'description' => '模板类型', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'sys'], + 'version' => ['title' => '模板版本', 'description' => '模板版本', 'visibility' => 'Public', 'type' => 'string', 'example' => '1'], + 'lang' => ['title' => '模板语言', 'description' => '模板语言', 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn'], + 'tokens' => ['title' => '模板携带的token', 'description' => '模板携带的token', 'visibility' => 'Public', 'type' => 'object', 'required' => false], + 'aonotations' => ['title' => '模板标注', 'description' => '模板标注', 'visibility' => 'Public', 'type' => 'object'], ], ], 'Ticket' => [ @@ -5914,344 +2306,80 @@ 'description' => 'Ticket信息', 'type' => 'object', 'properties' => [ - 'ticketId' => [ - 'title' => 'ticket对应唯一Id', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'ticket' => [ - 'title' => 'ticket', - 'type' => 'string', - 'example' => 'xxxxx', - ], - 'number' => [ - 'title' => 'ticket最大使用次数', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '1', - ], - 'expirationTime' => [ - 'title' => 'ticket过期时间，秒为单位', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'extra' => [ - 'title' => '扩展字段', - 'type' => 'string', - 'example' => '{"xx":"yy"}', - ], - 'callerUid' => [ - 'title' => 'ticket创建时的Uid', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000000000', - ], - 'name' => [ - 'title' => '名称', - 'type' => 'string', - 'example' => '测试', - ], - 'usedNumber' => [ - 'title' => 'ticket已使用次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'createDate' => [ - 'title' => 'ticket创建时间', - 'type' => 'string', - 'example' => '2023-09-06 14:57:07', - ], - 'expireDate' => [ - 'title' => 'ticket过期时间', - 'type' => 'string', - 'example' => '2023-09-06 14:58:07', - ], - 'valid' => [ - 'title' => '是否禁止', - 'type' => 'boolean', - 'example' => 'false', - ], - 'sharingTo' => [ - 'title' => '分享对象', - 'type' => 'string', - 'example' => '{"type":"aliyun","ids":[1,2]}', - ], + 'ticketId' => ['title' => 'ticket对应唯一Id', 'type' => 'string', 'example' => 'xxxxx'], + 'ticket' => ['title' => 'ticket', 'type' => 'string', 'example' => 'xxxxx'], + 'number' => ['title' => 'ticket最大使用次数', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1'], + 'expirationTime' => ['title' => 'ticket过期时间，秒为单位', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'extra' => ['title' => '扩展字段', 'type' => 'string', 'example' => '{"xx":"yy"}'], + 'callerUid' => ['title' => 'ticket创建时的Uid', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000000'], + 'name' => ['title' => '名称', 'type' => 'string', 'example' => '测试'], + 'usedNumber' => ['title' => 'ticket已使用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'createDate' => ['title' => 'ticket创建时间', 'type' => 'string', 'example' => '2023-09-06 14:57:07'], + 'expireDate' => ['title' => 'ticket过期时间', 'type' => 'string', 'example' => '2023-09-06 14:58:07'], + 'valid' => ['title' => '是否禁止', 'type' => 'boolean', 'example' => 'false'], + 'sharingTo' => ['title' => '分享对象', 'type' => 'string', 'example' => '{"type":"aliyun","ids":[1,2]}'], ], ], ], ], 'apis' => [ - 'AddMemories' => [ - 'path' => '/memorystores/{memoryStore}/memories', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ApplyConfigToMachineGroup' => [ + 'summary' => '将Logtail配置应用到机器组。', + 'path' => '/machinegroups/{machineGroup}/configs/{configName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'async_mode' => [ - 'type' => 'boolean', - ], - 'messages' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'type' => 'string', - 'description' => '', - ], - 'role' => [ - 'type' => 'string', - 'description' => '', - ], - ], - 'description' => '', - ], - 'description' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'properties' => [ - 'session_id' => [ - 'type' => 'string', - ], - 'timestamp' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'updated_by' => [ - 'type' => 'string', - ], - ], - 'description' => '', - ], - 'user_id' => [ - 'type' => 'string', - 'description' => '', - ], - 'agent_id' => [ - 'type' => 'string', - ], - 'app_id' => [ - 'type' => 'string', - ], - 'run_id' => [ - 'type' => 'string', - ], - 'infer' => [ - 'type' => 'boolean', - ], - 'custom_instructions' => [ - 'type' => 'string', - ], - ], - 'description' => '', - ], - ], - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'results' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'message' => [ - 'type' => 'string', - ], - 'status' => [ - 'type' => 'string', - ], - 'eventId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '添加记忆', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"results\\": [\\n {\\n \\"message\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"eventId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'ApplyConfigToMachineGroup' => [ - 'summary' => '将Logtail配置应用到机器组。', - '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', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'sample-group', - ], + 'schema' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'sample-group'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'title' => 'logtail 配置名称。', - 'description' => 'Logtail配置名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'logtail-config-sample', - ], + 'schema' => ['title' => 'logtail 配置名称。', 'description' => 'Logtail配置名称。', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '应用Logtail配置到机器组', 'description' => '+ Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" @@ -6279,24 +2407,11 @@ 'action' => 'log:ApplyConfigToGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['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}', - ], + ['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}'], ], ], ], @@ -6305,30 +2420,20 @@ 'CallAiTools' => [ 'summary' => '调用可观测 AI 工具，工具能力会持续更新，可通过工具列表接口获取当前支持能力', 'path' => '/ml/tool/call', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '267815', - 'abilityTreeNodes' => [ - 'FEATUREslsOO5P9U', - ], + 'abilityTreeNodes' => ['FEATUREslsOO5P9U'], ], 'parameters' => [ [ @@ -6338,25 +2443,14 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'toolName' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'toolName' => ['type' => 'string', 'required' => true, 'description' => ''], 'params' => [ 'description' => '工具参数', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - ], - ], - 'regionId' => [ - 'description' => '目标 Region', - 'type' => 'string', - 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => ''], ], + 'regionId' => ['description' => '目标 Region', 'type' => 'string', 'required' => false], ], 'required' => false, 'description' => '', @@ -6367,58 +2461,30 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => '调用可观测AI工具能力', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '调用可观测 AI 工具能力', + 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -6426,45 +2492,95 @@ 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\"\\"","type":"json"}]', ], + 'CancelDownloadJob' => [ + 'summary' => '取消下载', + '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名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'downloadJobName', + 'in' => 'path', + 'schema' => ['description' => '日志下载任务名称', 'type' => 'string', 'required' => true, 'example' => 'download-123'], + ], + ], + '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' => '取消日志下载任务', + 'description' => '当前支持区域：河源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], 'ChangeResourceGroup' => [ 'summary' => '修改Project归属的资源组。', 'path' => '/resourcegroup', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '158383', - 'abilityTreeNodes' => [ - 'FEATUREslsKS6FGY', - ], + 'abilityTreeNodes' => ['FEATUREslsKS6FGY'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '资源所属的project', - 'description' => '资源所属的Project名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => '资源所属的project', 'description' => '资源所属的Project名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], [ 'name' => 'body', @@ -6474,25 +2590,9 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'description' => '资源的类型。只支持PROJECT，固定填写为PROJECT。', - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT', - 'default' => 'PROJECT', - ], - 'resourceId' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - 'resourceGroupId' => [ - 'description' => '[资源组ID](~~151181~~)', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-ae******ey', - ], + 'resourceType' => ['description' => '资源的类型。只支持PROJECT，固定填写为PROJECT。', 'type' => 'string', 'required' => false, 'example' => 'PROJECT', 'default' => 'PROJECT'], + 'resourceId' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + 'resourceGroupId' => ['description' => '[资源组ID](~~151181~~)', 'type' => 'string', 'required' => true, 'example' => 'rg-ae******ey'], ], 'required' => false, 'example' => 'ali-test-project', @@ -6503,40 +2603,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], @@ -6554,17 +2636,10 @@ 'action' => 'log:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], + ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], @@ -6573,69 +2648,38 @@ 'ConsumerGroupHeartBeat' => [ 'summary' => '消费者发送心跳到服务端。', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}?type=heartbeat', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + 'methods' => ['post'], + 'schemes' => ['https', 'http'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'description' => '消费组名称，同一Project中消费组名称为唯一值。', - 'type' => 'string', - 'required' => true, - 'example' => 'consumer_group_test', - ], + 'schema' => ['description' => '消费组名称，同一Project中消费组名称为唯一值。', 'type' => 'string', 'required' => true, 'example' => 'consumer_group_test'], ], [ 'name' => 'consumer', 'in' => 'query', - 'schema' => [ - 'description' => '消费者。', - 'type' => 'string', - 'required' => true, - 'example' => 'consumer_1', - ], + 'schema' => ['description' => '消费者。', 'type' => 'string', 'required' => true, 'example' => 'consumer_1'], ], [ 'name' => 'body', @@ -6644,13 +2688,7 @@ 'schema' => [ 'description' => '正在消费的Shard ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '正在消费的Shard ID列表。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '[0]', - ], + 'items' => ['description' => '正在消费的Shard ID列表。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[0]'], 'required' => true, ], ], @@ -6659,45 +2697,25 @@ 200 => [ 'headers' => [ 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], ], 'schema' => [ 'description' => '消费者消费的所有Shard ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '消费者消费的所有Shard ID列表。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '[0]', - ], + 'items' => ['description' => '消费者消费的所有Shard ID列表。', 'type' => 'integer', 'format' => 'int32', 'example' => '[0]'], ], ], ], @@ -6738,18 +2756,10 @@ 'action' => 'log:ConsumerGroupHeartBeat', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -6758,20 +2768,14 @@ 'ConsumerGroupUpdateCheckPoint' => [ 'summary' => '更新指定消费组消费数据时Shard的checkpoint。', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}?type=checkpoint', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -6780,63 +2784,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '155573', - 'abilityTreeNodes' => [ - 'FEATUREslsD1VSU4', - ], + 'abilityTreeNodes' => ['FEATUREslsD1VSU4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'description' => '消费组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'consumer_group_test', - ], + 'schema' => ['description' => '消费组名称。', 'type' => 'string', 'required' => true, 'example' => 'consumer_group_test'], ], [ 'name' => 'consumer', 'in' => 'query', - 'schema' => [ - 'description' => '消费者。', - 'type' => 'string', - 'required' => true, - 'example' => 'consumer_1', - ], + 'schema' => ['description' => '消费者。', 'type' => 'string', 'required' => true, 'example' => 'consumer_1'], ], [ 'name' => 'forceSuccess', 'in' => 'query', - 'schema' => [ - 'description' => '是否强制更新。'."\n" - .' - true：强制更新'."\n" - .' - false：不强制更新', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否强制更新。'."\n" + .' - true：强制更新'."\n" + .' - false：不强制更新', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'body', @@ -6846,19 +2822,8 @@ 'description' => 'Shard ID。', 'type' => 'object', 'properties' => [ - 'shard' => [ - 'description' => 'Shard ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - 'checkpoint' => [ - 'description' => 'checkpoint值。', - 'type' => 'string', - 'required' => true, - 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng==', - ], + 'shard' => ['description' => 'Shard ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + 'checkpoint' => ['description' => 'checkpoint值。', 'type' => 'string', 'required' => true, 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng=='], ], 'required' => false, ], @@ -6868,47 +2833,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新消费进度', 'description' => '### 接口说明'."\n" @@ -6941,18 +2886,10 @@ 'action' => 'log:ConsumerGroupUpdateCheckPoint', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -6960,20 +2897,14 @@ ], 'CreateAgentInstanceConfig' => [ 'path' => '/agentinstanceconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -6982,9 +2913,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '233752', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -7001,20 +2930,8 @@ 'type' => 'string', 'required' => true, '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', + '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', ], 'example' => 'apm_trace', ], @@ -7022,27 +2939,14 @@ 'description' => '进程级配置归属', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '进程级配置归属', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - ], - ], - 'config' => [ - 'description' => '默认配置', - 'type' => 'string', - 'required' => true, - 'example' => '{}', + 'additionalProperties' => ['type' => 'string', 'description' => '进程级配置归属', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"'], ], + 'config' => ['description' => '默认配置', 'type' => 'string', 'required' => true, 'example' => '{}'], 'grayConfigs' => [ 'description' => '灰度配置', 'type' => 'array', - 'items' => [ - 'description' => '灰度配置', - 'required' => false, - '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', - ], + 'items' => ['description' => '灰度配置', 'required' => false, '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs'], 'required' => false, ], ], @@ -7054,47 +2958,27 @@ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '创建进程级配置', 'summary' => '创建进程级配置', 'changeSet' => [], @@ -7107,41 +2991,27 @@ 'CreateAlert' => [ 'summary' => '在指定Project下创建一个告警规则。', 'path' => '/alerts', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '200211', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'body', @@ -7151,34 +3021,11 @@ 'description' => '告警规则配置', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '告警名称，project下唯一', - 'type' => 'string', - 'required' => true, - 'example' => 'alert-123456', - ], - 'displayName' => [ - 'description' => '告警显示名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-alert', - ], - 'description' => [ - 'description' => '告警描述', - 'type' => 'string', - 'required' => false, - 'example' => '一条告警规则', - ], - 'configuration' => [ - 'description' => '告警详细配置', - 'required' => true, - '$ref' => '#/components/schemas/AlertConfiguration', - ], - 'schedule' => [ - 'description' => '告警调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], + 'name' => ['description' => '告警名称，project下唯一', 'type' => 'string', 'required' => true, 'example' => 'alert-123456'], + 'displayName' => ['description' => '告警显示名称', 'type' => 'string', 'required' => true, 'example' => 'test-alert'], + 'description' => ['description' => '告警描述', 'type' => 'string', 'required' => false, 'example' => 'An alert rule'], + 'configuration' => ['description' => '告警详细配置', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration'], + 'schedule' => ['description' => '告警调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], ], 'required' => false, ], @@ -7187,54 +3034,28 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建告警规则', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" @@ -7255,12 +3076,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -7269,99 +3085,57 @@ 'CreateAnnotationDataSet' => [ 'summary' => '创建数据集。', 'path' => '/ml/annotationdataset', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '请求数据集结构体参数', - 'required' => false, - '$ref' => '#/components/schemas/MLDataSetParam', - ], + 'schema' => ['description' => '请求数据集结构体参数', 'required' => false, '$ref' => '#/components/schemas/MLDataSetParam'], ], [ 'name' => 'datasetId', 'in' => 'query', - 'schema' => [ - 'description' => '数据集唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => '数据集唯一标识', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建数据集', + 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -7371,87 +3145,49 @@ 'CreateAnnotationLabel' => [ 'summary' => '创建标签表。', 'path' => '/ml/annotationlabel', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '请求标签表结构体。', - 'required' => false, - '$ref' => '#/components/schemas/MLLabelParam', - ], + 'schema' => ['description' => '请求标签表结构体。', 'required' => false, '$ref' => '#/components/schemas/MLLabelParam'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建标签', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -7462,42 +3198,29 @@ 'ramActions' => [], ], 'CreateAzureBlobIngestion' => [ - 'summary' => '创建Azure blob文件导入任务', + 'summary' => '创建AzureBlob导入任务', 'path' => '/azureblobingestions', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '291227', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ 'name' => 'body', @@ -7506,29 +3229,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'displayName' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], - 'schedule' => [ - '$ref' => '#/components/schemas/Schedule', - 'description' => '', - ], - 'configuration' => [ - 'required' => true, - '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', - 'description' => '', - ], - 'name' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'description' => ['type' => 'string', 'description' => ''], + 'displayName' => ['type' => 'string', 'required' => true, 'description' => ''], + 'schedule' => ['$ref' => '#/components/schemas/Schedule', 'description' => ''], + 'configuration' => ['required' => true, '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', 'description' => ''], + 'name' => ['type' => 'string', 'required' => true, 'description' => ''], ], 'required' => false, 'description' => '', @@ -7539,50 +3244,30 @@ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建AzureBlob导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -7593,21 +3278,14 @@ 'CreateConfig' => [ 'summary' => '创建Logtail采集配置。', 'path' => '/configs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -7616,75 +3294,40 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8979', - 'abilityTreeNodes' => [ - 'FEATUREslsYP6SBU', - ], + 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '请求消息体。', - 'required' => false, - '$ref' => '#/components/schemas/LogtailConfig', - ], + 'schema' => ['description' => '请求消息体。', 'required' => false, '$ref' => '#/components/schemas/LogtailConfig'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -7724,18 +3367,10 @@ 'action' => 'log:CreateConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], @@ -7744,47 +3379,28 @@ 'CreateConsumerGroup' => [ 'summary' => '在指定的Logstore上创建一个消费组。', 'path' => '/logstores/{logstore}/consumergroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - ], + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore'], ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project'], ], [ 'name' => 'body', @@ -7794,31 +3410,15 @@ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ - 'consumerGroup' => [ - 'description' => '消费组名称，在Project下必须唯一。', - 'type' => 'string', - 'required' => true, - 'example' => 'consumerGroupX', - ], - 'timeout' => [ - 'description' => '超时时间。在超时时间段内没有收到心跳，消费者将被删除。单位：秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '300', - ], - 'order' => [ - 'description' => '是否按顺序消费。'."\n" - ."\n" - .'- true：按顺序消费。'."\n" - .' - 同一个Shard内按照保留字段**\\_\\_tag\\_\\_:\\_\\_receive\\_time\\_\\_**由小到大按顺序消费。'."\n" - .' - Shard分裂后，先消费原Shard数据，然后同时消费由该Shard分裂的Shard数据。'."\n" - .' - Shard合并后，先消费原Shard数据，然后消费由原Shard合并后的新Shard数据。'."\n" - .'- false：不按顺序消费。即所有Shard同时开始消费，Shard分裂或者合并后产生的新Shard，也会立即消费。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'consumerGroup' => ['description' => '消费组名称，在Project下必须唯一。', 'type' => 'string', 'required' => true, 'example' => 'consumerGroupX'], + 'timeout' => ['description' => '超时时间。在超时时间段内没有收到心跳，消费者将被删除。单位：秒。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '300'], + 'order' => ['description' => '是否按顺序消费。'."\n" + ."\n" + .'- true：按顺序消费。'."\n" + .' - 同一个Shard内按照保留字段**\\_\\_tag\\_\\_:\\_\\_receive\\_time\\_\\_**由小到大按顺序消费。'."\n" + .' - Shard分裂后，先消费原Shard数据，然后同时消费由该Shard分裂的Shard数据。'."\n" + .' - Shard合并后，先消费原Shard数据，然后消费由原Shard合并后的新Shard数据。'."\n" + .'- false：不按顺序消费。即所有Shard同时开始消费，Shard分裂或者合并后产生的新Shard，也会立即消费。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], ], 'required' => true, ], @@ -7828,46 +3428,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -7908,18 +3484,10 @@ 'action' => 'log:CreateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], @@ -7928,97 +3496,55 @@ 'CreateDashboard' => [ 'summary' => '创建仪表盘。', 'path' => '/dashboards', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '10278', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', - 'schema' => [ - 'description' => '仪表盘数据结构。', - 'required' => true, - '$ref' => '#/components/schemas/dashboard', - ], + 'schema' => ['description' => '仪表盘数据结构。', 'required' => true, '$ref' => '#/components/schemas/dashboard'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -8047,138 +3573,35 @@ 'action' => 'log:CreateDashboard', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], - ], - ], - ], - ], - ], - 'CreateDataset' => [ - 'summary' => '创建数据集', - 'path' => '/datasets', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '296322', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'type' => 'string', - 'description' => 'A short description of struct', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - 'description' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'schema' => [ - 'type' => 'object', - 'additionalProperties' => [ - '$ref' => '#/components/schemas/IndexKey', - 'description' => '', - ], - 'description' => '', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], - 'description' => '', ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateDomain' => [ 'summary' => '为Project绑定新的自定义域名。', 'path' => '/domains', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', @@ -8188,12 +3611,7 @@ 'description' => '请求消息体。', 'type' => 'object', 'properties' => [ - 'domainName' => [ - 'description' => '域名。', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'domainName' => ['description' => '域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com'], ], 'required' => true, ], @@ -8203,46 +3621,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -8267,18 +3661,10 @@ 'action' => 'log:CreateDomain', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], ], ], ], @@ -8287,41 +3673,27 @@ 'CreateDownloadJob' => [ 'summary' => '在指定Project下创建一个日志下载任务。', 'path' => '/downloadjobs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '216705', - 'abilityTreeNodes' => [ - 'FEATUREsls1J4K38', - ], + 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'body', @@ -8332,60 +3704,22 @@ 'description' => '日志下载任务配置', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '资源名称', - 'description' => '作业名称。其命名规则如下：'."\n" - ."\n" - .'同一个 Project 下，作业的名称不可重复。'."\n" - .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'* 必须以小写字母或者数字开头和结尾。'."\n" - .'* 长度为 2-64 字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'download-123', - ], - 'description' => [ - 'title' => '描述', - 'description' => '日志下载任务描述', - 'type' => 'string', - 'required' => false, - 'example' => 'Log download task', - ], + 'name' => ['title' => '资源名称', 'description' => '作业名称。其命名规则如下：'."\n" + ."\n" + .'同一个 Project 下，作业的名称不可重复。'."\n" + .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'* 必须以小写字母或者数字开头和结尾。'."\n" + .'* 长度为 2-64 字符。', 'type' => 'string', 'required' => true, 'example' => 'download-123'], + 'description' => ['title' => '描述', 'description' => '日志下载任务描述', 'type' => 'string', 'required' => false, 'example' => 'Log download task'], 'configuration' => [ 'title' => '下载配置', 'description' => '下载配置', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => '源logstore', - 'description' => '源logstore', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'fromTime' => [ - 'title' => '起点时间戳（精确到秒）', - 'description' => '起点时间戳（精确到秒）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1722406260', - ], - 'toTime' => [ - 'title' => '结束时间戳（精确到秒）', - 'description' => '结束时间戳（精确到秒）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1722409860', - ], - 'query' => [ - 'title' => '查询语句', - 'description' => '查询语句', - 'type' => 'string', - 'required' => true, - 'example' => '* | select *', - ], + 'logstore' => ['title' => '源logstore', 'description' => '源logstore', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'fromTime' => ['title' => '起点时间戳（精确到秒）', 'description' => '起点时间戳（精确到秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1722406260'], + 'toTime' => ['title' => '结束时间戳（精确到秒）', 'description' => '结束时间戳（精确到秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1722409860'], + 'query' => ['title' => '查询语句', 'description' => '查询语句', 'type' => 'string', 'required' => true, 'example' => '* | select *'], 'powerSql' => [ 'title' => '是否启用powerSql', 'description' => '是否启用powerSql。枚举值：true，false', @@ -8429,39 +3763,16 @@ 'enumValueTitles' => [], 'example' => 'none', ], - 'roleArn' => [ - 'title' => '下载使用roleArn', - 'description' => '下载使用roleArn', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole', - ], - 'bucket' => [ - 'title' => '对象存储桶', - 'description' => '对象存储桶', - 'type' => 'string', - 'required' => false, - 'example' => 'oss-test-bucket', - ], - 'prefix' => [ - 'description' => '下载到用户oss bucket的路径前缀', - 'type' => 'string', - 'required' => false, - 'example' => 'download/', - ], + 'roleArn' => ['title' => '下载使用roleArn', 'description' => '下载使用roleArn', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole'], + 'bucket' => ['title' => '对象存储桶', 'description' => '对象存储桶', 'type' => 'string', 'required' => false, 'example' => 'oss-test-bucket'], + 'prefix' => ['description' => '下载到用户oss bucket的路径前缀', 'type' => 'string', 'required' => false, 'example' => 'download/'], ], 'required' => true, ], ], 'required' => true, ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => '显示名称', - 'type' => 'string', - 'required' => true, - 'example' => 'download-123456789', - ], + 'displayName' => ['title' => '显示名称', 'description' => '显示名称', 'type' => 'string', 'required' => true, 'example' => 'download-123456789'], ], 'required' => true, ], @@ -8471,52 +3782,36 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + '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' => '', - ], + ['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', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建日志下载任务', + 'extraInfo' => '下载数据量限制'."\n" + ."\n" + .'- 仅查询：华东1（杭州）、华东2（上海）、华北2（北京）、华南1（深圳）和新加坡地域最多支持下载2000万行数据，其他地域最多支持下载100万行数据。数据量不超过20 GB。'."\n" + ."\n" + .'- SQL分析：最多支持下载100万行数据。数据量不超过2GB。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -8526,41 +3821,27 @@ 'CreateETL' => [ 'summary' => '在指定Project下创建一个数据加工任务。', 'path' => '/etls', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203162', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', @@ -8570,34 +3851,15 @@ 'description' => '数据加工任务配置', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '作业名称。其命名规则如下：'."\n" - ."\n" - .'同一个 Project 下，作业的名称不可重复。'."\n" - .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'* 必须以小写字母或者数字开头和结尾。'."\n" - .'* 长度为 2-64 字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'etl-123456', - ], - 'displayName' => [ - 'description' => '数据加工任务显示名称', - 'type' => 'string', - 'required' => true, - 'example' => 'sls-test-etl', - ], - 'description' => [ - 'description' => '数据加工任务描述', - 'type' => 'string', - 'required' => false, - 'example' => 'this is ETL', - ], - 'configuration' => [ - 'description' => '数据加工任务详细配置', - 'required' => true, - '$ref' => '#/components/schemas/ETLConfiguration', - ], + 'name' => ['description' => '作业名称。其命名规则如下：'."\n" + ."\n" + .'同一个 Project 下，作业的名称不可重复。'."\n" + .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'* 必须以小写字母或者数字开头和结尾。'."\n" + .'* 长度为 2-64 字符。', 'type' => 'string', 'required' => true, 'example' => 'etl-123456'], + 'displayName' => ['description' => '数据加工任务显示名称', 'type' => 'string', 'required' => true, 'example' => 'sls-test-etl'], + 'description' => ['description' => '数据加工任务描述', 'type' => 'string', 'required' => false, 'example' => 'this is ETL'], + 'configuration' => ['description' => '数据加工任务详细配置', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration'], ], 'required' => false, ], @@ -8607,45 +3869,26 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', @@ -8728,23 +3971,185 @@ ], 'ramActions' => [], ], - 'CreateIndex' => [ - 'path' => '/logstores/{logstore}/index', - 'methods' => [ - 'post', + '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' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => '任务描述', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'es ingestion', + ], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => true, 'example' => 'es ingestion'."\n"], + 'schedule' => ['description' => '调度结构', 'required' => false, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['description' => 'ES/OpenSearch导入配置', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration'], + 'name' => ['description' => 'ES/OpenSearch导入任务唯一标识', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch- 123456-123'], + ], + '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' => '没有访问权限，需要进行用户身份认证'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建ES/OpenSearch导入任务', + 'summary' => '创建ES/OpenSearch导入任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'CreateGCSIngestion' => [ + 'path' => '/gcsingestions', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + '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' => ['title' => 'A short description of struct', 'description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求 Body', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'displayName' => ['description' => '显示名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'configuration' => ['description' => '配置', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration'], + 'name' => ['description' => '作业名称。其命名规则如下：'."\n" + ."\n" + .'同一个 Project 下，作业的名称不可重复。'."\n" + ."\n" + .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'- 必须以小写字母或者数字开头和结尾。'."\n" + .'- 长度为 2-64 字符。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + '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'], + ], + ], + 'schema' => ['description' => '响应体', 'type' => 'any', 'example' => '{}'], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '创建gcs导入任务', + 'summary' => '创建GCP Cloud Storage文件导入任务', + '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, @@ -8752,86 +4157,46 @@ 'operationType' => 'create', 'chargeType' => 'paid', 'abilityTreeCode' => '8963', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'Logstore的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-logstore-test', - ], + 'schema' => ['description' => 'Logstore的名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-logstore-test'], ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-project-test', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', - 'schema' => [ - 'description' => '请求消息体。', - 'required' => false, - '$ref' => '#/components/schemas/index', - ], + 'schema' => ['description' => '请求消息体。', 'required' => false, '$ref' => '#/components/schemas/index'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], @@ -8858,21 +4223,14 @@ 'CreateLogStore' => [ 'summary' => '创建 LogStore。', 'path' => '/logstores', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -8881,21 +4239,14 @@ 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '115729', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', @@ -8905,129 +4256,73 @@ 'description' => '请求参数。', 'type' => 'object', 'properties' => [ - 'logstoreName' => [ - 'description' => 'Logstore名称。其命名规则如下：'."\n" - ."\n" - .'- 同一个Project下，Logstore名称不可重复。'."\n" - .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'- 必须以小写字母或者数字开头和结尾。'."\n" - .'- 长度为2-63字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - 'shardCount' => [ - 'description' => 'Shard分区个数。'."\n" - ."\n" - .'> 该接口不支持更新Shard个数。只能通过SplitShard或MergeShards接口修改Shard个数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'ttl' => [ - 'description' => '数据的保存时间，单位为天。取值范围为1~3650。如果配置为3650，表示永久保存。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'encrypt_conf' => [ - 'description' => '加密配置数据结构，包含参数`enable`、 `encrypt_type`、 `user_cmk_info`。更多信息，请参见[EncryptConf ](~~409461~~)。', - 'required' => false, - '$ref' => '#/components/schemas/EncryptConf', - ], - 'autoSplit' => [ - 'description' => '是否自动分裂Shard。'."\n" - ."\n" - .'- true：自动分裂Shard。'."\n" - .'- false：不自动分裂Shard。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enable_tracking' => [ - 'description' => '是否开启WebTracking功能。默认值为false。'."\n" - ."\n" - .'- true：开启WebTracking。'."\n" - .'- false：不开启WebTracking。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'maxSplitShard' => [ - 'description' => '自动分裂时最大的Shard个数，最小值是1，最大值是256。'."\n" - ."\n" - .'> 当autoSplit参数为true时必须设置。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'appendMeta' => [ - 'description' => '是否记录**外网IP地址**和**日志接收时间**。默认值为false。'."\n" - ."\n" - .'- true：开启记录外网IP和日志接收时间功能，开启后日志服务自动把日志来源设备的公网IP地址和日志到达服务端的时间添加到日志的Tag字段中。'."\n" - .'- false：不开启记录外网IP和日志接收时间功能。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'telemetryType' => [ - 'description' => '可观测数据类型。取值包括：'."\n" - ."\n" - .'- **None**：日志数据。默认为日志数据。'."\n" - .'- **Metrics**：时序数据。', - 'type' => 'string', - 'required' => false, - 'example' => 'None', - ], - 'hot_ttl' => [ - 'title' => '数据在Logstore热存储层中的存储时间，最少为7天。单位：天，取值范围：7~3000。', - 'description' => '数据在Logstore热存储层中的存储时间。单位：天，最小为7，最大不能超过ttl的值，取值为-1代表保存时间ttl内全是热存储。'."\n" - ."\n" - .'当数据的存储时间超过您所配置的热存储层数据保存时间后，数据将转为低频存储。更多信息，请参见[智能冷热分层存储](~~308645~~)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'mode' => [ - 'description' => '日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。'."\n" - ."\n" - .'- **standard**：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。'."\n" - .'- **query**：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], - 'infrequentAccessTTL' => [ - 'title' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。', - 'description' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'processorId' => [ - 'title' => 'IngestProcessor ID', - 'description' => 'IngestProcessor ID', - 'type' => 'string', - 'required' => false, - 'example' => 'processor-nginx-parser-001', - ], - 'shardingPolicy' => [ - 'title' => '哈希写入配置', - 'description' => '哈希写入配置', - 'required' => false, - '$ref' => '#/components/schemas/ShardingPolicy', - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'type' => 'string', - 'required' => false, - 'description' => '资源组ID', - ], + 'logstoreName' => ['description' => 'Logstore名称。其命名规则如下：'."\n" + ."\n" + .'- 同一个Project下，Logstore名称不可重复。'."\n" + .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'- 必须以小写字母或者数字开头和结尾。'."\n" + .'- 长度为2-63字符。', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], + 'shardCount' => ['description' => 'Shard分区个数。'."\n" + ."\n" + .'> 该接口不支持更新Shard个数。只能通过SplitShard或MergeShards接口修改Shard个数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], + 'ttl' => ['description' => '数据的保存时间，单位为天。取值范围为1~3650。如果配置为3650，表示永久保存。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'encrypt_conf' => ['description' => '加密配置数据结构，包含参数`enable`、 `encrypt_type`、 `user_cmk_info`。更多信息，请参见[EncryptConf ](~~409461~~)。'."\n" + ."\n" + .'示例1 （开启默认加密配置）：'."\n" + .'```'."\n" + .'{'."\n" + .' "enable": true,'."\n" + .' "encrypt_conf": "default"'."\n" + .'}'."\n" + .'```'."\n" + .'示例2 （开启 BYOK 加密）:'."\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'], + 'autoSplit' => ['description' => '是否自动分裂Shard。开启后，当日志写入流量持续超限，会触发 Shard 自动分裂，提升写入能力。开启自动分裂时必须设置 maxSplitShard （最大分裂 Shard 数）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enable_tracking' => ['description' => '是否开启WebTracking功能。默认值为false。当需要收集和分析用户在浏览器或小程序中的行为数据（如页面浏览、购买记录、停留时长等）时，可以使用 WebTracking 功能。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'maxSplitShard' => ['description' => '自动分裂时最大的Shard个数，最小值是1，最大值是256。'."\n" + ."\n" + .'> 当autoSplit参数为true时必须设置。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64'], + 'appendMeta' => ['description' => '是否记录**外网IP地址**和**日志接收时间**。默认值为false。'."\n" + ."\n" + .'- true：开启记录外网IP和日志接收时间功能，开启后日志服务自动把日志来源设备的公网IP地址和日志到达服务端的时间添加到日志的Tag字段中。'."\n" + .'- false：不开启记录外网IP和日志接收时间功能。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'telemetryType' => ['description' => '可观测数据类型。默认为日志数据，可选的取值包括：'."\n" + ."\n" + .'- **None**：日志数据。默认为日志数据。'."\n" + .'- **Metrics**：时序数据。', 'type' => 'string', 'required' => false, 'example' => 'None'], + 'hot_ttl' => ['title' => '数据在Logstore热存储层中的存储时间，最少为7天。单位：天，取值范围：7~3000。', 'description' => '数据在Logstore热存储层中的存储时间。单位：天，最小为7，最大不能超过ttl的值，默认保存时间ttl内全是热存储。'."\n" + ."\n" + .'当数据的存储时间超过您所配置的热存储层数据保存时间后，数据将转为低频存储（开启低频存储时，要求热存储时间至少为 7 天）。更多信息，请参见[智能冷热分层存储](~~308645~~)。'."\n" + ."\n" + .'示例：'."\n" + .'- 场景1 （只开启热存储 30天）：`{"ttl": 30}` 或者 `{"ttl": 30, "hot_ttl": 30}`'."\n" + .'- 场景2 （开启热存储7天，低频存储 23 天）: `{"ttl": 30, "hot_ttl": 7}`', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'], + 'mode' => ['description' => '日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。'."\n" + ."\n" + .'- **standard**：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。'."\n" + .'- **query**：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。'."\n", 'type' => 'string', 'required' => false, 'example' => 'standard'], + 'infrequentAccessTTL' => ['title' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。', 'description' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。'."\n" + ."\n" + .'当日志存储时间大于热存储时间与低频存储时间之和时，剩余的存储时间将转化为归档存储。'."\n" + ."\n" + .'示例：'."\n" + .'- 场景 1 （开启热存 7 天，低频存储 23 天）：`{"ttl": 30, "hot_ttl": 7}`'."\n" + .'- 场景 2 （开启热存 7天，低频存储 30 天，归档 60 天）: `{"ttl": 97, "hot_ttl": 7, "infrequentAccessTTL": 30}`'."\n" + .'- 场景 3 （开启热存 60 天，低频存储 0 天，归档 60 天）: `{"ttl": 120, "hot_ttl": 60, "infrequentAccessTTL": 0}`', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + 'processorId' => ['title' => 'IngestProcessor ID', 'description' => 'IngestProcessor ID', 'type' => 'string', 'required' => false, 'example' => 'processor-nginx-parser-001'], + 'shardingPolicy' => ['title' => '哈希写入配置', 'description' => '哈希写入配置。写入数据时，日志会根据配置的哈希策略选择存储的 Shard。配置前需要确保 Shard 的哈希范围均匀，可能会影响写入能力，请谨慎配置。', 'required' => false, '$ref' => '#/components/schemas/ShardingPolicy'], + 'resourceGroupId' => ['title' => '资源组ID', 'description' => '资源组 ID。指定后，Logstore 将关联至该资源组。', 'type' => 'string', 'required' => false, 'example' => 'rg-xxxxxxxx'], + 'enableModify' => ['title' => '启用日志修改和删除功能', 'type' => 'boolean'], ], 'required' => true, ], @@ -9037,52 +4332,27 @@ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], [], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建LogStore', 'description' => '### 接口说明'."\n" ."\n" @@ -9110,88 +4380,52 @@ ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:09.000Z', - 'description' => '请求参数发生变更', - ], - [ - 'createdAt' => '2025-12-02T11:55:04.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI 下线', - ], - ], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [ + ['createdAt' => '2025-12-03T01:37:09.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-12-02T11:55:04.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateLogStore', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - [ - 'conditionKey' => 'log:Encrypted', - 'validationType' => 'conditional', - ], + ['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}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateLogging' => [ 'summary' => '为Project创建服务日志。', 'path' => '/logging', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', @@ -9202,13 +4436,7 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'loggingProject' => [ - 'title' => '服务日志要保存到的 project 名称。', - 'description' => '服务日志要保存到的Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'loggingProject' => ['title' => '服务日志要保存到的 project 名称。', 'description' => '服务日志要保存到的Project名称。', 'type' => 'string', 'required' => true, 'example' => 'my-project'], 'loggingDetails' => [ 'title' => '服务日志配置列表。', 'description' => '服务日志配置列表。', @@ -9233,24 +4461,9 @@ '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' => '该种类服务日志要保存到的Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', + 'enum' => ['consumergroup_log', 'logtail_alarm', 'operation_log', 'logtail_profile', 'metering', 'logtail_status', 'scheduled_sql_alert', 'etl_alert'], ], + 'logstore' => ['title' => '该种类服务日志要保存到的 logstore 名称。', 'description' => '该种类服务日志要保存到的Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], ], 'required' => false, ], @@ -9265,46 +4478,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -9323,18 +4512,10 @@ 'action' => 'log:CreateLogging', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], @@ -9343,20 +4524,14 @@ 'CreateLogtailPipelineConfig' => [ 'summary' => '创建Logtail流水线配置。', 'path' => '/pipelineconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -9365,21 +4540,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191781', - 'abilityTreeNodes' => [ - 'FEATUREsls9GTH7Z', - ], + 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => 'Project名称', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'body', @@ -9390,49 +4557,25 @@ 'description' => 'Logtail流水线配置内容。', 'type' => 'object', 'properties' => [ - 'configName' => [ - 'title' => '配置名称', - 'description' => '配置名称。'."\n" - ."\n" - .'> 配置名称在所属Project内唯一，且创建成功后无法修改。命名规则如下：'."\n" - .'> - 只能包括小写字母、数字、-和_。'."\n" - .'> - 必须以小写字母或数字开头和结尾。'."\n" - .'> - 长度必须在2~128字符之间。', - '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' => '日志样例。支持多条日志。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world', - ], - 'global' => [ - 'title' => '全局配置', - 'description' => '全局配置。', - 'type' => 'object', - 'required' => false, - ], + 'configName' => ['title' => '配置名称', 'description' => '配置名称。'."\n" + ."\n" + .'> 配置名称在所属Project内唯一，且创建成功后无法修改。命名规则如下：'."\n" + .'> - 只能包括小写字母、数字、-和_。'."\n" + .'> - 必须以小写字母或数字开头和结尾。'."\n" + .'> - 长度必须在2~128字符之间。', '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' => '日志样例。支持多条日志。', 'type' => 'string', 'required' => false, 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], + 'global' => ['title' => '全局配置', 'description' => '全局配置。', 'type' => 'object', 'required' => false], 'inputs' => [ 'title' => '输入插件列表', 'description' => '输入插件列表。'."\n" .'>目前，只允许配置1个输入插件。>', 'type' => 'array', - 'items' => [ - 'title' => '输入插件', - 'description' => '输入插件。'."\n" - ."\n" - .'> 文件输入插件参数请参见[文件插件](~~65064~~)，其余输入插件参数请参见[处理插件](~~64957~~)。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "input_file",'."\n" - .' "FilePaths": ["/var/log/*.log"]'."\n" - .'}', - ], + 'items' => ['title' => '输入插件', 'description' => '输入插件。'."\n" + ."\n" + .'> 文件输入插件参数请参见[文件插件](~~65064~~)，其余输入插件参数请参见[处理插件](~~64957~~)。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "Type": "input_file",'."\n" + .' "FilePaths": ["/var/log/*.log"]'."\n" + .'}'], 'required' => true, 'minItems' => 1, ], @@ -9450,18 +4593,12 @@ .'> - 第一个处理插件必须为正则解析插件、分隔符模式解析插件、JSON解析插件、NGINX模式解析插件、Apache模式解析插件或IIS模式解析插件。'."\n" .'> - 第一个处理插件之后仅允许存在1个时间解析处理插件，1个过滤插件和多个脱敏插件。>', 'type' => 'array', - 'items' => [ - 'title' => '输入插件', - 'description' => '处理插件。'."\n" - ."\n" - .'> 原生处理插件和扩展处理插件，详情请参见[处理插件](~~64957~~)。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "processor_parse_json_native",'."\n" - .' "SourceKey": "content"'."\n" - .'}', - ], + 'items' => ['title' => '输入插件', 'description' => '处理插件。'."\n" + ."\n" + .'> 原生处理插件和扩展处理插件，详情请参见[处理插件](~~64957~~)。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "Type": "processor_parse_json_native",'."\n" + .' "SourceKey": "content"'."\n" + .'}'], 'required' => false, 'minItems' => 1, ], @@ -9470,12 +4607,7 @@ 'description' => '聚合插件列表。'."\n" .'>仅当使用了扩展处理插件时有效，且最多允许使用1个聚合插件。>', 'type' => 'array', - 'items' => [ - 'title' => '聚合插件', - 'description' => '聚合插件。', - 'type' => 'object', - 'required' => false, - ], + 'items' => ['title' => '聚合插件', 'description' => '聚合插件。', 'type' => 'object', 'required' => false], 'required' => false, 'minItems' => 1, ], @@ -9484,24 +4616,14 @@ 'description' => '输出插件列表。'."\n" .'>目前，只允许存在1个flusher_sls插件。>', 'type' => 'array', - 'items' => [ - 'title' => '输出插件', - 'description' => '输出插件。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "flusher_sls",'."\n" - .' "Logstore": "test"'."\n" - .'}', - ], + 'items' => ['title' => '输出插件', 'description' => '输出插件。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "Type": "flusher_sls",'."\n" + .' "Logstore": "test"'."\n" + .'}'], 'required' => true, 'minItems' => 1, ], - 'task' => [ - 'description' => '任务配置', - 'type' => 'object', - 'required' => false, - ], + 'task' => ['description' => '任务配置', 'type' => 'object', 'required' => false], ], 'required' => false, ], @@ -9511,53 +4633,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建Logtail流水线配置', 'requestParamsDescription' => '## 全局配置'."\n" @@ -10189,17 +5285,10 @@ 'action' => 'log:CreateLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], + ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -10208,38 +5297,23 @@ 'CreateMachineGroup' => [ 'summary' => '创建一个机器组。', 'path' => '/machinegroups', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', @@ -10250,55 +5324,24 @@ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。其命名规则如下：'."\n" - ."\n" - .'- 同一个Project下，机器组名称不可重复。'."\n" - .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'- 必须以小写字母或者数字开头和结尾。'."\n" - .'- 长度为3-128字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group', - ], - 'machineIdentifyType' => [ - 'title' => '机器组标识种类，支持 ip 、userdefined 两种。', - 'description' => '机器标识类型。'."\n" - ."\n" - .'- ip：IP地址机器组。'."\n" - .'- userdefined：用户自定义标识机器组。', - 'type' => 'string', - 'required' => true, - 'example' => 'ip', - 'default' => 'ip', - ], - 'groupType' => [ - 'title' => '机器组类型，可选值，默认为空。', - 'description' => '机器组类型，可选值为空。', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], + 'groupName' => ['title' => '机器组名称。', 'description' => '机器组名称。其命名规则如下：'."\n" + ."\n" + .'- 同一个Project下，机器组名称不可重复。'."\n" + .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'- 必须以小写字母或者数字开头和结尾。'."\n" + .'- 长度为3-128字符。', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group'], + 'machineIdentifyType' => ['title' => '机器组标识种类，支持 ip 、userdefined 两种。', 'description' => '机器标识类型。'."\n" + ."\n" + .'- ip：IP地址机器组。'."\n" + .'- userdefined：用户自定义标识机器组。', 'type' => 'string', 'required' => true, 'example' => 'ip', 'default' => 'ip'], + 'groupType' => ['title' => '机器组类型，可选值，默认为空。', 'description' => '机器组类型，可选值为空。', 'type' => 'string', 'required' => false, 'example' => '""'], 'groupAttribute' => [ 'title' => '机器组属性。', 'description' => '机器组的属性。', 'type' => 'object', 'properties' => [ - 'groupTopic' => [ - 'title' => '机器组的日志主题。', - 'description' => '机器组的日志主题。', - 'type' => 'string', - 'required' => false, - 'example' => 'testtopic', - ], - 'externalName' => [ - 'title' => '机器组所依赖的外部管理系统标识。', - 'description' => '机器组所依赖的外部管理系统标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup', - ], + 'groupTopic' => ['title' => '机器组的日志主题。', 'description' => '机器组的日志主题。', 'type' => 'string', 'required' => false, 'example' => 'testtopic'], + 'externalName' => ['title' => '机器组所依赖的外部管理系统标识。', 'description' => '机器组所依赖的外部管理系统标识。', 'type' => 'string', 'required' => false, 'example' => 'testgroup'], ], 'required' => false, ], @@ -10309,13 +5352,7 @@ .'- 如果machineIdentifyType配置为ip，则此处填写服务器的IP地址。'."\n" .'- 如果machineIdentifyType配置为userdefined，则此处填写自定义的标识。', 'type' => 'array', - 'items' => [ - 'title' => '机器标识，如 ip 地址、用户自定义标识。', - 'description' => '机器标识，根据机器组类型填写IP地址或者用户自定义标识。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], + 'items' => ['title' => '机器标识，如 ip 地址、用户自定义标识。', 'description' => '机器标识，根据机器组类型填写IP地址或者用户自定义标识。', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'], 'required' => true, ], ], @@ -10328,46 +5365,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -10395,61 +5408,116 @@ 'action' => 'log:CreateMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['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}/machinegroup/{#MachineGroupName}'], + ], + ], + ], + ], + ], + 'CreateMaterializedView' => [ + 'summary' => '创建物化视图 ', + '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' => ['type' => 'string', 'description' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['type' => 'string', 'description' => ''], + 'logstore' => ['type' => 'string', 'description' => ''], + 'originalSql' => ['type' => 'string', 'description' => ''], + 'aggIntervalMins' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'startTime' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'ttl' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + ], + 'description' => '', + ], + ], + ], + '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"}]', ], 'CreateMaxComputeExport' => [ 'summary' => '创建MaxCompute投递任务。', 'path' => '/maxcomputeexports', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203409', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project'."\n", - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n"], ], [ 'name' => 'body', @@ -10459,29 +5527,10 @@ 'description' => 'MaxCompute投递任务配置', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'MaxCompute投递任务唯一标识', - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456'."\n", - ], - 'displayName' => [ - 'description' => '任务显示名', - 'type' => 'string', - 'required' => true, - 'example' => 'my-mc-job', - ], - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '创建一个MaxCompute投递任务'."\n", - ], - 'configuration' => [ - 'description' => '任务配置', - 'required' => true, - '$ref' => '#/components/schemas/MaxComputeExportConfiguration', - ], + 'name' => ['description' => 'MaxCompute投递任务唯一标识', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456'."\n"], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => true, 'example' => 'my-mc-job'], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Create a MaxCompute delivery task'], + 'configuration' => ['description' => '任务配置', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration'], ], 'required' => false, ], @@ -10490,46 +5539,27 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', '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', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', @@ -10545,109 +5575,17 @@ ], 'ramActions' => [], ], - 'CreateMemoryStore' => [ - 'summary' => '创建内存库', - 'path' => '/memorystores', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateMetricStore' => [ + 'summary' => '创建时序库（MetricStore），可用于存储时序数据。', + 'path' => '/metricstores', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'customInstructions' => [ - 'type' => 'string', - 'description' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'enableGraph' => [ - 'type' => 'boolean', - 'description' => '', - ], - 'strategy' => [ - 'type' => 'string', - 'description' => '', - ], - 'shortTermTtl' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'name' => [ - 'type' => 'string', - 'description' => '', - ], - ], - 'description' => '', - ], - ], - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - ], - 'CreateMetricStore' => [ - 'summary' => '创建时序库（MetricStore），可用于存储时序数据。', - 'path' => '/metricstores', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -10656,21 +5594,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225682', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '日志项目名称', - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['title' => '日志项目名称', 'description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'body', @@ -10681,96 +5611,22 @@ 'description' => '请求体', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '时序库名称', - 'description' => '要创建的时序库名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my_metric_store', - ], - 'ttl' => [ - 'title' => '时序库的保存时间，单位为天', - 'description' => '时序库的数据保存时间，单位为天', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '7', - ], - 'shardCount' => [ - 'title' => '时序库的 shard 分片数量', - 'description' => '时序库的 [shard](~~28976~~) 分片数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'autoSplit' => [ - 'title' => '是否开启自动分裂', - 'description' => '是否开启自动分裂', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - 'maxSplitShard' => [ - 'title' => '自动分裂的最大 shard 数，仅当 autoSplit 为 true 时有效', - 'description' => '自动分裂的最大 shard 数，仅当 autoSplit 为 true 时有效', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'mode' => [ - 'title' => '时序库的类型，例如 standard', - 'description' => '时序库的类型，目前仅支持 standard，默认为 standard', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - 'default' => 'standard', - ], - 'metricType' => [ - 'title' => '时序库类型，例如 prometheus', - 'description' => '时序库类型，目前仅支持 prometheus，默认为 prometheus', - 'type' => 'string', - 'required' => false, - 'example' => 'prometheus', - 'default' => 'prometheus', - ], - 'hot_ttl' => [ - 'title' => '数据在热存储层中的存储时间，单位为天。', - 'description' => '数据在Logstore热存储层中的存储时间。单位：天，最小为7，最大不能超过ttl的值，取值为-1代表保存时间ttl内全是热存储。'."\n" - ."\n" - .'当数据的存储时间超过您所配置的热存储层数据保存时间后，数据将转为低频存储。更多信息，请参见[智能冷热分层存储](~~308645~~)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'infrequentAccessTTL' => [ - 'title' => '低频存储，单位为天。', - 'description' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'appendMeta' => [ - 'title' => '是否记录外网IP地址和日志接收时间', - 'description' => '是否记录外网IP地址功能。默认值为false。'."\n" - ."\n" - .'- true：记录外网IP地址。'."\n" - .'- false：不记录外网IP地址。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'shardingPolicy' => [ - 'title' => '哈希写入配置', - 'description' => '哈希写入配置', - 'required' => false, - '$ref' => '#/components/schemas/ShardingPolicy', - ], + 'name' => ['title' => '时序库名称', 'description' => '要创建的时序库名称', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store'], + 'ttl' => ['title' => '时序库的保存时间，单位为天', 'description' => '时序库的数据保存时间，单位为天', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7'], + 'shardCount' => ['title' => '时序库的 shard 分片数量', 'description' => '时序库的 [shard](~~28976~~) 分片数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], + 'autoSplit' => ['title' => '是否开启自动分裂', 'description' => '是否开启自动分裂', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + 'maxSplitShard' => ['title' => '自动分裂的最大 shard 数，仅当 autoSplit 为 true 时有效', 'description' => '自动分裂的最大 shard 数，仅当 autoSplit 为 true 时有效', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64'], + 'mode' => ['title' => '时序库的类型，例如 standard', 'description' => '时序库的类型，目前仅支持 standard，默认为 standard', 'type' => 'string', 'required' => false, 'example' => 'standard', 'default' => 'standard'], + 'metricType' => ['title' => '时序库类型，例如 prometheus', 'description' => '时序库类型，目前仅支持 prometheus，默认为 prometheus', 'type' => 'string', 'required' => false, 'example' => 'prometheus', 'default' => 'prometheus'], + 'hot_ttl' => ['title' => '数据在热存储层中的存储时间，单位为天。', 'description' => '数据在Logstore热存储层中的存储时间。单位：天，最小为7，最大不能超过ttl的值，取值为-1代表保存时间ttl内全是热存储。'."\n" + ."\n" + .'当数据的存储时间超过您所配置的热存储层数据保存时间后，数据将转为低频存储。更多信息，请参见[智能冷热分层存储](~~308645~~)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'], + 'infrequentAccessTTL' => ['title' => '低频存储，单位为天。', 'description' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + 'appendMeta' => ['title' => '是否记录外网IP地址和日志接收时间', 'description' => '是否记录外网IP地址功能。默认值为false。'."\n" + ."\n" + .'- true：记录外网IP地址。'."\n" + .'- false：不记录外网IP地址。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + 'shardingPolicy' => ['title' => '哈希写入配置', 'description' => '哈希写入配置', 'required' => false, '$ref' => '#/components/schemas/ShardingPolicy'], ], 'required' => false, ], @@ -10780,62 +5636,32 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'MetricStoreAlreadyExist', - 'errorMessage' => 'The specified metricstore xxx already exists.', - 'description' => '参数所指定的时序库已存在', - ], + ['errorCode' => 'MetricStoreAlreadyExist', 'errorMessage' => 'The specified metricstore xxx already exists.', 'description' => '参数所指定的时序库已存在'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建时序库', 'description' => '[时序库](~~171723~~)可用于存储[时序数据](~~174965~~)。'."\n" @@ -10849,34 +5675,13 @@ .'- 当时序数据保存时间达到您所设置的数据保存时间后，数据将被删除。'."\n" .'- 同一个Project中，LogStore 与 MetricStore 不能重名。', 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:07.000Z', - 'description' => '请求参数发生变更', - ], - [ - 'createdAt' => '2025-12-02T11:55:01.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-11-24T09:35:52.000Z', - 'description' => '请求参数发生变更', - ], - [ - 'createdAt' => '2024-09-19T09:31:34.000Z', - 'description' => '请求参数发生变更', - ], - [ - 'createdAt' => '2024-08-28T13:00:54.000Z', - 'description' => 'OpenAPI 下线', - ], + ['createdAt' => '2025-12-03T01:37:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-12-02T11:55:01.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-11-24T09:35:52.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-09-19T09:31:34.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-28T13:00:54.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [], @@ -10889,12 +5694,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'MetricStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#name}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#name}'], ], ], ], @@ -10903,41 +5703,27 @@ 'CreateOSSExport' => [ 'summary' => '将Logstore中的日志投递到OSS的Bucket。', 'path' => '/ossexports', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203278', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project'."\n", - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n"], ], [ 'name' => 'body', @@ -10947,34 +5733,15 @@ 'description' => 'OSS投递任务配置', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '作业名称。其命名规则如下：'."\n" - ."\n" - .'同一个 Project 下，作业的名称不可重复。'."\n" - .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'* 必须以小写字母或者数字开头和结尾。'."\n" - .'* 长度为 2-64 字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456', - ], - 'displayName' => [ - 'description' => '任务显示名', - 'type' => 'string', - 'required' => true, - 'example' => 'my-oss-job', - ], - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '创建一个OSS投递任务', - ], - 'configuration' => [ - 'description' => '任务配置', - 'required' => true, - '$ref' => '#/components/schemas/OSSExportConfiguration', - ], + 'name' => ['description' => '作业名称。其命名规则如下：'."\n" + ."\n" + .'同一个 Project 下，作业的名称不可重复。'."\n" + .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'* 必须以小写字母或者数字开头和结尾。'."\n" + .'* 长度为 2-64 字符。', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => true, 'example' => 'my-oss-job'], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Create a Unit OSS delivery task'], + 'configuration' => ['description' => '任务配置', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration'], ], 'required' => false, ], @@ -10983,51 +5750,30 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建OSS投递任务', 'changeSet' => [], @@ -11039,41 +5785,27 @@ 'CreateOSSHDFSExport' => [ 'summary' => '在指定的Project下创建一个OSS-HDFS投递功能。', 'path' => '/osshdfsexports', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203480', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'body', @@ -11083,34 +5815,15 @@ 'description' => 'OSS投递任务配置', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '作业名称。其命名规则如下：'."\n" - ."\n" - .'同一个 Project 下，作业的名称不可重复。'."\n" - .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'* 必须以小写字母或者数字开头和结尾。'."\n" - .'* 长度为 2-64 字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'export-osshdfs-1234567890-123456', - ], - 'displayName' => [ - 'description' => '任务显示名', - 'type' => 'string', - 'required' => true, - 'example' => 'my-oss-hdfs-job'."\n", - ], - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '创建一个OSS-HDFS投递任务'."\n", - ], - 'configuration' => [ - 'description' => '任务配置', - 'required' => true, - '$ref' => '#/components/schemas/OSSExportConfiguration', - ], + 'name' => ['description' => '作业名称。其命名规则如下：'."\n" + ."\n" + .'同一个 Project 下，作业的名称不可重复。'."\n" + .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'* 必须以小写字母或者数字开头和结尾。'."\n" + .'* 长度为 2-64 字符。', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => true, 'example' => 'my-oss-hdfs-job'."\n"], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Create a Unit OSS-HDFS delivery task'], + 'configuration' => ['description' => '任务配置', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration'], ], 'required' => false, ], @@ -11119,46 +5832,27 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', @@ -11172,41 +5866,27 @@ 'CreateOSSIngestion' => [ 'summary' => '在指定Project下创建一个OSS导入任务。', 'path' => '/ossingestions', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '203082', - 'abilityTreeNodes' => [ - 'FEATUREslsDQM02M', - ], + 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', @@ -11216,39 +5896,16 @@ 'description' => 'OSS导入任务配置', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '任务描述'."\n", - ], - 'displayName' => [ - 'description' => '显示名称', - 'type' => 'string', - 'required' => true, - 'example' => 'OSS导入', - ], - 'schedule' => [ - 'description' => '调度类型，一般默认不需要填写。如果有强定时需求，如必须是每周一八点进行一次导入，可使用cron形式', - 'required' => false, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'description' => 'OSS导入配置', - 'required' => true, - '$ref' => '#/components/schemas/OSSIngestionConfiguration', - ], - 'name' => [ - 'description' => '作业名称。其命名规则如下：'."\n" - ."\n" - .'同一个 Project 下，作业的名称不可重复。'."\n" - .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'* 必须以小写字母或者数字开头和结尾。'."\n" - .'* 长度为 2-64 字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123456', - ], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Task description'], + 'displayName' => ['description' => '显示名称', 'type' => 'string', 'required' => true, 'example' => 'OSS import'], + 'schedule' => ['description' => '调度类型，一般默认不需要填写。如果有强定时需求，如必须是每周一八点进行一次导入，可使用cron形式', 'required' => false, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['description' => 'OSS导入配置', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration'], + 'name' => ['description' => '作业名称。其命名规则如下：'."\n" + ."\n" + .'同一个 Project 下，作业的名称不可重复。'."\n" + .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'* 必须以小写字母或者数字开头和结尾。'."\n" + .'* 长度为 2-64 字符。', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456'], ], 'required' => false, ], @@ -11257,51 +5914,30 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建OSS导入任务', 'changeSet' => [], @@ -11313,21 +5949,14 @@ 'CreateProject' => [ 'summary' => '创建一个Project。', 'path' => '/', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -11336,9 +5965,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8733', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -11351,32 +5978,14 @@ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => 'project描述信息', - 'description' => 'Project描述。', - 'type' => 'string', - 'required' => true, - 'example' => 'this is test', - ], - 'projectName' => [ - 'title' => 'project名字', - 'description' => 'Project名称在阿里云地域内全局唯一，创建后不可修改。其命名规则如下：'."\n" - ."\n" - .'- Project名称必须全局唯一。'."\n" - .'- 只能包括小写字母、数字和短划线（-）。'."\n" - .'- 必须以小写字母或者数字开头和结尾。'."\n" - .'- 长度为3-63字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], - 'resourceGroupId' => [ - 'title' => '资源组Id', - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzf******sxby', - ], + 'description' => ['title' => 'project描述信息', 'description' => 'Project描述。', 'type' => 'string', 'required' => true, 'example' => 'this is test'], + 'projectName' => ['title' => 'project名字', 'description' => 'Project名称在阿里云地域内全局唯一，创建后不可修改。其命名规则如下：'."\n" + ."\n" + .'- Project名称必须全局唯一。'."\n" + .'- 只能包括小写字母、数字和短划线（-）。'."\n" + .'- 必须以小写字母或者数字开头和结尾。'."\n" + .'- 长度为3-63字符。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], + 'resourceGroupId' => ['title' => '资源组Id', 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzf******sxby'], 'dataRedundancyType' => [ 'title' => '数据冗余类型：ZRS（同城冗余）、LRS（本地冗余）', 'description' => '容灾类型。'."\n" @@ -11386,19 +5995,13 @@ 'type' => 'string', 'required' => false, 'example' => 'LRS', - 'enum' => [ - 'LRS', - 'ZRS', - ], + 'enum' => ['LRS', 'ZRS'], ], 'recycleBinEnabled' => [ 'description' => '是否打开回收站', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', ], ], @@ -11411,46 +6014,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -11498,18 +6077,10 @@ 'action' => 'log:CreateProject', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#projectName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#projectName}'], ], ], ], @@ -11518,81 +6089,46 @@ 'CreateS3Ingestion' => [ 'summary' => '创建S3文件导入任务', 'path' => '/s3ingestions', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '263575', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testproject', - ], + 'schema' => ['description' => 'project名称。', 'type' => 'string', 'required' => true, 'example' => 'testproject'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => '请求Body', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'displayName' => [ - 'description' => '显示名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - 'schedule' => [ - 'required' => false, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'description' => '配置', - 'required' => false, - '$ref' => '#/components/schemas/S3IngestionConfiguration', - ], - 'name' => [ - 'description' => '作业名称。其命名规则如下：'."\n" - ."\n" - .'同一个 Project 下，作业的名称不可重复。'."\n" - .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'* 必须以小写字母或者数字开头和结尾。'."\n" - .'* 长度为 2-64 字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'test'], + 'displayName' => ['description' => '显示名称。', 'type' => 'string', 'required' => true, 'example' => 'test'], + 'schedule' => ['description' => '调度结构', 'required' => false, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['description' => '配置', 'required' => false, '$ref' => '#/components/schemas/S3IngestionConfiguration'], + 'name' => ['description' => '作业名称。其命名规则如下：'."\n" + ."\n" + .'同一个 Project 下，作业的名称不可重复。'."\n" + .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'* 必须以小写字母或者数字开头和结尾。'."\n" + .'* 长度为 2-64 字符。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], 'required' => false, ], @@ -11601,46 +6137,27 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], 'title' => '创建S3导入任务', @@ -11654,30 +6171,21 @@ 'CreateSavedSearch' => [ 'summary' => '创建一个快速查询。', 'path' => '/savedsearches', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '10284', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ @@ -11689,37 +6197,12 @@ 'description' => '快速查询结构体。', 'type' => 'object', 'properties' => [ - 'savedsearchName' => [ - 'description' => '快速查询的名称。名称长度为3~63个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'pv in minutes', - ], - 'searchQuery' => [ - 'description' => '快速查询的查询和分析语句。由查询语句和分析语句构成，格式为`查询语句|分析语句`。'."\n" - .'查询语句或者分析语句。更多信息，请参见[查询语法](~~43772~~)和[分析语法](~~53608~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time', - ], - 'logstore' => [ - 'description' => '快速查询所属的Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - ], - 'topic' => [ - 'description' => '日志主题。', - 'type' => 'string', - 'required' => true, - 'example' => 'theme', - ], - 'displayName' => [ - 'description' => '显示名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'displayname', - ], + 'savedsearchName' => ['description' => '快速查询的名称。名称长度为3~63个字符。', 'type' => 'string', 'required' => true, 'example' => 'pv in minutes'], + 'searchQuery' => ['description' => '快速查询的查询和分析语句。由查询语句和分析语句构成，格式为`查询语句|分析语句`。'."\n" + .'查询语句或者分析语句。更多信息，请参见[查询语法](~~43772~~)和[分析语法](~~53608~~)。', 'type' => 'string', 'required' => true, 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time'], + 'logstore' => ['description' => '快速查询所属的Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore'], + 'topic' => ['description' => '日志主题。', 'type' => 'string', 'required' => true, 'example' => 'theme'], + 'displayName' => ['description' => '显示名称。', 'type' => 'string', 'required' => true, 'example' => 'displayname'], ], 'required' => true, ], @@ -11727,58 +6210,29 @@ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -11813,18 +6267,10 @@ 'action' => 'log:CreateSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], @@ -11833,21 +6279,14 @@ 'CreateScheduledSQL' => [ 'summary' => '在指定的Project下创建一个定时SQL任务。', 'path' => '/scheduledsqls', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -11856,21 +6295,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209629', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'body', @@ -11880,39 +6311,16 @@ 'description' => '定时SQL任务配置', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '作业名称。其命名规则如下：'."\n" - ."\n" - .'同一个 Project 下，作业的名称不可重复。'."\n" - .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'* 必须以小写字母或者数字开头和结尾。'."\n" - .'* 长度为 2-64 字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456', - ], - 'displayName' => [ - 'description' => '任务显示名', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-scheduled-sql', - ], - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '创建一个定时SQL任务', - ], - 'schedule' => [ - 'description' => '任务调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'description' => '任务配置', - 'required' => true, - '$ref' => '#/components/schemas/ScheduledSQLConfiguration', - ], + 'name' => ['description' => '作业名称。其命名规则如下：'."\n" + ."\n" + .'同一个 Project 下，作业的名称不可重复。'."\n" + .'* 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'* 必须以小写字母或者数字开头和结尾。'."\n" + .'* 长度为 2-64 字符。', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => true, 'example' => 'ali-test-scheduled-sql'], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Create a scheduled SQL task'], + 'schedule' => ['description' => '任务调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['description' => '任务配置', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration'], ], 'required' => false, ], @@ -11922,45 +6330,26 @@ 200 => [ 'headers' => [ 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', @@ -11977,12 +6366,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -11991,38 +6375,23 @@ 'CreateSqlInstance' => [ 'summary' => '当您使用SQL分析时，如果数据量较大，SQL普通版无法在一次查询中完整扫描指定时间段内的所有日志，返回的结果可能不包括所有匹配的数据，增加Shard可以提升读写能力，但只对新写入的数据生效。您可以通过开启SQL独享版，增加计算资源，提升单次分析的数据量。', 'path' => '/sqlinstance', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => '需要开启SQL独享版的Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => '需要开启SQL独享版的Project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'body', @@ -12032,20 +6401,8 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'cu' => [ - 'title' => '独享sql能使用的最大cu', - 'description' => 'CU（ComputeUnit）是SQL独享版运行过程中可以并行使用的计算核数', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'useAsDefault' => [ - 'title' => '是否默认开启', - 'description' => '是否为Project默认开启SQL独享版。 如果为true，当前Project下的所有查询和分析操作（包括告警、仪表盘等），都使用SQL独享版。', - 'type' => 'boolean', - 'required' => true, - ], + 'cu' => ['title' => '独享sql能使用的最大cu', 'description' => 'CU（ComputeUnit）是SQL独享版运行过程中可以并行使用的计算核数', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], + 'useAsDefault' => ['title' => '是否默认开启', 'description' => '是否为Project默认开启SQL独享版。 如果为true，当前Project下的所有查询和分析操作（包括告警、仪表盘等），都使用SQL独享版。', 'type' => 'boolean', 'required' => true], ], 'required' => false, ], @@ -12055,53 +6412,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建SQL独享实例', 'description' => '**请确保在使用该接口前，已充分了解独享SQL的收费方式和[价格](~~223777~~)。**', @@ -12117,12 +6448,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], @@ -12131,20 +6457,14 @@ 'CreateStoreView' => [ 'summary' => '创建数据集。', 'path' => '/storeviews', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -12153,20 +6473,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208488', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => '日志项目名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - ], + 'schema' => ['description' => '日志项目名称。', 'type' => 'string', 'required' => true, 'example' => 'example-project'], ], [ 'name' => 'body', @@ -12176,33 +6489,21 @@ 'description' => '数据集配置。', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '数据集名称。'."\n" - .'- 只能包括小写字母、数字和下划线（_）。'."\n" - .'- 必须以小写字母开头。'."\n" - .'- 长度为3-62字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - ], + 'name' => ['description' => '数据集名称。'."\n" + .'- 只能包括小写字母、数字和下划线（_）。'."\n" + .'- 必须以小写字母开头。'."\n" + .'- 长度为3-62字符。', 'type' => 'string', 'required' => true, 'example' => 'my_storeview'], 'storeType' => [ 'description' => '数据集类型，支持两种类型，当创建时序库数据集时 storeType 指定为 metricstore ，当创建日志库数据集时， storeType 指定为 logstore 。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'metricstore' => 'metricstore', - 'logstore' => 'logstore', - ], + 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'example' => 'logstore', ], 'stores' => [ 'description' => '日志库或者时序库列表。', 'type' => 'array', - 'items' => [ - 'description' => '日志库或时序库。', - 'required' => true, - '$ref' => '#/components/schemas/StoreViewStore', - ], + 'items' => ['description' => '日志库或时序库。', 'required' => true, '$ref' => '#/components/schemas/StoreViewStore'], 'required' => true, ], ], @@ -12214,53 +6515,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建数据集', 'changeSet' => [], @@ -12275,12 +6550,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -12289,113 +6559,65 @@ 'CreateTicket' => [ 'summary' => '如果您需要将日志服务的查询分析页面、仪表盘页面，免密分享给其他人或者嵌入到第三方系统，可以调用CreateTicket生成ticket，然后拼接免密链接。', 'path' => '/tickets', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'expirationTime', 'in' => 'query', - 'schema' => [ - 'description' => '- 服务地址只能是华东2（上海）或新加坡，但获取的Ticket可以在各个地域使用。'."\n" - .'- 过期时间（秒），即内嵌页面URL链接过期时间，默认86400秒（一天），取值0~2592000秒（30天）。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', - ], + 'schema' => ['description' => '- 服务地址只能是华东2（上海）或新加坡，但获取的Ticket可以在各个地域使用。'."\n" + .'- 过期时间（秒），即内嵌页面URL链接过期时间，默认86400秒（一天），取值0~2592000秒（30天）。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86400'], ], [ 'name' => 'accessTokenExpirationTime', 'in' => 'query', - 'schema' => [ - 'description' => '- 访问令牌过期时间（秒），即用户可以访问页面接口的过期时间，默认86400秒（一天），取值0~86400秒（一天）。'."\n" - .'- 访问令牌过期时间是accessTokenExpirationTime、expirationTime的最小值。'."\n" - .'- 若通过STS调用，访问令牌过期时间（即用户可以访问页面接口的时间）是accessTokenExpirationTime、expirationTime、STS过期时间的最小值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '600', - ], + 'schema' => ['description' => '- 访问令牌过期时间（秒），即用户可以访问页面接口的过期时间，默认86400秒（一天），取值0~86400秒（一天）。'."\n" + .'- 访问令牌过期时间是accessTokenExpirationTime、expirationTime的最小值。'."\n" + .'- 若通过STS调用，访问令牌过期时间（即用户可以访问页面接口的时间）是accessTokenExpirationTime、expirationTime、STS过期时间的最小值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'ticket' => [ - 'description' => '免登录票据。', - 'type' => 'string', - 'example' => 'eyJ***************.eyJ******************.KUT****************', - ], + 'ticket' => ['description' => '免登录票据。', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', 'title' => '创建免登录票据', 'changeSet' => [], @@ -12407,20 +6629,14 @@ 'DeleteAgentInstanceConfig' => [ 'summary' => '删除进程级配置', 'path' => '/agentinstanceconfigs/{configType}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -12429,9 +6645,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227415', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -12443,20 +6657,8 @@ 'type' => 'string', 'required' => true, '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', + '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', ], 'example' => 'apm_biz_trace', ], @@ -12469,12 +6671,8 @@ 'description' => '进程级配置归属', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '进程级配置归属', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - ], + 'additionalProperties' => ['type' => 'string', 'description' => '进程级配置归属', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"'], ], ], ], @@ -12482,47 +6680,27 @@ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '删除进程级配置', 'changeSet' => [], 'flowControl' => [ @@ -12534,104 +6712,59 @@ 'DeleteAlert' => [ 'summary' => '删除指定的告警规则。', 'path' => '/alerts/{alertName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '200218', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'alertName', 'in' => 'path', - 'schema' => [ - 'description' => '告警规则ID', - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456', - ], + 'schema' => ['description' => '告警规则ID', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除告警规则', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" @@ -12652,12 +6785,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -12666,98 +6794,54 @@ 'DeleteAnnotationData' => [ 'summary' => '删除数据集中的数据。', 'path' => '/ml/annotationdataset/{datasetId}/annotationdata/{annotationdataId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => '数据集唯一标识', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be'], ], [ 'name' => 'annotationdataId', 'in' => 'path', - 'schema' => [ - 'description' => '数据的唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => '2156d560fc7c01420542df92cd6365ds', - ], + 'schema' => ['description' => '数据的唯一标识', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除数据', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -12770,88 +6854,49 @@ 'DeleteAnnotationDataSet' => [ 'summary' => '删除数据集。删除数据集的前提是数据集下不存在数据结构。', 'path' => '/ml/annotationdataset/{datasetId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => '数据集唯一标识', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除数据集', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -12864,88 +6909,49 @@ 'DeleteAnnotationLabel' => [ 'summary' => '删除标签表。删除标签只能删除非内置标签。', 'path' => '/ml/annotationlabel/{labelId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'labelId', 'in' => 'path', - 'schema' => [ - 'description' => '标签ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799', - ], + 'schema' => ['description' => '标签ID。', 'type' => 'string', 'required' => false, 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除标签', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -12956,96 +6962,62 @@ 'ramActions' => [], ], 'DeleteAzureBlobIngestion' => [ - 'summary' => '创建Azure blob文件导入任务', + 'summary' => '删除AzureBlob导入任务', 'path' => '/azureblobingestions/{azureBlobIngestionName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '291243', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除AzureBlob导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -13056,20 +7028,14 @@ 'DeleteCollectionPolicy' => [ 'summary' => '删除云产品日志采集的采集规则。', 'path' => '/collectionpolicy/{policyName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, @@ -13078,89 +7044,50 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194655', - 'abilityTreeNodes' => [ - 'FEATUREsls9NGCVR', - ], + 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ 'name' => 'policyName', 'in' => 'path', - 'schema' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'your_log_policy', - 'maxLength' => 63, - 'minLength' => 3, - ], + 'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => true, 'example' => 'your_log_policy', 'maxLength' => 63, 'minLength' => 3], ], [ 'name' => 'productCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss', - ], + 'schema' => ['description' => '产品编码。', 'type' => 'string', 'required' => false, 'example' => 'oss'], ], [ 'name' => 'dataCode', 'in' => 'query', - 'schema' => [ - 'description' => '日志类型编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'access_log', - ], + 'schema' => ['description' => '日志类型编码。', 'type' => 'string', 'required' => false, 'example' => 'access_log'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除云产品日志采集的采集规则', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡、河源专属云汽车合规（cn-heyuan-acdr-1）。', @@ -13174,98 +7101,54 @@ 'DeleteConfig' => [ 'summary' => '删除指定的Logtail配置。', 'path' => '/configs/{configName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '9090', - 'abilityTreeNodes' => [ - 'FEATUREslsYP6SBU', - ], + 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'description' => 'Logtail配置名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'logtail-config-sample', - ], + 'schema' => ['description' => 'Logtail配置名称。', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -13304,222 +7187,131 @@ 'action' => 'log:DeleteConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], 'DeleteConsumeProcessor' => [ - 'summary' => '删除消费处理器', 'path' => '/consumeprocessors/{processorName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '225104', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'processorName', 'in' => 'path', - 'schema' => [ - 'description' => '消费处理器标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'consume-processor-1', - ], + 'schema' => ['description' => '消费处理器标识。', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '删除消费处理器', + 'summary' => '删除消费处理器', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'DeleteConsumerGroup' => [ 'summary' => '删除一个指定的消费组。', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project name', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project name', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'Logstore name', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['title' => 'Logstore name', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'title' => 'Consumer group', - 'description' => '消费组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'consumer-group-1', - ], + 'schema' => ['title' => 'Consumer group', 'description' => '消费组名称。', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Length' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Access-Control-Allow-Origin' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '*', - ], + 'schema' => ['type' => 'string', 'example' => '*'], ], 'Date' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -13557,18 +7349,10 @@ 'action' => 'log:DeleteConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], @@ -13577,99 +7361,54 @@ 'DeleteDashboard' => [ 'summary' => '删除指定仪表盘。', 'path' => '/dashboards/{dashboardName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '10280', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project name', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project name', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'dashboardName', 'in' => 'path', - 'schema' => [ - 'title' => 'Dashboard name', - 'description' => '仪表盘名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], + 'schema' => ['title' => 'Dashboard name', 'description' => '仪表盘名称。', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -13698,175 +7437,62 @@ 'action' => 'log:DeleteDashboard', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], - 'DeleteDataset' => [ - 'path' => '/datasets/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '296324', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'type' => 'string', - 'description' => '', - ], - ], - [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '删除数据集', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - ], 'DeleteDomain' => [ 'summary' => '删除Project绑定的自定义域名。', 'path' => '/domains/{domainName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'domainName', 'in' => 'path', - 'schema' => [ - 'title' => '要删除的域名', - 'description' => '要删除的域名。', - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['title' => '要删除的域名', 'description' => '要删除的域名。', 'type' => 'string', 'required' => true, 'example' => 'example.com'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -13891,18 +7517,10 @@ 'action' => 'log:DeleteDomain', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], ], ], ], @@ -13911,30 +7529,21 @@ 'DeleteDownloadJob' => [ 'summary' => '删除下载任务。', 'path' => '/downloadjobs/{downloadJobName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '216706', - 'abilityTreeNodes' => [ - 'FEATUREsls1J4K38', - ], + 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ @@ -13952,68 +7561,39 @@ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + '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' => '', - ], + ['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', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除日志下载任务', 'changeSet' => [], @@ -14025,98 +7605,59 @@ 'DeleteETL' => [ 'summary' => '删除一个数据加工任务', 'path' => '/etls/{etlName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203167', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'etlName', 'in' => 'path', - 'schema' => [ - 'description' => '数据加工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'etl-123456', - ], + 'schema' => ['description' => '数据加工名称', 'type' => 'string', 'required' => true, 'example' => 'etl-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除数据加工任务', 'changeSet' => [], @@ -14125,337 +7666,264 @@ ], 'ramActions' => [], ], - 'DeleteIndex' => [ - 'summary' => '删除指定Logstore的索引。', - 'path' => '/logstores/{logstore}/index', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteElasticsearchIngestion' => [ + 'path' => '/elasticsearchingestions/{esIngestionName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', + 'abilityTreeCode' => '273960', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ - [ - 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], - ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'esIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'ES/OpenSearch导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '删除索引', - 'description' => '### 接口说明'."\n" - .'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', - '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~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除ES/OpenSearch导入任务', + 'summary' => '删除ES/OpenSearch导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'DeleteIndex' => [ + 'summary' => '删除指定Logstore的索引。', + 'path' => '/logstores/{logstore}/index', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'operationType' => 'delete', - 'ramAction' => [ - 'action' => 'log:DeleteIndex', - 'authLevel' => 'resource', + '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' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], + ], + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'Project名称。', 'type' => 'string', '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' => '删除索引', + 'description' => '### 接口说明'."\n" + .'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', + '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', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], ], 'DeleteIngestProcessor' => [ - 'summary' => '删除写入处理器。', 'path' => '/ingestprocessors/{processorName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '225107', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'processorName', 'in' => 'path', - 'schema' => [ - 'title' => '写入处理器标识。', - 'description' => '写入处理器标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'parse-nginx-log', - ], + 'schema' => ['title' => '写入处理器标识。', 'description' => '写入处理器标识。', 'type' => 'string', 'required' => true, 'example' => 'parse-nginx-log'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '删除写入处理器', + 'summary' => '删除写入处理器。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'DeleteLogStore' => [ 'summary' => '删除指定Logstore，包括所有Shard数据和索引。', 'path' => '/logstores/{logstore}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - ], + 'schema' => ['title' => 'logstore 名称', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -14483,18 +7951,10 @@ 'action' => 'log:DeleteLogStore', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], @@ -14503,83 +7963,45 @@ 'DeleteLogging' => [ 'summary' => '删除一个指定Project的服务日志。', 'path' => '/logging', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => 'Project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -14593,435 +8015,305 @@ ], 'ramActions' => [], ], - 'DeleteLogtailPipelineConfig' => [ - 'summary' => '删除Logtail流水线配置。', - 'path' => '/pipelineconfigs/{configName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteLogs' => [ + 'summary' => '删除指定Project下某个Logstore中的日志数据', + 'path' => '/logstores/{logstore}/deletelogs', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'riskType' => 'none', + 'riskType' => 'high', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'Project名称', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'from' => ['description' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268100'], + 'to' => ['description' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200'], + 'query' => ['description' => '可选：查询语句，用于筛选需要更新的日志。更多信息，请参见[查询概述](~~43772~~)。'."\n" + ."\n" + .'说明：本参数仅支持查询语句，不支持如SPL、SQL等分析语句。', 'type' => 'string', 'required' => false, 'example' => 'status:400'], + 'rowId' => ['description' => '可选：查询结果中自动返回内置字段 __rowid__的值。'."\n" + ."\n" + .'rowId和query这两个字段必须给一个，如果两个都给，rowId的优先级更高', 'type' => 'string', 'required' => false, 'example' => ' 0|1000001|638732499'], + ], + 'required' => false, ], ], [ - 'name' => 'configName', + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-project-test'], + ], + [ + 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'Logtail流水线配置名称', - 'description' => 'Logtail流水线配置名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', - ], + 'schema' => ['description' => '查询Logstore中的数据。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + ], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'affectedRows' => ['description' => '删除的日志行数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '删除Logtail流水线配置', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '删除日志', + 'description' => 'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"affectedRows\\": 10\\n}","type":"json"}]', ], - 'DeleteMachineGroup' => [ - 'summary' => '删除机器组。如果机器组已应用Logtail采集配置，则删除机器组后，会解绑对应的Logtail配置。', - 'path' => '/machinegroups/{machineGroup}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteLogtailPipelineConfig' => [ + 'summary' => '删除Logtail流水线配置。', + 'path' => '/pipelineconfigs/{configName}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project名称', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'machineGroup', + 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group-4', - ], + 'schema' => ['title' => 'Logtail流水线配置名称', 'description' => 'Logtail流水线配置名称', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '删除机器组', - 'description' => '### 接口说明'."\n" - .'请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', - '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", + 'title' => '删除Logtail流水线配置', '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}', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'DeleteMaxComputeExport' => [ - 'summary' => '删除MC投递任务。', - 'path' => '/maxcomputeexports/{mcExportName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteMachineGroup' => [ + 'summary' => '删除机器组。如果机器组已应用Logtail采集配置，则删除机器组后，会解绑对应的Logtail配置。', + 'path' => '/machinegroups/{machineGroup}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '203413', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'mcExportName', + 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456', - ], + 'schema' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group-4'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '删除MaxCompute投递任务', - 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + 'title' => '删除机器组', + 'description' => '### 接口说明'."\n" + .'请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', + '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" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', + .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'DeleteMemories' => [ - 'path' => '/memorystores/{memoryStore}/memories', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', + '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' => '删除物化视图 ', + 'path' => '/materializedviews/{name}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '294477', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], [ - 'name' => 'memoryStore', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - [ - 'name' => 'agent_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'user_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'run_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], - [ - 'name' => 'app_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + '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'], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '批量删除记忆', + 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -15029,124 +8321,67 @@ 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'DeleteMemory' => [ - 'path' => '/memorystores/{memoryStore}/memories/{memoryId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteMaxComputeExport' => [ + 'summary' => '删除MC投递任务。', + 'path' => '/maxcomputeexports/{mcExportName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '203413', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'memoryId', + 'name' => 'mcExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '删除记忆', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - ], - 'DeleteMemoryStore' => [ - 'path' => '/memorystores/{memoryStore}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456'], ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', + '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'], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '删除内存库', + 'title' => '删除MaxCompute投递任务', + 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -15157,12 +8392,8 @@ 'DeleteMetricStore' => [ 'summary' => '删除一个已存在的时序库，该时序库所存储的时序数据、关联的采集配置、加工配置等关联资源将被一并删除。', 'path' => '/metricstores/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15177,94 +8408,50 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225684', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '日志项目名称', - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['title' => '日志项目名称', 'description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'title' => '时序库名称', - 'description' => '时序库名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my_metric_store', - ], + 'schema' => ['title' => '时序库名称', 'description' => '时序库名称', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'MetricStoreNotExist', - 'errorMessage' => 'The specified metricstore xxx does not exist.', - 'description' => '参数中所指定的时序库不存在', - ], + ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => '参数中所指定的时序库不存在'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], @@ -15282,10 +8469,7 @@ .'- 一个Project中，最多创建 200 个 Logstore 或 MetricStore。'."\n" .'- 当时序数据保存时间达到您所设置的数据保存时间后，数据将被删除。', 'changeSet' => [ - [ - 'createdAt' => '2024-08-28T13:00:54.000Z', - 'description' => 'OpenAPI 下线', - ], + ['createdAt' => '2024-08-28T13:00:54.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [], @@ -15295,98 +8479,59 @@ 'DeleteOSSExport' => [ 'summary' => '删除指定的OSS投递任务。', 'path' => '/ossexports/{ossExportName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203472', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456'."\n", - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除OSS投递任务', 'changeSet' => [], @@ -15398,92 +8543,55 @@ 'DeleteOSSHDFSExport' => [ 'summary' => '删除指定的OSS-HDFS投递任务。', 'path' => '/osshdfsexports/{ossExportName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203483', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-osshdfs-1234567890-123456'."\n" - ."\n", - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n" + ."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], @@ -15499,98 +8607,59 @@ 'DeleteOSSIngestion' => [ 'summary' => '删除一个 OSS 导入任务。', 'path' => '/ossingestions/{ossIngestionName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '203138', - 'abilityTreeNodes' => [ - 'FEATUREslsDQM02M', - ], + 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'ossIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'OSS导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123456', - ], + 'schema' => ['description' => 'OSS导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除OSS导入任务', 'changeSet' => [], @@ -15602,30 +8671,21 @@ 'DeleteProject' => [ 'summary' => '删除一个指定的Project。', 'path' => '/', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '8740', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -15633,67 +8693,34 @@ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'projetc 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-project-test', - ], + 'schema' => ['title' => 'projetc 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test'], ], [ 'name' => 'forceDelete', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -15738,18 +8765,10 @@ 'action' => 'log:DeleteProject', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}'], ], ], ], @@ -15758,80 +8777,48 @@ 'DeleteProjectPolicy' => [ 'summary' => '删除Project的授权策略（Policy）。', 'path' => '/policy', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '157643', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], @@ -15856,111 +8843,71 @@ 'action' => 'log:DeleteProjectPolicy', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], 'DeleteS3Ingestion' => [ - 'summary' => '删除s3导入任务', 'path' => '/s3ingestions/{s3IngestionName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '263584', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ 'name' => 's3IngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], + 'title' => '删除S3导入任务', + 'summary' => '删除s3导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -15971,94 +8918,50 @@ 'DeleteSavedSearch' => [ 'summary' => '删除一个快速查询。', 'path' => '/savedsearches/{savedsearchName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'savedsearchName', 'in' => 'path', - 'schema' => [ - 'description' => '待删除的快速查询名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-savedsearch-name', - ], + 'schema' => ['description' => '待删除的快速查询名称。', 'type' => 'string', 'required' => true, 'example' => 'test-savedsearch-name'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -16088,18 +8991,10 @@ 'action' => 'log:DeleteSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], @@ -16108,91 +9003,54 @@ 'DeleteScheduledSQL' => [ 'summary' => '删除指定的定时SQL任务。', 'path' => '/scheduledsqls/{scheduledSQLName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '209792', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456'."\n", - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], @@ -16211,12 +9069,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -16225,20 +9078,14 @@ 'DeleteStoreView' => [ 'summary' => '根据名称删除指定数据集。', 'path' => '/storeviews/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -16247,83 +9094,45 @@ 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '208667', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - ], + 'schema' => ['description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'example-project'], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => '数据集名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - ], + 'schema' => ['description' => '数据集名称', 'type' => 'string', 'required' => true, 'example' => 'my_storeview'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '删除数据集', 'changeSet' => [], @@ -16338,37 +9147,23 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], 'DescribeRegions' => [ - 'summary' => '查询可用的区域。', 'path' => '/regions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -16376,9 +9171,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226892', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ @@ -16389,11 +9182,7 @@ 'description' => '返回参数localName对应的语言。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ja' => 'ja', - 'en' => 'en', - 'zh' => 'zh', - ], + 'enumValueTitles' => ['ja' => 'ja', 'en' => 'en', 'zh' => 'zh'], 'example' => 'zh', ], ], @@ -16401,35 +9190,20 @@ 'responses' => [ 200 => [ 'headers' => [ - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], ], 'schema' => [ @@ -16442,28 +9216,14 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'region' => [ - 'description' => 'SLS region', - 'type' => 'string', - ], - 'localName' => [ - 'description' => 'SLS region名称。', - 'type' => 'string', - ], - 'intranetEndpoint' => [ - 'description' => 'SLS内网地址', - 'type' => 'string', - ], - 'internetEndpoint' => [ - 'description' => 'SLS公网地址', - 'type' => 'string', - ], + 'region' => ['description' => 'SLS region', 'type' => 'string'], + 'localName' => ['description' => 'SLS region名称。', 'type' => 'string'], + 'intranetEndpoint' => ['description' => 'SLS内网地址', 'type' => 'string'], + 'internetEndpoint' => ['description' => 'SLS公网地址', 'type' => 'string'], + 'internalEndpoint' => ['type' => 'string'], 'dataRedundancyType' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - ], + 'items' => ['type' => 'string', 'description' => ''], 'description' => '', ], ], @@ -16477,124 +9237,75 @@ ], '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' => '', - ], + ['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":"{\\n \\"regions\\": [\\n {\\n \\"region\\": \\"\\",\\n \\"localName\\": \\"\\",\\n \\"intranetEndpoint\\": \\"\\",\\n \\"internetEndpoint\\": \\"\\",\\n \\"dataRedundancyType\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询可用区域', + 'summary' => '查询可用的区域。', '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' => '关闭指定的告警规则。', 'path' => '/alerts/{alertName}?action=disable', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '200858', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'alertName', 'in' => 'path', - 'schema' => [ - 'description' => '告警规则ID', - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456'."\n", - ], + 'schema' => ['description' => '告警规则ID', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '关闭告警规则', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" @@ -16615,12 +9326,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -16629,91 +9335,54 @@ 'DisableScheduledSQL' => [ 'summary' => '关闭指定的定时SQL。', 'path' => '/scheduledsqls/{scheduledSQLName}?action=disable', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '219106', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], ], ], @@ -16732,12 +9401,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -16746,103 +9410,59 @@ 'EnableAlert' => [ 'summary' => '开启指定的告警规则。', 'path' => '/alerts/{alertName}?action=enable', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '200854', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'alertName', 'in' => 'path', - 'schema' => [ - 'description' => '告警规则ID', - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456', - ], + 'schema' => ['description' => '告警规则ID', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '开启告警规则', 'changeSet' => [], @@ -16857,12 +9477,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -16871,91 +9486,54 @@ 'EnableScheduledSQL' => [ 'summary' => '开启指定的定时SQL。', 'path' => '/scheduledsqls/{scheduledSQLName}?action=enable', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '219089', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + '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", - ], + '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' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], @@ -16974,92 +9552,58 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], - 'ExecuteQuery' => [ - 'summary' => '执行 sql、spl 等查询接口', - 'path' => '/execute-query', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetAgentInstanceConfig' => [ + 'path' => '/agentinstanceconfigs/{configType}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '227420', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', + 'name' => 'configType', + 'in' => 'path', 'schema' => [ - 'title' => '日志项目', + 'description' => '进程级配置类型', 'type' => 'string', 'required' => true, - 'description' => '日志项目', + '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', + ], + 'example' => 'apm_biz_trace', ], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'attributes', + 'in' => 'query', 'style' => 'json', 'schema' => [ + 'description' => '进程级配置归属', 'type' => 'object', - 'properties' => [ - 'type' => [ - 'title' => '类型，例如 SQL', - 'type' => 'string', - 'required' => true, - 'example' => 'SQL', - 'default' => 'SQL', - 'description' => '类型，例如 SQL', - ], - 'query' => [ - 'title' => '查询语句', - 'type' => 'string', - 'required' => true, - 'description' => '查询语句', - ], - ], - 'description' => '', - ], - ], - [ - 'name' => 'Accept-Encoding', - 'in' => 'header', - 'schema' => [ - 'title' => '压缩方式', - 'type' => 'string', 'required' => false, - 'example' => 'lz4', + 'additionalProperties' => ['type' => 'string', 'description' => '进程级配置归属', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"'], ], ], ], @@ -17067,371 +9611,115 @@ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'meta' => [ + 'configType' => ['title' => '配置类型', 'description' => '进程级配置类型', 'type' => 'string', 'example' => 'apm_biz_trace'], + 'attributes' => [ + 'description' => '进程级配置归属', 'type' => 'object', - 'properties' => [ - 'affectedRows' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - ], - 'elapsedMillisecond' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - ], - 'description' => '', + 'additionalProperties' => ['type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"', 'description' => '进程级配置归属'], + ], + 'config' => ['title' => '兜底配置', 'description' => '默认配置', 'type' => 'string', 'example' => '{}'], + 'grayConfigs' => [ + 'title' => '灰度配置', + 'description' => '灰度配置', + 'type' => 'array', + 'items' => ['description' => '灰度配置', '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs'], ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1749543828'], + 'lastModifyTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1749543828'], ], - 'description' => 'Schema of Response', + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取进程级配置', + 'summary' => '获取进程级配置', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meta\\": {\\n \\"affectedRows\\": 0,\\n \\"elapsedMillisecond\\": 0\\n }\\n}","type":"json"}]', + '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\\": \\"\\",\\n \\"content\\": \\"\\"\\n }\\n ],\\n \\"createTime\\": 1749543828,\\n \\"lastModifyTime\\": 1749543828\\n}","type":"json"}]', ], - 'GetAgentInstanceConfig' => [ - 'path' => '/agentinstanceconfigs/{configType}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetAlert' => [ + 'summary' => '获取指定的告警规则。', + 'path' => '/alerts/{alertName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '227420', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '200220', + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ - 'name' => 'configType', - 'in' => 'path', - 'schema' => [ - 'description' => '进程级配置类型', - 'type' => 'string', - 'required' => true, - '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', - ], - 'example' => 'apm_biz_trace', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ - 'name' => 'attributes', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '进程级配置归属', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '进程级配置归属', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - ], - ], + 'name' => 'alertName', + 'in' => 'path', + 'schema' => ['description' => '告警规则ID', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - ], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'configType' => [ - 'title' => '配置类型', - 'description' => '进程级配置类型', - 'type' => 'string', - 'example' => 'apm_biz_trace', - ], - 'attributes' => [ - 'description' => '进程级配置归属', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - 'description' => '进程级配置归属', - ], - ], - 'config' => [ - 'title' => '兜底配置', - 'description' => '默认配置', - 'type' => 'string', - 'example' => '{}', - ], - 'grayConfigs' => [ - 'title' => '灰度配置', - 'description' => '灰度配置', - 'type' => 'array', - 'items' => [ - 'description' => '灰度配置', - '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', - ], - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1749543828', - ], - 'lastModifyTime' => [ - 'title' => '修改时间', - 'description' => '修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1749543828', - ], - ], - 'description' => '', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => '获取进程级配置', - 'summary' => '获取进程级配置', - '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\\": \\"\\",\\n \\"content\\": \\"\\"\\n }\\n ],\\n \\"createTime\\": 1749543828,\\n \\"lastModifyTime\\": 1749543828\\n}","type":"json"}]', - ], - 'GetAlert' => [ - 'summary' => '获取指定的告警规则。', - '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' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], - ], - [ - 'name' => 'alertName', - 'in' => 'path', - 'schema' => [ - 'description' => '告警规则ID', - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], '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' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], - 'schema' => [ - 'description' => '告警规则配置', - '$ref' => '#/components/schemas/Alert', - ], + 'schema' => ['description' => '告警规则配置', '$ref' => '#/components/schemas/Alert'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\n },\\n \\"createTime\\": 0,\\n \\"lastModifiedTime\\": 0,\\n \\"status\\": \\"ENABLED/DISABLED\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取告警规则', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" @@ -17451,118 +9739,65 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', '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' => '通过数据唯一标识得到数据集中的数据结构体。', 'path' => '/ml/annotationdataset/{datasetId}/annotationdata/{annotationdataId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => '数据集唯一标识', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be'], ], [ 'name' => 'annotationdataId', 'in' => 'path', - 'schema' => [ - 'description' => '数据的唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => '2156d560fc7c01420542df92cd6365ds', - ], + 'schema' => ['description' => '数据的唯一标识', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'description' => '数据的结构体', - '$ref' => '#/components/schemas/MLDataParam', - ], + 'schema' => ['description' => '数据的结构体', '$ref' => '#/components/schemas/MLDataParam'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => '获取数据', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -17575,94 +9810,50 @@ 'GetAnnotationDataSet' => [ 'summary' => '取得数据集信息。', 'path' => '/ml/annotationdataset/{datasetId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => '数据集唯一标识', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'description' => '数据集结构体', - '$ref' => '#/components/schemas/MLDataSetParam', - ], + 'schema' => ['description' => '数据集结构体', '$ref' => '#/components/schemas/MLDataSetParam'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => '获取数据集', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -17675,94 +9866,50 @@ 'GetAnnotationLabel' => [ 'summary' => '通过labelId拿到某个标签表。', 'path' => '/ml/annotationlabel/{labelId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'labelId', 'in' => 'path', - 'schema' => [ - 'description' => '标签ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799', - ], + 'schema' => ['description' => '标签ID。', 'type' => 'string', 'required' => false, 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'description' => '标签表结构体。', - '$ref' => '#/components/schemas/MLLabelParam', - ], + 'schema' => ['description' => '标签表结构体。', '$ref' => '#/components/schemas/MLLabelParam'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => '获取标签', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -17775,97 +9922,50 @@ 'GetAppliedConfigs' => [ 'summary' => '获取目标机器组上已经被应用的Logtail配置列表。', 'path' => '/machinegroups/{machineGroup}/configs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group', - ], + 'schema' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ @@ -17873,23 +9973,12 @@ 'description' => '请求返回体。', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => 'Logtail配置数量。', - 'description' => 'Logtail配置数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'count' => ['title' => 'Logtail配置数量。', 'description' => 'Logtail配置数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'configs' => [ 'title' => 'Logtail配置名称列表。', 'description' => 'Logtail配置名称列表。', 'type' => 'array', - 'items' => [ - 'title' => 'Logtail 配置名称。', - 'description' => 'Logtail配置信息。', - 'type' => 'string', - 'example' => '[ "two", "three", "test_logstore" ]', - ], + 'items' => ['title' => 'Logtail 配置名称。', 'description' => 'Logtail配置信息。', 'type' => 'string', 'example' => '[ "two", "three", "test_logstore" ]'], ], ], ], @@ -17916,18 +10005,10 @@ 'action' => 'log:GetAppliedConfigs', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['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}/machinegroup/{#MachineGroupName}'], ], ], ], @@ -17936,97 +10017,50 @@ 'GetAppliedMachineGroups' => [ 'summary' => '调用GetAppliedMachineGroups接口获取已绑定指定Logtail配置的机器组列表。', 'path' => '/configs/{configName}/machinegroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'title' => 'logtail 配置名称。', - 'description' => 'Logtail配置名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'logtail-config-sample', - ], + 'schema' => ['title' => 'logtail 配置名称。', 'description' => 'Logtail配置名称。', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ @@ -18034,23 +10068,12 @@ 'description' => '请求返回体。', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '返回的机器组数量。', - 'description' => '返回的机器组数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'count' => ['title' => '返回的机器组数量。', 'description' => '返回的机器组数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'machinegroups' => [ 'title' => '返回的机器组名称列表。', 'description' => '返回的机器组名称。', 'type' => 'array', - 'items' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'example' => 'sample-group1', - ], + 'items' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'example' => 'sample-group1'], 'example' => '[ "sample-group1","sample-group2" ]', ], ], @@ -18078,32 +10101,19 @@ 'action' => 'log:GetAppliedMachineGroups', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], ], ], 'GetAsyncSql' => [ - 'summary' => '获取异步SQL的状态以及结果', 'path' => '/asyncsql/{queryId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -18118,99 +10128,56 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '292959', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'sls的project名称', - 'type' => 'string', - 'required' => false, - 'example' => 'sls-demo-project', - ], + 'schema' => ['description' => 'sls的project名称', 'type' => 'string', 'required' => false, 'example' => 'sls-demo-project'], ], [ 'name' => 'queryId', 'in' => 'path', - 'schema' => [ - 'description' => '异步SQL对应的ID（整个SQL生命周期内固定）', - 'type' => 'string', - 'required' => false, - 'example' => '690C4F2A16FBD65C40000484_14', - ], + 'schema' => ['description' => '异步SQL对应的ID（整个SQL生命周期内固定）', 'type' => 'string', 'required' => false, 'example' => '690C4F2A16FBD65C40000484_14'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '分页结果的offset', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '分页结果的offset', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'line', 'in' => 'query', - 'schema' => [ - 'description' => '分页结果的page大小，最大支持1000', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '分页结果的page大小，最大支持1000', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], - 'schema' => [ - 'description' => 'body 中返回的数据格式（对应 protobuf 格式）', - '$ref' => '#/components/schemas/AsyncSqlResponseData', - ], + 'schema' => ['description' => 'body 中返回的数据格式（对应 protobuf 格式）', '$ref' => '#/components/schemas/AsyncSqlResponseData'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '获取异步SQL结果', + 'summary' => '获取异步SQL的状态以及结果', 'description' => '通过SubmitAsyncSql接口提交SQL请求后，后续可以通过本接口来轮询请求的执行状态（建议轮询周期设置为不低于1s）。当接口执行成功后，可以通过GetAsyncSql接口以分页的形式来拉去结果。', 'responseParamsDescription' => '仅当结果中state为FAILED时，结果集中的error_code和error_message才有意义。', 'changeSet' => [], @@ -18221,194 +10188,112 @@ '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' => [ - 'summary' => '获取Azure blob文件导入任务信息', 'path' => '/azureblobingestions/{azureBlobIngestionName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '291248', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - '$ref' => '#/components/schemas/AzureBlobIngestion', - 'description' => '', - ], + 'schema' => ['$ref' => '#/components/schemas/AzureBlobIngestion', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取AzureBlob导入任务', + 'summary' => '获取AzureBlob导入任务', '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 }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\"\\n}","type":"json"}]', ], 'GetCheckPoint' => [ 'summary' => '调用GetCheckPoint接口获取指定消费组消费数据时Shard的checkpoint。', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'title' => '消费组名称。', - 'description' => '消费组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'consumer-group-1', - ], + 'schema' => ['title' => '消费组名称。', 'description' => '消费组名称。', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1'], ], [ 'name' => 'shard', 'in' => 'query', - 'schema' => [ - 'title' => 'Shard ID。'."\n" - .'如果指定的Shard不存在，则返回空列表。'."\n" - .'如果不指定Shard，则返回所有Shard的checkpoint。', - 'description' => 'Shard ID。'."\n" - ."\n" - .'- 如果指定的Shard不存在，则返回空列表。'."\n" - .'- 如果不指定Shard，则返回所有Shard的Checkpoint。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => 'Shard ID。'."\n" + .'如果指定的Shard不存在，则返回空列表。'."\n" + .'如果不指定Shard，则返回所有Shard的checkpoint。', 'description' => 'Shard ID。'."\n" + ."\n" + .'- 如果指定的Shard不存在，则返回空列表。'."\n" + .'- 如果不指定Shard，则返回所有Shard的Checkpoint。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ @@ -18420,32 +10305,10 @@ 'description' => 'Checkpoint结构体。', 'type' => 'object', 'properties' => [ - 'shard' => [ - 'title' => 'shard id。', - 'description' => 'Shard ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'checkpoint' => [ - 'title' => 'checkpoint 值。', - 'description' => 'Checkpoint值。', - 'type' => 'string', - 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng==', - ], - 'updateTime' => [ - 'title' => 'checkpoint最后的更新时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => 'Checkpoint最后的更新时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1524224984800922', - ], - 'consumer' => [ - 'title' => '消费者。', - 'description' => 'Checkpoint处的消费者。', - 'type' => 'string', - 'example' => 'consumer_1', - ], + 'shard' => ['title' => 'shard id。', 'description' => 'Shard ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'checkpoint' => ['title' => 'checkpoint 值。', 'description' => 'Checkpoint值。', 'type' => 'string', 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng=='], + 'updateTime' => ['title' => 'checkpoint最后的更新时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => 'Checkpoint最后的更新时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1524224984800922'], + 'consumer' => ['title' => '消费者。', 'description' => 'Checkpoint处的消费者。', 'type' => 'string', 'example' => 'consumer_1'], ], ], ], @@ -18483,104 +10346,59 @@ 'GetCollectionPolicy' => [ 'summary' => '调用GetCollectionPolicy获取对应的规则。', 'path' => '/collectionpolicy/{policyName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '195429', - 'abilityTreeNodes' => [ - 'FEATUREsls9NGCVR', - ], + 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ 'name' => 'policyName', 'in' => 'path', - 'schema' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'your_log_policy'."\n", - 'maxLength' => 63, - 'minLength' => 3, - ], + 'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => true, 'example' => 'your_log_policy'."\n", 'maxLength' => 63, 'minLength' => 3], ], [ 'name' => 'productCode', 'in' => 'query', - 'schema' => [ - 'description' => '产品编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss', - ], + 'schema' => ['description' => '产品编码。', 'type' => 'string', 'required' => false, 'example' => 'oss'], ], [ 'name' => 'dataCode', 'in' => 'query', - 'schema' => [ - 'description' => '日志类型编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'access_log', - ], + 'schema' => ['description' => '日志类型编码。', 'type' => 'string', 'required' => false, 'example' => 'access_log'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], ], 'schema' => [ @@ -18592,109 +10410,48 @@ 'description' => '返回规则。', 'type' => 'object', 'properties' => [ - 'policyName' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'example' => 'your_log_policy', - ], - 'enabled' => [ - 'description' => '是否开启。', - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'productCode' => [ - 'description' => '产品编码。', - 'type' => 'string', - 'example' => 'oss', - ], - 'dataCode' => [ - 'description' => '日志类型编码。', - 'type' => 'string', - 'example' => 'access_log', - ], + 'policyName' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'your_log_policy'], + 'enabled' => ['description' => '是否开启。', 'type' => 'boolean', 'example' => 'true'."\n"], + 'productCode' => ['description' => '产品编码。', 'type' => 'string', 'example' => 'oss'], + 'dataCode' => ['description' => '日志类型编码。', 'type' => 'string', 'example' => 'access_log'], 'policyConfig' => [ 'description' => '采集规则配置。', 'type' => 'object', 'properties' => [ - 'resourceMode' => [ - 'description' => '资源采集模式。', - 'type' => 'string', - 'example' => 'all', - ], + 'resourceMode' => ['description' => '资源采集模式。', 'type' => 'string', 'example' => 'all'], 'regions' => [ 'description' => '实例所属的地域集合，支持通配符。', 'type' => 'array', - 'items' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'items' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], ], 'instanceIds' => [ 'description' => '实例ID集合。', 'type' => 'array', - 'items' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'your-test-bucket1'."\n", - ], - ], - 'resourceTags' => [ - 'description' => '资源标签。', - 'type' => 'object', - 'example' => '{"tag1":"value1","tag2":"value2"}', + 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'your-test-bucket1'."\n"], ], + 'resourceTags' => ['description' => '资源标签。', 'type' => 'object', 'example' => '{"tag1":"value1","tag2":"value2"}'], ], ], - 'centralizeEnabled' => [ - 'description' => '是否开启中心化存储。', - 'type' => 'boolean', - 'example' => 'false', - ], + 'centralizeEnabled' => ['description' => '是否开启中心化存储。', 'type' => 'boolean', 'example' => 'false'], 'centralizeConfig' => [ 'description' => '中心化转投配置。', 'type' => 'object', 'properties' => [ - 'destRegion' => [ - 'description' => '中心化转投目的地域。', - 'type' => 'string', - 'example' => 'cn-beijing'."\n", - ], - 'destProject' => [ - 'description' => '中心化转投目的项目。', - 'type' => 'string', - 'example' => 'your-sls-project-in-beijing'."\n", - ], - 'destLogstore' => [ - 'description' => '中心化转投目的日志库。', - 'type' => 'string', - 'example' => 'your-sls-logstore-in-beijing'."\n", - ], - 'destTTL' => [ - 'description' => '中心化转投目的天数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'destRegion' => ['description' => '中心化转投目的地域。', 'type' => 'string', 'example' => 'cn-beijing'."\n"], + 'destProject' => ['description' => '中心化转投目的项目。', 'type' => 'string', 'example' => 'your-sls-project-in-beijing'."\n"], + 'destLogstore' => ['description' => '中心化转投目的日志库。', 'type' => 'string', 'example' => 'your-sls-logstore-in-beijing'."\n"], + 'destTTL' => ['description' => '中心化转投目的天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], 'resourceDirectory' => [ 'description' => '资源目录配置, 如有配置，否则为空', 'type' => 'object', 'properties' => [ - 'accountGroupType' => [ - 'description' => '在该资源目录下，全选模式all或自定义模式custom', - 'type' => 'string', - 'example' => 'all,custom', - ], + 'accountGroupType' => ['description' => '在该资源目录下，全选模式all或自定义模式custom', 'type' => 'string', 'example' => 'all,custom'], 'members' => [ 'description' => '当资源目录配置为custom模式时，对应的成员账号列表', 'type' => 'array', - 'items' => [ - 'description' => '阿里云账号Uid', - 'type' => 'string', - 'example' => '165***********50', - ], + 'items' => ['description' => '阿里云账号Uid', 'type' => 'string', 'example' => '165***********50'], ], ], ], @@ -18702,37 +10459,19 @@ 'description' => '当且仅当日志类型为全局日志类型时支持的配置，例如productCode为sls时的场景。否则为空。', 'type' => 'object', 'properties' => [ - 'dataRegion' => [ - 'description' => '当且仅当日志类型为全局日志类型时支持的配置，例如productCode为sls时的场景，表示首次配置时全局日志将被采集到对应地域。', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'dataProject' => [ - 'description' => '当且仅当日志类型为全局日志类型时有效，例如productCode为sls时的场景，如果为空，表示日志被采集到该账号在特定dataRegion下的默认专属的Project中。', - 'type' => 'string', - 'example' => '""', - ], + 'dataRegion' => ['description' => '当且仅当日志类型为全局日志类型时支持的配置，例如productCode为sls时的场景，表示首次配置时全局日志将被采集到对应地域。', 'type' => 'string', 'example' => 'cn-beijing'], + 'dataProject' => ['description' => '当且仅当日志类型为全局日志类型时有效，例如productCode为sls时的场景，如果为空，表示日志被采集到该账号在特定dataRegion下的默认专属的Project中。', 'type' => 'string', 'example' => '""'], ], ], - 'internalPolicy' => [ - 'description' => '是否是内置规则策略，内置规则不允许修改、删除。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'policyUid' => [ - 'description' => '规则所属的账号阿里云账号Uid，如果该规则由资源目录管理员或者资源目录委派管理员创建，则为其阿里云账号Uid。', - 'type' => 'string', - 'example' => '148***********50'."\n", - ], + 'internalPolicy' => ['description' => '是否是内置规则策略，内置规则不允许修改、删除。', 'type' => 'boolean', 'example' => 'false'], + 'policyUid' => ['description' => '规则所属的账号阿里云账号Uid，如果该规则由资源目录管理员或者资源目录委派管理员创建，则为其阿里云账号Uid。', 'type' => 'string', 'example' => '148***********50'."\n"], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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' => '获取云产品日志采集的采集规则', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡、河源专属云汽车合规（cn-heyuan-acdr-1）。', @@ -18745,100 +10484,57 @@ 'GetConfig' => [ 'summary' => '调用GetConfig接口获取Logtail配置的详细信息。', 'path' => '/configs/{configName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '9089', - 'abilityTreeNodes' => [ - 'FEATUREslsYP6SBU', - ], + 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'description' => 'Logtail配置名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'logtail-config-sample', - ], + 'schema' => ['description' => 'Logtail配置名称。', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'description' => 'Logtail配置数据结构。', - '$ref' => '#/components/schemas/LogtailConfig', - ], + 'schema' => ['description' => 'Logtail配置数据结构。', '$ref' => '#/components/schemas/LogtailConfig'], ], ], 'eventInfo' => [ @@ -18874,225 +10570,125 @@ 'action' => 'log:GetConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], ], ], 'GetConsumeProcessor' => [ - 'summary' => '查询消费处理器的详情', 'path' => '/consumeprocessors/{processorName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '225109', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'processorName', 'in' => 'path', - 'schema' => [ - 'description' => '消费处理器标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'consume-processor-1', - ], + 'schema' => ['description' => '消费处理器标识。', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], - 'schema' => [ - 'description' => '消费处理器详情', - '$ref' => '#/components/schemas/ConsumeProcessor', - ], + 'schema' => ['description' => '消费处理器详情', '$ref' => '#/components/schemas/ConsumeProcessor'], ], ], - '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"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询消费处理器详情', + 'summary' => '查询消费处理器的详情', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + '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"}]', ], 'GetContextLogs' => [ 'summary' => '调用GetContextLogs接口查询指定日志前（上文）后（下文）的若干条日志。', 'path' => '/logstores/{logstore}?type=context_log', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'pack_id', 'in' => 'query', - 'schema' => [ - 'title' => '起始日志所属的LogGroup的唯一身份标识。', - 'description' => '起始日志所属的LogGroup的唯一身份标识。', - 'type' => 'string', - 'required' => true, - 'example' => '85C897C740352DC6-808', - ], + 'schema' => ['title' => '起始日志所属的LogGroup的唯一身份标识。', 'description' => '起始日志所属的LogGroup的唯一身份标识。', 'type' => 'string', 'required' => true, 'example' => '85C897C740352DC6-808'], ], [ 'name' => 'pack_meta', 'in' => 'query', - 'schema' => [ - 'title' => '起始日志在对应LogGroup内的唯一上下文结构标识。', - 'description' => '起始日志在对应LogGroup内的唯一上下文结构标识。', - 'type' => 'string', - 'required' => true, - 'example' => '2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0', - ], + 'schema' => ['title' => '起始日志在对应LogGroup内的唯一上下文结构标识。', 'description' => '起始日志在对应LogGroup内的唯一上下文结构标识。', 'type' => 'string', 'required' => true, 'example' => '2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0'], ], [ 'name' => 'back_lines', 'in' => 'query', - 'schema' => [ - 'title' => '指定起始日志往前（上文）的日志条数，取值范围为(0,100]。', - 'description' => '指定起始日志往前（上文）的日志条数，取值范围为`(0,100]`。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '指定起始日志往前（上文）的日志条数，取值范围为(0,100]。', 'description' => '指定起始日志往前（上文）的日志条数，取值范围为`(0,100]`。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], ], [ 'name' => 'forward_lines', 'in' => 'query', - 'schema' => [ - 'title' => '指定起始日志往后（下文）的日志条数，取值范围为(0,100]。', - 'description' => '指定起始日志往后（下文）的日志条数，取值范围为`(0,100]`。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['title' => '指定起始日志往后（下文）的日志条数，取值范围为(0,100]。', 'description' => '指定起始日志往后（下文）的日志条数，取值范围为`(0,100]`。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], ], ], 'responses' => [ @@ -19102,53 +10698,25 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total_lines' => [ - 'title' => '返回的总日志条数，包含请求参数中所指定的起始日志。', - 'description' => '返回的总日志条数，包含请求参数中所指定的起始日志。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201', - ], - 'back_lines' => [ - 'title' => '向前查询到的日志条数。', - 'description' => '向前查询到的日志条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'forward_lines' => [ - 'title' => '向后查询到的日志条数。', - 'description' => '向后查询到的日志条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'progress' => [ - 'title' => '查询的结果是否完整。'."\n" - .'Complete：查询已经完成，返回结果为完整结果。'."\n" - .'Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'description' => '查询的结果是否完整。'."\n" - ."\n" - .'- Complete：查询已经完成，返回结果为完整结果。'."\n" - .'- Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'type' => 'string', - 'example' => 'Complete', - ], + 'total_lines' => ['title' => '返回的总日志条数，包含请求参数中所指定的起始日志。', 'description' => '返回的总日志条数，包含请求参数中所指定的起始日志。', 'type' => 'integer', 'format' => 'int64', 'example' => '201'], + 'back_lines' => ['title' => '向前查询到的日志条数。', 'description' => '向前查询到的日志条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'forward_lines' => ['title' => '向后查询到的日志条数。', 'description' => '向后查询到的日志条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'progress' => ['title' => '查询的结果是否完整。'."\n" + .'Complete：查询已经完成，返回结果为完整结果。'."\n" + .'Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'description' => '查询的结果是否完整。'."\n" + ."\n" + .'- Complete：查询已经完成，返回结果为完整结果。'."\n" + .'- Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'type' => 'string', 'example' => 'Complete'], 'logs' => [ 'title' => '获取到的日志，按上下文顺序排列。当根据指定起始日志查询不到上下文日志时，此参数为空。', 'description' => '获取到的日志。', 'type' => 'array', - 'items' => [ - 'title' => '每一条日志是一个 map，例如 {'."\n" - .' "__index_number__": "-100",'."\n" - .' "__tag__:__pack_id__": "895CEA449A52FE-8c8",'."\n" - .' "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1",'."\n" - .' ...'."\n" - .' }。', - 'description' => '获取到的日志，按上下文顺序排列。当根据指定起始日志查询不到上下文日志时，此参数为空。', - 'type' => 'object', - 'example' => '{ "__index_number__": "-100", "__tag__:__pack_id__": "895CEA449A52FE-8c8", "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"}', - ], + 'items' => ['title' => '每一条日志是一个 map，例如 {'."\n" + .' "__index_number__": "-100",'."\n" + .' "__tag__:__pack_id__": "895CEA449A52FE-8c8",'."\n" + .' "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1",'."\n" + .' ...'."\n" + .' }。', 'description' => '获取到的日志，按上下文顺序排列。当根据指定起始日志查询不到上下文日志时，此参数为空。', 'type' => 'object', 'example' => '{ "__index_number__": "-100", "__tag__:__pack_id__": "895CEA449A52FE-8c8", "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"}'], ], ], ], @@ -19335,132 +10903,67 @@ 'GetCursor' => [ 'summary' => '可以根据时间获取对应的游标（Cursor）。', 'path' => '/logstores/{logstore}/shards/{shardId}?type=cursor', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'sls-test-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'sls-test-logstore'], ], [ 'name' => 'shardId', 'in' => 'path', - 'schema' => [ - 'title' => 'shard id。', - 'description' => 'Shard ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => 'shard id。', 'description' => 'Shard ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'title' => '时间点（Unix时间戳）或者字符串begin、end。', - 'description' => '时间点（Unix时间戳）或者字符串`begin`、`end`。', - 'type' => 'string', - 'required' => true, - 'example' => 'begin', - ], + 'schema' => ['title' => '时间点（Unix时间戳）或者字符串begin、end。', 'description' => '时间点（Unix时间戳）或者字符串`begin`、`end`。', 'type' => 'string', 'required' => true, 'example' => 'begin'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => 'Cursor值。', 'type' => 'object', 'properties' => [ - 'cursor' => [ - 'title' => '游标位置。', - 'description' => 'Cursor值。', - 'type' => 'string', - 'example' => 'MTQ0NzI5OTYwNjg5NjYzMjM1Ng==', - ], + 'cursor' => ['title' => '游标位置。', 'description' => 'Cursor值。', 'type' => 'string', 'example' => 'MTQ0NzI5OTYwNjg5NjYzMjM1Ng=='], ], ], ], @@ -19503,18 +11006,10 @@ 'action' => 'log:GetCursorOrData', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], @@ -19523,134 +11018,70 @@ 'GetCursorTime' => [ 'summary' => '根据 Cursor 游标获取游标对应的服务端时间。', 'path' => '/logstores/{logstore}/shards/{shardId}?type=cursor_time', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'shardId', 'in' => 'path', - 'schema' => [ - 'title' => 'shard id。', - 'description' => 'Shard ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => 'shard id。', 'description' => 'Shard ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'cursor', 'in' => 'query', - 'schema' => [ - 'title' => '游标。', - 'description' => '希望获取时间戳的Cursor。接口[GetCursor](~~2771314~~)可以获取Cursor。'."\n" - ."\n" - .'> 如果Cursor取值小于Begin Cursor或者Cursor取值大于End Cursor，返回InvalidCursor；当Shard中无数据时，返回当前时间。', - 'type' => 'string', - 'required' => true, - 'example' => 'MTU0NzQ3MDY4MjM3NjUxMzQ0Ng==', - ], + 'schema' => ['title' => '游标。', 'description' => '希望获取时间戳的游标 Cursor。接口[GetCursor](~~2771314~~)可以获取Cursor。'."\n" + ."\n" + .'> 如果Cursor取值小于Begin Cursor或者Cursor取值大于End Cursor，返回InvalidCursor；当Shard中无数据时，返回当前时间。', 'type' => 'string', 'required' => true, 'example' => 'MTU0NzQ3MDY4MjM3NjUxMzQ0Ng=='], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ - 'cursor_time' => [ - 'title' => 'Cursor的服务端时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => 'Cursor的服务端时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'string', - 'example' => '1554260243', - ], + 'cursor_time' => ['title' => 'Cursor的服务端时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => 'Cursor的服务端时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'string', 'example' => '1554260243'], ], + 'description' => '', ], ], ], @@ -19688,18 +11119,10 @@ 'action' => 'log:GetCursorOrData', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], @@ -19708,94 +11131,54 @@ 'GetDashboard' => [ 'summary' => '获取指定仪表盘。', 'path' => '/dashboards/{dashboardName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '10281', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'dashboardName', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '仪表盘名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => '仪表盘名称。', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Length' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'description' => '仪表盘数据结构。', - '$ref' => '#/components/schemas/dashboard', - ], + 'schema' => ['description' => '仪表盘数据结构。', '$ref' => '#/components/schemas/dashboard'], ], ], 'eventInfo' => [ @@ -19822,150 +11205,33 @@ 'action' => 'log:GetDashboard', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}', - ], - ], - ], - ], - ], - ], - 'GetDataset' => [ - 'summary' => '查询数据集', - 'path' => '/datasets/{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' => '296325', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'type' => 'string', - 'description' => 'A short description of struct', - ], - ], - [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - 'description' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'createTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'schema' => [ - 'type' => 'object', - 'additionalProperties' => [ - '$ref' => '#/components/schemas/IndexKey', - 'description' => '', - ], - 'description' => '', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ], - 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"updateTime\\": 0,\\n \\"schema\\": {\\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}","type":"json"}]', ], 'GetDownloadJob' => [ 'summary' => '获取下载任务信息。', 'path' => '/downloadjobs/{downloadJobName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '216704', - 'abilityTreeNodes' => [ - 'FEATUREsls1J4K38', - ], + 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ @@ -19983,12 +11249,7 @@ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], ], 'responses' => [ @@ -19998,68 +11259,23 @@ 'description' => 'download job info', 'type' => 'object', 'properties' => [ - 'status' => [ - 'title' => '资源状态', - 'description' => '下载任务状态', - 'type' => 'string', - 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR', - ], - 'name' => [ - 'title' => '资源名称', - 'description' => '下载任务名称', - 'type' => 'string', - 'example' => 'download-123', - ], - 'description' => [ - 'title' => '描述', - 'description' => '描述', - 'type' => 'string', - 'example' => 'a download job', - ], + 'status' => ['title' => '资源状态', 'description' => '下载任务状态', 'type' => 'string', 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR'], + 'name' => ['title' => '资源名称', 'description' => '下载任务名称', 'type' => 'string', 'example' => 'download-123'], + 'description' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'a download job'], 'configuration' => [ 'title' => '下载配置', 'description' => '下载配置', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => '源logstore', - 'description' => '源logstore', - 'type' => 'string', - 'example' => 'ali-test-logstore', - ], - 'fromTime' => [ - 'title' => '起点时间戳（精确到秒）', - 'description' => '起点时间戳（精确到秒）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1722409860', - ], - 'toTime' => [ - 'title' => '结束时间戳（精确到秒）', - 'description' => '结束时间戳（精确到秒）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1722411060', - ], - 'query' => [ - 'title' => '查询语句', - 'description' => '查询语句', - 'type' => 'string', - 'example' => '* | select *', - ], - 'powerSql' => [ - 'title' => '是否启用powerSql', - 'description' => '是否启用powerSql', - 'type' => 'boolean', - 'example' => 'false', - ], + 'logstore' => ['title' => '源logstore', 'description' => '源logstore', 'type' => 'string', 'example' => 'ali-test-logstore'], + 'fromTime' => ['title' => '起点时间戳（精确到秒）', 'description' => '起点时间戳（精确到秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1722409860'], + 'toTime' => ['title' => '结束时间戳（精确到秒）', 'description' => '结束时间戳（精确到秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1722411060'], + 'query' => ['title' => '查询语句', 'description' => '查询语句', 'type' => 'string', 'example' => '* | select *'], + 'powerSql' => ['title' => '是否启用powerSql', 'description' => '是否启用powerSql', 'type' => 'boolean', 'example' => 'false'], 'allowInComplete' => [ 'description' => '允许下载不精确数据', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', ], 'sink' => [ @@ -20067,119 +11283,39 @@ 'description' => '导出配置', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '固定为AliyunOSS', - 'type' => 'string', - 'example' => 'AliyunOSS', - ], - 'contentType' => [ - 'title' => '下载文件格式', - 'description' => '下载文件格式', - 'type' => 'string', - 'example' => 'csv', - ], - 'compressionType' => [ - 'title' => '压缩格式', - 'description' => '压缩格式', - 'type' => 'string', - 'example' => 'none', - ], - 'roleArn' => [ - 'title' => '下载使用roleArn', - 'description' => '下载使用roleArn', - 'type' => 'string', - 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole', - ], - 'bucket' => [ - 'title' => '对象存储桶', - 'description' => '对象存储桶', - 'type' => 'string', - 'example' => 'ali-test-oss-bucket', - ], - 'prefix' => [ - 'description' => '下载日志到用户bucket时的文件前缀', - 'type' => 'string', - 'example' => 'download/', - ], + 'type' => ['description' => '固定为AliyunOSS', 'type' => 'string', 'example' => 'AliyunOSS'], + 'contentType' => ['title' => '下载文件格式', 'description' => '下载文件格式', 'type' => 'string', 'example' => 'csv'], + 'compressionType' => ['title' => '压缩格式', 'description' => '压缩格式', 'type' => 'string', 'example' => 'none'], + 'roleArn' => ['title' => '下载使用roleArn', 'description' => '下载使用roleArn', 'type' => 'string', 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole'], + 'bucket' => ['title' => '对象存储桶', 'description' => '对象存储桶', 'type' => 'string', 'example' => 'ali-test-oss-bucket'], + 'prefix' => ['description' => '下载日志到用户bucket时的文件前缀', 'type' => 'string', 'example' => 'download/'], ], ], ], ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '1722411060', - ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => '显示名称', - 'type' => 'string', - 'example' => 'download-123456', - ], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '1722411060'], + 'displayName' => ['title' => '显示名称', 'description' => '显示名称', 'type' => 'string', 'example' => 'download-123456'], 'executionDetails' => [ 'title' => '执行细节', 'description' => '执行细节', 'type' => 'object', 'properties' => [ - 'progress' => [ - 'title' => '下载进度', - 'description' => '下载进度', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'filePath' => [ - 'title' => '下载结果链接', - 'description' => '下载结果链接', - 'type' => 'string', - 'example' => 'https://xxx.csv.zst?xxx', - ], - 'fileSize' => [ - 'title' => '下载文件大小', - 'description' => '下载文件大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'executeTime' => [ - 'title' => '下载执行时间', - 'description' => '下载执行时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'logCount' => [ - 'title' => '下载日志条数', - 'description' => '下载日志条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'errorMessage' => [ - 'title' => '下载错误信息', - 'description' => '下载错误信息', - 'type' => 'string', - 'example' => 'timeout', - ], - 'checkSum' => [ - 'description' => '文件ETAG', - 'type' => 'string', - 'example' => 'EXSFGSDASDASDG123ASD', - ], - 'notice' => [ - 'type' => 'string', - ], + 'progress' => ['title' => '下载进度', 'description' => '下载进度', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'filePath' => ['title' => '下载结果链接', 'description' => '下载结果链接', 'type' => 'string', 'example' => 'https://xxx.csv.zst?xxx'], + 'fileSize' => ['title' => '下载文件大小', 'description' => '下载文件大小', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'executeTime' => ['title' => '下载执行时间', 'description' => '下载执行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'logCount' => ['title' => '下载日志条数', 'description' => '下载日志条数', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'errorMessage' => ['title' => '下载错误信息', 'description' => '下载错误信息', 'type' => 'string', 'example' => 'timeout'], + 'checkSum' => ['description' => '文件ETAG', 'type' => 'string', 'example' => 'EXSFGSDASDASDG123ASD'], + 'notice' => ['description' => '通知文本。', 'type' => 'string', 'example' => 'test'], ], ], ], ], ], ], - '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\\": \\"\\"\\n }\\n}","type":"json"}]', + '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' => '获取日志下载任务', 'changeSet' => [], 'flowControl' => [ @@ -20190,66 +11326,40 @@ 'GetETL' => [ 'summary' => '获取指定的数据加工任务配置。', 'path' => '/etls/{etlName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '203168', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], [ 'name' => 'etlName', 'in' => 'path', - 'schema' => [ - 'description' => '数据加工名称', - 'type' => 'string', - 'required' => false, - 'example' => 'etl-123456', - ], + 'schema' => ['description' => '数据加工名称', 'type' => 'string', 'required' => false, 'example' => 'etl-123456'], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => '数据加工配置', - '$ref' => '#/components/schemas/ETL', - ], + 'schema' => ['description' => '数据加工配置', '$ref' => '#/components/schemas/ETL'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"etl-20240426\\",\\n \\"description\\": \\"加工作业\\",\\n \\"displayName\\": \\"etljob\\",\\n \\"configuration\\": {\\n \\"script\\": \\"* | extend 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' => '获取数据加工任务', 'changeSet' => [], @@ -20264,161 +11374,179 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], - 'GetHistograms' => [ - 'summary' => '调用GetHistograms接口查询指定Logstore中满足查询语法条件的日志分布情况。', - 'path' => '/logstores/{logstore}/index?type=histogram', - 'methods' => [ - 'get', + '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' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'esIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'ES/OpenSearch任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'ES/OpenSearch导入任务配置', '$ref' => '#/components/schemas/ESIngestion'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取ES/OpenSearch导入任务', + 'summary' => '获取ES/OpenSearch导入任务', + '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', + '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' => ['title' => 'A short description of struct', 'description' => 'project 名称', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'gcsIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'gcs导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-12345'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'gcs 导入任务', '$ref' => '#/components/schemas/GCSIngestion'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取gcs导入任务', + 'summary' => '获取GCP Cloud Storage文件导入任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'produces' => [ - 'application/json', + '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\\": 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 \\"tagPackId\\": true,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"format\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"lastModifiedTime\\": 1714360581\\n}","type":"json"}]', + ], + 'GetHistograms' => [ + 'summary' => '调用GetHistograms接口查询指定Logstore中满足查询语法条件的日志分布情况。', + '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' => 'project 名称。', - 'description' => 'project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'title' => '查询开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" - ."\n" - .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', - 'description' => '子时间区间的开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1409529600', - ], + 'schema' => ['title' => '查询开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" + ."\n" + .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', 'description' => '子时间区间的开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1409529600'], ], [ 'name' => 'to', 'in' => 'query', - 'schema' => [ - 'title' => '查询结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" - ."\n" - .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', - 'description' => '子时间区间的结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1409569200', - ], + 'schema' => ['title' => '查询结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" + ."\n" + .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', 'description' => '子时间区间的结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1409569200'], ], [ 'name' => 'topic', 'in' => 'query', - 'schema' => [ - 'title' => '日志主题。', - 'description' => '日志主题。', - 'type' => 'string', - 'required' => false, - 'example' => 'topic', - ], + 'schema' => ['title' => '日志主题。', 'description' => '日志主题。', 'type' => 'string', 'required' => false, 'example' => 'topic'], ], [ 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'title' => '查询语句。仅支持查询语句，不支持分析语句。关于查询语句的详细语法，请参见查询语法。', - 'description' => '查询语句。仅支持查询语句，不支持分析语句。关于查询语句的详细语法，请参见[查询语法](~~43772~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'with_pack_meta', - ], + 'schema' => ['title' => '查询语句。仅支持查询语句，不支持分析语句。关于查询语句的详细语法，请参见查询语法。', 'description' => '查询语句。仅支持查询语句，不支持分析语句。关于查询语句的详细语法，请参见[查询语法](~~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', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ @@ -20426,51 +11554,30 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'from' => [ - 'title' => '子时间区间的开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" - ."\n" - .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', - 'description' => '子时间区间的开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" - ."\n" - .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1409529600', - ], - 'to' => [ - 'title' => '子时间区间的结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" - ."\n" - .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', - 'description' => '子时间区间的结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" - ."\n" - .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1409569200', - ], - 'count' => [ - 'title' => '该子时间区间内查询到的日志条数。', - 'description' => '该子时间区间内查询到的日志条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'progress' => [ - 'title' => '当前查询结果在该子时间区间内的结果是否完整。'."\n" - ."\n" - .'Complete：查询已经完成，返回结果为完整结果。'."\n" - ."\n" - .'Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'description' => '当前查询结果在该子时间区间内的结果是否完整。'."\n" - ."\n" - .'Complete：查询已经完成，返回结果为完整结果。'."\n" - ."\n" - .'Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'type' => 'string', - 'example' => 'Complete', - ], + 'from' => ['title' => '子时间区间的开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" + ."\n" + .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', 'description' => '子时间区间的开始时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" + ."\n" + .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', 'type' => 'integer', 'format' => 'int64', 'example' => '1409529600'], + 'to' => ['title' => '子时间区间的结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" + ."\n" + .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', 'description' => '子时间区间的结束时间点。UNIX时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" + ."\n" + .'时间区间遵循“左闭右开”原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。', 'type' => 'integer', 'format' => 'int64', 'example' => '1409569200'], + 'count' => ['title' => '该子时间区间内查询到的日志条数。', 'description' => '该子时间区间内查询到的日志条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'progress' => ['title' => '当前查询结果在该子时间区间内的结果是否完整。'."\n" + ."\n" + .'Complete：查询已经完成，返回结果为完整结果。'."\n" + ."\n" + .'Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'description' => '当前查询结果在该子时间区间内的结果是否完整。'."\n" + ."\n" + .'Complete：查询已经完成，返回结果为完整结果。'."\n" + ."\n" + .'Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'type' => 'string', 'example' => 'Complete'], ], + 'description' => '', ], + 'description' => '', ], ], ], @@ -20506,194 +11613,104 @@ ], 'GetIndex' => [ 'path' => '/logstores/{logstore}/index', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '8966', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ 'description' => '请求返回的结构体。', 'type' => 'object', 'properties' => [ - 'ttl' => [ - 'title' => 'ttl', - 'description' => '索引文件生命周期，支持7天、30天、90天。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '30', - ], - 'max_text_len' => [ - 'title' => '统计字段最大长度', - 'description' => '日志服务默认字段值的最大长度为2048字节，即2 KB。如果您需要修改字段值的最大长度，可设置统计字段（text）最大长度，取值范围为64~16384字节。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', - ], + 'ttl' => ['title' => 'ttl', 'description' => '索引文件生命周期，支持7天、30天、90天。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30'], + 'max_text_len' => ['title' => '统计字段最大长度', 'description' => '日志服务默认字段值的最大长度为2048字节，即2 KB。如果您需要修改字段值的最大长度，可设置统计字段（text）最大长度，取值范围为64~16384字节。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048'], 'log_reduce_white_list' => [ 'title' => '日志聚类的聚类字段过滤白名单，仅当日志聚类开启时有效', 'description' => '日志聚类的聚类字段过滤白名单，仅当日志聚类开启时有效', 'type' => 'array', - 'items' => [ - 'description' => '白名单字段。', - 'type' => 'string', - 'example' => 'a', - ], + 'items' => ['description' => '白名单字段。', 'type' => 'string', 'example' => 'a'], ], 'log_reduce_black_list' => [ 'title' => '日志聚类的聚类字段过滤黑名单，仅当日志聚类开启时有效', 'description' => '日志聚类的聚类字段过滤黑名单，仅当日志聚类开启时有效。', 'type' => 'array', - 'items' => [ - 'description' => '黑名单字段。', - 'type' => 'string', - 'example' => 'b', - ], + 'items' => ['description' => '黑名单字段。', 'type' => 'string', 'example' => 'b'], ], 'line' => [ 'title' => '全文索引', 'description' => '全文索引配置。', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'title' => '包含中文', - 'description' => '是否包含中文。'."\n" - ."\n" - .'- true：包含中文。'."\n" - .'- false：不包含中文。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'caseSensitive' => [ - 'title' => '大小写敏感', - 'description' => '是否大小写敏感。'."\n" - .' - true：大小写敏感。'."\n" - .' - false：大小写不敏感。', - 'type' => 'boolean', - 'example' => 'false', - ], + 'chn' => ['title' => '包含中文', 'description' => '是否包含中文。'."\n" + ."\n" + .'- true：包含中文。'."\n" + .'- false：不包含中文。', 'type' => 'boolean', 'example' => 'false'], + 'caseSensitive' => ['title' => '大小写敏感', 'description' => '是否大小写敏感。'."\n" + .' - true：大小写敏感。'."\n" + .' - false：大小写不敏感。', 'type' => 'boolean', 'example' => 'false'], 'token' => [ 'title' => '分词符', 'description' => '分词符列表。', 'type' => 'array', - 'items' => [ - 'description' => '分词符。例如 "," "." "\\r" "\\n" 等。', - 'type' => 'string', - 'example' => ',', - ], + 'items' => ['description' => '分词符。例如 "," "." "\\r" "\\n" 等。', 'type' => 'string', 'example' => ','], 'required' => true, ], 'include_keys' => [ 'title' => '包含的字段列表，不能与exclude_keys同时指定。', 'description' => '包含的字段列表。', 'type' => 'array', - 'items' => [ - 'description' => '包含字段列表。', - 'type' => 'string', - 'example' => 'includeField', - ], + 'items' => ['description' => '包含字段列表。', 'type' => 'string', 'example' => 'includeField'], ], 'exclude_keys' => [ 'title' => '排除的字段列表，不能与include_keys同时指定。', 'description' => ' 排除的字段列表。', 'type' => 'array', - 'items' => [ - 'description' => '排除字段列表。', - 'type' => 'string', - 'example' => 'excludeField', - ], + 'items' => ['description' => '排除字段列表。', 'type' => 'string', 'example' => 'excludeField'], ], ], ], @@ -20701,36 +11718,12 @@ 'title' => '字段索引', 'description' => '字段索引配置。key为字段名称，value为索引配置。', 'type' => 'object', - 'additionalProperties' => [ - '$ref' => '#/components/schemas/IndexKey', - 'description' => '单个字段的索引配置。', - ], - ], - 'log_reduce' => [ - 'title' => '是否开启日志聚类', - 'description' => '是否开启日志聚类。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'lastModifyTime' => [ - 'title' => '上次修改时间', - 'description' => '索引最后更新时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1524155379', - ], - 'index_mode' => [ - 'title' => 'index 模式', - 'description' => '索引类型。', - 'type' => 'string', - 'example' => 'v2', - ], - 'storage' => [ - 'title' => '存储类型', - 'description' => '存储类型，目前固定取值为pg。', - 'type' => 'string', - 'example' => 'pg', + 'additionalProperties' => ['$ref' => '#/components/schemas/IndexKey', 'description' => '单个字段的索引配置。'], ], + 'log_reduce' => ['title' => '是否开启日志聚类', 'description' => '是否开启日志聚类。', 'type' => 'boolean', 'example' => 'false'], + 'lastModifyTime' => ['title' => '上次修改时间', 'description' => '索引最后更新时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1524155379'], + 'index_mode' => ['title' => 'index 模式', 'description' => '索引类型。', 'type' => 'string', 'example' => 'v2'], + 'storage' => ['title' => '存储类型', 'description' => '存储类型，目前固定取值为pg。', 'type' => 'string', 'example' => 'pg'], ], ], ], @@ -20755,178 +11748,107 @@ 'responseDemo' => '[{"type":"json","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 \\"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\\": false,\\n \\"lastModifyTime\\": 1524155379,\\n \\"index_mode\\": \\"v2\\",\\n \\"storage\\": \\"pg\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', ], 'GetIngestProcessor' => [ - 'summary' => '查询写入处理器的信息。', 'path' => '/ingestprocessors/{processorName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '225108', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称。', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project名称。', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'processorName', 'in' => 'path', - 'schema' => [ - 'title' => '写入处理器标识。', - 'description' => '写入处理器标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'parse-nginx-log', - ], + 'schema' => ['title' => '写入处理器标识。', 'description' => '写入处理器标识。', 'type' => 'string', 'required' => true, 'example' => 'parse-nginx-log'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], - 'schema' => [ - 'description' => '写入处理器信息。', - '$ref' => '#/components/schemas/IngestProcessor', - ], + 'schema' => ['description' => '写入处理器信息。', '$ref' => '#/components/schemas/IngestProcessor'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"processorName\\": \\"ingest-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\",\\n \\"parseFail\\": \\"keep\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n}","type":"json"}]', 'title' => '查询写入处理器信息', + 'summary' => '查询写入处理器的信息。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"processorName\\": \\"ingest-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\",\\n \\"parseFail\\": \\"keep\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n}","type":"json"}]', ], 'GetLogStore' => [ - 'summary' => '查看Logstore的详细信息。', 'path' => '/logstores/{logstore}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '115730', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'The logstore name.', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['title' => 'The logstore name.', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Logstore结构体。', - 'example' => 'ali-test-logstore', - '$ref' => '#/components/schemas/logstore', - ], + 'schema' => ['title' => 'Schema of Response', 'description' => 'Logstore结构体。', 'example' => 'ali-test-logstore', '$ref' => '#/components/schemas/logstore'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查看Logstore信息', + 'summary' => '查看Logstore的详细信息。', 'description' => '### 接口说明'."\n" .'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', 'extraInfo' => '### 错误码'."\n" @@ -20948,44 +11870,117 @@ 'action' => 'log:GetLogStore', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}', + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","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\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'GetLogStoreConfig' => [ + 'summary' => '获取日志库配置', + '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' => ['title' => 'Project 名称。', 'description' => 'Project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['title' => 'LogStore 名称。', 'description' => 'LogStore 名称。', 'type' => 'string', 'required' => true, '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' => [ + 'title' => '配置 logstore 写入时提取 IP 地址的来源 header keys。顺序敏感，大小写不敏感。配置后需要打开 logstore 的 appendMeta 记录外网 Ip 来源功能才会生效，将从请求的 Header 中按照配置的 keys 提取 IP，添加到日志 Tag 中。', + 'description' => '配置 logstore 写入时提取 IP 地址的来源 header keys。顺序敏感，大小写不敏感。配置后需要打开 logstore 的 appendMeta 记录外网 Ip 来源功能才会生效，将从请求的 Header 中按照配置的 keys 提取 IP，添加到日志 Tag 中。', + 'type' => 'array', + 'items' => ['description' => '配置 logstore 写入时提取 IP 地址的来源 header key。大小写不敏感，例如 X-Forwarded-For。', 'type' => 'string', 'example' => 'X-Forwarded-For'], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取日志库配置', + 'description' => '### 接口说明'."\n" + ."\n" + .'- 请求语法中的Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等信息。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\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' => '获取Logstore计量模式。', 'path' => '/logstores/{logstore}/meteringmode', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -20993,78 +11988,40 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '195981', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project名称', - 'description' => 'project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'projectName', - ], + 'schema' => ['title' => 'project名称', 'description' => 'project名称', 'type' => 'string', 'required' => true, 'example' => 'projectName'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore名称', - 'description' => 'logstore名称', - 'type' => 'string', - 'required' => true, - 'example' => 'logstoreName', - ], + 'schema' => ['title' => 'logstore名称', 'description' => 'logstore名称', 'type' => 'string', 'required' => true, 'example' => 'logstoreName'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ @@ -21075,18 +12032,13 @@ 'description' => '计量模式。ChargeByFunction 默认计量模式，ChargeByDataIngest 流量模式。', 'type' => 'string', 'example' => 'ChargeByFunction', - 'enum' => [ - 'ChargeByFunction', - 'ChargeByDataIngest', - ], + 'enum' => ['ChargeByFunction', 'ChargeByDataIngest'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meteringMode\\": \\"ChargeByFunction\\"\\n}","type":"json"}]', 'title' => '查询LogStore计量模式', 'changeSet' => [], @@ -21101,12 +12053,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -21115,92 +12062,48 @@ 'GetLogging' => [ 'summary' => '查询目标Project的服务日志配置。', 'path' => '/logging', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'description' => '服务日志信息。', - '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", - '$ref' => '#/components/schemas/logging', - ], + 'schema' => ['description' => '服务日志信息。', '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", '$ref' => '#/components/schemas/logging'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"loggingProject\\": \\"my-project\\",\\n \\"loggingDetails\\": [\\n {\\n \\"type\\": \\"consumergroup_log\\",\\n \\"logstore\\": \\"my-logstore\\"\\n }\\n ]\\n}","type":"json"}]', @@ -21217,318 +12120,182 @@ 'action' => 'log:GetLogging', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], ], ], ], ], ], 'GetLogs' => [ - 'summary' => '查询指定Project下某个Logstore中的日志数据。', + 'summary' => '查询指定Project下某个Logstore中的日志数据。已废弃，请使用 GetLogsV2 接口替代。', 'path' => '/logstores/{logstore}?type=log', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '8954', - 'abilityTreeNodes' => [ - 'FEATUREslsCAO32E', - ], + 'abilityTreeNodes' => ['FEATUREslsCAO32E'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => '查询Logstore中的数据。', - 'type' => 'string', - 'required' => true, - 'example' => 'example-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => '查询Logstore中的数据。', 'type' => 'string', 'required' => true, 'example' => 'example-logstore'], ], [ 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'title' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" - ."\n" - .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" - ."\n" - .'- 请求参数**from**和**to**定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果**from**和**to**的值相同，则为无效区间，函数直接返回错误。'."\n" - .'- Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" - ."\n" - .'> 如果您要确保不漏查数据，请将查询时间对齐到分钟级别。如果您在分析语句中设置了时间范围，则查询分析时以该时间范围为准。'."\n" - ."\n" - .'如果您需要精确到秒，需要在分析语句中指定时间时，使用[from_unixtime函数](~~63451~~)或[to_unixtime函数](~~63451~~)转换下时间格式。例如：'."\n" - .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\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', - ], + 'schema' => ['title' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'- 请求参数**from**和**to**定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果**from**和**to**的值相同，则为无效区间，函数直接返回错误。'."\n" + .'- Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" + ."\n" + .'> 如果您要确保不漏查数据，请将查询时间对齐到分钟级别。如果您在分析语句中设置了时间范围，则查询分析时以该时间范围为准。'."\n" + ."\n" + .'如果您需要精确到秒，需要在分析语句中指定时间时，使用[from_unixtime函数](~~63451~~)或[to_unixtime函数](~~63451~~)转换下时间格式。例如：'."\n" + .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\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'], ], [ 'name' => 'to', 'in' => 'query', - 'schema' => [ - 'title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" - ."\n" - .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" - ."\n" - .'- 请求参数**from**和**to**定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果**from**和**to**的值相同，则为无效区间，函数直接返回错误。'."\n" - .'- Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" - ."\n" - .'> 如果您要确保不漏查数据，请将查询时间对齐到分钟级别。如果您在分析语句中设置了时间范围，则查询分析时以该时间范围为准。'."\n" - ."\n" - .'如果您需要精确到秒，需要在分析语句中指定时间时，使用[from_unixtime函数](~~63451~~)或[to_unixtime函数](~~63451~~)转换下时间格式。例如：'."\n" - .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\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', - ], + 'schema' => ['title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'- 请求参数**from**和**to**定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果**from**和**to**的值相同，则为无效区间，函数直接返回错误。'."\n" + .'- Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。'."\n" + ."\n" + .'> 如果您要确保不漏查数据，请将查询时间对齐到分钟级别。如果您在分析语句中设置了时间范围，则查询分析时以该时间范围为准。'."\n" + ."\n" + .'如果您需要精确到秒，需要在分析语句中指定时间时，使用[from_unixtime函数](~~63451~~)或[to_unixtime函数](~~63451~~)转换下时间格式。例如：'."\n" + .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\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'], ], [ 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'title' => '查询语句或者分析语句。更多信息，请参见查询概述和分析概述。'."\n" - ."\n" - .'在query参数的分析语句中加上set session parallel_sql=true;，表示使用SQL独享版。例如* | set session parallel_sql=true; select count(*) as pv 。'."\n" - ."\n" - .'说明 当query参数中有分析语句（SQL语句）时，该接口的line参数和offset参数无效，建议设置为0，需通过SQL语句的LIMIT语法实现翻页。更多信息，请参见分页显示查询分析结果。', - 'description' => '查询语句或者分析语句。更多信息，请参见[查询概述](~~43772~~)和[分析概述](~~53608~~)。'."\n" - .'在query参数的分析语句中加上`set session parallel_sql=true;`，表示使用SQL独享版。例如`* | set session parallel_sql=true; select count(*) as pv` 。常见查询与分析问题，请参见[查询与分析日志的常见报错](~~61628~~)。'."\n" - ."\n" - .'> 当query参数中有分析语句（SQL语句）时，该接口的line参数和offset参数无效，建议设置该接口的参数为0，需通过SQL语句的LIMIT语法实现翻页。更多信息，请参见[分页显示查询分析结果](~~89994~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', - ], + 'schema' => ['title' => '查询语句或者分析语句。更多信息，请参见查询概述和分析概述。'."\n" + ."\n" + .'在query参数的分析语句中加上set session parallel_sql=true;，表示使用SQL独享版。例如* | set session parallel_sql=true; select count(*) as pv 。'."\n" + ."\n" + .'说明 当query参数中有分析语句（SQL语句）时，该接口的line参数和offset参数无效，建议设置为0，需通过SQL语句的LIMIT语法实现翻页。更多信息，请参见分页显示查询分析结果。', 'description' => '查询语句或者分析语句。更多信息，请参见[查询概述](~~43772~~)和[分析概述](~~53608~~)。'."\n" + .'在query参数的分析语句中加上`set session parallel_sql=true;`，表示使用SQL独享版。例如`* | set session parallel_sql=true; select count(*) as pv` 。常见查询与分析问题，请参见[查询与分析日志的常见报错](~~61628~~)。'."\n" + ."\n" + .'> 当query参数中有分析语句（SQL语句）时，该接口的line参数和offset参数无效，建议设置该接口的参数为0，需通过SQL语句的LIMIT语法实现翻页。更多信息，请参见[分页显示查询分析结果](~~89994~~)。', 'type' => 'string', 'required' => false, 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5'], ], [ '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' => '日志主题。默认值为空字符串。更多信息，请参见[日志主题（Topic）](~~48881~~)。', - 'type' => 'string', - 'required' => false, - 'example' => 'topic', - ], + 'schema' => ['title' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', 'description' => '日志主题。默认值为空字符串。更多信息，请参见[日志主题（Topic）](~~48881~~)。', 'type' => 'string', 'required' => false, 'example' => 'topic'], ], [ 'name' => 'line', 'in' => 'query', - 'schema' => [ - 'title' => '仅当query参数为查询语句时，该参数有效，表示请求返回的最大日志条数。最小值为0，最大值为100，默认值为100。', - 'description' => '仅当query参数为查询语句时，该参数有效，表示请求返回的最大日志条数。最小值为0，最大值为100，默认值为100。分页查询请参见[分页显示查询分析结果](~~89994~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '100', - 'default' => '100', - ], + 'schema' => ['title' => '仅当query参数为查询语句时，该参数有效，表示请求返回的最大日志条数。最小值为0，最大值为100，默认值为100。', 'description' => '仅当query参数为查询语句时，该参数有效，表示请求返回的最大日志条数。最小值为0，最大值为100，默认值为100。分页查询请参见[分页显示查询分析结果](~~89994~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '100', 'default' => '100'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '仅当query参数为查询语句时，该参数有效，表示查询开始行。默认值为0。', - 'description' => '仅当query参数为查询语句时，该参数有效，表示查询开始行。默认值为0。分页查询请参见[分页显示查询分析结果](~~89994~~)。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['title' => '仅当query参数为查询语句时，该参数有效，表示查询开始行。默认值为0。', 'description' => '仅当query参数为查询语句时，该参数有效，表示查询开始行。默认值为0。分页查询请参见[分页显示查询分析结果](~~89994~~)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => '0'], ], [ 'name' => 'reverse', 'in' => 'query', - 'schema' => [ - 'title' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" - ."\n" - .'true：按照日志时间戳降序返回日志。'."\n" - .'false（默认值）：按照日志时间戳升序返回日志。'."\n" - .'注意'."\n" - .'当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" - .'当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。', - 'description' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" - ."\n" - .'- true：按照日志时间戳降序返回日志。'."\n" - .'- false（默认值）：按照日志时间戳升序返回日志。'."\n" - ."\n" - .'>'."\n" - ."\n" - .'- 当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" - .'- 当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。'."\n" - ."\n" - .'>', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['title' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" + ."\n" + .'true：按照日志时间戳降序返回日志。'."\n" + .'false（默认值）：按照日志时间戳升序返回日志。'."\n" + .'注意'."\n" + .'当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" + .'当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。', 'description' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" + ."\n" + .'- true：按照日志时间戳降序返回日志。'."\n" + .'- false（默认值）：按照日志时间戳升序返回日志。'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- 当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" + .'- 当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。'."\n" + ."\n" + .'>', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ 'name' => 'powerSql', 'in' => 'query', - 'schema' => [ - 'title' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" - ."\n" - .'true：按照日志时间戳降序返回日志。'."\n" - .'false（默认值）：按照日志时间戳升序返回日志。'."\n" - .'注意'."\n" - .'当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" - .'当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。', - 'description' => '是否使用SQL独享版。更多信息，请参见[开启SQL独享版](~~223777~~)。'."\n" - ."\n" - .'- true：使用SQL独享版。'."\n" - .'- false（默认值）：使用SQL普通版。'."\n" - ."\n" - .'除通过powerSql参数配置SQL独享版外，您还可以使用**query**参数。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['title' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" + ."\n" + .'true：按照日志时间戳降序返回日志。'."\n" + .'false（默认值）：按照日志时间戳升序返回日志。'."\n" + .'注意'."\n" + .'当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" + .'当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。', 'description' => '是否使用SQL独享版。更多信息，请参见[开启SQL独享版](~~223777~~)。'."\n" + ."\n" + .'- true：使用SQL独享版。'."\n" + .'- false（默认值）：使用SQL普通版。'."\n" + ."\n" + .'除通过powerSql参数配置SQL独享版外，您还可以使用**query**参数。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-progress' => [ - 'schema' => [ - 'title' => '查询结果的状态，包括： Complete：查询已经完成，返回结果为完整结果。 Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'type' => 'string', - 'example' => 'Complete', - ], + 'schema' => ['title' => '查询结果的状态，包括： Complete：查询已经完成，返回结果为完整结果。 Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'type' => 'string', 'example' => 'Complete'], ], 'x-log-count' => [ - 'schema' => [ - 'title' => '当前查询结果的日志总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], + 'schema' => ['title' => '当前查询结果的日志总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], ], 'x-log-processed-rows' => [ - 'schema' => [ - 'title' => '本次查询处理的行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], + 'schema' => ['title' => '本次查询处理的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], ], 'x-log-elapsed-millisecond' => [ - 'schema' => [ - 'title' => '本次查询消耗的毫秒时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'schema' => ['title' => '本次查询消耗的毫秒时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ 'description' => '日志数组Logs。其每个元素就是一条Log。', 'type' => 'array', - 'items' => [ - 'description' => '日志数组Logs，其每个元素就是一条Log。', - '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\'}]', - ], + 'items' => ['description' => '日志数组Logs，其每个元素就是一条Log。', '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\'}]'], ], ], ], @@ -21583,23 +12350,15 @@ 'GetLogsV2' => [ 'summary' => '查询指定Project下某个Logstore中的原始日志数据，返回结果显示某时间区间中的原始日志（返回结果压缩后传输）。', 'path' => '/logstores/{logstore}/logs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -21607,49 +12366,32 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179698', - 'abilityTreeNodes' => [ - 'FEATUREslsCAO32E', - ], + 'abilityTreeNodes' => ['FEATUREslsCAO32E'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'logstore 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => 'logstore 名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'Accept-Encoding', 'in' => 'header', 'schema' => [ 'title' => '压缩方式', - 'description' => '压缩方式'."\n" + 'description' => '返回内容的压缩方式。sdk 用户无需指定，由 sdk 自动处理压缩与解压。'."\n" ."\n" .'- Java、Python、Go目前支持lz4 、gzip 解压缩'."\n" ."\n" .'- php、Js、C#目前仅支持gzip解压缩', 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'lz4' => 'lz4', - 'gzip' => 'gzip', - ], + 'required' => false, + 'enumValueTitles' => ['lz4' => 'lz4', 'gzip' => 'gzip'], 'example' => 'lz4', 'default' => 'lz4', ], @@ -21662,129 +12404,49 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'from' => [ - 'title' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" - ."\n" - .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" - ."\n" - .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268185', - ], - 'to' => [ - 'title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" - ."\n" - .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" - ."\n" - .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" - .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268185', - ], - 'line' => [ - 'title' => '仅当query参数为查询语句时，该参数有效，表示请求返回的最大日志条数。最小值为0，最大值为100，默认值为100。', - 'description' => '仅当query参数为查询语句时，该参数有效，表示请求返回的最大日志条数。最小值为0，最大值为100，默认值为100。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '100', - 'default' => '100', - ], - 'offset' => [ - 'title' => '仅当query参数为查询语句时，该参数有效，表示查询开始行。默认值为0。', - 'description' => '仅当query参数为查询语句时，该参数有效，表示查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], - 'reverse' => [ - 'title' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" - ."\n" - .'true：按照日志时间戳降序返回日志。'."\n" - .'false（默认值）：按照日志时间戳升序返回日志。'."\n" - .'注意'."\n" - .'当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" - .'当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。', - 'description' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" - ."\n" - .'true：按照日志时间戳降序返回日志。'."\n" - .'false（默认值）：按照日志时间戳升序返回日志。'."\n" - .'注意'."\n" - .'当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" - .'当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'powerSql' => [ - 'title' => '是否开启增强sql，默认关闭。', - 'description' => '是否开启增强sql，默认关闭。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'session' => [ - 'description' => '查询参数', - 'type' => 'string', - 'required' => false, - 'example' => 'mode=scan', - ], - 'topic' => [ - 'description' => '日志主题。默认值为双引号（""）。', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'query' => [ - 'title' => '查询语句或者分析语句。更多信息，请参见查询概述和分析概述。'."\n" - ."\n" - .'在query参数的分析语句中加上set session parallel_sql=true;，表示使用SQL独享版。例如* | set session parallel_sql=true; select count(*) as pv 。'."\n" - ."\n" - .'说明 当query参数中有分析语句（SQL语句）时，该接口的line参数和offset参数无效，建议设置为0，需通过SQL语句的LIMIT语法实现翻页。更多信息，请参见分页显示查询分析结果。', - 'description' => '查询语句或者分析语句。更多信息，请参见[查询概述](~~43772~~)和[分析概述](~~53608~~)。'."\n" - ."\n" - .'在query参数的分析语句中加上set session parallel_sql=true;，表示使用SQL独享版。例如* | set session parallel_sql=true; select count(*) as pv 。'."\n" - ."\n" - .'说明当query参数中有分析语句（SQL语句）时，该接口的line参数和offset参数无效，建议设置为0，需通过SQL语句的LIMIT语法实现翻页。更多信息，请参见分页显示查询分析结果。', - 'type' => 'string', - 'required' => false, - 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', - ], - 'forward' => [ - 'description' => 'scan或短语查询表示是否向前或向后翻页', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'highlight' => [ - 'description' => '是否高亮', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - 'isAccurate' => [ - 'description' => '是否开启纳秒级有序', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'from' => ['title' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185'], + 'to' => ['title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185'], + 'line' => ['title' => '仅当query参数为查询语句时，该参数有效，表示请求返回的最大日志条数。最小值为0，最大值为100，默认值为100。', 'description' => '请求返回的最大日志条数。仅当query参数为查询语句（非 SQL 分析语句）时，该参数有效。最小值为0，最大值为100，默认值为100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '100', 'default' => '100'], + 'offset' => ['title' => '仅当query参数为查询语句时，该参数有效，表示查询开始行。默认值为0。', 'description' => '查询开始行。仅当query参数为查询语句（非 SQL 分析语句）时，该参数有效。值从 0 开始，默认值为 0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => '0'], + 'reverse' => ['title' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。'."\n" + ."\n" + .'true：按照日志时间戳降序返回日志。'."\n" + .'false（默认值）：按照日志时间戳升序返回日志。'."\n" + .'注意'."\n" + .'当query参数为查询语句时，参数reverse有效，用于指定返回日志排序方式。'."\n" + .'当query参数为查询和分析语句时，参数reverse无效，由SQL分析语句中order by语法指定排序方式。如果order by为asc（默认），则为升序；如果order by为desc，则为降序。', 'description' => '用于指定返回结果是否按日志时间戳降序返回日志，精确到分钟级别。仅当 query 为查询语句（非 SQL 分析语句）时有效。'."\n" + ."\n" + .'- true：按照日志时间戳降序返回日志。'."\n" + .'- false（默认值）：按照日志时间戳升序返回日志。'."\n" + ."\n" + .'如需在SQL分析语句中排序，请使用 order by 语法指定排序方式。如果 order by为asc（默认），则为升序；如果order by为desc，则为降序。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + 'powerSql' => ['title' => '是否开启增强sql，默认关闭。', 'description' => '是否开启独享版 SQL，默认关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + 'session' => ['description' => '查询参数', 'type' => 'string', 'required' => false, 'example' => 'mode=scan'], + 'topic' => ['description' => '日志主题。默认值为空。', 'type' => 'string', 'required' => false, 'example' => '""'], + 'query' => ['title' => '查询语句或者分析语句。更多信息，请参见查询概述和分析概述。'."\n" + ."\n" + .'在query参数的分析语句中加上set session parallel_sql=true;，表示使用SQL独享版。例如* | set session parallel_sql=true; select count(*) as pv 。'."\n" + ."\n" + .'说明 当query参数中有分析语句（SQL语句）时，该接口的line参数和offset参数无效，建议设置为0，需通过SQL语句的LIMIT语法实现翻页。更多信息，请参见分页显示查询分析结果。', 'description' => '查询语句或者分析语句。更多信息，请参见[查询概述](~~43772~~)和[分析概述](~~53608~~)。'."\n" + ."\n" + .'在query参数的分析语句中加上set session parallel_sql=true;，表示使用SQL独享版。例如* | set session parallel_sql=true; select count(*) as pv 。'."\n" + ."\n" + .'说明当query参数中有分析语句（SQL语句）时，该接口的line参数和offset参数无效，建议设置为0，需通过SQL语句的LIMIT语法实现翻页。更多信息，请参见分页显示查询分析结果。', 'type' => 'string', 'required' => false, 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5'], + 'forward' => ['description' => 'scan或短语查询表示是否向前或向后翻页', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + 'highlight' => ['description' => '是否高亮', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + 'isAccurate' => ['description' => '是否开启纳秒级有序', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, ], @@ -21794,52 +12456,28 @@ 200 => [ 'headers' => [ 'date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'content-length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'x-log-bodyrawsize' => [ - 'schema' => [ - 'title' => '返回响应内容的大小。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应内容的大小。', 'type' => 'string'], ], 'connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'content-type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'x-log-compresstype' => [ - 'schema' => [ - 'title' => '返回响应内容的压缩格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应内容的压缩格式。', 'type' => 'string'], ], ], 'schema' => [ @@ -21850,165 +12488,62 @@ 'description' => '返回数据meta信息', 'type' => 'object', 'properties' => [ - 'progress' => [ - 'description' => '查询的结果是否完整。'."\n" - ."\n" - .'- Complete：查询已经完成，返回结果为完整结果。'."\n" - .'- Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'type' => 'string', - 'example' => 'Complete', - ], - 'aggQuery' => [ - 'description' => '查询语句中 | 之后的SQL部分', - 'type' => 'string', - 'example' => 'select *', - ], - 'whereQuery' => [ - 'description' => '查询语句中 | 之前的部分', - 'type' => 'string', - 'example' => '*', - ], - 'hasSQL' => [ - 'description' => '是否sql查询', - 'type' => 'boolean', - 'example' => 'false', - ], - 'processedRows' => [ - 'description' => '本次查询处理的行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'elapsedMillisecond' => [ - 'description' => '本次查询消耗的毫秒时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'cpuSec' => [ - 'description' => '独享SQL的核时', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.002', - ], - 'cpuCores' => [ - 'description' => '使用cpu核数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], + 'progress' => ['description' => '查询的结果是否完整。'."\n" + ."\n" + .'- Complete：查询已经完成，返回结果为完整结果。'."\n" + .'- Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'type' => 'string', 'example' => 'Complete'], + 'aggQuery' => ['description' => '查询语句中 | 之后的SQL部分', 'type' => 'string', 'example' => 'select *'], + 'whereQuery' => ['description' => '查询语句中 | 之前的部分', 'type' => 'string', 'example' => '*'], + 'hasSQL' => ['description' => '是否sql查询', 'type' => 'boolean', 'example' => 'false'], + 'processedRows' => ['description' => '本次查询处理的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'elapsedMillisecond' => ['description' => '本次查询消耗的毫秒时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'cpuSec' => ['description' => '独享SQL的核时', 'type' => 'number', 'format' => 'double', 'example' => '0.002'], + 'cpuCores' => ['description' => '使用cpu核数', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'keys' => [ 'description' => '查询结果中所有的key', 'type' => 'array', - 'items' => [ - 'description' => 'key', - 'type' => 'string', - 'example' => 'key', - ], + 'items' => ['description' => 'key', 'type' => 'string', 'example' => 'key'], ], 'terms' => [ 'description' => '查询语句中所有的词', 'type' => 'array', - 'items' => [ - 'description' => '词', - 'type' => 'object', - 'example' => '{term=*, key=}', - ], - ], - 'limited' => [ - 'description' => '限制条数，sql不带limit会返回', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'mode' => [ - 'description' => '查询模式枚举'."\n" - .'0: 普通查询（包括sql）'."\n" - .'1: 短语查询'."\n" - .'2: SCAN扫描'."\n" - .'3: SCAN SQL', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'items' => ['description' => '词', 'type' => 'object', 'example' => '{term=*, key=}'], ], + 'limited' => ['description' => '限制条数，sql不带limit会返回', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'mode' => ['description' => '查询模式枚举'."\n" + .'0: 普通查询（包括sql）'."\n" + .'1: 短语查询'."\n" + .'2: SCAN扫描'."\n" + .'3: SCAN SQL', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'phraseQueryInfo' => [ 'description' => '短语查询', 'type' => 'object', 'properties' => [ - 'scanAll' => [ - 'description' => '是否已经扫描了全部日志', - 'type' => 'boolean', - 'example' => 'true', - ], - 'beginOffset' => [ - 'description' => '本次扫描结果对应的索引过滤后的起始offset', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'endOffset' => [ - 'description' => '本次扫描结果对应的索引过滤后的结束offset', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'endTime' => [ - 'description' => '本次扫描结果对应的索引过滤后的最后时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'scanAll' => ['description' => '是否已经扫描了全部日志', 'type' => 'boolean', 'example' => 'true'], + 'beginOffset' => ['description' => '本次扫描结果对应的索引过滤后的起始offset', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'endOffset' => ['description' => '本次扫描结果对应的索引过滤后的结束offset', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'endTime' => ['description' => '本次扫描结果对应的索引过滤后的最后时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], ], - 'scanBytes' => [ - 'description' => 'scan时返回扫描的数据量（字节）。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], + 'scanBytes' => ['description' => 'scan时返回扫描的数据量（字节）。', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], 'highlights' => [ 'description' => '高亮内容', 'type' => 'array', 'items' => [ 'description' => '高亮内容', - 'type' => 'array', - 'items' => [ - 'description' => '高亮日志内容', - '$ref' => '#/components/schemas/LogContent', - ], + 'type' => 'object', + 'items' => ['description' => '高亮日志内容', 'extendType' => 'true', '$ref' => '#/components/schemas/LogContent'], ], ], - 'count' => [ - 'description' => '本次查询请求返回的日志行数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'processedBytes' => [ - 'description' => '查询处理日志量', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'isAccurate' => [ - 'description' => '是否开启纳秒级有序', - 'type' => 'boolean', - 'example' => 'true', - ], + 'count' => ['description' => '本次查询请求返回的日志行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'processedBytes' => ['description' => '查询处理日志量', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + 'isAccurate' => ['description' => '是否开启纳秒级有序', 'type' => 'boolean', 'example' => 'true'], 'columnTypes' => [ 'description' => '列类型', 'type' => 'array', - 'items' => [ - 'description' => '类型', - 'type' => 'string', - 'example' => 'long', - ], - ], - 'telementryType' => [ - 'description' => '可观测数据类型', - 'type' => 'string', - 'example' => 'None', + 'items' => ['description' => '类型', 'type' => 'string', 'example' => 'long'], ], + 'telementryType' => ['description' => '可观测数据类型', 'type' => 'string', 'example' => 'None'], ], ], 'data' => [ @@ -22017,145 +12552,83 @@ 'items' => [ 'description' => '返回的数据。', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}', - 'description' => '返回数据。', - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}', 'description' => '返回数据。'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","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 {\\n \\"Key\\": \\"key-test\\",\\n \\"Value\\": \\"value-test\\"\\n }\\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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '查询Logstore中的日志数据', - 'description' => '- 日志服务SDK目前仅支持Go、Java、Python三种语言，OpenAPI全部已支持。'."\n" - ."\n" - .'- 使用过程中注意指定压缩方法，不同语言实现的压缩算法不同，详情参考入参Accept-Encoding。'."\n" + 'description' => '- 使用过程中注意指定压缩方法，不同语言实现的压缩算法不同，详情参考入参Accept-Encoding。'."\n" ."\n" .'- 更多相关说明请参见[GetLogs](~~2771313~~)。'."\n" .'### 鉴权资源'."\n" .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" .'| :------------ | :------------ |'."\n" - .'| `log:GetLogStoreLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', + .'| `log:GetLogStoreLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', ], 'GetLogtailPipelineConfig' => [ 'summary' => '获取Logtail流水线配置。', 'path' => '/pipelineconfigs/{configName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => 'Project名称', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'title' => 'Logtail流水线配置名称', - 'description' => 'Logtail流水线配置名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', - ], + 'schema' => ['title' => 'Logtail流水线配置名称', 'description' => 'Logtail流水线配置名称', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'description' => 'Logtail流水线配置', - '$ref' => '#/components/schemas/LogtailPipelineConfig', - ], + 'schema' => ['description' => 'Logtail流水线配置', '$ref' => '#/components/schemas/LogtailPipelineConfig'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + '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 \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"inputs\\": [\\n {\\n \\"Type\\": \\"input_file\\",\\n \\"FilePaths\\": [\\n \\"/var/log/*.log\\"\\n ]\\n }\\n ],\\n \\"processors\\": [\\n {\\n \\"Type\\": \\"processor_parse_json_native\\",\\n \\"SourceKey\\": \\"content\\"\\n }\\n ],\\n \\"aggregators\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"flushers\\": [\\n {\\n \\"Type\\": \\"flusher_sls\\",\\n \\"Project\\": \\"test_project\\",\\n \\"Logstore\\": \\"test\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Endpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"TelemetryType\\": \\"log\\"\\n }\\n ],\\n \\"createTime\\": 1655176807,\\n \\"lastModifyTime\\": 1655176807,\\n \\"task\\": {\\n \\"Type\\": \\"task_example\\"\\n }\\n}","type":"json"}]', 'title' => '获取Logtail流水线配置', 'changeSet' => [], @@ -22169,17 +12642,10 @@ 'action' => 'log:GetLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], + ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -22188,30 +12654,20 @@ 'GetMLServiceResults' => [ 'summary' => '在阿里云日志服务平台上，提供了基础数据（Log、Metric、Trace）的智能分析能力。用户调用相关模型，可以直接得到模型的分析结果。目前主要涉及：日志数据的NER任务、时间序列数据的异常检测、高延时链路数据的Span根因定位。', 'path' => '/ml/service/{serviceName}/analysis', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '200786', - 'abilityTreeNodes' => [ - 'FEATUREsls4A0DBM', - ], + 'abilityTreeNodes' => ['FEATUREsls4A0DBM'], ], 'parameters' => [ [ @@ -22221,11 +12677,7 @@ 'description' => '服务名。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'sls_builtin_service_trace_rca' => '高延时trace请求链路分析的服务名', - 'sls_builtin_service_log_struct' => 'LogNER的服务名', - 'sls_builtin_service_metric_anomaly' => '单维度时间序列异常检测的服务名', - ], + 'enumValueTitles' => ['sls_builtin_service_trace_rca' => '高延时trace请求链路分析的服务名', 'sls_builtin_service_log_struct' => 'LogNER的服务名', 'sls_builtin_service_metric_anomaly' => '单维度时间序列异常检测的服务名'], 'example' => 'sls_builtin_service_log_struct', ], ], @@ -22237,10 +12689,7 @@ .'+ false 表示请求不允许使用系统内置的服务', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '允许使用系统内置的服务', - 'false' => '不允许使用系统内置的服务名', - ], + 'enumValueTitles' => ['true' => '允许使用系统内置的服务', 'false' => '不允许使用系统内置的服务名'], 'example' => 'true', ], ], @@ -22248,12 +12697,7 @@ 'name' => 'version', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '设置算法的版本号，不同的版本对应不同算法', - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - ], + 'schema' => ['description' => '设置算法的版本号，不同的版本对应不同算法', 'type' => 'string', 'required' => false, 'example' => 'v1'], ], [ 'name' => 'body', @@ -22261,9 +12705,7 @@ 'schema' => [ 'description' => '请求结构体。', 'required' => false, - 'enumValueTitles' => [ - 'others' => '根据不同的serviceName有不一样的说明', - ], + 'enumValueTitles' => ['others' => '根据不同的serviceName有不一样的说明'], '$ref' => '#/components/schemas/MLServiceAnalysisParam', ], ], @@ -22272,46 +12714,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ @@ -22325,13 +12743,9 @@ 'type' => 'string', 'example' => '200', 'description' => '默认为空，表示返回所有状态的任务，支持success、fail和running状态。', - 'enumValueTitles' => [ - '无' => '无', - ], - ], - 'enumValueTitles' => [ - '无' => '无', + 'enumValueTitles' => ['无' => '无'], ], + 'enumValueTitles' => ['无' => '无'], ], 'data' => [ 'description' => '返回的数据。', @@ -22339,23 +12753,15 @@ 'items' => [ 'description' => '数据集结构体', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{\'marker\': \'\'}', - 'description' => '返回结果。', - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{\'marker\': \'\'}', 'description' => '返回结果。'], ], ], ], - 'enumValueTitles' => [ - '无' => '无', - ], + 'enumValueTitles' => ['无' => '无'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": {\\n \\"key\\": \\"200\\"\\n },\\n \\"data\\": [\\n {\\n \\"key\\": \\"{\'marker\': \'\'}\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取指定场景任务的算法分析结果', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。'."\n" @@ -22539,104 +12945,53 @@ 'GetMachineGroup' => [ 'summary' => '查看目标机器组的具体信息。', 'path' => '/machinegroups/{machineGroup}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group', - ], + 'schema' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'title' => '请求返回体。', - 'description' => '机器组数据结构。', - '$ref' => '#/components/schemas/machineGroup', - ], + 'schema' => ['title' => '请求返回体。', 'description' => '机器组数据结构。', '$ref' => '#/components/schemas/machineGroup'], ], ], 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', @@ -22671,81 +13026,148 @@ 'action' => 'log:GetMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['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}/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' => ''], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => ''], + ], + [ + 'name' => 'Content-Type', + 'in' => 'header', + 'schema' => ['type' => 'string', 'default' => 'application/json', 'description' => ''], + ], + [ + 'name' => 'returnStatus', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => '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', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => 'Id of the request', 'type' => 'string', 'description' => ''], + 'logstore' => ['type' => 'string', 'description' => ''], + 'originalSql' => ['type' => 'string', 'description' => ''], + 'aggIntervalMins' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'startTime' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'ttl' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'enabled' => ['type' => 'boolean', 'description' => ''], + 'status' => [ + 'type' => 'object', + 'properties' => [ + 'lastRunTime' => ['type' => 'integer', 'format' => 'int64'], + 'maxCursorTime' => ['type' => 'integer', 'format' => 'int64'], + 'lastRunError' => ['type' => 'string'], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '获取物化视图 ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"\\",\\n \\"logstore\\": \\"\\",\\n \\"originalSql\\": \\"\\",\\n \\"aggIntervalMins\\": 0,\\n \\"startTime\\": 0,\\n \\"ttl\\": 0,\\n \\"enabled\\": true,\\n \\"status\\": {\\n \\"lastRunTime\\": 0,\\n \\"maxCursorTime\\": 0,\\n \\"lastRunError\\": \\"\\"\\n }\\n}","type":"json"}]', + ], 'GetMaxComputeExport' => [ 'summary' => '获取MaxCompute投递任务信息。', 'path' => '/maxcomputeexports/{mcExportName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '203462', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'mcExportName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-123456789-123456', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-mc-123456789-123456'], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => '任务配置详细', - '$ref' => '#/components/schemas/MaxComputeExport', - ], + 'schema' => ['description' => '任务配置详细', '$ref' => '#/components/schemas/MaxComputeExport'], ], ], '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"}]', @@ -22761,1321 +13183,757 @@ ], 'ramActions' => [], ], - 'GetMemories' => [ - 'path' => '/memorystores/{memoryStore}/all-memories', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetMetricStore' => [ + 'summary' => '查询时序库。', + 'path' => '/metricstores/{name}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '225685', + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'limit' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'user_id' => [ - 'type' => 'string', - 'description' => '', - ], - 'agent_id' => [ - 'type' => 'string', - ], - 'app_id' => [ - 'type' => 'string', - ], - 'run_id' => [ - 'type' => 'string', - ], - 'page' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'page_size' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'metadata' => [ - 'type' => 'object', - ], - ], - 'description' => '', - ], - ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['title' => '日志项目名称', 'description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'memoryStore', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['title' => '时序库名称', 'description' => '时序库名称', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store'], ], ], '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' => '返回结构体', 'type' => 'object', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'type' => 'string', - 'backendName' => 'id', - ], - 'memory' => [ - 'type' => 'string', - 'backendName' => 'memory', - ], - 'created_at' => [ - 'type' => 'string', - 'backendName' => 'createdAt', - ], - 'updated_at' => [ - 'type' => 'string', - 'backendName' => 'updatedAt', - ], - 'owner' => [ - 'type' => 'string', - 'backendName' => 'owner', - ], - 'organization' => [ - 'type' => 'string', - 'backendName' => 'organization', - ], - 'immutable' => [ - 'type' => 'boolean', - 'backendName' => 'immutable', - ], - 'expiration_date' => [ - 'type' => 'string', - 'backendName' => 'expirationDate', - ], - 'metadata' => [ - 'type' => 'object', - 'properties' => [ - 'session_id' => [ - 'type' => 'string', - 'backendName' => 'sessionId', - ], - 'timestamp' => [ - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'timestamp', - ], - 'updated_by' => [ - 'type' => 'string', - 'backendName' => 'updatedBy', - ], - ], - 'backendName' => 'metadata', - ], - ], - ], 'properties' => [ - 'results' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'actorId' => [ - 'type' => 'string', - ], - 'agentId' => [ - 'type' => 'string', - ], - 'createdAt' => [ - 'type' => 'string', - ], - 'hash' => [ - 'type' => 'string', - ], - 'id' => [ - 'type' => 'string', - ], - 'memory' => [ - 'type' => 'string', - ], - 'metadata' => [ - 'type' => 'object', - ], - 'role' => [ - 'type' => 'string', - ], - 'runId' => [ - 'type' => 'string', - ], - 'score' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'updatedAt' => [ - 'type' => 'string', - ], - 'userId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'relations' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'destination' => [ - 'type' => 'string', - ], - 'relationship' => [ - 'type' => 'string', - ], - 'source' => [ - 'type' => 'string', - ], - ], - ], - ], + 'name' => ['title' => '时序库名称', 'description' => '时序库名称', 'type' => 'string', 'example' => 'my_metric_store'], + 'ttl' => ['title' => '保存时间，单位为天', 'description' => '保存时间，单位为天', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'shardCount' => ['title' => 'shard 分片数量', 'description' => 'shard 分片数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'autoSplit' => ['title' => '是否开启自动分裂', 'description' => '是否开启自动分裂', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'], + 'maxSplitShard' => ['title' => 'shard 最大自动分裂数量', 'description' => 'shard 最大自动分裂数量', 'type' => 'integer', 'format' => 'int32', 'example' => '64'], + 'mode' => ['title' => '时序库规格类型，例如 standard', 'description' => '时序库规格类型，例如 standard', 'type' => 'string', 'example' => 'standard'], + 'metricType' => ['title' => '时序库种类，例如 prometheus', 'description' => '时序库种类，例如 prometheus', 'type' => 'string', 'example' => 'prometheus'], + 'createTime' => ['title' => '创建时间，unix 时间戳', 'description' => '创建时间，unix 时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1698933894'], + 'lastModifyTime' => ['title' => '最后更新时间，unix 时间戳', 'description' => '最后更新时间，unix 时间戳', 'type' => 'integer', 'format' => 'int64', 'example' => '1712023974'], + 'hot_ttl' => ['title' => '数据在热存储层中的存储时间，单位为天。', 'description' => '数据在热存储层中的存储时间，单位为天。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'infrequentAccessTTL' => ['title' => '低频存储，单位为天。', 'description' => '低频存储，单位为天。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'appendMeta' => ['title' => '是否记录外网IP地址和日志接收时间', 'description' => '是否记录外网IP地址和日志接收时间', 'type' => 'boolean', 'example' => 'false', 'default' => 'false'], + 'shardingPolicy' => ['title' => '哈希写入配置', 'description' => '哈希写入配置', '$ref' => '#/components/schemas/ShardingPolicy'], + 'processorId' => ['title' => '时序库关联的写入处理器 id', 'description' => '时序库关联的写入处理器 id', 'type' => 'string'], ], - 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => '参数中所指定的时序库不存在'], + ], + ], + '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' => '查询时序库', + 'description' => '[时序库](~~171723~~)可用于存储[时序数据](~~174965~~)。'."\n" + .'此接口仅用于查询时序库的配置，若要查询时序库中的时序数据，可参见[查询与分析](~~174968~~)以及[GetLogsV2](~~2771318~~)。'."\n" + .'- 此接口需要指定一个已存在的时序库。'."\n" + .'- 请求语法中的Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等信息。如何查询，请参见[管理Project](~~48984~~)。'."\n" + ."\n" + .'- 一个Project中，最多创建 200 个 Logstore 或 MetricStore。'."\n" + .'- 当时序数据保存时间达到您所设置的数据保存时间后，数据将被删除。', + 'changeSet' => [ + ['createdAt' => '2025-12-03T01:37:06.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-12-02T11:55:01.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-11-24T09:35:51.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-28T13:00:54.000Z', 'description' => 'OpenAPI 下线'], ], - 'summary' => '获取全部记忆', - 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"results\\": [\\n {\\n \\"actorId\\": \\"\\",\\n \\"agentId\\": \\"\\",\\n \\"createdAt\\": \\"\\",\\n \\"hash\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"memory\\": \\"\\",\\n \\"metadata\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"role\\": \\"\\",\\n \\"runId\\": \\"\\",\\n \\"score\\": 0,\\n \\"updatedAt\\": \\"\\",\\n \\"userId\\": \\"\\"\\n }\\n ],\\n \\"relations\\": [\\n {\\n \\"destination\\": \\"\\",\\n \\"relationship\\": \\"\\",\\n \\"source\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetMemory' => [ - 'path' => '/memorystores/{memoryStore}/memories/{memoryId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetMetricStoreMeteringMode' => [ + 'summary' => '查询指定时序库的当前计费模式。', + 'path' => '/metricstores/{metricStore}/meteringmode', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '213243', + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['title' => '日志项目名称', 'description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'projectName'], ], [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - [ - 'name' => 'memoryId', + 'name' => 'metricStore', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['title' => 'metricStore', 'description' => '时序库名称', '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' => '请求返回的结构体', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'description' => '', - ], - 'immutable' => [ - 'type' => 'boolean', - 'description' => '', - ], - 'owner' => [ - 'type' => 'string', - 'description' => '', - ], - 'updatedAt' => [ - 'type' => 'string', - ], - 'organization' => [ - 'type' => 'string', - 'description' => '', - ], - 'memory' => [ - 'type' => 'string', - 'description' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'properties' => [ - 'session_id' => [ - 'type' => 'string', - ], - 'timestamp' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'updated_by' => [ - 'type' => 'string', - ], - ], - 'description' => '', - ], - 'id' => [ - 'type' => 'string', - 'description' => '', - ], - 'expirationDate' => [ - 'type' => 'string', - ], - 'createdAt' => [ + 'meteringMode' => [ + 'title' => '计量模式。ChargeByFunction 默认计量模式，ChargeByDataIngest 流量模式。', + 'description' => '当前时序库计费模式。ChargeByFunction 表示[按使用功能计费](~~48220~~) ，ChargeByDataIngest 表示 [按写入数据量计费](~~2365756~~)。', 'type' => 'string', + 'example' => 'ChargeByFunction', + 'enum' => ['ChargeByFunction', 'ChargeByDataIngest'], ], ], - 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meteringMode\\": \\"ChargeByFunction\\"\\n}","type":"json"}]', + 'title' => '查询时序库计费模式', + 'description' => '时序库支持两种计费模式，[按使用功能计费](~~48220~~) 与 [按写入数据量计费](~~2365756~~)。'."\n" + .'- 此接口需要指定一个已存在的时序库。'."\n" + .'- 请求语法中的Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等信息。如何查询，请参见[管理Project](~~48984~~)。'."\n" + ."\n" + .'- 一个Project中，最多创建 200 个 Logstore 或 MetricStore。'."\n" + .'- 当时序数据保存时间达到您所设置的数据保存时间后，数据将被删除。', + 'changeSet' => [ + ['createdAt' => '2024-09-19T09:31:34.000Z', 'description' => '响应参数发生变更'], ], - 'summary' => '获取记忆', - 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"immutable\\": true,\\n \\"owner\\": \\"\\",\\n \\"updatedAt\\": \\"\\",\\n \\"organization\\": \\"\\",\\n \\"memory\\": \\"\\",\\n \\"metadata\\": {\\n \\"session_id\\": \\"\\",\\n \\"timestamp\\": 0,\\n \\"updated_by\\": \\"\\"\\n },\\n \\"id\\": \\"\\",\\n \\"expirationDate\\": \\"\\",\\n \\"createdAt\\": \\"\\"\\n}","type":"json"}]', ], - 'GetMemoryHistory' => [ - 'path' => '/memorystores/{memoryStore}/memories/{memoryId}/history', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetOSSExport' => [ + 'path' => '/ossexports/{ossExportName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '203470', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'memoryId', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-oss-123456789-123456'."\n"], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'type' => 'string', - 'description' => '', - ], - 'memoryId' => [ - 'type' => 'string', - ], - 'input' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'role' => [ - 'type' => 'string', - 'description' => '', - ], - 'content' => [ - 'type' => 'string', - 'description' => '', - ], - ], - 'description' => '', - ], - 'description' => '', - ], - 'newMemory' => [ - 'type' => 'string', - ], - 'userId' => [ - 'type' => 'string', - ], - 'event' => [ - 'type' => 'string', - 'description' => '', - ], - 'createdAt' => [ - 'type' => 'string', - ], - 'updatedAt' => [ - 'type' => 'string', - ], - 'oldMemory' => [ - 'type' => 'string', - ], - 'metadata' => [ - 'type' => 'object', - 'properties' => [ - 'session_id' => [ - 'type' => 'string', - ], - 'timestamp' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'updated_by' => [ - 'type' => 'string', - ], - ], - 'description' => '', - ], - ], - 'description' => '', - ], - 'description' => '', - ], + 'schema' => ['description' => '任务配置详细', '$ref' => '#/components/schemas/OSSExport'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '获取内存历史记录', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => ' 获取OSS投递任务', + 'summary' => '获取指定的 OSS 投递任务。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"id\\": \\"\\",\\n \\"memoryId\\": \\"\\",\\n \\"input\\": [\\n {\\n \\"role\\": \\"\\",\\n \\"content\\": \\"\\"\\n }\\n ],\\n \\"newMemory\\": \\"\\",\\n \\"userId\\": \\"\\",\\n \\"event\\": \\"\\",\\n \\"createdAt\\": \\"\\",\\n \\"updatedAt\\": \\"\\",\\n \\"oldMemory\\": \\"\\",\\n \\"metadata\\": {\\n \\"session_id\\": \\"\\",\\n \\"timestamp\\": 0,\\n \\"updated_by\\": \\"\\"\\n }\\n }\\n]","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"export-oss-1234567890-123456\\",\\n \\"description\\": \\"my-oss-job\\",\\n \\"displayName\\": \\"my-oss-job\\",\\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\\": true\\n },\\n \\"createTime\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', ], - 'GetMemoryStore' => [ - 'path' => '/memorystores/{memoryStore}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetOSSHDFSExport' => [ + 'path' => '/osshdfsexports/{ossExportName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '203478', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'memoryStore', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n"], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'description' => '', - ], - 'customInstructions' => [ - 'type' => 'string', - 'description' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'createTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'enableGraph' => [ - 'type' => 'boolean', - 'description' => '', - ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'strategy' => [ - 'type' => 'string', - 'description' => '', - ], - 'shortTermTtl' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'name' => [ - 'type' => 'string', - 'description' => '', - ], - ], - 'description' => '', - ], + 'schema' => ['description' => '任务配置详细', '$ref' => '#/components/schemas/OSSExport'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '查询scmc数据库', + 'title' => '获取OSS-HDFS投递任务', + 'summary' => '获取指定的 OSS-HDFS 投递任务。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"customInstructions\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"enableGraph\\": true,\\n \\"updateTime\\": 0,\\n \\"strategy\\": \\"\\",\\n \\"shortTermTtl\\": 0,\\n \\"name\\": \\"\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"export-oss-1234567890-123456\\",\\n \\"description\\": \\"my-oss-job\\",\\n \\"displayName\\": \\"my-oss-job\\",\\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\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', ], - 'GetMetricStore' => [ - 'path' => '/metricstores/{name}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetOSSIngestion' => [ + 'path' => '/ossingestions/{ossIngestionName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225685', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeCode' => '203101', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '日志项目名称', - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'name', + 'name' => 'ossIngestionName', 'in' => 'path', - 'schema' => [ - 'title' => '时序库名称', - 'description' => '时序库名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my_metric_store', - ], + 'schema' => ['description' => 'OSS导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456'], ], ], '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' => [ - 'name' => [ - 'title' => '时序库名称', - 'description' => '时序库名称', - 'type' => 'string', - 'example' => 'my_metric_store', - ], - 'ttl' => [ - 'title' => '保存时间，单位为天', - 'description' => '保存时间，单位为天', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'shardCount' => [ - 'title' => 'shard 分片数量', - 'description' => 'shard 分片数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'autoSplit' => [ - 'title' => '是否开启自动分裂', - 'description' => '是否开启自动分裂', - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'maxSplitShard' => [ - 'title' => 'shard 最大自动分裂数量', - 'description' => 'shard 最大自动分裂数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'mode' => [ - 'title' => '时序库规格类型，例如 standard', - 'description' => '时序库规格类型，例如 standard', - 'type' => 'string', - 'example' => 'standard', - ], - 'metricType' => [ - 'title' => '时序库种类，例如 prometheus', - 'description' => '时序库种类，例如 prometheus', - 'type' => 'string', - 'example' => 'prometheus', - ], - 'createTime' => [ - 'title' => '创建时间，unix 时间戳', - 'description' => '创建时间，unix 时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1698933894', - ], - 'lastModifyTime' => [ - 'title' => '最后更新时间，unix 时间戳', - 'description' => '最后更新时间，unix 时间戳', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1712023974', - ], - 'hot_ttl' => [ - 'title' => '数据在热存储层中的存储时间，单位为天。', - 'description' => '数据在热存储层中的存储时间，单位为天。', - 'type' => 'integer', - 'format' => 'int32', - ], - 'infrequentAccessTTL' => [ - 'title' => '低频存储，单位为天。', - 'description' => '低频存储，单位为天。', - 'type' => 'integer', - 'format' => 'int32', - ], - 'appendMeta' => [ - 'type' => 'boolean', - 'default' => 'false', - ], - 'shardingPolicy' => [ - '$ref' => '#/components/schemas/ShardingPolicy', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'MetricStoreNotExist', - 'errorMessage' => 'The specified metricstore xxx does not exist.', - 'description' => '参数中所指定的时序库不存在', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => '查询时序库', - 'summary' => '查询时序库。', - 'description' => '[时序库](~~171723~~)可用于存储[时序数据](~~174965~~)。'."\n" - .'此接口仅用于查询时序库的配置，若要查询时序库中的时序数据，可参见[查询与分析](~~174968~~)以及[GetLogsV2](~~2771318~~)。'."\n" - .'- 此接口需要指定一个已存在的时序库。'."\n" - .'- 请求语法中的Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等信息。如何查询，请参见[管理Project](~~48984~~)。'."\n" - ."\n" - .'- 一个Project中，最多创建 200 个 Logstore 或 MetricStore。'."\n" - .'- 当时序数据保存时间达到您所设置的数据保存时间后，数据将被删除。', - 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:06.000Z', - 'description' => '响应参数发生变更', - ], - [ - 'createdAt' => '2025-12-02T11:55:01.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-11-24T09:35:51.000Z', - 'description' => '响应参数发生变更', - ], - [ - 'createdAt' => '2024-08-28T13:00:54.000Z', - 'description' => 'OpenAPI 下线', + 'schema' => ['description' => 'OSS导入任务配置', '$ref' => '#/components/schemas/OSSIngestion'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取OSS导入任务', + 'summary' => '获取指定 OSS 导入任务。', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - '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\\": 0,\\n \\"infrequentAccessTTL\\": 0,\\n \\"appendMeta\\": true,\\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}","type":"json"}]', + '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"}]', ], - 'GetMetricStoreMeteringMode' => [ - 'summary' => '查询指定时序库的当前计费模式。', - 'path' => '/metricstores/{metricStore}/meteringmode', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetProject' => [ + 'path' => '/', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '213243', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeCode' => '8911', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '日志项目名称', - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'projectName', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test'], ], [ - 'name' => 'metricStore', - 'in' => 'path', - 'schema' => [ - 'title' => 'metricStore', - 'description' => '时序库名称', - 'type' => 'string', - 'required' => true, - 'example' => 'metricStoreName', - ], + 'name' => 'crossRegion', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'default' => 'false'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - ], - 'schema' => [ - 'title' => '请求返回的结构体', - 'description' => '请求返回的结构体', - 'type' => 'object', - 'properties' => [ - 'meteringMode' => [ - 'title' => '计量模式。ChargeByFunction 默认计量模式，ChargeByDataIngest 流量模式。', - 'description' => '当前时序库计费模式。ChargeByFunction 表示[按使用功能计费](~~48220~~) ，ChargeByDataIngest 表示 [按写入数据量计费](~~2365756~~)。', - 'type' => 'string', - 'example' => 'ChargeByFunction', - 'enum' => [ - 'ChargeByFunction', - 'ChargeByDataIngest', - ], - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], + 'schema' => ['description' => '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" }', '$ref' => '#/components/schemas/project'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meteringMode\\": \\"ChargeByFunction\\"\\n}","type":"json"}]', - 'title' => '查询时序库计费模式', - 'description' => '时序库支持两种计费模式，[按使用功能计费](~~48220~~) 与 [按写入数据量计费](~~2365756~~)。'."\n" - .'- 此接口需要指定一个已存在的时序库。'."\n" - .'- 请求语法中的Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等信息。如何查询，请参见[管理Project](~~48984~~)。'."\n" + 'title' => '获取指定Project', + 'summary' => '查询目标Project的详细信息。', + 'description' => '### 接口说明'."\n" + .'请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist| The Project does not exist : projectName | Project不存在。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" - .'- 一个Project中，最多创建 200 个 Logstore 或 MetricStore。'."\n" - .'- 当时序数据保存时间达到您所设置的数据保存时间后，数据将被删除。', - 'changeSet' => [ - [ - 'createdAt' => '2024-09-19T09:31:34.000Z', - 'description' => '响应参数发生变更', - ], - ], + .'更多信息，请参见[通用错误码](~~29013~~)。', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'GetOSSExport' => [ - 'summary' => '获取指定的 OSS 投递任务。', - 'path' => '/ossexports/{ossExportName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'GetProjectLogs' => [ + 'summary' => '查询目标Project下的日志，该接口是Project级别的SQL查询接口。', + 'path' => '/logs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '203470', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8913', + 'abilityTreeNodes' => ['FEATUREslsCAO32E'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'ossExportName', - 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-123456789-123456'."\n", - ], + 'name' => 'query', + 'in' => 'query', + 'schema' => ['title' => '标准SQL语句。例如日志库名称为nginx-moni，查询时间区间在2022-03-01 10:41:40到2022-03-01 10:56:40之间的访问数量。', 'description' => '标准SQL语句。例如日志库名称为nginx-moni，查询时间区间在2022-03-01 10:41:40到2022-03-01 10:56:40之间的访问数量。', 'type' => 'string', 'required' => true, 'example' => 'SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400'], + ], + [ + 'name' => 'powerSql', + 'in' => 'query', + 'schema' => ['title' => '是否使用SQL独享版。更多信息，请参见开启SQL独享版。'."\n" + ."\n" + .'true：使用SQL独享版。'."\n" + .'false（默认值）：使用SQL普通版。'."\n" + .'除通过powerSql参数配置SQL独享版外，您还可以使用query参数。', 'description' => '是否使用SQL独享版。更多信息，请参见[开启SQL独享版](~~223777~~)。'."\n" + ."\n" + .'- true：使用SQL独享版。'."\n" + .'- false（默认值）：使用SQL普通版。'."\n" + ."\n" + .'除通过powerSql参数配置SQL独享版外，您还可以使用**query**参数。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => '任务配置详细', - '$ref' => '#/components/schemas/OSSExport', + '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'], + ], ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"export-oss-1234567890-123456\\",\\n \\"description\\": \\"my-oss-job\\",\\n \\"displayName\\": \\"my-oss-job\\",\\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\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', - 'title' => ' 获取OSS投递任务', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - 'GetOSSHDFSExport' => [ - 'summary' => '获取指定的 OSS-HDFS 投递任务。', - 'path' => '/osshdfsexports/{ossExportName}', - 'methods' => [ - 'get', + 'schema' => [ + 'title' => '返回日志列表，列表中每一项对应一条返回的日志。', + 'description' => '查询到的日志。', + 'type' => 'array', + 'items' => [ + 'title' => '每条日志是一个 Map, 示例 {'."\n" + .' "__time__" : 1409529660,'."\n" + .' "__source__" : "192.168.1.100",'."\n" + .' "Key1" : "error",'."\n" + .' "Key2" : "Value2"'."\n" + .'}', + 'description' => '查询到的日志。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '查询到的日志。', 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]'], + 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","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]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取目标Project下的日志', + 'description' => '### 接口说明'."\n" + .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" + .'- 查询日志前，已配置索引。具体操作，请参见[创建索引](~~90732~~)。'."\n" + .'- 日志服务查询日志时存在使用限制。请设计合理查询与分析语句、设置合理查询区间等。更多信息，请参见[查询日志使用限制](~~43772~~)和[分析日志使用限制](~~53608~~)。'."\n" + .'- 参数query是一个标准的SQL查询语句。'."\n" + .'- 查询的Logstore在查询语句的from条件中指定。可以将Logstore看做是SQL中的表。'."\n" + .'- 在查询的SQL条件中必须指定要查询的时间范围，时间范围由__date__（Timestamp类型）或__time__（Integer类型，单位是秒）来指定。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" + .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" + .'| :------------ | :------------ |'."\n" + .'| `log:GetProjectLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', + 'requestParamsDescription' => '**请求示例：** '."\n" + ."\n" + .'~~~'."\n" + .'GET /logs?query=SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400&powerSql=false HTTP/1.1'."\n" + .'Host:ali-test-project.ch-hangzhou.log.aliyuncs.com'."\n" + .'Content-Type:application/json'."\n" + .'~~~', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 400 | ParameterInvalid| Parameter is invalid. | 请求的参数错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetProjectPolicy' => [ + 'summary' => '查询Project权限策略（Policy）。', + 'path' => '/policy', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '203478', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeCode' => '157642', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], - ], - [ - 'name' => 'ossExportName', - 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-osshdfs-1234567890-123456'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => '任务配置详细', - '$ref' => '#/components/schemas/OSSExport', + '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' => '授权策略。', 'type' => 'string', 'example' => '{ "Version": "1", "Statement": [{ "Action": ["log:PostLogStoreLogs"], "Resource": "acs:log:*:*:project/exampleproject/*", "Effect": "Deny", "Condition": { "StringNotLike": { "acs:SourceVpc": ["vpc-*"] } } }] }'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"export-oss-1234567890-123456\\",\\n \\"description\\": \\"my-oss-job\\",\\n \\"displayName\\": \\"my-oss-job\\",\\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\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', - 'title' => '获取OSS-HDFS投递任务', + 'responseDemo' => '[{"type":"json","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}] }\\"","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询Project授权策略', + 'description' => '### 接口说明'."\n" + ."\n" + .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'GetOSSIngestion' => [ - 'summary' => '获取指定 OSS 导入任务。', - 'path' => '/ossingestions/{ossIngestionName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetS3Ingestion' => [ + 'summary' => '获取s3导入任务信息', + 'path' => '/s3ingestions/{s3IngestionName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '203101', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'abilityTreeCode' => '263582', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'project名称', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ - 'name' => 'ossIngestionName', + 'name' => 's3IngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'OSS导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123456', - ], + 'schema' => ['description' => 's3导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'OSS导入任务配置', - '$ref' => '#/components/schemas/OSSIngestion', - ], + 'schema' => ['description' => 's3导入任务', '$ref' => '#/components/schemas/S3Ingestion'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-oss-123456\\",\\n \\"description\\": \\"oss ingestion\\",\\n \\"displayName\\": \\"oss ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\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 \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"Line\\\\\\"}\\"\\n },\\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 }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\"\\n}","type":"json"}]', - 'title' => '获取OSS导入任务', + 'title' => '获取S3导入任务', '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\\": true,\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', ], - 'GetProject' => [ - 'summary' => '查询目标Project的详细信息。', - 'path' => '/', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSavedSearch' => [ + 'summary' => '获取指定的快速查询。', + 'path' => '/savedsearches/{savedsearchName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '8911', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-project-test', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project'], + ], + [ + 'name' => 'savedsearchName', + 'in' => 'path', + 'schema' => ['description' => '快速查询名称。', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'description' => '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" }', - '$ref' => '#/components/schemas/project', - ], + 'schema' => ['description' => '快速查询结构体。', 'example' => 'saved-search', '$ref' => '#/components/schemas/SavedSearch'], ], ], - 'responseDemo' => '[{"type":"json","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 \\"quota\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"recycleBinEnabled\\": false,\\n \\"location\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取指定Project', + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '获取指定快速查询', 'description' => '### 接口说明'."\n" - .'请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ProjectNotExist| The Project does not exist : projectName | Project不存在。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" + .'- 您可以通过ListSavedSearch查询具体的快速查询名称。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" + .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" + .'| :------------ | :------------ |'."\n" + .'| `log:GetSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -24084,2449 +13942,1787 @@ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:GetProject', + 'action' => 'log:GetSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], ], ], - 'GetProjectLogs' => [ - 'summary' => '查询目标Project下的日志，该接口是Project级别的SQL查询接口。', - 'path' => '/logs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetScheduledSQL' => [ + 'summary' => '获取指定的定时SQL任务', + 'path' => '/scheduledsqls/{scheduledSQLName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8913', - 'abilityTreeNodes' => [ - 'FEATUREslsCAO32E', - ], + 'abilityTreeCode' => '209801', + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'title' => '标准SQL语句。例如日志库名称为nginx-moni，查询时间区间在2022-03-01 10:41:40到2022-03-01 10:56:40之间的访问数量。', - 'description' => '标准SQL语句。例如日志库名称为nginx-moni，查询时间区间在2022-03-01 10:41:40到2022-03-01 10:56:40之间的访问数量。', - 'type' => 'string', - 'required' => true, - 'example' => 'SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ - 'name' => 'powerSql', - 'in' => 'query', - 'schema' => [ - 'title' => '是否使用SQL独享版。更多信息，请参见开启SQL独享版。'."\n" - ."\n" - .'true：使用SQL独享版。'."\n" - .'false（默认值）：使用SQL普通版。'."\n" - .'除通过powerSql参数配置SQL独享版外，您还可以使用query参数。', - 'description' => '是否使用SQL独享版。更多信息，请参见[开启SQL独享版](~~223777~~)。'."\n" - ."\n" - .'- true：使用SQL独享版。'."\n" - .'- false（默认值）：使用SQL普通版。'."\n" - ."\n" - .'除通过powerSql参数配置SQL独享版外，您还可以使用**query**参数。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'name' => 'scheduledSQLName', + 'in' => 'path', + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'x-log-progress' => [ - 'schema' => [ - 'title' => '查询结果的状态，包括： Complete：查询已经完成，返回结果为完整结果。 Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'type' => 'string', - 'example' => 'Complete', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], - 'x-log-count' => [ - 'schema' => [ - 'title' => '当前查询结果的日志总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], - 'x-log-processed-rows' => [ - 'schema' => [ - 'title' => '本次查询处理的行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - ], - 'x-log-elapsed-millisecond' => [ - 'schema' => [ - 'title' => '本次查询消耗的毫秒时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + ], + 'schema' => ['description' => '定时SQL任务配置', '$ref' => '#/components/schemas/ScheduledSQL'], + ], + ], + '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\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\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' => '获取定时SQL任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], + ], + ], + ], + ], + 'GetSlsService' => [ + 'summary' => '调用GetSlsService接口获取日志服务的开通状态。服务地址只能是华东2（上海）或新加坡', + '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', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'Server' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - ], - 'schema' => [ - 'title' => '返回日志列表，列表中每一项对应一条返回的日志。', - 'description' => '查询到的日志。', - 'type' => 'array', - 'items' => [ - 'title' => '每条日志是一个 Map, 示例 {'."\n" - .' "__time__" : 1409529660,'."\n" - .' "__source__" : "192.168.1.100",'."\n" - .' "Key1" : "error",'."\n" - .' "Key2" : "Value2"'."\n" - .'}', - 'description' => '查询到的日志。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '查询到的日志。', - 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', - ], - 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], ], + 'schema' => ['description' => '响应消息体。', '$ref' => '#/components/schemas/serviceStatus'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","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]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取目标Project下的日志', - 'description' => '### 接口说明'."\n" - .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" - .'- 查询日志前，已配置索引。具体操作，请参见[创建索引](~~90732~~)。'."\n" - .'- 日志服务查询日志时存在使用限制。请设计合理查询与分析语句、设置合理查询区间等。更多信息，请参见[查询日志使用限制](~~43772~~)和[分析日志使用限制](~~53608~~)。'."\n" - .'- 参数query是一个标准的SQL查询语句。'."\n" - .'- 查询的Logstore在查询语句的from条件中指定。可以将Logstore看做是SQL中的表。'."\n" - .'- 在查询的SQL条件中必须指定要查询的时间范围，时间范围由__date__（Timestamp类型）或__time__（Integer类型，单位是秒）来指定。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" - .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" - .'| :------------ | :------------ |'."\n" - .'| `log:GetProjectLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', - 'requestParamsDescription' => '**请求示例：** '."\n" - ."\n" - .'~~~'."\n" - .'GET /logs?query=SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400&powerSql=false HTTP/1.1'."\n" - .'Host:ali-test-project.ch-hangzhou.log.aliyuncs.com'."\n" - .'Content-Type:application/json'."\n" - .'~~~', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 400 | ParameterInvalid| Parameter is invalid. | 请求的参数错误。 |'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"status\\": \\"NotExist\\",\\n \\"enabled\\": false\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询日志服务的开通状态', + 'description' => '该接口需要您已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'GetProjectPolicy' => [ - 'summary' => '查询Project权限策略（Policy）。', - 'path' => '/policy', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetSqlInstance' => [ + 'summary' => '查询Project的SQL独享版本的CU数、是否为 Project 默认开启SQL独享版等信息。使用该接口前，必须先调用CreateSqlInstance或UpdateSqlInstance接口创建SQL独享版。', + 'path' => '/sqlinstance', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '157642', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215092', + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'project名称', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ - 'description' => '授权策略。', - 'type' => 'string', - 'example' => '{ "Version": "1", "Statement": [{ "Action": ["log:PostLogStoreLogs"], "Resource": "acs:log:*:*:project/exampleproject/*", "Effect": "Deny", "Condition": { "StringNotLike": { "acs:SourceVpc": ["vpc-*"] } } }] }', + 'description' => 'Sql独享实例', + 'type' => 'array', + 'items' => [ + 'description' => 'Sql独享实例', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '名称', 'description' => '统一为group1，内部参数，用户无需关注。', 'type' => 'string', 'example' => 'group1'], + 'cu' => ['title' => '独享sql能使用的最大cu', 'description' => '独享sql能使用的最大CU。CU（ComputeUnit）是 SQL 独享版运行过程中可以并行使用的计算核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'createTime' => ['title' => '创建时间', 'description' => '创建SQL独享版配置的时间。Unix时间戳。', 'type' => 'integer', 'format' => 'int32', 'example' => '1710230272'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新SQL独享版配置的时间。Unix时间戳。', 'type' => 'integer', 'format' => 'int32', 'example' => '1710230272'], + 'useAsDefault' => ['title' => '是否默认开启', 'description' => '是否为Project默认开启SQL独享版。 如果为true，当前Project下的所有查询和分析操作（包括告警、仪表盘等），都使用SQL独享版。', 'type' => 'boolean', 'example' => 'true'], + ], + ], ], ], ], - 'responseDemo' => '[{"type":"json","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}] }\\"","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '查询Project授权策略', - 'description' => '### 接口说明'."\n" - ."\n" - .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', + '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' => '查询SQL 独享实例', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'none', 'ramAction' => [ - 'action' => 'log:GetProjectPolicy', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], + 'action' => 'log:GetSqlInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], - 'GetS3Ingestion' => [ - 'summary' => '获取s3导入任务信息', - 'path' => '/s3ingestions/{s3IngestionName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetStoreView' => [ + 'summary' => '根据名称查询指定数据集配置。', + 'path' => '/storeviews/{name}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '263582', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208676', + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '日志项目名称。', 'type' => 'string', 'required' => true, 'example' => 'example-project'], ], [ - 'name' => 's3IngestionName', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 's3导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '数据集名称。', 'type' => 'string', 'required' => true, 'example' => 'my_storeview'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 's3导入任务', - '$ref' => '#/components/schemas/S3Ingestion', + 'title' => 'Schema of Response', + 'description' => '数据集配置。', + 'type' => 'object', + 'properties' => [ + 'storeType' => [ + 'title' => 'Id of the request', + 'description' => '数据集类型。', + 'type' => 'string', + 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], + 'example' => 'logstore', + ], + 'stores' => [ + 'description' => '日志库或时序库列表。', + 'type' => 'array', + 'items' => ['description' => '日志库或者时序库。', '$ref' => '#/components/schemas/StoreViewStore'], + ], + ], ], ], ], - 'title' => '获取S3导入任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"storeType\\": \\"logstore\\",\\n \\"stores\\": [\\n {\\n \\"project\\": \\"ali-test-project\\",\\n \\"storeName\\": \\"my-logstore\\",\\n \\"query\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询指定数据集', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-s3-123456\\",\\n \\"description\\": \\"s3 ingestion\\",\\n \\"displayName\\": \\"s3 ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\n },\\n \\"configuration\\": {\\n \\"awsRegion\\": \\"ap-northeast-1\\",\\n \\"awsAccessKey\\": \\"AKIxxxxxxxxxxYJE\\",\\n \\"awsAccessKeySecret\\": \\"123xxxxxxxxxxfjf\\",\\n \\"bucket\\": \\"s3bucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\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 },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\"\\n}","type":"json"}]', - ], - 'GetSavedSearch' => [ - 'summary' => '获取指定的快速查询。', - 'path' => '/savedsearches/{savedsearchName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetStoreView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetStoreViewIndex' => [ + 'path' => '/storeviews/{name}/index', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => '日志项目名称。', 'type' => 'string', 'required' => true, 'example' => 'example-project'], ], [ - 'name' => 'savedsearchName', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => '快速查询名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'savedsearch-name', - ], + 'schema' => ['description' => '数据集名称。', 'type' => 'string', 'required' => true, 'example' => 'my_storeview'], ], ], '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' => [ + 'title' => 'Schema of Response', + 'description' => '数据集中所有 LogStore 索引配置。', + 'type' => 'object', + 'properties' => [ + 'indexes' => [ + 'description' => '索引配置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '索引配置。', + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'LogStore 所属日志项目名称。', 'type' => 'string', 'example' => 'example-project'], + 'logstore' => ['description' => 'LogStore 名称。', 'type' => 'string', 'example' => 'my-logstore'], + 'index' => ['description' => 'LogStore 索引配置。', '$ref' => '#/components/schemas/index'], + ], + ], ], ], ], - 'schema' => [ - 'description' => '快速查询结构体。', - 'example' => 'saved-search', - '$ref' => '#/components/schemas/SavedSearch', - ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '获取指定快速查询', - 'description' => '### 接口说明'."\n" - .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" - .'- 您可以通过ListSavedSearch查询具体的快速查询名称。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" - .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" - .'| :------------ | :------------ |'."\n" - .'| `log:GetSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询指定数据集索引配置', + 'summary' => '根据指定名称查询数据集索引，只支持 logstore 类型的数据集。', '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}', - ], - ], - ], - ], - ], + 'ramActions' => [], + '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"}]', ], - 'GetScheduledSQL' => [ - 'summary' => '获取指定的定时SQL任务', - 'path' => '/scheduledsqls/{scheduledSQLName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAgentInstanceConfigs' => [ + 'summary' => '列出进程级配置', + 'path' => '/agentinstanceconfigs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '209801', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'abilityTreeCode' => '227400', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '查询开始行，默认 0', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ - 'name' => 'scheduledSQLName', - 'in' => 'path', + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => '数据条数，默认为 500。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'configType', + 'in' => 'query', 'schema' => [ - 'description' => '已存在的唯一任务名称', + 'description' => '进程级配置类型', 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456'."\n", + 'required' => false, + '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', + ], + 'example' => 'apm_trace', ], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度', - 'type' => 'string', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'description' => '定时SQL任务配置', - '$ref' => '#/components/schemas/ScheduledSQL', - ], - ], - ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', + 'type' => 'object', + 'properties' => [ + 'size' => ['description' => '数据条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'total' => ['description' => '符合查询条件的总数据条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'configs' => ['description' => '进程级配置', '$ref' => '#/components/schemas/ListAgentInstanceConfigs'], + ], + '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\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\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' => '获取定时SQL任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出进程级配置', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'log:GetScheduledSQL', - 'authLevel' => 'resource', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'GetSlsService' => [ - 'summary' => '调用GetSlsService接口获取日志服务的开通状态。服务地址只能是华东2（上海）或新加坡', - 'path' => '/slsservice', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAiTools' => [ + 'summary' => '获取可观测提供的智能工具列表，包括可观测各业务 Copilot 相关能力', + 'path' => '/ml/tool/list', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '194671', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + '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', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], - 'Server' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ - 'description' => '响应消息体。', - '$ref' => '#/components/schemas/serviceStatus', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fields' => [ + 'description' => '工具字段', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => '字段名称', 'type' => 'string'], + 'option' => [ + 'description' => '字段可选值', + 'type' => 'array', + 'items' => ['type' => 'string'], + ], + 'required' => ['description' => '是否必须', 'type' => 'boolean'], + 'type' => ['description' => '字段类型', 'type' => 'string'], + 'example' => ['description' => '字段样例', 'type' => 'string'], + 'description' => ['description' => '字段说明', 'type' => 'string'], + ], + ], + ], + 'name' => ['description' => '工具名称', 'type' => 'string'], + 'description' => ['description' => '工具说明', 'type' => 'string'], + ], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"status\\": \\"NotExist\\",\\n \\"enabled\\": false\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '查询日志服务的开通状态', - 'description' => '该接口需要您已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列举可观测 AI 工具能力', + 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"option\\": [\\n \\"\\"\\n ],\\n \\"required\\": true,\\n \\"type\\": \\"\\",\\n \\"example\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n ],\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n]","type":"json"}]', ], - 'GetSqlInstance' => [ - 'summary' => '查询Project的SQL独享版本的CU数、是否为 Project 默认开启SQL独享版等信息。使用该接口前，必须先调用CreateSqlInstance或UpdateSqlInstance接口创建SQL独享版。', - 'path' => '/sqlinstance', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAlerts' => [ + 'summary' => '列出指定Project下的告警规则。', + 'path' => '/alerts', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '215092', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '199870', + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', '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', - ], + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，设置的每页行数。最大值为200。默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'logstore', + 'in' => 'query', + 'schema' => ['description' => '获取指定Logstore下的告警规则。默认值为空。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore'], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ - 'description' => 'Sql独享实例', - 'type' => 'array', - 'items' => [ - 'description' => 'Sql独享实例', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '名称', - 'description' => '统一为group1，内部参数，用户无需关注。', - 'type' => 'string', - 'example' => 'group1', - ], - 'cu' => [ - 'title' => '独享sql能使用的最大cu', - 'description' => '独享sql能使用的最大CU。CU（ComputeUnit）是 SQL 独享版运行过程中可以并行使用的计算核数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => '创建SQL独享版配置的时间。Unix时间戳。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1710230272。Unix时间戳。', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => '更新SQL独享版配置的时间。Unix时间戳。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1710230272', - ], - 'useAsDefault' => [ - 'title' => '是否默认开启', - 'description' => '是否为Project默认开启SQL独享版。 如果为true，当前Project下的所有查询和分析操作（包括告警、仪表盘等），都使用SQL独享版。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'Project下告警总数量', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'count' => ['description' => '当前返回的告警数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'results' => [ + 'description' => '告警配置结果列表', + 'type' => 'array', + 'items' => ['description' => '告警配置', '$ref' => '#/components/schemas/Alert'], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"name\\": \\"group1\\",\\n \\"cu\\": 2,\\n \\"createTime\\": 0,\\n \\"updateTime\\": 1710230272,\\n \\"useAsDefault\\": true\\n }\\n]","type":"json"}]', - 'title' => '查询SQL 独享实例', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出告警规则', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'none', + 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:GetSqlInstance', - 'authLevel' => 'operate', + 'action' => 'log:ListAlerts', + 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', '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"}]', ], - 'GetStoreView' => [ - 'summary' => '根据名称查询指定数据集配置。', - 'path' => '/storeviews/{name}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAnnotationData' => [ + 'summary' => '列出数据集中的所有数据。', + 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '208676', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => '日志项目名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - ], + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '起始行', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'name', + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'datasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - ], + 'schema' => ['description' => '数据集唯一标识', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '数据集配置。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'storeType' => [ - 'title' => 'Id of the request', - 'description' => '数据集类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'metricstore' => 'metricstore', - 'logstore' => 'logstore', - ], - 'example' => 'logstore', - ], - 'stores' => [ - 'description' => '日志库或时序库列表。', + 'data' => [ + 'description' => '返回的数据列表。', 'type' => 'array', - 'items' => [ - 'description' => '日志库或者时序库。', - '$ref' => '#/components/schemas/StoreViewStore', - ], + 'items' => ['description' => '数据结构体。', '$ref' => '#/components/schemas/MLDataParam'], ], + 'total' => ['description' => ' 总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"storeType\\": \\"logstore\\",\\n \\"stores\\": [\\n {\\n \\"project\\": \\"ali-test-project\\",\\n \\"storeName\\": \\"my-logstore\\",\\n \\"query\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询指定数据集', + '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' => '获取数据列表', + 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'log:GetStoreView', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'GetStoreViewIndex' => [ - 'path' => '/storeviews/{name}/index', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAnnotationDataSets' => [ + 'summary' => '取得数据集结构体列表。', + 'path' => '/ml/annotationdataset', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '212612', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '日志项目名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - ], + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '查询开始行。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - ], + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], ], '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' => '数据集中所有 LogStore 索引配置。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'indexes' => [ - 'description' => '索引配置列表。', + 'data' => [ + 'description' => '返回的数据列表。', 'type' => 'array', - 'items' => [ - 'description' => '索引配置。', - 'type' => 'object', - 'properties' => [ - 'project' => [ - 'description' => 'LogStore 所属日志项目名称。', - 'type' => 'string', - 'example' => 'example-project', - ], - 'logstore' => [ - 'description' => 'LogStore 名称。', - 'type' => 'string', - 'example' => 'my-logstore', - ], - 'index' => [ - 'description' => 'LogStore 索引配置。', - '$ref' => '#/components/schemas/index', - ], - ], - ], + 'items' => ['description' => '数据集结构体', '$ref' => '#/components/schemas/MLDataSetParam'], ], + 'total' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => '查询指定数据集索引配置', - 'summary' => '根据指定名称查询数据集索引，只支持 logstore 类型的数据集。', + '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' => '获取数据集列表', + 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - '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' => '列出进程级配置', - 'path' => '/agentinstanceconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAnnotationLabels' => [ + 'summary' => '取得标签表的列表。', + 'path' => '/ml/annotationlabel', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '227400', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行，默认 0', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '查询开始行。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '数据条数，默认为 500。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'configType', - 'in' => 'query', - 'schema' => [ - 'description' => '进程级配置类型', - 'type' => 'string', - 'required' => false, - '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', - ], - 'example' => 'apm_trace', - ], + 'schema' => ['description' => '分页查询时，设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应返回数据', 'type' => 'object', 'properties' => [ - 'size' => [ - 'description' => '数据条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'total' => [ - 'description' => '符合查询条件的总数据条数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'configs' => [ - 'description' => '进程级配置', - '$ref' => '#/components/schemas/ListAgentInstanceConfigs', - ], - ], - 'description' => '', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => '列出进程级配置', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - 'ListAiTools' => [ - 'summary' => '获取可观测提供的智能工具列表，包括可观测各业务 Copilot 相关能力', - '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' => [ - 'description' => '工具字段', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '字段名称', - 'type' => 'string', - ], - 'option' => [ - 'description' => '字段可选值', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'required' => [ - 'description' => '是否必须', - 'type' => 'boolean', - ], - 'type' => [ - 'description' => '字段类型', - 'type' => 'string', - ], - 'example' => [ - 'description' => '字段样例', - 'type' => 'string', - ], - 'description' => [ - 'description' => '字段说明', - 'type' => 'string', - ], - ], - ], - ], - 'name' => [ - 'description' => '工具名称', - 'type' => 'string', - ], - 'description' => [ - 'description' => '工具说明', - 'type' => 'string', - ], + 'data' => [ + 'description' => '返回的标签表结构体列表。', + 'type' => 'array', + 'items' => ['description' => '返回的标签表结构体。', '$ref' => '#/components/schemas/MLLabelParam'], ], + 'total' => ['description' => '符合查询条件的数据总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => '列举可观测 AI 工具能力', + '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' => '获取标签列表', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"option\\": [\\n \\"\\"\\n ],\\n \\"required\\": true,\\n \\"type\\": \\"\\",\\n \\"example\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n ],\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n]","type":"json"}]', ], - 'ListAlerts' => [ - 'summary' => '列出指定Project下的告警规则。', - 'path' => '/alerts', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAzureBlobIngestion' => [ + 'path' => '/azureblobingestions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '199870', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], + 'abilityTreeCode' => '291245', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，设置的每页行数。最大值为200。默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], ], [ 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'description' => '获取指定Logstore下的告警规则。默认值为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'Project下告警总数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'count' => [ - 'description' => '当前返回的告警数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'total' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'count' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], 'results' => [ - 'description' => '告警配置结果列表', 'type' => 'array', - 'items' => [ - 'description' => '告警配置', - '$ref' => '#/components/schemas/Alert', - ], + 'items' => ['$ref' => '#/components/schemas/AzureBlobIngestion', 'description' => ''], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\n },\\n \\"createTime\\": 0,\\n \\"lastModifiedTime\\": 0,\\n \\"status\\": \\"ENABLED/DISABLED\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列出告警规则', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出AzureBlob导入任务', + 'summary' => '列出AzureBlob导入任务', '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"}]', ], - 'ListAnnotationData' => [ - 'summary' => '列出数据集中的所有数据。', - 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListCollectionPolicies' => [ + 'summary' => '列出云产品日志采集的采集规则。', + 'path' => '/collectionpolicy', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192483', + 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ - 'name' => 'offset', + 'name' => 'productCode', 'in' => 'query', - 'schema' => [ - 'description' => '起始行', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '产品的编码。', 'type' => 'string', 'required' => false, 'example' => 'oss'], + ], + [ + 'name' => 'dataCode', + 'in' => 'query', + 'schema' => ['description' => '日志类型编码。', 'type' => 'string', 'required' => false, 'example' => 'access_log'], + ], + [ + 'name' => 'policyName', + 'in' => 'query', + 'schema' => ['description' => '规则名称。', 'type' => 'string', 'required' => false, 'example' => 'your_log_policy'."\n"], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，设置的每页行数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '分页查询时，设置的每页行数。默认值为 50，最多返回 100 个 规则信息。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '50', 'default' => '50'], ], [ - 'name' => 'datasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'name' => 'offset', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => '查询开始行，默认值为 0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。如果配置实例ID，则可以根据实例ID反向查询实例命中的规则，必须和productCode、dataCode结合使用。', 'type' => 'string', 'required' => false, 'example' => 'your-test-bucket1'."\n"], + ], + [ + 'name' => 'centralProject', + 'in' => 'query', + 'schema' => ['description' => '中心化转投目的Project。如果配置中心化转投目的Project，则可以根据Project反向查询有多少规则配置了中心化转投到该centralProejct下。', 'type' => 'string', 'required' => false, 'example' => 'your-central-project1'], ], ], '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' => 'Schema of Response', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ + 'totalCount' => ['description' => '总数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'currentCount' => ['description' => '当前页数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'data' => [ - 'description' => '返回的数据列表。', + 'description' => '当前查询条件下按照分页配置返回的规则数据。', 'type' => 'array', 'items' => [ - 'description' => '数据结构体。', - '$ref' => '#/components/schemas/MLDataParam', - ], - ], - 'total' => [ - 'description' => ' 总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'description' => '规则详情。', + 'type' => 'object', + 'properties' => [ + 'productCode' => ['description' => '产品编码。', 'type' => 'string', 'example' => 'oss'], + 'dataCode' => ['description' => '日志类型编码。', 'type' => 'string', 'example' => 'access_log'], + 'policyName' => ['description' => '规则名称。', 'type' => 'string', 'example' => 'your_log_policy'], + 'enabled' => ['description' => '是否开启。', 'type' => 'boolean', 'example' => 'true'], + 'policyConfig' => [ + 'description' => '采集规则配置。', + 'type' => 'object', + 'properties' => [ + 'resourceMode' => ['description' => '资源采集模式。', 'type' => 'string', 'example' => 'all'], + 'regions' => [ + 'description' => '实例所属的地域集合。', + 'type' => 'array', + 'items' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + 'instanceIds' => [ + 'description' => '实例ID集合。', + 'type' => 'array', + 'items' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'your-test-bucket1'."\n"], + ], + 'resourceTags' => ['description' => '资源标签。', 'type' => 'object', 'example' => '{"tag1":"value1","tag2":"value2"}'], + ], + ], + 'centralizeEnabled' => ['description' => '是否开启中心化转投。', 'type' => 'boolean', 'example' => 'false'], + 'centralizeConfig' => [ + 'description' => '中心化转投配置。', + 'type' => 'object', + 'properties' => [ + 'destRegion' => ['description' => '中心化转投目的地域。', 'type' => 'string', 'example' => 'cn-beijing'."\n"], + 'destProject' => ['description' => '中心化转投目的项目。', 'type' => 'string', 'example' => 'your-sls-project-in-beijing'."\n"], + 'destLogstore' => ['description' => '中心化转投目的日志库。', 'type' => 'string', 'example' => 'your-sls-logstore-in-beijing'."\n"], + 'destTTL' => ['description' => '中心化转投目的存储天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + ], + ], + 'resourceDirectory' => [ + 'description' => '资源目录配置, 如有配置，否则为空', + 'type' => 'object', + 'properties' => [ + 'accountGroupType' => ['description' => '在该资源目录下，全选模式all或自定义模式custom', 'type' => 'string', 'example' => 'all,custom'], + 'members' => [ + 'description' => '当资源目录配置为custom模式时，对应的成员账号列表', + 'type' => 'array', + 'items' => ['description' => '阿里云账号Uid', 'type' => 'string', 'example' => '165***********50'], + ], + ], + ], + 'dataConfig' => [ + 'description' => '当且仅当日志类型为全局日志类型时支持配置，例如productCode为sls时的场景。否则为空。', + 'type' => 'object', + 'properties' => [ + 'dataRegion' => ['description' => '当且仅当日志类型为全局日志类型时支持的配置，例如productCode为sls时的场景，表示首次配置时全局日志将被采集到对应地域。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'dataProject' => ['description' => '当且仅当日志类型为全局日志类型时有效，例如productCode为sls时的场景，如果为空，表示日志被采集到该账号在特定dataRegion下的默认专属的Project中。', 'type' => 'string', 'example' => '""'], + ], + ], + 'internalPolicy' => ['description' => '是否是内置规则策略，内置规则不允许修改、删除。', 'type' => 'boolean', 'example' => 'false'], + 'policyUid' => ['description' => '规则所属的账号阿里云账号Uid，如果该规则由资源目录管理员或者资源目录委派管理员创建，则为其阿里云账号Uid。', 'type' => 'string', 'example' => '148***********50'], + ], + ], + ], + 'statistics' => [ + 'description' => '当前查询条件下返回的统计数据。', + 'type' => 'array', + 'items' => [ + 'description' => '按照productCode的规则统计结果', + 'type' => 'object', + 'properties' => [ + 'productCode' => ['description' => '产品编码。', 'type' => 'string', 'example' => 'oss'], + 'policySourceList' => [ + 'description' => '规则来源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则来源对象。', + 'type' => 'object', + 'properties' => [ + 'policyUid' => ['description' => '规则所属的账号阿里云账号Uid，如果该规则由资源目录管理员或者资源目录委派管理员创建，则为其阿里云账号Uid。', 'type' => 'string', 'example' => '148***********50'], + 'policyName' => ['description' => '规则名称', 'type' => 'string', 'example' => 'policy_name1_from148'], + ], + ], + ], + ], + ], + ], + ], + ], + ], ], - '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' => '获取数据列表', - 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', + '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' => '列出云产品日志采集的采集规则', + 'description' => '该接口服务地址只能是华东 2（上海）、新加坡、河源专属云汽车合规（cn-heyuan-acdr-1）。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'ListAnnotationDataSets' => [ - 'summary' => '取得数据集结构体列表。', - 'path' => '/ml/annotationdataset', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListConfig' => [ + 'summary' => '调用ListConfig接口查询指定Project下所有的Logtail配置。', + 'path' => '/configs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', + 'abilityTreeCode' => '8980', + 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'logstoreName', + 'in' => 'query', + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], + ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，设置的每页行数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '分页查询时，设置的每页行数。最大值为500。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'configName', + 'in' => 'query', + 'schema' => ['title' => '可以进行名字匹配', 'description' => 'Logtail配置名称，用于模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'logtail-config-sample'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '返回的数据列表。', + 'count' => ['description' => '当前页返回的Logtail配置数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'total' => ['description' => '符合查询条件的Logtail配置总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'configs' => [ + 'description' => '当前页返回的Logtail配置列表。', 'type' => 'array', - 'items' => [ - 'description' => '数据集结构体', - '$ref' => '#/components/schemas/MLDataSetParam', - ], - ], - 'total' => [ - 'description' => '总条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'items' => ['description' => '查询出来的Logtail配置列表。', 'type' => 'string', 'example' => 'logtail-config-sample'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - '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' => '获取数据集列表', - 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"count\\": 3,\\n \\"total\\": 2,\\n \\"configs\\": [\\n \\"logtail-config-sample\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询Logtail配置列表', + 'description' => '### 接口说明'."\n" + ."\n" + .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理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' => [], - ], - 'ListAnnotationLabels' => [ - 'summary' => '取得标签表的列表。', - 'path' => '/ml/annotationlabel', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + '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' => '列出符合参数条件的消费处理器。', + 'path' => '/consumeprocessors', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', + 'abilityTreeCode' => '225118', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], + ], + [ + 'name' => 'processorName', + 'in' => 'query', + 'schema' => ['description' => '消费处理器标识。', 'type' => 'string', 'required' => false, 'example' => 'consume-processor-1'], + ], + [ + 'name' => 'displayName', + 'in' => 'query', + 'schema' => ['description' => '消费处理器显示名称', 'type' => 'string', 'required' => false, 'example' => 'filter-get-request'], + ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '偏移值，默认为0。', 'type' => 'string', 'required' => false, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，设置的每页行数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => '数据条数，默认为200。', 'type' => 'string', 'required' => false, 'example' => '100'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ 'title' => 'Schema of Response', - 'description' => '响应返回数据', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => '返回的标签表结构体列表。', + 'total' => ['description' => '符合查询条件的总的消费处理器数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'count' => ['description' => '当前偏移的消费处理器数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'processors' => [ + 'description' => '消费处理器信息列表。', 'type' => 'array', - 'items' => [ - 'description' => '返回的标签表结构体。', - '$ref' => '#/components/schemas/MLLabelParam', - ], - ], - 'total' => [ - 'description' => '符合查询条件的数据总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'items' => ['description' => '消费处理器信息。', '$ref' => '#/components/schemas/ConsumeProcessor'], ], ], ], ], ], - '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' => '获取标签列表', - 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出消费处理器', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + '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"}]', ], - 'ListAzureBlobIngestion' => [ - 'summary' => '列出Azure blob文件导入任务', - 'path' => '/azureblobingestions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListConsumerGroup' => [ + 'summary' => '查询指定Logstore的所有消费组。', + 'path' => '/logstores/{logstore}/consumergroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '291245', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'schema' => ['title' => 'Project name', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['title' => 'Logstore name', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '消费组列表。', + 'type' => 'array', + 'items' => ['description' => '消费组结构体。', 'example' => 'test-consumer-group', '$ref' => '#/components/schemas/ConsumerGroup'], + 'example' => '[{\'\'name\'\': \'\'test-consumer-group\'\', \'\'timeout\'\': 30, \'\'order\'\': False}]', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"name\\": \\"test-consumer-group\\",\\n \\"timeout\\": 300,\\n \\"order\\": false\\n }\\n]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询消费组', + 'description' => '### 接口说明'."\n" + ."\n" + .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\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' => '查询仪表盘。', + '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' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], + ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - ], + 'schema' => ['title' => '默认值为 500。', 'description' => '分页查询时，设置的每页行数。最大值为500。默认值为500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '500'], ], [ - 'name' => 'logstore', + 'name' => 'tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', - 'description' => '', + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, + ], + 'required' => false, ], ], + [ + 'name' => 'dashboardName', + 'in' => 'query', + 'schema' => ['description' => '仪表盘名称。', 'type' => 'string', 'required' => false, 'example' => 'dashboard-1609294922657-434834'], + ], + [ + 'name' => 'displayName', + 'in' => 'query', + 'schema' => ['description' => '显示名称', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], ], 'responses' => [ 200 => [ 'headers' => [ - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + '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' => '仪表盘。', 'type' => 'object', 'properties' => [ - 'total' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - ], - 'count' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', + 'dashboards' => [ + 'title' => 'dashboard 的名字列表，对应 dashboardName', + 'description' => '仪表盘的名字列表，对应dashboardName。', + 'type' => 'array', + 'items' => ['description' => '仪表盘的名字列表，对应dashboardName。', 'type' => 'string', 'example' => 'dashboard-1609294922657-434834'], ], - 'results' => [ + 'dashboardItems' => [ + 'description' => '仪表盘。', 'type' => 'array', 'items' => [ - '$ref' => '#/components/schemas/AzureBlobIngestion', - 'description' => '', + 'description' => '仪表盘。', + 'type' => 'object', + 'properties' => [ + 'dashboardName' => ['description' => '仪表盘ID。同一个Project下，仪表盘ID唯一，不可重复。支持模糊查询，例如输入da，会查询出所有以da开头的仪表盘。', 'type' => 'string', 'example' => 'dashboard-1609294922657-434834'], + 'displayName' => ['description' => '仪表盘显示名称。', 'type' => 'string', 'example' => 'data-ingest'], + 'description' => ['description' => '描述', 'type' => 'string', 'example' => 'tablet_ai'], + ], ], - 'description' => '', ], ], - 'description' => 'Schema of Response', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询仪表盘', + 'description' => '### 接口说明'."\n" + ."\n" + .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~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' => [], - ], - 'ListCollectionPolicies' => [ - 'summary' => '列出云产品日志采集的采集规则。', - 'path' => '/collectionpolicy', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + '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' => '列出Project绑定的自定义域名。', + 'path' => '/domains', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '192483', - 'abilityTreeNodes' => [ - 'FEATUREsls9NGCVR', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'productCode', - 'in' => 'query', - 'schema' => [ - 'description' => '产品的编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'oss', - ], - ], - [ - 'name' => 'dataCode', - 'in' => 'query', - 'schema' => [ - 'description' => '日志类型编码。', - 'type' => 'string', - 'required' => false, - 'example' => 'access_log', - ], - ], - [ - 'name' => 'policyName', - 'in' => 'query', - 'schema' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'your_log_policy'."\n", - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '分页查询时，设置的每页行数。默认值为 50，最多返回 100 个 规则信息。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '50', - 'default' => '50', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['title' => 'Project name', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '查询开始行，默认值为 0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => '分页查询开始的位置。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'instanceId', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。如果配置实例ID，则可以根据实例ID反向查询实例命中的规则，必须和productCode、dataCode结合使用。', - 'type' => 'string', - 'required' => false, - 'example' => 'your-test-bucket1'."\n", - ], + 'schema' => ['description' => '分页查询时，设置的每页行数。默认值为500，最大值为500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'centralProject', + 'name' => 'domainName', 'in' => 'query', - 'schema' => [ - 'description' => '中心化转投目的Project。如果配置中心化转投目的Project，则可以根据Project反向查询有多少规则配置了中心化转投到该centralProejct下。', - 'type' => 'string', - 'required' => false, - 'example' => 'your-central-project1', - ], + 'schema' => ['title' => '用于搜索匹配的自定义域名', 'description' => '用于匹配自定义域名，例如`example.com`会匹配到`a.example.com`与`b.example.com`。', 'type' => 'string', 'required' => false, 'example' => 'example.com'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + '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', + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], + 'schema' => [ + 'description' => '请求返回体。', + 'type' => 'object', + 'properties' => [ + 'domains' => [ + 'description' => '域名列表。', + 'type' => 'array', + 'items' => ['description' => '域名。', 'type' => 'string', 'example' => 'example.com'], ], + 'count' => ['description' => '当前页返回的域名数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'total' => ['description' => '域名总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domains\\": [\\n \\"example.com\\"\\n ],\\n \\"count\\": 1,\\n \\"total\\": 1\\n}","type":"json"}]', + 'title' => '查询自定义域名', + 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 目前每个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' => '列出指定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' => ['title' => 'A short description of struct', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '查询开始行，默认值为0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => '单次查询需要获取的日志下载任务数量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'logstore', + 'in' => 'query', + 'schema' => ['description' => 'Logstore名称', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结构体。', + 'description' => '所有的日志下载任务信息。', 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => '总数据条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'currentCount' => [ - 'description' => '当前页数据条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'data' => [ - 'description' => '当前查询条件下按照分页配置返回的规则数据。', + 'total' => ['title' => '总记录数。', 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'count' => ['title' => '当总结果个数大于MaxResults时，用于翻页的token。', 'description' => '当前列出的日志下载任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'results' => [ + 'title' => '数组，返回示例目录。', + 'description' => '数组，返回日志下载任务列表', 'type' => 'array', 'items' => [ - 'description' => '规则详情。', + 'title' => 'DownloadJobItemType', + 'description' => '日志下载任务信息', 'type' => 'object', 'properties' => [ - 'productCode' => [ - 'description' => '产品编码。', - 'type' => 'string', - 'example' => 'oss', - ], - 'dataCode' => [ - 'description' => '日志类型编码。', - 'type' => 'string', - 'example' => 'access_log', - ], - 'policyName' => [ - 'description' => '规则名称。', - 'type' => 'string', - 'example' => 'your_log_policy', - ], - 'enabled' => [ - 'description' => '是否开启。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'policyConfig' => [ - 'description' => '采集规则配置。', + 'description' => ['title' => '描述', 'description' => '日志下载任务描述', 'type' => 'string', 'example' => 'a download job'], + 'configuration' => [ + 'title' => '下载配置', + 'description' => '下载配置', 'type' => 'object', 'properties' => [ - 'resourceMode' => [ - 'description' => '资源采集模式。', - 'type' => 'string', - 'example' => 'all', - ], - 'regions' => [ - 'description' => '实例所属的地域集合。', - 'type' => 'array', - 'items' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - 'instanceIds' => [ - 'description' => '实例ID集合。', - 'type' => 'array', - 'items' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'your-test-bucket1'."\n", - ], - ], - 'resourceTags' => [ - 'description' => '资源标签。', + 'logstore' => ['title' => '源logstore', 'description' => '源logstore', 'type' => 'string', 'example' => 'ali-test-logstore'], + 'fromTime' => ['title' => '起点时间戳（精确到秒）', 'description' => '起点时间戳（精确到秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1722409260'], + 'toTime' => ['title' => '结束时间戳（精确到秒）', 'description' => '结束时间戳（精确到秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1722411060'], + 'query' => ['title' => '查询语句', 'description' => '查询语句', 'type' => 'string', 'example' => '* | select *'], + 'powerSql' => ['title' => '是否启用powerSql', 'description' => '是否启用powerSql', 'type' => 'boolean', 'example' => 'true'], + 'allowInComplete' => ['description' => '允许下载不精确结果', 'type' => 'string', 'example' => 'false'], + 'sink' => [ + 'title' => '导出配置', + 'description' => '日志下载任务配置', 'type' => 'object', - 'example' => '{"tag1":"value1","tag2":"value2"}', - ], - ], - ], - 'centralizeEnabled' => [ - 'description' => '是否开启中心化转投。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'centralizeConfig' => [ - 'description' => '中心化转投配置。', - 'type' => 'object', - 'properties' => [ - 'destRegion' => [ - 'description' => '中心化转投目的地域。', - 'type' => 'string', - 'example' => 'cn-beijing'."\n", - ], - 'destProject' => [ - 'description' => '中心化转投目的项目。', - 'type' => 'string', - 'example' => 'your-sls-project-in-beijing'."\n", - ], - 'destLogstore' => [ - 'description' => '中心化转投目的日志库。', - 'type' => 'string', - 'example' => 'your-sls-logstore-in-beijing'."\n", - ], - 'destTTL' => [ - 'description' => '中心化转投目的存储天数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'resourceDirectory' => [ - 'description' => '资源目录配置, 如有配置，否则为空', - 'type' => 'object', - 'properties' => [ - 'accountGroupType' => [ - 'description' => '在该资源目录下，全选模式all或自定义模式custom', - 'type' => 'string', - 'example' => 'all,custom', - ], - 'members' => [ - 'description' => '当资源目录配置为custom模式时，对应的成员账号列表', - 'type' => 'array', - 'items' => [ - 'description' => '阿里云账号Uid', - 'type' => 'string', - 'example' => '165***********50', + 'properties' => [ + 'compressionType' => ['title' => '压缩格式', 'description' => '压缩格式', 'type' => 'string', 'example' => 'none'], + 'contentType' => ['title' => '下载文件格式', 'description' => '下载文件格式', 'type' => 'string', 'example' => 'csv'], + 'roleArn' => ['title' => '下载使用roleArn', 'description' => '下载使用roleArn', 'type' => 'string', 'example' => 'acs:ram::123456:role/aliyunlogimportossrole'], + 'bucket' => ['title' => '对象存储桶', 'description' => '对象存储桶', 'type' => 'string', 'example' => 'ali-test-oss-bucket'], + 'prefix' => ['description' => '下载到用户oss bucket时的文件前缀', 'type' => 'string', 'example' => 'download/'], + 'type' => ['description' => '固定为AliyunOSS', 'type' => 'string', 'example' => 'AliyunOSS'], ], ], ], ], - 'dataConfig' => [ - 'description' => '当且仅当日志类型为全局日志类型时支持配置，例如productCode为sls时的场景。否则为空。', + 'displayName' => ['title' => '显示名称', 'description' => '显示名称', 'type' => 'string', 'example' => 'download-123'], + 'executionDetails' => [ + 'title' => '执行细节', + 'description' => '执行细节', 'type' => 'object', 'properties' => [ - 'dataRegion' => [ - 'description' => '当且仅当日志类型为全局日志类型时支持的配置，例如productCode为sls时的场景，表示首次配置时全局日志将被采集到对应地域。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'dataProject' => [ - 'description' => '当且仅当日志类型为全局日志类型时有效，例如productCode为sls时的场景，如果为空，表示日志被采集到该账号在特定dataRegion下的默认专属的Project中。', - 'type' => 'string', - 'example' => '""', - ], - ], - ], - 'internalPolicy' => [ - 'description' => '是否是内置规则策略，内置规则不允许修改、删除。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'policyUid' => [ - 'description' => '规则所属的账号阿里云账号Uid，如果该规则由资源目录管理员或者资源目录委派管理员创建，则为其阿里云账号Uid。', - 'type' => 'string', - 'example' => '148***********50', - ], - ], - ], - ], - 'statistics' => [ - 'description' => '当前查询条件下返回的统计数据。', - 'type' => 'array', - 'items' => [ - 'description' => '按照productCode的规则统计结果', - 'type' => 'object', - 'properties' => [ - 'productCode' => [ - 'description' => '产品编码。', - 'type' => 'string', - 'example' => 'oss', - ], - 'policySourceList' => [ - 'description' => '规则来源列表。', - 'type' => 'array', - 'items' => [ - 'description' => '规则来源对象。', - 'type' => 'object', - 'properties' => [ - 'policyUid' => [ - 'description' => '规则所属的账号阿里云账号Uid，如果该规则由资源目录管理员或者资源目录委派管理员创建，则为其阿里云账号Uid。', - 'type' => 'string', - 'example' => '148***********50', - ], - 'policyName' => [ - 'description' => '规则名称', - 'type' => 'string', - 'example' => 'policy_name1_from148', - ], - ], + 'progress' => ['title' => '下载进度', 'description' => '下载进度', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], + 'filePath' => ['title' => '下载结果链接', 'description' => '下载结果链接', 'type' => 'string', 'example' => 'https://sls-downloaded-xxxx.csv.gzip?Expiresxxx'], + 'fileSize' => ['title' => '下载文件大小', 'description' => '下载文件大小', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'executeTime' => ['title' => '下载执行时间', 'description' => '下载执行时间', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'logCount' => ['title' => '下载日志条数', 'description' => '下载日志条数', 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'errorMessage' => ['title' => '下载错误信息', 'description' => '下载错误信息', 'type' => 'string', 'example' => 'timeout'], + 'checkSum' => ['description' => '文件ETag', 'type' => 'string', 'example' => 'ETASFGASDASQWDasd'], + 'notice' => ['description' => '通知信息', 'type' => 'string', 'example' => 'test'], ], ], + 'name' => ['title' => '资源名称', 'description' => '日志下载任务名称', 'type' => 'string', 'example' => 'download-123'], + 'createTime' => ['description' => '日志下载任务创建时间', 'type' => 'string', 'example' => '1722411060'], + 'status' => ['description' => '任务状态', 'type' => 'string', 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR'], ], ], ], @@ -26534,199 +15730,106 @@ ], ], ], - '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' => '列出云产品日志采集的采集规则', - 'description' => '该接口服务地址只能是华东 2（上海）、新加坡、河源专属云汽车合规（cn-heyuan-acdr-1）。', + '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' => '列出日志下载任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'ListConfig' => [ - 'summary' => '调用ListConfig接口查询指定Project下所有的Logtail配置。', - 'path' => '/configs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListDownloadJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListETLs' => [ + 'summary' => '列出 project 下的数据加工任务', + 'path' => '/etls', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '8980', - 'abilityTreeNodes' => [ - 'FEATUREslsYP6SBU', - ], + 'abilityTreeCode' => '203166', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'logstoreName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，设置的每页行数。最大值为500。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => '指定查询返回的数据加工任务数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'configName', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'title' => '可以进行名字匹配', - 'description' => 'Logtail配置名称，用于模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'logtail-config-sample', - ], + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], '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', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'count' => [ - 'description' => '当前页返回的Logtail配置数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'total' => [ - 'description' => '符合查询条件的Logtail配置总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'configs' => [ - 'description' => '当前页返回的Logtail配置列表。', + 'total' => ['description' => 'Project下总的数据加工数量', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'count' => ['description' => '当前返回的数据加工数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'results' => [ + 'description' => '数据加工结果列表', 'type' => 'array', - 'items' => [ - 'description' => '查询出来的Logtail配置列表。', - 'type' => 'string', - 'example' => 'logtail-config-sample', - ], + 'items' => ['description' => '数据加工配置', '$ref' => '#/components/schemas/ETL'], ], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"count\\": 3,\\n \\"total\\": 2,\\n \\"configs\\": [\\n \\"logtail-config-sample\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '查询Logtail配置列表', - 'description' => '### 接口说明'."\n" - ."\n" - .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理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~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"etl-20240426\\",\\n \\"description\\": \\"加工作业\\",\\n \\"displayName\\": \\"etljob\\",\\n \\"configuration\\": {\\n \\"script\\": \\"* | extend 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' => '列出数据加工任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -26735,145 +15838,73 @@ [ 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:ListConfig', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], + 'action' => 'log:ListETLs', + 'authLevel' => 'operate', + 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], - 'ListConsumeProcessors' => [ - 'summary' => '列出符合参数条件的消费处理器。', - 'path' => '/consumeprocessors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListElasticsearchIngestions' => [ + 'path' => '/elasticsearchingestions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '225118', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeCode' => '273942', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], - ], - [ - 'name' => 'processorName', - 'in' => 'query', - 'schema' => [ - 'description' => '消费处理器标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'consume-processor-1', - ], + 'schema' => ['description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'displayName', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '消费处理器显示名称', - 'type' => 'string', - 'required' => false, - 'example' => 'filter-get-request', - ], + 'schema' => ['description' => '查询开始行。默认值为 0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'offset', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '偏移值，默认为0。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '指定查询数量，默认值为 10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'size', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'description' => '数据条数，默认为200。', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'logstore 名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ @@ -26881,373 +15912,314 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => '符合查询条件的总的消费处理器数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'count' => [ - 'description' => '当前偏移的消费处理器数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'processors' => [ - 'description' => '消费处理器信息列表。', + 'total' => ['description' => '指定 Project 下 ES/OpenSearch 导入任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'count' => ['description' => '当前列出的 ES/OpenSearch 导入任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'results' => [ + 'description' => '具体 ES/OpenSearch 导入任务列表', 'type' => 'array', - 'items' => [ - 'description' => '消费处理器信息。', - '$ref' => '#/components/schemas/ConsumeProcessor', - ], + 'items' => ['description' => 'ES/OpenSearch 导入任务配置', '$ref' => '#/components/schemas/ESIngestion'], ], ], ], ], ], - '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' => '列出消费处理器', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出ES/OpenSearch导入任务', + 'summary' => '列出ES/OpenSearch导入任务', '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"}]', ], - 'ListConsumerGroup' => [ - 'summary' => '查询指定Logstore的所有消费组。', - 'path' => '/logstores/{logstore}/consumergroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListGCSIngestions' => [ + 'summary' => '列出GCP Cloud Storage文件导入任务', + 'path' => '/gcsingestions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project name', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'project 名称。', 'type' => 'string', 'required' => true, 'example' => 'testproject'], + ], + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '返回结果在全部数据集中的偏移位置， 默认为 0 。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'title' => 'Logstore name', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'in' => 'query', + 'schema' => ['description' => 'Logstore 名称', 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], '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' => '消费组列表。', - 'type' => 'array', - 'items' => [ - 'description' => '消费组结构体。', - 'example' => 'test-consumer-group', - '$ref' => '#/components/schemas/ConsumerGroup', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => '符合查询条件的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'count' => ['description' => '当前页返回的任务个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'results' => [ + 'description' => '任务配置详细', + 'type' => 'array', + 'items' => ['description' => '任务配置详细', '$ref' => '#/components/schemas/GCSIngestion'], + ], ], - 'example' => '[{\'\'name\'\': \'\'test-consumer-group\'\', \'\'timeout\'\': 30, \'\'order\'\': False}]', ], ], ], - 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"name\\": \\"test-consumer-group\\",\\n \\"timeout\\": 300,\\n \\"order\\": false\\n }\\n]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '查询消费组', - 'description' => '### 接口说明'."\n" - ."\n" - .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\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", + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出gcs导入任务', '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/*', - ], - ], - ], - ], - ], + '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\\": 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 \\"tagPackId\\": true,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"format\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"lastModifiedTime\\": 1714360581\\n }\\n ]\\n}","type":"json"}]', ], - 'ListDashboard' => [ - 'summary' => '查询仪表盘。', - 'path' => '/dashboards', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListIngestProcessors' => [ + 'summary' => '列出符合参数条件的写入处理器。', + 'path' => '/ingestprocessors', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '10283', - 'abilityTreeNodes' => [ - 'FEATUREslsHU53H2', - ], + 'abilityTreeCode' => '225111', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'offset', + 'name' => 'processorName', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['title' => '写入处理器标识。', 'description' => '写入处理器标识。', 'type' => 'string', 'required' => false, 'example' => 'parse-nginx-log'], ], [ - 'name' => 'size', + 'name' => 'displayName', 'in' => 'query', - 'schema' => [ - 'title' => '默认值为 500。', - 'description' => '分页查询时，设置的每页行数。最大值为500。默认值为500。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '500', - ], + 'schema' => ['title' => '写入处理器展示名称。', 'description' => '写入处理器展示名称。', 'type' => 'string', 'required' => false, 'example' => 'Parse Nginx log'], ], [ - 'name' => 'tags', + 'name' => 'offset', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '标签信息', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['title' => '偏移值，默认为0。', 'description' => '偏移值，默认为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], ], [ - 'name' => 'dashboardName', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '仪表盘名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'dashboard-1609294922657-434834', - ], + 'schema' => ['title' => '数据条数，默认为200。', 'description' => '数据条数，默认为200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'default' => '200'], ], - [ - 'name' => 'displayName', - 'in' => 'query', + ], + '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' => '显示名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => '符合查询条件的总数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'count' => ['description' => '当前返回数据条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], + 'processors' => [ + 'description' => '满足查询条件的写入处理器列表。', + 'type' => 'array', + 'items' => ['description' => '写入处理器信息。', '$ref' => '#/components/schemas/IngestProcessor'], + ], + ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 5,\\n \\"processors\\": [\\n {\\n \\"processorName\\": \\"ingest-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\",\\n \\"parseFail\\": \\"keep\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n }\\n ]\\n}","type":"json"}]', + 'title' => '列出写入处理器', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListLogStores' => [ + 'summary' => '查询指定Project下所有或匹配的LogStore列表。', + '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' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['title' => '默认值为 500。', 'description' => '分页查询时，设置的每页行数。最大值为500。默认值为200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '500'], + ], + [ + 'name' => 'logstoreName', + 'in' => 'query', + 'schema' => ['description' => 'Logstore名称。支持模糊匹配，例如输入test，则返回名称包含test的Logstore列表。', 'type' => 'string', 'required' => false, 'example' => 'my-logstore'], + ], + [ + 'name' => 'telemetryType', + 'in' => 'query', + 'schema' => ['description' => '要查询的日志类型。取值包括：'."\n" + ."\n" + .'- None：查询所有日志类型。'."\n" + .'- Metrics：查询Metrics类型。', 'type' => 'string', 'required' => false, 'example' => 'None'], + ], + [ + 'name' => 'mode', + 'in' => 'query', + 'schema' => ['description' => '日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。'."\n" + .' - **standard**：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。'."\n" + .' - **query**：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。', 'type' => 'string', 'required' => false, 'example' => 'standard'], + ], + ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ - 'description' => '仪表盘。', + 'title' => '', + 'description' => '返回body', 'type' => 'object', 'properties' => [ - 'dashboards' => [ - 'title' => 'dashboard 的名字列表，对应 dashboardName', - 'description' => '仪表盘的名字列表，对应dashboardName。', - 'type' => 'array', - 'items' => [ - 'description' => '仪表盘的名字列表，对应dashboardName。', - 'type' => 'string', - 'example' => 'dashboard-1609294922657-434834', - ], - ], - 'dashboardItems' => [ - 'description' => '仪表盘。', + 'total' => ['title' => '符合查询条件的logstore总数', 'description' => '符合查询条件的Logstore总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'count' => ['title' => '当前返回行数', 'description' => '当前返回行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'logstores' => [ + 'description' => '满足条件的Logstore列表。', 'type' => 'array', - 'items' => [ - 'description' => '仪表盘。', - 'type' => 'object', - 'properties' => [ - 'dashboardName' => [ - 'description' => '仪表盘ID。同一个Project下，仪表盘ID唯一，不可重复。支持模糊查询，例如输入da，会查询出所有以da开头的仪表盘。', - 'type' => 'string', - 'example' => 'dashboard-1609294922657-434834', - ], - 'displayName' => [ - 'description' => '仪表盘显示名称。', - 'type' => 'string', - 'example' => 'data-ingest', - ], - 'description' => [ - 'description' => '描述', - 'type' => 'string', - 'example' => 'tablet_ai', - ], - ], - ], + 'items' => ['description' => 'Logstore信息。', 'type' => 'string', 'example' => 'test-1,test-2'], + 'example' => '["test-1","test-2"]', ], ], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '查询仪表盘', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"total\\": 2,\\n \\"count\\": 2,\\n \\"logstores\\": [\\n \\"test-1,test-2\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '列出LogStore', 'description' => '### 接口说明'."\n" ."\n" - .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\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" - .'| 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~~)。', @@ -27257,308 +16229,220 @@ ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:ListDashboard', + 'action' => 'log:ListLogStores', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/*'], ], ], ], ], ], - 'ListDatasets' => [ - 'summary' => '查询数据集列表', - 'path' => '/datasets', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListLogtailPipelineConfig' => [ + 'summary' => '列举指定条件下的Logtail流水线配置名称。', + 'path' => '/pipelineconfigs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '296327', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, + 'abilityTreeCode' => '191816', + 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'type' => 'string', - 'description' => 'A short description of struct', - ], + 'schema' => ['title' => 'Project名称', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'name', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['title' => '起始行', 'description' => '起始行', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', 'default' => '0'], ], [ - 'name' => 'offset', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '每页的流水线配置数量', 'description' => '每页的流水线配置数量', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20', 'default' => '500'], ], [ - 'name' => 'size', + 'name' => 'logstoreName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => 'logstore名称', 'description' => 'logstore名称', 'type' => 'string', 'required' => false, 'example' => 'test-logstore'], + ], + [ + 'name' => 'configName', + 'in' => 'query', + 'schema' => ['title' => '流水线配置名称', 'description' => '流水线配置名称', 'type' => 'string', 'required' => false, 'example' => 'logtail-config-sample'], + ], + [ + 'name' => 'configType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['type' => 'string', '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' => 'Schema of Response', + 'title' => '', + 'description' => '', 'type' => 'object', 'properties' => [ - 'total' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - ], - 'count' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - ], - 'datasets' => [ + 'count' => ['title' => '当前页返回的Logtail流水线配置数量', 'description' => '当前页返回的Logtail流水线配置数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'total' => ['title' => '当前Project下的Logtail流水线配置总数', 'description' => '当前Project下的Logtail流水线配置总数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'configs' => [ + 'title' => '当前页返回的Logtail流水线配置列表', + 'description' => '当前页返回的Logtail流水线配置列表', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - 'description' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'createTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'title' => '创建时间', - 'description' => '创建时间', - ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - ], - 'description' => '', - ], - 'description' => '', + 'items' => ['title' => 'Logtail流水线配置名称', 'description' => 'Logtail流水线配置名称', 'type' => 'string', 'example' => 'test_logstore'], ], ], - 'description' => 'Schema of Response', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 10,\\n \\"total\\": 20,\\n \\"configs\\": [\\n \\"test_logstore\\"\\n ]\\n}","type":"json"}]', + 'title' => '罗列Logtail流水线配置', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 0,\\n \\"count\\": 0,\\n \\"datasets\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"updateTime\\": 0\\n }\\n ]\\n}","type":"json"}]', ], - 'ListDomains' => [ - 'summary' => '列出Project绑定的自定义域名。', - 'path' => '/domains', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMachineGroup' => [ + 'summary' => '列出目标Project下的机器组。', + 'path' => '/machinegroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project name', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询开始的位置。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '分页请求的起始位置。默认为0。', 'description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，设置的每页行数。默认值为500，最大值为500。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '分页查询时，设置的每页行数。默认值为2000。', 'description' => '分页查询时，设置的每页行数。最大值为500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '2000'], ], [ - 'name' => 'domainName', + 'name' => 'groupName', 'in' => 'query', - 'schema' => [ - 'title' => '用于搜索匹配的自定义域名', - 'description' => '用于匹配自定义域名，例如`example.com`会匹配到`a.example.com`与`b.example.com`。', - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - ], + 'schema' => ['title' => '可将 groupName 作为 pattern 匹配名称，只会返回匹配的机器组。例如 test 可以匹配机器组 test-group。', 'description' => '机器组名称。用于过滤机器组，支持部分匹配。', 'type' => 'string', 'required' => false, 'example' => 'test-machine-group'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ - 'description' => '请求返回体。', + 'title' => '请求返回体。', + 'description' => '符合查询条件的数据。', 'type' => 'object', 'properties' => [ - 'domains' => [ - 'description' => '域名列表。', + 'count' => ['title' => '当前页返回的机器组数量。', 'description' => '当前页返回的机器组数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'total' => ['title' => '机器组总数量。', 'description' => '符合查询条件的机器组总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'machinegroups' => [ + 'title' => '机器组名称列表。', + 'description' => '符合查询条件的机器组列表。', 'type' => 'array', - 'items' => [ - 'description' => '域名。', - 'type' => 'string', - 'example' => 'example.com', - ], - ], - 'count' => [ - 'description' => '当前页返回的域名数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'total' => [ - 'description' => '域名总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'items' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'example' => 'test-group'], + 'example' => '[ "test-machine-group-1", "test-machine-group-2" ]', ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domains\\": [\\n \\"example.com\\"\\n ],\\n \\"count\\": 1,\\n \\"total\\": 1\\n}","type":"json"}]', - 'title' => '查询自定义域名', - 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 目前每个Project最多只可以绑定一个自定义域名。', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"count\\": 1,\\n \\"total\\": 1,\\n \\"machinegroups\\": [\\n \\"test-group\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询Project下的机器组', + 'description' => '### 接口说明'."\n" + .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + ."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" + .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" + .'| :------------ | :------------ |'."\n" + .'| `log:ListMachineGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*` |', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 500 | InternalServerError | internal server error. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[错误码对照表](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -27567,1595 +16451,746 @@ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:ListDomains', + 'action' => 'log:ListMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*'], ], ], ], ], ], - 'ListDownloadJobs' => [ - 'summary' => '列出指定Project下的日志下载任务。', - 'path' => '/downloadjobs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMachines' => [ + 'summary' => '列出目标机器组中与日志服务连接正常的机器列表。', + 'path' => '/machinegroups/{machineGroup}/machines', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '216707', - 'abilityTreeNodes' => [ - 'FEATUREsls1J4K38', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行，默认值为0。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'name' => 'machineGroup', + 'in' => 'path', + 'schema' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-group'], ], [ - 'name' => 'size', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '单次查询需要获取的日志下载任务数量', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '查询开始行。默认值为0。', 'description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], ], [ - 'name' => 'logstore', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'Logstore名称', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['title' => '分页查询时，设置的每页行数。默认值为2000。', 'description' => '分页查询时，设置的每页行数。默认值为100，最大值为500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '2000'], ], ], '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' => '所有的日志下载任务信息。', + 'description' => '返回的机器信息列表。', 'type' => 'object', 'properties' => [ - 'total' => [ - 'title' => '总记录数。', - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'count' => [ - 'title' => '当总结果个数大于MaxResults时，用于翻页的token。', - 'description' => '当前列出的日志下载任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'results' => [ - 'title' => '数组，返回示例目录。', - 'description' => '数组，返回日志下载任务列表', + 'count' => ['title' => '当前页返回的机器数目。', 'description' => '当前页返回的机器数目。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'total' => ['title' => '机器总数。', 'description' => '机器总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'machines' => [ + 'title' => '返回的机器信息列表。', + 'description' => '返回的机器信息列表。', 'type' => 'array', - 'items' => [ - 'title' => 'DownloadJobItemType', - 'description' => '日志下载任务信息', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'title' => '描述', - 'description' => '日志下载任务描述', - 'type' => 'string', - 'example' => 'a download job', - ], - 'configuration' => [ - 'title' => '下载配置', - 'description' => '下载配置', - 'type' => 'object', - 'properties' => [ - 'logstore' => [ - 'title' => '源logstore', - 'description' => '源logstore', - 'type' => 'string', - 'example' => 'ali-test-logstore', - ], - 'fromTime' => [ - 'title' => '起点时间戳（精确到秒）', - 'description' => '起点时间戳（精确到秒）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1722409260', - ], - 'toTime' => [ - 'title' => '结束时间戳（精确到秒）', - 'description' => '结束时间戳（精确到秒）', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1722411060', - ], - 'query' => [ - 'title' => '查询语句', - 'description' => '查询语句', - 'type' => 'string', - 'example' => '* | select *', - ], - 'powerSql' => [ - 'title' => '是否启用powerSql', - 'description' => '是否启用powerSql', - 'type' => 'boolean', - 'example' => 'true', - ], - 'allowInComplete' => [ - 'description' => '允许下载不精确结果', - 'type' => 'string', - 'example' => 'false', - ], - 'sink' => [ - 'title' => '导出配置', - 'description' => '日志下载任务配置', - 'type' => 'object', - 'properties' => [ - 'compressionType' => [ - 'title' => '压缩格式', - 'description' => '压缩格式', - 'type' => 'string', - 'example' => 'none', - ], - 'contentType' => [ - 'title' => '下载文件格式', - 'description' => '下载文件格式', - 'type' => 'string', - 'example' => 'csv', - ], - 'roleArn' => [ - 'title' => '下载使用roleArn', - 'description' => '下载使用roleArn', - 'type' => 'string', - 'example' => 'acs:ram::123456:role/aliyunlogimportossrole', - ], - 'bucket' => [ - 'title' => '对象存储桶', - 'description' => '对象存储桶', - 'type' => 'string', - 'example' => 'ali-test-oss-bucket', - ], - 'prefix' => [ - 'description' => '下载到用户oss bucket时的文件前缀', - 'type' => 'string', - 'example' => 'download/', - ], - 'type' => [ - 'description' => '固定为AliyunOSS', - 'type' => 'string', - 'example' => 'AliyunOSS', - ], - ], - ], - ], - ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => '显示名称', - 'type' => 'string', - 'example' => 'download-123', - ], - 'executionDetails' => [ - 'title' => '执行细节', - 'description' => '执行细节', - 'type' => 'object', - 'properties' => [ - 'progress' => [ - 'title' => '下载进度', - 'description' => '下载进度', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'filePath' => [ - 'title' => '下载结果链接', - 'description' => '下载结果链接', - 'type' => 'string', - 'example' => 'https://sls-downloaded-xxxx.csv.gzip?Expiresxxx', - ], - 'fileSize' => [ - 'title' => '下载文件大小', - 'description' => '下载文件大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'executeTime' => [ - 'title' => '下载执行时间', - 'description' => '下载执行时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'logCount' => [ - 'title' => '下载日志条数', - 'description' => '下载日志条数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'errorMessage' => [ - 'title' => '下载错误信息', - 'description' => '下载错误信息', - 'type' => 'string', - 'example' => 'timeout', - ], - 'checkSum' => [ - 'description' => '文件ETag', - 'type' => 'string', - 'example' => 'ETASFGASDASQWDasd', - ], - 'notice' => [ - 'description' => '通知信息', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - 'name' => [ - 'title' => '资源名称', - 'description' => '日志下载任务名称', - 'type' => 'string', - 'example' => 'download-123', - ], - 'createTime' => [ - 'description' => '日志下载任务创建时间', - 'type' => 'string', - 'example' => '1722411060', - ], - 'status' => [ - 'description' => '任务状态', - 'type' => 'string', - 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR', - ], - ], - ], + 'items' => ['title' => '机器信息。', 'description' => '机器信息。', 'example' => '[{"ip": "10.***.***.***", "machine-uniqueid": "", "userdefined-id": "", "lastHeartbeatTime": 1447182247},{"ip": "10.***.***.***", "machine-uniqueid": "","userdefined-id": "","lastHeartbeatTime": 1447182246}]', '$ref' => '#/components/schemas/machine'], ], ], ], ], ], - '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' => '列出日志下载任务', + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询机器组中的机器列表', + 'description' => 'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', + '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' => 'list', + 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:ListDownloadJobs', - 'authLevel' => 'operate', - 'actionConditions' => [], + 'action' => 'log:ListMachines', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], ], ], ], ], ], - 'ListETLs' => [ - 'summary' => '列出 project 下的数据加工任务', - 'path' => '/etls', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMaterializedView' => [ + 'path' => '/materializedviews', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '203166', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'riskType' => 'none', + 'abilityTreeCode' => '294478', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], [ - 'name' => 'offset', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], [ - 'name' => 'size', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '指定查询返回的数据加工任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], ], [ - 'name' => 'logstore', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], + '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-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'Project下总的数据加工数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'count' => [ - 'description' => '当前返回的数据加工数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'results' => [ - 'description' => '数据加工结果列表', + 'count' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'total' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'materializedViews' => [ 'type' => 'array', - 'items' => [ - 'description' => '数据加工配置', - '$ref' => '#/components/schemas/ETL', - ], + 'items' => ['type' => 'string', 'description' => ''], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"etl-20240426\\",\\n \\"description\\": \\"加工作业\\",\\n \\"displayName\\": \\"etljob\\",\\n \\"configuration\\": {\\n \\"script\\": \\"* | extend 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' => '列出数据加工任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => '列举物化视图 ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'log:ListETLs', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 0,\\n \\"total\\": 0,\\n \\"materializedViews\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', ], - 'ListIngestProcessors' => [ - 'summary' => '列出符合参数条件的写入处理器。', - 'path' => '/ingestprocessors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListMaterializedViews' => [ + 'summary' => '列举物化视图 ', + 'path' => '/materializedviews', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '225111', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'riskType' => 'none', + 'abilityTreeCode' => '294661', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'processorName', - 'in' => 'query', - 'schema' => [ - 'title' => '写入处理器标识。', - 'description' => '写入处理器标识。', - 'type' => 'string', - 'required' => false, - 'example' => 'parse-nginx-log', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], [ - 'name' => 'displayName', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'title' => '写入处理器展示名称。', - 'description' => '写入处理器展示名称。', - 'type' => 'string', - 'required' => false, - 'example' => '解析Nginx日志', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '偏移值，默认为0。', - 'description' => '偏移值，默认为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '数据条数，默认为200。', - 'description' => '数据条数，默认为200。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '200', - 'default' => '200', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => '符合查询条件的总数据条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'count' => [ - 'description' => '当前返回数据条数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'processors' => [ - 'description' => '满足查询条件的写入处理器列表。', + 'count' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'total' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'materializedViews' => [ 'type' => 'array', - 'items' => [ - 'description' => '写入处理器信息。', - '$ref' => '#/components/schemas/IngestProcessor', - ], + 'items' => ['type' => 'string', 'description' => ''], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 5,\\n \\"processors\\": [\\n {\\n \\"processorName\\": \\"ingest-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\",\\n \\"parseFail\\": \\"keep\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列出写入处理器', + 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 0,\\n \\"total\\": 0,\\n \\"materializedViews\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', ], - 'ListLogStores' => [ - 'summary' => '查询指定Project下所有或匹配的LogStore列表。', - 'path' => '/logstores', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMaxComputeExports' => [ + 'summary' => '列出 MC 投递任务', + 'path' => '/maxcomputeexports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'abilityTreeCode' => '203415', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => '查询开始行，默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '默认值为 500。', - 'description' => '分页查询时，设置的每页行数。最大值为500。默认值为200。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '500', - ], - ], - [ - 'name' => 'logstoreName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Logstore名称。支持模糊匹配，例如输入test，则返回名称包含test的Logstore列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'my-logstore', - ], - ], - [ - 'name' => 'telemetryType', - 'in' => 'query', - 'schema' => [ - 'description' => '要查询的日志类型。取值包括：'."\n" - ."\n" - .'- None：查询所有日志类型。'."\n" - .'- Metrics：查询Metrics类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'None', - ], + 'schema' => ['description' => '指定查询数量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'mode', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'description' => '日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。'."\n" - .' - **standard**：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。'."\n" - .' - **query**：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], + 'schema' => ['description' => 'Logstore名称', 'type' => 'string', 'required' => false, 'example' => 'my-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => '', - 'description' => '返回body', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'title' => '符合查询条件的logstore总数', - 'description' => '符合查询条件的Logstore总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'count' => [ - 'title' => '当前返回行数', - 'description' => '当前返回行数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'logstores' => [ - 'description' => '满足条件的Logstore列表。', + 'total' => ['description' => '指定Project下所有MaxCompute投递任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'count' => ['description' => '当前列出的MaxCompute投递任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'results' => [ + 'description' => '具体MaxCompute投递任务列表', 'type' => 'array', - 'items' => [ - 'description' => 'Logstore信息。', - 'type' => 'string', - 'example' => 'test-1,test-2', - ], - 'example' => '["test-1","test-2"]', + 'items' => ['description' => '任务配置详细', '$ref' => '#/components/schemas/MaxComputeExport'], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"total\\": 2,\\n \\"count\\": 2,\\n \\"logstores\\": [\\n \\"test-1,test-2\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '列出LogStore', - 'description' => '### 接口说明'."\n" - ."\n" - .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + 'title' => '列出MaxCompute投递任务', + 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\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~~)。', + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', '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/*', - ], - ], - ], - ], - ], + 'ramActions' => [], + '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"}]', ], - 'ListLogtailPipelineConfig' => [ - 'summary' => '列举指定条件下的Logtail流水线配置名称。', - 'path' => '/pipelineconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListMetricStores' => [ + 'summary' => '列出日志项目下的时序库，支持按照时序库名称模糊查找。', + 'path' => '/metricstores', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '191816', - 'abilityTreeNodes' => [ - 'FEATUREsls9GTH7Z', - ], + 'abilityTreeCode' => '225690', + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => '日志项目名称', 'description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '起始行', - 'description' => '起始行', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['title' => '查询分页的起始位置', 'description' => '查询分页的起始位置', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '每页的流水线配置数量', - 'description' => '每页的流水线配置数量', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '20', - 'default' => '500', - ], + 'schema' => ['title' => '查询分页的页大小，一次请求最多返回的时序库名称数量', 'description' => '查询分页的页大小，一次请求最多返回的时序库数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'default' => '500'], ], [ - 'name' => 'logstoreName', + 'name' => 'mode', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => 'logstore名称', - 'description' => 'logstore名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test-logstore', - ], + 'schema' => ['title' => '要查询的时序库规格类型，例如 standard', 'description' => '要查询的时序库规格类型，例如 standard', 'type' => 'string', 'required' => false, 'example' => 'standard'], ], [ - 'name' => 'configName', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'title' => '流水线配置名称', - 'description' => '流水线配置名称', - 'type' => 'string', - 'required' => false, - 'example' => 'logtail-config-sample', - ], - ], - [ - 'name' => 'configType', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['title' => '要查询的时序库名称，支持模糊查询', 'description' => '要查询的时序库名称，支持模糊查询，此参数为空或者不传递此参数表示查询所有时序库', 'type' => 'string', 'required' => false, 'example' => 'metric_store'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ - 'title' => '', - 'description' => '', + 'title' => '请求返回的结构体', + 'description' => '返回结构体', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '当前页返回的Logtail流水线配置数量', - 'description' => '当前页返回的Logtail流水线配置数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'total' => [ - 'title' => '当前Project下的Logtail流水线配置总数', - 'description' => '当前Project下的Logtail流水线配置总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'configs' => [ - 'title' => '当前页返回的Logtail流水线配置列表', - 'description' => '当前页返回的Logtail流水线配置列表', + 'count' => ['title' => '此次返回结果中包含的时序库数量', 'description' => '此次返回结果中包含的时序库数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'total' => ['title' => '总共包含的时序库数量', 'description' => '总共包含的时序库数量', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'metricstores' => [ + 'title' => '时序库名称列表，列表中元素为时序库名称', + 'description' => '时序库名称列表，列表中元素为时序库名称', 'type' => 'array', - 'items' => [ - 'title' => 'Logtail流水线配置名称', - 'description' => 'Logtail流水线配置名称', - 'type' => 'string', - 'example' => 'test_logstore', - ], + 'items' => ['title' => '时序库名称', 'description' => '时序库名称', 'type' => 'string', 'example' => 'my_metric_store'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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' => '列出时序库', + 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', + 'changeSet' => [ + ['createdAt' => '2024-09-19T09:31:34.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-28T13:00:54.000Z', 'description' => 'OpenAPI 下线'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 10,\\n \\"total\\": 20,\\n \\"configs\\": [\\n \\"test_logstore\\"\\n ]\\n}","type":"json"}]', - 'title' => '罗列Logtail流水线配置', - 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'ListMachineGroup' => [ - 'summary' => '列出目标Project下的机器组。', - 'path' => '/machinegroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListOSSExports' => [ + 'summary' => '列出指定 Project 下的 OSS 投递任务。', + 'path' => '/ossexports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'abilityTreeCode' => '203471', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n"], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '分页请求的起始位置。默认为0。', - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '查询开始行，默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时，设置的每页行数。默认值为2000。', - 'description' => '分页查询时，设置的每页行数。最大值为500。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '2000', - ], + 'schema' => ['description' => '指定查询数量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'groupName', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'title' => '可将 groupName 作为 pattern 匹配名称，只会返回匹配的机器组。例如 test 可以匹配机器组 test-group。', - 'description' => '机器组名称。用于过滤机器组，支持部分匹配。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-machine-group', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => '请求返回体。', - 'description' => '符合查询条件的数据。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '当前页返回的机器组数量。', - 'description' => '当前页返回的机器组数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'total' => [ - 'title' => '机器组总数量。', - 'description' => '符合查询条件的机器组总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'machinegroups' => [ - 'title' => '机器组名称列表。', - 'description' => '符合查询条件的机器组列表。', + 'total' => ['description' => '指定Project下所有OSS投递任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'count' => ['description' => '当前列出的OSS投递任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'results' => [ + 'description' => '具体OSS投递任务列表', 'type' => 'array', - 'items' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'example' => 'test-group', - ], - 'example' => '[ "test-machine-group-1", "test-machine-group-2" ]', + 'items' => ['description' => '任务配置详细', '$ref' => '#/components/schemas/OSSExport'], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"count\\": 1,\\n \\"total\\": 1,\\n \\"machinegroups\\": [\\n \\"test-group\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '查询Project下的机器组', - 'description' => '### 接口说明'."\n" - .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - ."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" - .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" - .'| :------------ | :------------ |'."\n" - .'| `log:ListMachineGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*` |', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 500 | InternalServerError | internal server error. | 内部服务调用错误。 |'."\n" - ."\n" - .'更多信息，请参见[错误码对照表](~~29013~~)。'."\n", + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出OSS投递任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:ListMachineGroup', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], + 'action' => 'log:ListOSSExports', + 'authLevel' => 'operate', + 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"export-oss-1234567890-123456\\",\\n \\"description\\": \\"my-oss-job\\",\\n \\"displayName\\": \\"my-oss-job\\",\\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\\": true\\n },\\n \\"createTime\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListMachines' => [ - 'summary' => '列出目标机器组中与日志服务连接正常的机器列表。', - 'path' => '/machinegroups/{machineGroup}/machines', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListOSSHDFSExports' => [ + 'path' => '/osshdfsexports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'abilityTreeCode' => '203484', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'machineGroup', - 'in' => 'path', - 'schema' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n"], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '查询开始行。默认值为0。', - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => '查询开始行，默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '分页查询时，设置的每页行数。默认值为2000。', - 'description' => '分页查询时，设置的每页行数。默认值为100，最大值为500。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '2000', - ], + 'schema' => ['description' => '指定查询数量，默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'logstore', + 'in' => 'query', + 'schema' => ['description' => 'logstore名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'description' => '返回的机器信息列表。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '当前页返回的机器数目。', - 'description' => '当前页返回的机器数目。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'total' => [ - 'title' => '机器总数。', - 'description' => '机器总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'machines' => [ - 'title' => '返回的机器信息列表。', - 'description' => '返回的机器信息列表。', + 'total' => ['description' => '指定Project下所有OSS-HDFS投递任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'count' => ['description' => '当前列出的OSS-HDFS投递任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'results' => [ + 'description' => '具体OSS-HDFS投递任务列表', 'type' => 'array', - 'items' => [ - 'title' => '机器信息。', - 'description' => '机器信息。', - 'example' => '[{"ip": "10.***.***.***", "machine-uniqueid": "", "userdefined-id": "", "lastHeartbeatTime": 1447182247},{"ip": "10.***.***.***", "machine-uniqueid": "","userdefined-id": "","lastHeartbeatTime": 1447182246}]', - '$ref' => '#/components/schemas/machine', - ], + 'items' => ['description' => '任务配置详细', '$ref' => '#/components/schemas/OSSExport'], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '查询机器组中的机器列表', - 'description' => 'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', - '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", + 'title' => '列出OSS-HDFS投递任务', + 'summary' => '列出指定 Project 下的 OSS-HDFS 投递任务。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:ListMachines', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], + 'action' => 'log:ListOSSHDFSExports', + 'authLevel' => 'operate', + 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"export-oss-1234567890-123456\\",\\n \\"description\\": \\"my-oss-job\\",\\n \\"displayName\\": \\"my-oss-job\\",\\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\\": true\\n },\\n \\"createTime\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListMaxComputeExports' => [ - 'summary' => '列出 MC 投递任务', - 'path' => '/maxcomputeexports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListOSSIngestions' => [ + 'path' => '/ossingestions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '203415', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'abilityTreeCode' => '203123', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行，默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '指定查询数量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '单次查询需要获取的OSS导入任务数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'."\n"], ], [ 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'description' => 'Logstore名称', - 'type' => 'string', - 'required' => false, - 'example' => 'my-logstore', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ @@ -29163,839 +17198,589 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => '指定Project下所有MaxCompute投递任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'count' => [ - 'description' => '当前列出的MaxCompute投递任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'total' => ['description' => '指定Project下OSS导入任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'count' => ['description' => '当前列出的OSS导入任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'results' => [ - 'description' => '具体MaxCompute投递任务列表', + 'description' => '具体OSS导入任务列表', 'type' => 'array', - 'items' => [ - 'description' => '任务配置详细', - '$ref' => '#/components/schemas/MaxComputeExport', - ], + 'items' => ['description' => 'OSS导入任务配置', '$ref' => '#/components/schemas/OSSIngestion'], ], ], ], ], ], - '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' => '列出MaxCompute投递任务', - 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出OSS导入任务', + 'summary' => '列出指定 Project 下的 OSS 导入任务。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'ListMemoryStores' => [ - 'summary' => '查询scmc数据库列表', - 'path' => '/memorystores', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListOSSIngestions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', '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', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '8912', + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'name' => 'projectName', + 'in' => 'query', + 'schema' => ['description' => 'Project的名称，支持模糊查询。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], [ - 'name' => 'name', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => '查询开始行，默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], + 'schema' => ['title' => '默认值为 500。', 'description' => '分页查询时，设置的每页行数。默认值为100，最多返回500个Project信息。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '500'], ], [ - 'name' => 'offset', + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzf******sxby'], + ], + [ + 'name' => 'fetchQuota', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', + 'description' => '是否获取Project 配额信息', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'false', ], ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => 'Project 描述，用于过滤。', 'type' => 'string', 'required' => false, 'example' => 'abc'], + ], ], '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' => 'Project列表。', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'description' => 'Id of the request', - ], - 'total' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'memoryStores' => [ + 'count' => ['description' => '当前页返回的Project个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'total' => ['description' => '符合查询条件的Project总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'projects' => [ + 'description' => '符合查询条件Project列表。', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'createTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'name' => [ - 'type' => 'string', - 'description' => '', - ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - ], - 'description' => '', - ], - 'description' => '', - ], - 'count' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', + 'items' => ['description' => '符合查询条件Project。', 'example' => '不涉及', '$ref' => '#/components/schemas/project'], + 'example' => 'Not applicable', ], ], - 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '列出Project信息', + 'summary' => '列出符合条件的Project信息。', + 'description' => '### 接口说明'."\n" + .'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', + 'requestParamsDescription' => '请求示例：'."\n" + ."\n" + .'GET /?projectName=ali-test-project&offset=0&size=10 HTTP/1.1'."\n" + .'Host:ali-test-project.cn-hangzhou.log.aliyuncs.com'."\n" + .'Content-Type:application/json', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ParameterInvalid | offset : offset pair is invalid | offset参数取值不合法。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"total\\": 0,\\n \\"memoryStores\\": [\\n {\\n \\"createTime\\": 0,\\n \\"description\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"updateTime\\": 0\\n }\\n ],\\n \\"count\\": 0\\n}","type":"json"}]', - ], - 'ListMetricStores' => [ - 'summary' => '列出日志项目下的时序库，支持按照时序库名称模糊查找。', - 'path' => '/metricstores', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + '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' => [], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '225690', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeCode' => '263587', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '日志项目名称', - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'project名称。', 'type' => 'string', 'required' => false, 'example' => 'testproject'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '查询分页的起始位置', - 'description' => '查询分页的起始位置', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => '返回结果在全部数据集中的偏移位置， 默认为 0 。', 'type' => 'integer', 'required' => false, 'example' => '0', 'format' => 'int32'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '查询分页的页大小，一次请求最多返回的时序库名称数量', - 'description' => '查询分页的页大小，一次请求最多返回的时序库数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'default' => '500', - ], - ], - [ - 'name' => 'mode', - 'in' => 'query', - 'schema' => [ - 'title' => '要查询的时序库规格类型，例如 standard', - 'description' => '要查询的时序库规格类型，例如 standard', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], + 'schema' => ['description' => '分页查询时，设置的每页行数。', 'type' => 'integer', 'required' => false, 'example' => '100', 'format' => 'int32'], ], [ - 'name' => 'name', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'title' => '要查询的时序库名称，支持模糊查询', - 'description' => '要查询的时序库名称，支持模糊查询，此参数为空或者不传递此参数表示查询所有时序库', - 'type' => 'string', - 'required' => false, - 'example' => 'metric_store', - ], + 'schema' => ['description' => 'Logstore名称', 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => '请求返回的结构体', - 'description' => '返回结构体', - 'type' => 'object', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '此次返回结果中包含的时序库数量', - 'description' => '此次返回结果中包含的时序库数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'total' => [ - 'title' => '总共包含的时序库数量', - 'description' => '总共包含的时序库数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'metricstores' => [ - 'title' => '时序库名称列表，列表中元素为时序库名称', - 'description' => '时序库名称列表，列表中元素为时序库名称', + 'total' => ['description' => '符合查询条件的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'count' => ['description' => '当前页返回的任务个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'results' => [ + 'description' => '任务配置详细', 'type' => 'array', - 'items' => [ - 'title' => '时序库名称', - 'description' => '时序库名称', - 'type' => 'string', - 'example' => 'my_metric_store', - ], + 'items' => ['description' => '任务配置详细', '$ref' => '#/components/schemas/S3Ingestion'], ], ], ], ], ], - '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' => '列出时序库', - 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', - 'changeSet' => [ - [ - 'createdAt' => '2024-09-19T09:31:34.000Z', - 'description' => '响应参数发生变更', - ], - [ - 'createdAt' => '2024-08-28T13:00:54.000Z', - 'description' => 'OpenAPI 下线', - ], - ], + 'title' => '列出OSS导入任务', + 'summary' => '列出s3导入任务', + '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\\": true,\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', ], - 'ListOSSExports' => [ - 'summary' => '列出指定 Project 下的 OSS 投递任务。', - 'path' => '/ossexports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSavedSearch' => [ + 'summary' => '查询快速查询列表。', + 'path' => '/savedsearches', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '203471', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行，默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '查询开始行。默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '指定查询数量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => '', - ], + 'schema' => ['title' => '默认值为 500。', 'description' => '分页查询时，设置的每页行数。最大值为500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '500'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + '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', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => '指定Project下所有OSS投递任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'count' => [ - 'description' => '当前列出的OSS投递任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'results' => [ - 'description' => '具体OSS投递任务列表', + 'total' => ['description' => '符合查询条件的快速查询总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'count' => ['description' => '当前页返回的快速查询个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'savedsearchItems' => [ + 'description' => '快速查询列表。', 'type' => 'array', - 'items' => [ - 'description' => '任务配置详细', - '$ref' => '#/components/schemas/OSSExport', - ], + 'items' => ['description' => '快速查询。', 'example' => 'test-1', '$ref' => '#/components/schemas/SavedSearch'], + 'example' => '[ "test-1", "test-2" ]', ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"export-oss-1234567890-123456\\",\\n \\"description\\": \\"my-oss-job\\",\\n \\"displayName\\": \\"my-oss-job\\",\\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\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列出OSS投递任务', + 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询快速查询', + 'description' => '### 接口说明'."\n" + .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" + .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" + .'| :------------ | :------------ |'."\n" + .'| `log:ListSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:ListOSSExports', - 'authLevel' => 'operate', - 'actionConditions' => [], + 'action' => 'log:ListSavedSearch', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*'], ], ], ], ], ], - 'ListOSSHDFSExports' => [ - 'summary' => '列出指定 Project 下的 OSS-HDFS 投递任务。', - 'path' => '/osshdfsexports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListScheduledSQLs' => [ + 'summary' => '列出指定Project下的定时SQL任务。', + 'path' => '/scheduledsqls', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '203484', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '209929', + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行，默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '查询开始行，默认值为0。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '指定查询数量，默认值为10。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '指定查询数量，默认值为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], ], [ 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'description' => 'logstore名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'logstore名称', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => '指定Project下所有OSS-HDFS投递任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'count' => [ - 'description' => '当前列出的OSS-HDFS投递任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'total' => ['description' => 'Project下总的定时SQL任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], + 'count' => ['description' => '当前返回的定时SQL任务数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'results' => [ - 'description' => '具体OSS-HDFS投递任务列表', + 'description' => '定时SQL任务列表', 'type' => 'array', - 'items' => [ - 'description' => '任务配置详细', - '$ref' => '#/components/schemas/OSSExport', - ], + 'items' => ['description' => '定时SQL任务配置', '$ref' => '#/components/schemas/ScheduledSQL'], ], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"export-oss-1234567890-123456\\",\\n \\"description\\": \\"my-oss-job\\",\\n \\"displayName\\": \\"my-oss-job\\",\\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\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列出OSS-HDFS投递任务', + '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\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\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' => '列出定时SQL任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'none', 'ramAction' => [ - 'action' => 'log:ListOSSHDFSExports', + 'action' => 'log:ListScheduledSQLs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], - 'ListOSSIngestions' => [ - 'summary' => '列出指定 Project 下的 OSS 导入任务。', - 'path' => '/ossingestions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListShards' => [ + 'summary' => '列出指定Logstore中所有可用的Shard。', + 'path' => '/logstores/{logstore}/shards', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '203123', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['title' => 'logstore 名称。', 'description' => 'logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], - [ - 'name' => 'size', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '单次查询需要获取的OSS导入任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10'."\n", + 'title' => 'shard 列表。', + 'description' => '返回项目下所有 shard 的列表。', + 'type' => 'array', + 'items' => ['title' => 'shard 结构体。', 'description' => 'shard 结构体。', '$ref' => '#/components/schemas/shard'], ], ], + ], + 'responseDemo' => '[{"type":"json","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]","errorExample":""},{"type":"xml","example":"\\n 0\\n readwrite\\n 0\\n 8000000000000000000000000000000\\n 1453949705\\n","errorExample":""}]', + 'title' => '查询shard列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'logstore', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, + '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}'], + ], ], ], ], - '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', - ], - ], + ], + 'ListStoreViews' => [ + 'summary' => '查询日志项目中的数据集列表。', + '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' => '日志项目名称。', 'type' => 'string', 'required' => true, 'example' => 'example-project'], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => '期望返回的数据集个数， 默认值为 100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => '返回结果在全部数据集中的偏移位置， 默认为 0 。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => '用于模糊搜索的数据集名称。', 'type' => 'string', 'required' => false, 'example' => 'my_storeview'], + ], + [ + 'name' => 'storeType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据集类型，默认不根据类型过滤。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], + 'example' => 'logstore', ], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '数据集列表。', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => '指定Project下OSS导入任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'count' => [ - 'description' => '当前列出的OSS导入任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'results' => [ - 'description' => '具体OSS导入任务列表', + 'count' => ['description' => '返回的数据集个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'total' => ['description' => '日志项目中的数据集总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'storeviews' => [ + 'description' => '数据集名称列表。', 'type' => 'array', - 'items' => [ - 'description' => 'OSS导入任务配置', - '$ref' => '#/components/schemas/OSSIngestion', - ], + 'items' => ['description' => '数据集名称。', 'type' => 'string', 'example' => 'my_storeview'], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\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 \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"Line\\\\\\"}\\"\\n },\\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 }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列出OSS导入任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 100,\\n \\"total\\": 100,\\n \\"storeviews\\": [\\n \\"my_storeview\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询数据集列表', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -30004,111 +17789,88 @@ [ 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:ListOSSIngestions', + 'action' => 'log:ListStoreViews', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], - 'ListProject' => [ - 'summary' => '列出符合条件的Project信息。', - 'path' => '/', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTagResources' => [ + 'summary' => '列出所查询资源的标签列表，可以一次查询多个同类型的资源，也可以按标签键值过滤查询。', + 'path' => '/tags', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '8912', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'projectName', + 'name' => 'resourceType', 'in' => 'query', 'schema' => [ - 'description' => 'Project的名称，支持模糊查询。', + 'title' => '资源类型。目前取值范围：project。', + 'description' => '资源的类型。'."\n" + .'- project：项目。'."\n" + .'- logstore：日志库。'."\n" + .'- dashboard：仪表盘。'."\n" + .'- machinegroup：机器组。'."\n" + .'- logtailconfig：logtail配置。', 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行，默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'title' => '默认值为 500。', - 'description' => '分页查询时，设置的每页行数。默认值为100，最多返回500个Project信息。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '500', + 'required' => true, + 'enumValueTitles' => ['project' => 'project'], + 'example' => 'project', ], ], [ - 'name' => 'resourceGroupId', + 'name' => 'resourceId', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', + 'title' => '查询的资源的 id 列表。resource id 与 tags 应至少存在一个。', + 'description' => '查询的资源ID列表。resourceId与tags应至少存在一个。', + 'type' => 'array', + 'items' => ['title' => 'resource id。', 'description' => '资源ID。以日志库为例，projectName代表项目名称，#为拼接字符，logstore为日志库名称。'."\n" + .'- project：projectName'."\n" + .'- logstore：projectName#logstore'."\n" + .'- dashboard：projectName#dashboard'."\n" + .'- machinegroup：projectName#machinegroup'."\n" + .'- logtailconfig：projectName#logtailconfig', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], 'required' => false, - 'example' => 'rg-aekzf******sxby', + 'maxItems' => 1, ], ], [ - 'name' => 'fetchQuota', + 'name' => 'tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '是否获取Project 配额信息', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', + 'title' => '精确查找时过滤的标签键值对。resource id 与 tags 应至少存在一个。', + 'description' => '精确查询时，用于过滤的标签键值对。resourceId与tags应至少配置一个。'."\n" + ."\n" + .'最多设置20个tag。', + 'type' => 'array', + 'items' => [ + 'description' => '用于过滤查询的标签键值对。', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '精确过滤的标签的键。', 'description' => '查询时用于过滤标签的键，例如key为` "test-key" `时，只会返回绑定了标签键为` "test-key" `的资源。', 'type' => 'string', 'required' => true, 'example' => 'key1'], + 'value' => ['title' => '精确过滤的标签的值。', 'description' => '查询时用于过滤标签的值，当值为null时表示只根据key过滤。', 'type' => 'string', 'required' => false, 'example' => 'value1'], + ], + 'required' => false, ], - 'example' => 'false', + 'required' => false, + 'maxItems' => 20, ], ], ], @@ -30116,90 +17878,65 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'close', - ], - ], - 'Access-Control-Allow-Origin' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '*', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], 'schema' => [ - 'description' => 'Project列表。', + 'title' => 'Schema of Response', + 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ - 'count' => [ - 'description' => '当前页返回的Project个数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'total' => [ - 'description' => '符合查询条件的Project总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'projects' => [ - 'description' => '符合查询条件Project列表。', + 'nextToken' => ['title' => '下一个查询开始Token。', 'description' => '下一个查询开始Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], + 'tagResources' => [ + 'title' => '返回的标签列表。', + 'description' => '返回的标签列表。', 'type' => 'array', 'items' => [ - 'description' => '符合查询条件Project。', - 'example' => '不涉及', - '$ref' => '#/components/schemas/project', + 'title' => '标签。', + 'description' => '绑定了标签的资源。', + 'type' => 'object', + 'properties' => [ + 'resourceId' => ['title' => '资源 id。', 'description' => '资源ID。', 'type' => 'string', 'example' => 'ali-test-project'], + 'resourceType' => ['title' => '资源类型。', 'description' => '资源类型。', 'type' => 'string', 'example' => 'project'], + 'tagKey' => ['title' => '标签的键。', 'description' => '标签的键。', 'type' => 'string', 'example' => 'key1'], + 'tagValue' => ['title' => '标签的值。', 'description' => '标签的值。', 'type' => 'string', 'example' => 'value1'], + ], ], - 'example' => '不涉及', ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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 \\"quota\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"recycleBinEnabled\\": false,\\n \\"location\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '列出Project信息', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"nextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"tagResources\\": [\\n {\\n \\"resourceId\\": \\"ali-test-project\\",\\n \\"resourceType\\": \\"project\\",\\n \\"tagKey\\": \\"key1\\",\\n \\"tagValue\\": \\"value1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '列出资源标签', 'description' => '### 接口说明'."\n" - .'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', - 'requestParamsDescription' => '请求示例：'."\n" ."\n" - .'GET /?projectName=ali-test-project&offset=0&size=10 HTTP/1.1'."\n" - .'Host:ali-test-project.cn-hangzhou.log.aliyuncs.com'."\n" - .'Content-Type:application/json', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ParameterInvalid | offset : offset pair is invalid | offset参数取值不合法。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" + .'- 鉴权规则，请参见[鉴权概览](~~29049~~)。目前支持的资源包括project、logstore、dashboard、machineGroup和logtailConfig。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" + .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" + .'| :------------ | :------------ |'."\n" + .'| `log:ListTagResources` |
不同类型资源对应不同格式。
-`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' => [], @@ -30208,1564 +17945,1080 @@ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:ListProject', + 'action' => 'log:ListTagResources', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], - 'ListS3Ingestions' => [ - 'summary' => '列出s3导入任务', - 'path' => '/s3ingestions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'MergeShard' => [ + 'summary' => '合并相邻位置的读写Shard。', + 'path' => '/logstores/{logstore}/shards/{shard}?action=merge', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '263587', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '155307', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'project名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'testproject', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => '返回结果在全部数据集中的偏移位置， 默认为 0 。', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，设置的每页行数。', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'query', - 'schema' => [ - 'description' => 'Logstore名称', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'shard', + 'in' => 'path', + 'schema' => ['description' => 'Shard ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'total' => [ - 'description' => '符合查询条件的总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'count' => [ - 'description' => '当前页返回的任务个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'results' => [ - 'description' => '任务配置详细', - 'type' => 'array', - 'items' => [ - 'description' => '任务配置详细', - '$ref' => '#/components/schemas/S3Ingestion', - ], - ], - ], + 'description' => 'Shard数据结构。', + 'type' => 'array', + 'items' => ['description' => '包含3个Shard元素组成的数组，第一个Shard为合并之后的Shard，后两个为合并之前的Shard。', '$ref' => '#/components/schemas/shard'], ], ], ], - 'title' => '列出OSS导入任务', + 'responseDemo' => '[{"type":"json","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]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '合并shard', + 'description' => '### 接口说明'."\n" + ."\n" + .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 每个Shard均有范围，为MD5左闭右开区间`[BeginKey,EndKey)`。Shard状态包括readwrite（读写）和readonly（只读），支持分裂和合并Shard。更多信息，请参见[分区（Shard）](~~28976~~)。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~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' => [], - '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\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\n },\\n \\"configuration\\": {\\n \\"awsRegion\\": \\"ap-northeast-1\\",\\n \\"awsAccessKey\\": \\"AKIxxxxxxxxxxYJE\\",\\n \\"awsAccessKeySecret\\": \\"123xxxxxxxxxxfjf\\",\\n \\"bucket\\": \\"s3bucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\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 },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\"\\n }\\n ]\\n}","type":"json"}]', - ], - 'ListSavedSearch' => [ - 'summary' => '查询快速查询列表。', - 'path' => '/savedsearches', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + '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' => '开通日志服务。服务地址只能是华东2（上海）或新加坡。', + 'path' => '/slsservice', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-project', - ], - ], - [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行。默认值为0。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'title' => '默认值为 500。', - 'description' => '分页查询时，设置的每页行数。最大值为500。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '500', - ], - ], + 'operationType' => 'create', + 'abilityTreeCode' => '194669', + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], + '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', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - ], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'total' => [ - 'description' => '符合查询条件的快速查询总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'count' => [ - 'description' => '当前页返回的快速查询个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'savedsearchItems' => [ - 'description' => '快速查询列表。', - 'type' => 'array', - 'items' => [ - 'description' => '快速查询。', - 'example' => 'test-1', - '$ref' => '#/components/schemas/SavedSearch', - ], - 'example' => '[ "test-1", "test-2" ]', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"type":"json","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}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '查询快速查询', - 'description' => '### 接口说明'."\n" - .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '开通日志服务', + 'description' => '该接口需要您已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" - .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" - .'| :------------ | :------------ |'."\n" - .'| `log:ListSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*` |', + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。', + 'requestParamsDescription' => '服务地址只能是华东2（上海）或新加坡。', '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/*', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'ListScheduledSQLs' => [ - 'summary' => '列出指定Project下的定时SQL任务。', - 'path' => '/scheduledsqls', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'PullLogs' => [ + 'summary' => '调用PullLogs接口获取指定游标（Cursor）位置的日志数据。此接口获取的是原始日志，如要查询或分析日志，请使用GetLogsV2接口。', + 'path' => '/logstores/{logStore}/shards/{shardId}?type=log', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => [], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '209929', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238167', + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], + 'autoTest' => false, ], 'parameters' => [ [ 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'in' => 'path', + 'schema' => ['title' => '日志项目。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'offset', + 'name' => 'logStore', + 'in' => 'path', + 'schema' => ['title' => '日志库。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'."\n"], + ], + [ + 'name' => 'shardId', + 'in' => 'path', + 'schema' => ['title' => '日志库的分片 id。', 'description' => '日志库的分片 id。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'cursor', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始行，默认值为0。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '游标，表示从什么位置开始读取数据，相当于起点。', 'description' => '游标，表示从什么位置开始读取数据，相当于起点。', 'type' => 'string', 'required' => true, 'example' => 'MTQ0NzMyOTQwMTEwMjEzMDkwNA'], ], [ - 'name' => 'size', + 'name' => 'count', 'in' => 'query', - 'schema' => [ - 'description' => '指定查询数量，默认值为10。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => '要拉取的日志的 logGroup 的最大数量，最小值为1，最大值为1000。', 'description' => '返回的Loggroup数目，最小值为1，最大值为1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1000'], ], [ - 'name' => 'logstore', + 'name' => 'end_cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'logstore名称', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['title' => '结束游标，表示读取数据到什么地方结束，相当于终点，不包括此位点。', 'description' => '结束游标，表示读取数据到什么地方结束，相当于终点。', 'type' => 'string', 'required' => false, 'example' => 'MTU1NzA1NzQwMTEwMjEzMDkwCg'], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => ['title' => '过滤语句，spl 语法，https://help.aliyun.com/zh/sls/user-guide/spl-overview?spm=a2c4g.11174283.0.i3', 'description' => '过滤语句，spl 语法，请参见[SPL指令](~~2536530~~)', 'type' => 'string', 'required' => false, 'example' => '* | where userId=\'123\''], + ], + [ + 'name' => 'Accept-Encoding', + 'in' => 'header', + 'schema' => ['title' => '期望服务端返回的数据压缩格式，支持 lz4', 'description' => '期望服务端返回的数据压缩格式，支持 lz4', 'type' => 'string', 'required' => false, 'example' => 'lz4'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'x-log-count' => [ + 'schema' => ['title' => '拉取到的日志组 logGroup 的数量', 'type' => 'string'], ], - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - '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' => ['title' => '压缩后的 pb 数据', 'description' => '压缩后的 pb 数据', '$ref' => '#/components/schemas/LogGroupList'], + ], + ], + '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' => '拉取日志', + 'description' => '>目前OpenAPI SDK不支持此接口，请使用[日志服务SDK](~~29063~~)。>'."\n" + ."\n" + .'* 获取日志时必须指定Shard。'."\n" + .'* 目前仅支持读取[Protocol Buffer](~~29055~~)格式数据。'."\n" + .'* 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', + 'requestParamsDescription' => 'PullLogs接口的特有请求头如下所示：'."\n" + ."\n" + .'* Accept：application/x-protobuf'."\n" + .'* Accept-Encoding：lz4'."\n" + ."\n" + .'其中，Accept-Encoding取值包括lz4、deflate或双引号（""）之一。'."\n" + ."\n" + .'**请求示例：** '."\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' => 'PullLogs接口的特有响应元素如下所示：'."\n" + ."\n" + .'* x-log-cursor：当前读取数据下一条Cursor。'."\n" + .'* x-log-end-of-cursor：当前读取数据最后一条Cursor。'."\n" + .'* x-log-count：当前返回数量。'."\n" + ."\n" + .'关于Log Service API的公共响应头，请参见[公共响应头](~~29011~~)。'."\n" + ."\n" + .'响应元素为protobuf格式序列化后的数据（可能经过压缩）。', + 'changeSet' => [ + ['createdAt' => '2024-09-06T05:58:31.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'PutAnnotationData' => [ + 'summary' => '向数据集中存入数据。', + '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' => '数据集唯一标识', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be'], + ], + [ + 'name' => 'annotationdataId', + 'in' => 'query', + 'schema' => ['description' => '数据的唯一标识', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'Project下总的定时SQL任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'count' => [ - 'description' => '当前返回的定时SQL任务数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'results' => [ - 'description' => '定时SQL任务列表', + 'rawLog' => [ + 'description' => '原始日志数据', 'type' => 'array', 'items' => [ - 'description' => '定时SQL任务配置', - '$ref' => '#/components/schemas/ScheduledSQL', + 'description' => '日志数据为 key: value的 map形式', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "time": "1694761550",'."\n" + .' "cnt": "45416",'."\n" + .' "cnt2": "12454"'."\n" + .' }'."\n" + .']', 'description' => '原始日志数据key value都为String'], ], + 'required' => false, ], + 'mlDataParam' => ['description' => '数据的结构体', 'required' => false, '$ref' => '#/components/schemas/MLDataParam'], ], + 'required' => false, ], ], ], - '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\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m\\"\\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' => '列出定时SQL任务', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [ - [ - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'log:ListScheduledSQLs', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + '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'], ], ], ], ], - ], - 'ListShards' => [ - 'summary' => '列出指定Logstore中所有可用的Shard。', - 'path' => '/logstores/{logstore}/shards', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '存储数据', + 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'PutConsumeProcessor' => [ + 'summary' => '创建新的消费处理器或者更新已有的消费处理器', + 'path' => '/consumeprocessors/{processorName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', + 'abilityTreeCode' => '225103', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'logstore', + 'name' => 'processorName', 'in' => 'path', + 'schema' => ['description' => '消费处理器标识。', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', + 'description' => '请求Body', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => '显示名称。', 'type' => 'string', 'required' => true, 'example' => 'filter-get-request'], + 'description' => ['description' => '描述信息', 'type' => 'string', 'required' => false, 'example' => 'Filter only GET requests'], + 'configuration' => ['description' => '消费处理器配置', 'required' => true, '$ref' => '#/components/schemas/ConsumeProcessorConfiguration'], + ], + 'required' => false, ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'shard 列表。', - 'description' => '返回项目下所有 shard 的列表。', - 'type' => 'array', - 'items' => [ - 'title' => 'shard 结构体。', - 'description' => 'shard 结构体。', - '$ref' => '#/components/schemas/shard', + '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' => '[{"type":"json","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]","errorExample":""},{"type":"xml","example":"\\n 0\\n readwrite\\n 0\\n 8000000000000000000000000000000\\n 1453949705\\n","errorExample":""}]', - 'title' => '查询shard列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '创建或修改消费处理器', '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}', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'ListStoreViews' => [ - 'summary' => '查询日志项目中的数据集列表。', - 'path' => '/storeviews', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'PutIngestProcessor' => [ + 'summary' => '创建或修改写入处理器。', + 'path' => '/ingestprocessors/{processorName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '208670', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '225106', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => '日志项目名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - ], + 'schema' => ['title' => 'Project名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => '期望返回的数据集个数， 默认值为 100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'name' => 'processorName', + 'in' => 'path', + 'schema' => ['title' => '写入处理器标识。', 'description' => '写入处理器标识。', 'type' => 'string', 'required' => true, 'example' => 'parse-nginx-log'], ], [ - 'name' => 'offset', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '返回结果在全部数据集中的偏移位置， 默认为 0 。', - 'type' => 'integer', - 'format' => 'int32', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['title' => '写入处理器展示名称。', 'description' => '写入处理器展示名称。', 'type' => 'string', 'required' => true, 'example' => 'Nginx log parsing'], + 'description' => ['title' => '写入处理器描述信息。', 'description' => '写入处理器描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Extract fields from Nginx logs using regex.'], + 'configuration' => ['title' => '写入处理器配置详情。', 'description' => '写入处理器配置详情。', 'required' => true, '$ref' => '#/components/schemas/IngestProcessorConfiguration'], + ], 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '用于模糊搜索的数据集名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'my_storeview', - ], - ], - [ - 'name' => 'storeType', - 'in' => 'query', - 'schema' => [ - 'description' => '数据集类型，默认不根据类型过滤。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'metricstore' => 'metricstore', - 'logstore' => 'logstore', - ], - 'example' => 'logstore', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '数据集列表。', - 'type' => 'object', - 'properties' => [ - 'count' => [ - 'description' => '返回的数据集个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'total' => [ - 'description' => '日志项目中的数据集总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'storeviews' => [ - 'description' => '数据集名称列表。', - 'type' => 'array', - 'items' => [ - 'description' => '数据集名称。', - 'type' => 'string', - 'example' => 'my_storeview', - ], - ], + '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":"{\\n \\"count\\": 100,\\n \\"total\\": 100,\\n \\"storeviews\\": [\\n \\"my_storeview\\"\\n ]\\n}","type":"json"}]', - 'title' => '查询数据集列表', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '创建或修改写入处理器', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'log:ListStoreViews', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'ListTagResources' => [ - 'summary' => '列出所查询资源的标签列表，可以一次查询多个同类型的资源，也可以按标签键值过滤查询。', - 'path' => '/tags', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'PutLogStoreConfig' => [ + 'path' => '/logstores/{logstore}/config', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ - 'name' => 'resourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型。目前取值范围：project。', - 'description' => '资源的类型。'."\n" - .'- project：项目。'."\n" - .'- logstore：日志库。'."\n" - .'- dashboard：仪表盘。'."\n" - .'- machinegroup：机器组。'."\n" - .'- logtailconfig：logtail配置。', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'project' => 'project', - ], - 'example' => 'project', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['title' => 'Project 名称', 'description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'resourceId', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '查询的资源的 id 列表。resource id 与 tags 应至少存在一个。', - 'description' => '查询的资源ID列表。resourceId与tags应至少存在一个。', - 'type' => 'array', - 'items' => [ - 'title' => 'resource id。', - 'description' => '资源ID。以日志库为例，projectName代表项目名称，#为拼接字符，logstore为日志库名称。'."\n" - .'- project：projectName'."\n" - .'- logstore：projectName#logstore'."\n" - .'- dashboard：projectName#dashboard'."\n" - .'- machinegroup：projectName#machinegroup'."\n" - .'- logtailconfig：projectName#logtailconfig', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], - 'required' => false, - 'maxItems' => 1, - ], + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['title' => 'Logstore 名称。', 'description' => 'Logstore 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ - 'name' => 'tags', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '精确查找时过滤的标签键值对。resource id 与 tags 应至少存在一个。', - 'description' => '精确查询时，用于过滤的标签键值对。resourceId与tags应至少配置一个。'."\n" - ."\n" - .'最多设置20个tag。', - 'type' => 'array', - 'items' => [ - 'description' => '用于过滤查询的标签键值对。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '精确过滤的标签的键。', - 'description' => '查询时用于过滤标签的键，例如key为` "test-key" `时，只会返回绑定了标签键为` "test-key" `的资源。', - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '精确过滤的标签的值。', - 'description' => '查询时用于过滤标签的值，当值为null时表示只根据key过滤。', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + 'title' => '请求体。', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'clientIpHeaders' => [ + 'title' => '配置 logstore 写入时提取 IP 地址的来源 header keys。顺序敏感，大小写不敏感。配置后需要打开 logstore 的 appendMeta 记录外网 Ip 来源功能才会生效，将从请求的 Header 中按照配置的 keys 提取 IP，添加到日志 Tag 中。', + 'description' => '配置 logstore 写入时提取 IP 地址的来源 header keys。顺序敏感，大小写不敏感。配置后需要打开 logstore 的 appendMeta 记录外网 Ip 来源功能才会生效，将从请求的 Header 中按照配置的 keys 提取 IP，添加到日志 Tag 中。', + 'type' => 'array', + 'items' => ['description' => '配置 logstore 写入时提取 IP 地址的来源 header key。大小写不敏感，例如 X-Forwarded-For。', 'type' => 'string', 'required' => false, 'example' => 'X-Forwarded-For'], + 'required' => false, ], - 'required' => false, ], 'required' => false, - 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + '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' => '返回结构体。', - 'type' => 'object', - 'properties' => [ - 'nextToken' => [ - 'title' => '下一个查询开始Token。', - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'tagResources' => [ - 'title' => '返回的标签列表。', - 'description' => '返回的标签列表。', - 'type' => 'array', - 'items' => [ - 'title' => '标签。', - 'description' => '绑定了标签的资源。', - 'type' => 'object', - 'properties' => [ - 'resourceId' => [ - 'title' => '资源 id。', - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'ali-test-project', - ], - 'resourceType' => [ - 'title' => '资源类型。', - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'project', - ], - 'tagKey' => [ - 'title' => '标签的键。', - 'description' => '标签的键。', - 'type' => 'string', - 'example' => 'key1', - ], - 'tagValue' => [ - 'title' => '标签的值。', - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'value1', - ], - ], - ], - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"nextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"tagResources\\": [\\n {\\n \\"resourceId\\": \\"ali-test-project\\",\\n \\"resourceType\\": \\"project\\",\\n \\"tagKey\\": \\"key1\\",\\n \\"tagValue\\": \\"value1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '列出资源标签', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新日志库配置', + 'summary' => '修改日志库的配置', 'description' => '### 接口说明'."\n" ."\n" - .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 请求语法中的Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" - .'- 鉴权规则，请参见[鉴权概览](~~29049~~)。目前支持的资源包括project、logstore、dashboard、machineGroup和logtailConfig。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等信息。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" .'### 鉴权资源'."\n" .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" .'| :------------ | :------------ |'."\n" - .'| `log:ListTagResources` |
不同类型资源对应不同格式。
-`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}` |', + .'| `log:PutLogStoreConfig` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', + 'requestParamsDescription' => '该接口访问时，需要至少携带一项配置才能请求成功。', '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}', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'MergeShard' => [ - 'summary' => '合并相邻位置的读写Shard。', - 'path' => '/logstores/{logstore}/shards/{shard}?action=merge', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'PutLogs' => [ + 'summary' => '调用PutLogs接口向指定的Logstore中写入日志数据。', + 'path' => '/logstores/{logstore}/shards/lb', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '155307', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'tenantRelevance' => 'tenant', + 'chargeType' => 'free', + 'abilityTreeCode' => '186129', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', + 'schema' => ['title' => 'Logstore名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], + ], + [ + 'name' => 'x-log-compresstype', + 'in' => 'header', 'schema' => [ - 'description' => 'Logstore名称。', + 'title' => '压缩方式，目前支持 lz4。', + 'description' => '日志压缩类型，目前支持lz4、gzip两种类型。', 'type' => 'string', 'required' => true, - 'example' => 'ali-test-logstore', + 'example' => 'lz4', + 'default' => 'lz4', + 'enum' => ['lz4'], ], ], [ - 'name' => 'shard', - 'in' => 'path', - 'schema' => [ - 'description' => 'Shard ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['title' => '压缩后的 pb 日志数据', 'description' => '压缩后的 pb 日志数据', 'required' => false, '$ref' => '#/components/schemas/LogGroup'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], - ], - 'schema' => [ - 'description' => 'Shard数据结构。', - 'type' => 'array', - 'items' => [ - 'description' => '包含3个Shard元素组成的数组，第一个Shard为合并之后的Shard，后两个为合并之前的Shard。', - '$ref' => '#/components/schemas/shard', + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'responseDemo' => '[{"type":"json","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]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '合并shard', - 'description' => '### 接口说明'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '写入日志', + 'description' => '> - 目前OpenAPI SDK不支持此接口，请使用[日志服务SDK](~~29063~~)。'."\n" + .'* 服务端会对每次PutLogs写入的日志数据做格式检查，只要日志数据中有任何一条日志不符合规范，则整个请求失败且无任何日志数据成功写入。'."\n" + .'* 目前仅支持写入[PB格式](~~29055~~)的日志数据，日志数据以LogGroup的形式展示。'."\n" + .'* 日志数据写入时有两种模式：'."\n" + .' * **负载均衡模式（LoadBalance）**：自动根据Logstore下所有可写的Shard进行负载均衡写入。该方法写入可用性较高，适合不保证顺序的数据消费场景。请求语法：'."\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" + .' * **Key路由Shard模式（KeyHash）**：在URL参数中增加Key字段，用来判断数据写入哪个Shard中。该参数为可选参数，不设置时自动切换为负载均衡写入模式。例如，可以将某个生产者（例如instance）根据名称Hash固定到Shard上，这样就能保证写入与消费在该Shard上的数据是严格有序的（在合并、分裂过程中能够严格保证对于Key在一个时间点只会出现在一个Shard上）。请求语法：'."\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" + .'* PutLogs接口每次可以写入的原始日志大小上限为10 MB，日志组中每条日志下的Value部分建议不超过1 MB。历史版本的SDK可能存在不同限制，建议升级到最新的版本解决。'."\n" + .'* 在SDK参考中，日志服务提供Java和Python SDK等PutLogs的使用示例。'."\n" ."\n" - .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 每个Shard均有范围，为MD5左闭右开区间`[BeginKey,EndKey)`。Shard状态包括readwrite（读写）和readonly（只读），支持分裂和合并Shard。更多信息，请参见[分区（Shard）](~~28976~~)。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + .' '."\n" + ."\n\n" + ."\n\n" + .'PB数据 '."\n" + .'-------------------------'."\n" + .'PB格式日志压缩数据字段描述如下。详情请参见[数据模型](~~29054~~)和[数据编码方式](~~29055~~)。'."\n" ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~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" + .'+ Log'."\n" ."\n" - .'更多信息，请参见[错误码对照表](~~29013~~)。', - 'changeSet' => [], + .'| **参数名称** | **数据类型** | **是否必填** | **描述** |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| Time | Integer | 是 | 日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。 |'."\n" + .'| Contents | List | 是 | 日志字段列表，至少包含一个元素，每个元素类型请参见下方Content表格。 |'."\n" + ."\n\n" + .'+ Content'."\n" + ."\n" + .'| **参数名称** | **数据类型** | **是否必填** | **描述** |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| Key | String | 是 | 自定义Key名称。 |'."\n" + .'| Value | String | 是 | 自定义Key对应的值。 |'."\n" + ."\n\n" + .'+ LogTag'."\n" + ."\n" + .'| **参数名称** | **数据类型** | **是否必填** | **描述** |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| Key | String | 是 | 自定义Key名称。 |'."\n" + .'| Value | String | 是 | 自定义Key对应的值。 |'."\n" + ."\n\n" + .'+ LogGroup'."\n" + ."\n" + .'| **参数名称** | **数据类型** | **是否必填** | **描述** |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| Logs | List | 是 | 日志列表，每个元素请参见Log字段表格。 |'."\n" + .'| Topic | String | 否 | 日志主题，用户自定义字段，用于区分不同特征的日志数据。 |'."\n" + .'| Source | String | 否 | 日志的来源。例如产生该日志的机器的IP地址。 |'."\n" + .'| LogTags | List | 是 | 日志的标签列表，每个元素请参见LogTag。 |', + 'requestParamsDescription' => '**请求头**'."\n" + ."\n" + .' 关于Log Service API的公共请求头，请参见[公共请求头](~~29010~~)。'."\n" + ."\n" + .'**请求示例：** '."\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' => '**响应头**'."\n" + ."\n" + .' PutLogs接口无特有响应头。关于Log Service API的公共响应头，请参见[公共响应头](~~29011~~)。'."\n" + ."\n" + .'**响应元素**'."\n" + ."\n" + .' 返回HTTP状态码200，则表示请求成功。该接口调用成功后无任何响应元素。', + 'changeSet' => [ + ['createdAt' => '2024-09-06T05:58:30.000Z', 'description' => '请求参数发生变更'], + ], '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}', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'OpenSlsService' => [ - 'summary' => '开通日志服务。服务地址只能是华东2（上海）或新加坡。', - 'path' => '/slsservice', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'PutProjectPolicy' => [ + 'summary' => '创建Project权限策略（Policy）。', + 'path' => '/policy', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '194669', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', + 'abilityTreeCode' => '157641', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['title' => 'A short description of struct', 'description' => '请求参数，即授权策略。', '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' => 'Project名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [ - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '开通日志服务', - 'description' => '该接口需要您已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '创建Project授权策略', + 'description' => '### 接口说明'."\n" + .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。', - 'requestParamsDescription' => '服务地址只能是华东2（上海）或新加坡。', + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" + .'- Project Policy是阿里云SLS推出的Project授权策略，您可以通过Project Policy授权其他用户访问您指定的SLS资源。'."\n" + ."\n" + .' - 通过策略语法的方式配置Project Policy前，您需要先了解SLS Action、Resource以及Condition分类信息。更多信息，请参见[访问控制RAM](~~128139~~)。'."\n" + ."\n" + .' - 配置Project Policy时，如果授权用户选择了匿名账号（\\*），且不包含Condition的情况下，Project Policy对Project Owner以外的所有用户生效。如果授权用户选择了匿名账号（*），且包含Condition的情况下，Project Policy对包含Project Owner在内的所有用户生效。'."\n" + ."\n" + .' - 您可以添加多条Project Policy，但所有Project Policy的大小不允许超过16 KB。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'PullLogs' => [ - 'summary' => '调用PullLogs接口获取指定游标（Cursor）位置的日志数据。此接口获取的是原始日志，如要查询或分析日志，请使用GetLogsV2接口。', - 'path' => '/logstores/{logStore}/shards/{shardId}?type=log', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:PutProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'PutProjectTransferAcceleration' => [ + 'summary' => '开通或关闭传输加速。', + 'path' => '/transferacceleration', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], + 'consumes' => ['application/json'], 'produces' => [], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '238167', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], - 'autoTest' => false, + 'chargeType' => 'paid', + 'abilityTreeCode' => '205449', + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', - 'in' => 'path', - 'schema' => [ - 'title' => '日志项目。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'in' => 'host', + 'schema' => ['description' => 'project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ - 'name' => 'logStore', - 'in' => 'path', - 'schema' => [ - 'title' => '日志库。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore'."\n", - ], - ], - [ - 'name' => 'shardId', - 'in' => 'path', - 'schema' => [ - 'title' => '日志库的分片 id。', - 'description' => '日志库的分片 id。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'cursor', - 'in' => 'query', - 'schema' => [ - 'title' => '游标，表示从什么位置开始读取数据，相当于起点。', - 'description' => '游标，表示从什么位置开始读取数据，相当于起点。', - 'type' => 'string', - 'required' => true, - 'example' => 'MTQ0NzMyOTQwMTEwMjEzMDkwNA', - ], - ], - [ - 'name' => 'count', - 'in' => 'query', - 'schema' => [ - 'title' => '要拉取的日志的 logGroup 的最大数量，最小值为1，最大值为1000。', - 'description' => '返回的Loggroup数目，最小值为1，最大值为1000。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1000', - ], - ], - [ - 'name' => 'end_cursor', - 'in' => 'query', - 'schema' => [ - 'title' => '结束游标，表示读取数据到什么地方结束，相当于终点，不包括此位点。', - 'description' => '结束游标，表示读取数据到什么地方结束，相当于终点。', - 'type' => 'string', - 'required' => false, - 'example' => 'MTU1NzA1NzQwMTEwMjEzMDkwCg', - ], - ], - [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'title' => '过滤语句，spl 语法，https://help.aliyun.com/zh/sls/user-guide/spl-overview?spm=a2c4g.11174283.0.i3', - 'description' => '过滤语句，spl 语法，请参见[SPL指令](~~2536530~~)', - 'type' => 'string', - 'required' => false, - 'example' => '* | where userId=\'123\'', - ], - ], - [ - 'name' => 'Accept-Encoding', - 'in' => 'header', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '期望服务端返回的数据压缩格式，支持 lz4', - 'description' => '期望服务端返回的数据压缩格式，支持 lz4', - 'type' => 'string', + 'description' => '请求body。', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => '是否开通传输加速。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + ], 'required' => false, - 'example' => 'lz4', ], ], ], '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', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'x-log-cursor-time' => [ - 'schema' => [ - 'title' => 'cursor 的时间戳', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], - 'x-log-end-of-cursor' => [ - 'schema' => [ - 'title' => '是否已经拉取到末尾', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], - 'x-log-compresstype' => [ - 'schema' => [ - 'title' => '返回体的压缩格式', - 'type' => 'string', - ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - 'x-log-bodyrawsize' => [ - 'schema' => [ - 'title' => '返回体压缩前大小，单位为字节', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], - 'schema' => [ - 'title' => '压缩后的 pb 数据', - 'description' => '压缩后的 pb 数据', - '$ref' => '#/components/schemas/LogGroupList', - ], - ], - ], - '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' => '拉取日志', - 'description' => '>目前OpenAPI SDK不支持此接口，请使用[日志服务SDK](~~29063~~)。>'."\n" - ."\n" - .'* 获取日志时必须指定Shard。'."\n" - .'* 目前仅支持读取[Protocol Buffer](~~29055~~)格式数据。'."\n" - .'* 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', - 'requestParamsDescription' => 'PullLogs接口的特有请求头如下所示：'."\n" - ."\n" - .'* Accept：application/x-protobuf'."\n" - .'* Accept-Encoding：lz4'."\n" - ."\n" - .'其中，Accept-Encoding取值包括lz4、deflate或双引号（""）之一。'."\n" - ."\n" - .'**请求示例：** '."\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' => 'PullLogs接口的特有响应元素如下所示：'."\n" - ."\n" - .'* x-log-cursor：当前读取数据下一条Cursor。'."\n" - .'* x-log-end-of-cursor：当前读取数据最后一条Cursor。'."\n" - .'* x-log-count：当前返回数量。'."\n" - ."\n" - .'关于Log Service API的公共响应头，请参见[公共响应头](~~29011~~)。'."\n" - ."\n" - .'响应元素为protobuf格式序列化后的数据（可能经过压缩）。', - 'changeSet' => [ - [ - 'createdAt' => '2024-09-06T05:58:31.000Z', - 'description' => 'OpenAPI 下线', ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '配置传输加速', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'PutAnnotationData' => [ - 'summary' => '向数据集中存入数据。', - 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'PutWebtracking' => [ + 'summary' => '通过 WebTracking 方式单次写入多条日志。', + 'path' => '/logstores/{logstoreName}/track', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AK' => [], + 'Anonymous' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '9127', + 'abilityTreeNodes' => ['FEATUREslsWY5SG2'], ], 'parameters' => [ [ - 'name' => 'datasetId', - 'in' => 'path', - 'schema' => [ - 'description' => '数据集唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'annotationdataId', - 'in' => 'query', - 'schema' => [ - 'description' => '数据的唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => '2156d560fc7c01420542df92cd6365ds', - ], + 'name' => 'logstoreName', + 'in' => 'path', + 'schema' => ['title' => 'A short description of struct', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '请求结构体。', + 'description' => '请求消息体。', 'type' => 'object', 'properties' => [ - 'rawLog' => [ - 'description' => '原始日志数据', + '__topic__' => ['description' => '日志主题。', 'type' => 'string', 'required' => false, 'example' => 'topic'], + '__source__' => ['description' => '日志来源。', 'type' => 'string', 'required' => true, 'example' => 'source'], + '__logs__' => [ + 'description' => '日志内容列表。每个元素为一个JSON对象，表示一条日志。'."\n" + .'> **说明**WebTracking采集的日志时间为日志到达服务端的时间，每条日志中无需设置__time__字段，如果存在该字段，将被服务端使用日志到达的时间覆盖。', 'type' => 'array', 'items' => [ - 'description' => '日志数据为 key: value的 map形式', + 'description' => '日志内容列表。', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "time": "1694761550",'."\n" - .' "cnt": "45416",'."\n" - .' "cnt2": "12454"'."\n" - .' }'."\n" - .']', - 'description' => '原始日志数据key value都为String', - ], + 'additionalProperties' => ['type' => 'string', 'description' => '日志内容。', 'example' => '{ "key1": "value1", "key2": "value2" }'], ], - 'required' => false, + 'required' => true, ], - 'mlDataParam' => [ - 'description' => '数据的结构体', + '__tags__' => [ + 'description' => '日志标签。', + 'type' => 'object', 'required' => false, - '$ref' => '#/components/schemas/MLDataParam', + 'additionalProperties' => ['type' => 'string', 'description' => '日志标签。', 'example' => '{ "tag1": "value1", "tag2": "value2" }'], ], ], - 'required' => false, + 'required' => true, ], ], ], @@ -31773,2735 +19026,1503 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '存储数据', - 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', + 'title' => '通过WebTracking批量写入日志', + 'description' => '### 接口说明'."\n" + ."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" + ."\n" + .'- 适用于在网页或者客户端采集日志的场景。'."\n" + .'- 使用Web Tracking采集日志时，单个请求只能写入一条日志。更多信息，请参见[使用Web Tracking采集日志](~~31752~~)。'."\n" + .'- 针对日志量较大的场景，可以调用PutWebTracking接口将多条日志合并为一次请求。'."\n" + .'- 使用PutWebTracking接口写入日志时，需要先为Logstore打开Web Tracking开关。更多信息，请参见[使用Web Tracking采集日志](~~31752~~)。'."\n" + .'- 该接口不支持同时写入多个Topic的日志数据。'."\n" + .'- 使用该接口则表示该Logstore打开互联网匿名写入权限，没有经过有效鉴权（不需要AccessKey），可能产生脏数据。', + 'requestParamsDescription' => '仅支持如下三个请求头，在调用PutWebTracking接口时前两个为必选，格式和含义请参见公共请求参数文档。'."\n" + ."\n" + .'- x-log-apiversion: 0.6.0'."\n" + .'- x-log-bodyrawsize: 1234'."\n" + .'- x-log-compresstype: lz4'."\n" + ."\n" + .'如果发送的数据没有经过任何压缩，不需要指定x-log-compresstype。如果需要对数据压缩发送，当前仅支持lz4和Deflate算法，其分别对应的请求头为：`x-log-compresstype: lz4`或`x-log-compresstype: deflate`。详细数据压缩步骤，请参见[数据压缩](~~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' => [], ], - 'PutConsumeProcessor' => [ - 'summary' => '创建新的消费处理器或者更新已有的消费处理器', - 'path' => '/consumeprocessors/{processorName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'RefreshToken' => [ + 'summary' => '通过票据刷新访问令牌，用于访问控制台接口。', + 'path' => '/token/refresh', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '225103', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], - ], - [ - 'name' => 'processorName', - 'in' => 'path', - 'schema' => [ - 'description' => '消费处理器标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'consume-processor-1', - ], + 'name' => 'ticket', + 'in' => 'query', + 'schema' => ['description' => '免登录票据。', 'type' => 'string', 'required' => false, 'example' => 'eyJ***************.eyJ******************.KUT****************'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求Body', - 'type' => 'object', - 'properties' => [ - 'displayName' => [ - 'description' => '显示名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'filter-get-request', - ], - 'description' => [ - 'description' => '描述信息', - 'type' => 'string', - 'required' => false, - 'example' => '仅过滤Get请求', - ], - 'configuration' => [ - 'description' => '消费处理器配置', - 'required' => true, - '$ref' => '#/components/schemas/ConsumeProcessorConfiguration', - ], - ], - 'required' => false, - ], + 'name' => 'accessTokenExpirationTime', + 'in' => 'query', + 'schema' => ['description' => '- 访问令牌过期时间（秒），即用户可以访问页面接口的过期时间，默认86400秒（一天），取值0~86400秒（一天）。'."\n" + .'- 访问令牌过期时间是accessTokenExpirationTime、expirationTime的最小值。'."\n" + .'- 若通过STS调用，访问令牌过期时间是accessTokenExpirationTime、expirationTime、STS过期时间的最小值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - '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' => '返回响应的时间。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + ], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'accessToken' => ['title' => 'Id of the request', 'description' => '访问令牌。', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '创建或修改消费处理器', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"accessToken\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', + 'title' => '刷新令牌', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'PutIngestProcessor' => [ - 'summary' => '创建或修改写入处理器。', - 'path' => '/ingestprocessors/{processorName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'RemoveConfigFromMachineGroup' => [ + 'summary' => '从机器组中移除Logtail配置。', + 'path' => '/machinegroups/{machineGroup}/configs/{configName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '225106', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'processorName', + 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '写入处理器标识。', - 'description' => '写入处理器标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'parse-nginx-log', - ], + 'schema' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-group'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'displayName' => [ - 'title' => '写入处理器展示名称。', - 'description' => '写入处理器展示名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'Nginx日志解析', - ], - 'description' => [ - 'title' => '写入处理器描述信息。', - 'description' => '写入处理器描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => '将Nginx日志通过正则解析提取字段。', - ], - 'configuration' => [ - 'title' => '写入处理器配置详情。', - 'description' => '写入处理器配置详情。', - 'required' => true, - '$ref' => '#/components/schemas/IngestProcessorConfiguration', - ], - ], - 'required' => false, - ], + 'name' => 'configName', + 'in' => 'path', + 'schema' => ['title' => 'logtail 配置名称。', 'description' => 'Logtail配置名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logtail'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '创建或修改写入处理器', + 'title' => '删除机器组Logtail配置', + 'description' => 'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', + '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' => [], ], - 'PutLogs' => [ - 'summary' => '调用PutLogs接口向指定的Logstore中写入日志数据。', - 'path' => '/logstores/{logstore}/shards/lb', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SplitShard' => [ + 'summary' => '分裂一个指定的readwrite状态的Shard。', + 'path' => '/logstores/{logstore}/shards/{shard}?action=split', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '186129', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'Logstore名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['title' => 'Logstore 名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'logstorename'], ], [ - 'name' => 'x-log-compresstype', - 'in' => 'header', - 'schema' => [ - 'title' => '压缩方式，目前支持 lz4。', - 'description' => '日志压缩类型，目前支持lz4、gzip两种类型。', - 'type' => 'string', - 'required' => true, - 'example' => 'lz4', - 'default' => 'lz4', - 'enum' => [ - 'lz4', - ], - ], + 'name' => 'shard', + 'in' => 'path', + 'schema' => ['title' => '必须是一个 readwrite 状态的 shard 的 id。', 'description' => 'Shard ID。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'title' => '压缩后的 pb 日志数据', - 'description' => '压缩后的 pb 日志数据', - 'required' => false, - '$ref' => '#/components/schemas/LogGroup', - ], + 'name' => 'key', + 'in' => 'query', + 'schema' => ['title' => '分裂的位置。', 'description' => '分裂位置。', 'type' => 'string', 'required' => false, 'example' => 'ef000000000000000000000000000000'], + ], + [ + 'name' => 'shardCount', + 'in' => 'query', + 'schema' => ['title' => '要分裂成的 shard 数量，默认为 2。', 'description' => 'Shard分裂个数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], + 'schema' => [ + 'title' => '请求成功后，其响应Body中包含3个Shard元素组成的数组，第一个Shard为原Shard，后两个为分裂后的Shard。', + 'description' => '返回的Shard列表。例如Shard数量为2，则返回3个Shard元素组成的数组，第一个Shard为原Shard，后两个为分裂后的Shard。', + 'type' => 'array', + 'items' => ['title' => 'shard 结构体。', 'description' => 'Shard信息。', '$ref' => '#/components/schemas/shard'], + ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '写入日志', - 'description' => '> - 目前OpenAPI SDK不支持此接口，请使用[日志服务SDK](~~29063~~)。'."\n" - .'* 服务端会对每次PutLogs写入的日志数据做格式检查，只要日志数据中有任何一条日志不符合规范，则整个请求失败且无任何日志数据成功写入。'."\n" - .'* 目前仅支持写入[PB格式](~~29055~~)的日志数据，日志数据以LogGroup的形式展示。'."\n" - .'* 日志数据写入时有两种模式：'."\n" - .' * **负载均衡模式（LoadBalance）**：自动根据Logstore下所有可写的Shard进行负载均衡写入。该方法写入可用性较高，适合不保证顺序的数据消费场景。请求语法：'."\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" - .' * **Key路由Shard模式（KeyHash）**：在URL参数中增加Key字段，用来判断数据写入哪个Shard中。该参数为可选参数，不设置时自动切换为负载均衡写入模式。例如，可以将某个生产者（例如instance）根据名称Hash固定到Shard上，这样就能保证写入与消费在该Shard上的数据是严格有序的（在合并、分裂过程中能够严格保证对于Key在一个时间点只会出现在一个Shard上）。请求语法：'."\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" - .'* PutLogs接口每次可以写入的原始日志大小上限为10 MB，日志组中每条日志下的Value部分建议不超过1 MB。历史版本的SDK可能存在不同限制，建议升级到最新的版本解决。'."\n" - .'* 在SDK参考中，日志服务提供Java和Python SDK等PutLogs的使用示例。'."\n" - ."\n" - .' '."\n" - ."\n\n" - ."\n\n" - .'PB数据 '."\n" - .'-------------------------'."\n" - .'PB格式日志压缩数据字段描述如下。详情请参见[数据模型](~~29054~~)和[数据编码方式](~~29055~~)。'."\n" + 'responseDemo' => '[{"type":"json","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]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '分裂Shard', + 'description' => '### 接口说明'."\n" ."\n" - .'+ Log'."\n" + .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" - .'| **参数名称** | **数据类型** | **是否必填** | **描述** |'."\n" - .'| --- | --- | --- | --- |'."\n" - .'| Time | Integer | 是 | 日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。 |'."\n" - .'| Contents | List | 是 | 日志字段列表，至少包含一个元素，每个元素类型请参见下方Content表格。 |'."\n" - ."\n\n" - .'+ Content'."\n" - ."\n" - .'| **参数名称** | **数据类型** | **是否必填** | **描述** |'."\n" - .'| --- | --- | --- | --- |'."\n" - .'| Key | String | 是 | 自定义Key名称。 |'."\n" - .'| Value | String | 是 | 自定义Key对应的值。 |'."\n" - ."\n\n" - .'+ LogTag'."\n" - ."\n" - .'| **参数名称** | **数据类型** | **是否必填** | **描述** |'."\n" - .'| --- | --- | --- | --- |'."\n" - .'| Key | String | 是 | 自定义Key名称。 |'."\n" - .'| Value | String | 是 | 自定义Key对应的值。 |'."\n" - ."\n\n" - .'+ LogGroup'."\n" - ."\n" - .'| **参数名称** | **数据类型** | **是否必填** | **描述** |'."\n" - .'| --- | --- | --- | --- |'."\n" - .'| Logs | List | 是 | 日志列表，每个元素请参见Log字段表格。 |'."\n" - .'| Topic | String | 否 | 日志主题，用户自定义字段，用于区分不同特征的日志数据。 |'."\n" - .'| Source | String | 否 | 日志的来源。例如产生该日志的机器的IP地址。 |'."\n" - .'| LogTags | List | 是 | 日志的标签列表，每个元素请参见LogTag。 |', - 'requestParamsDescription' => '**请求头**'."\n" - ."\n" - .' 关于Log Service API的公共请求头，请参见[公共请求头](~~29010~~)。'."\n" - ."\n" - .'**请求示例：** '."\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' => '**响应头**'."\n" - ."\n" - .' PutLogs接口无特有响应头。关于Log Service API的公共响应头，请参见[公共响应头](~~29011~~)。'."\n" - ."\n" - .'**响应元素**'."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" + .'- 每个Shard均有范围，为MD5左闭右开区间`[BeginKey,EndKey)`。Shard状态包括readwrite（读写）和readonly（只读），支持分裂和合并Shard。更多信息，请参见[分区（Shard）](~~28976~~)。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" + .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" + .'| :------------ | :------------ |'."\n" + .'| `log:SplitShard` | `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 | ParameterInvalid| invalid shard id. | 无效Shard ID。 |'."\n" + .'| 400 | ParameterInvalid| invalid mid hash. | 无效分裂位置参数。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" - .' 返回HTTP状态码200，则表示请求成功。该接口调用成功后无任何响应元素。', - 'changeSet' => [ - [ - 'createdAt' => '2024-09-06T05:58:30.000Z', - 'description' => '请求参数发生变更', - ], - ], + .'更多信息，请参见[错误码对照表](~~29013~~)。', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'PutProjectPolicy' => [ - 'summary' => '创建Project权限策略（Policy）。', - 'path' => '/policy', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + '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', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '157641', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '291253', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '请求参数，即授权策略。', - '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' => 'Project名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], + ], + [ + 'name' => 'azureBlobIngestionName', + 'in' => 'path', + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '创建Project授权策略', - 'description' => '### 接口说明'."\n" - .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" - .'- Project Policy是阿里云SLS推出的Project授权策略，您可以通过Project Policy授权其他用户访问您指定的SLS资源。'."\n" - ."\n" - .' - 通过策略语法的方式配置Project Policy前，您需要先了解SLS Action、Resource以及Condition分类信息。更多信息，请参见[访问控制RAM](~~128139~~)。'."\n" - ."\n" - .' - 配置Project Policy时，如果授权用户选择了匿名账号（\\*），且不包含Condition的情况下，Project Policy对Project Owner以外的所有用户生效。如果授权用户选择了匿名账号（*），且包含Condition的情况下，Project Policy对包含Project Owner在内的所有用户生效。'."\n" - ."\n" - .' - 您可以添加多条Project Policy，但所有Project Policy的大小不允许超过16 KB。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启动AzureBlob导入任务', + 'summary' => '启动AzureBlob导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'create', - 'ramAction' => [ - 'action' => 'log:PutProjectPolicy', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'PutProjectTransferAcceleration' => [ - 'summary' => '开通或关闭传输加速。', - 'path' => '/transferacceleration', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'StartETL' => [ + 'summary' => '启动指定的数据加工任务。', + 'path' => '/etls/{etlName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '205449', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '203160', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求body。', - 'type' => 'object', - 'properties' => [ - 'enabled' => [ - 'description' => '是否开通传输加速。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], - 'required' => false, - ], + 'name' => 'etlName', + 'in' => 'path', + 'schema' => ['description' => '数据加工名称', 'type' => 'string', 'required' => false, 'example' => 'etl-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '配置传输加速', + 'title' => '启动数据加工任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'PutWebtracking' => [ - 'summary' => '通过 WebTracking 方式单次写入多条日志。', - 'path' => '/logstores/{logstoreName}/track', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartElasticsearchIngestion' => [ + 'path' => '/elasticsearchingestions/{elasticsearchIngestionName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'Anonymous' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '9127', - 'abilityTreeNodes' => [ - 'FEATUREslsWY5SG2', - ], + 'abilityTreeCode' => '287660', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'logstoreName', + 'name' => 'elasticsearchIngestionName', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '请求消息体。', - 'type' => 'object', - 'properties' => [ - '__topic__' => [ - 'description' => '日志主题。', - 'type' => 'string', - 'required' => false, - 'example' => 'topic', - ], - '__source__' => [ - 'description' => '日志来源。', - 'type' => 'string', - 'required' => true, - 'example' => 'source', - ], - '__logs__' => [ - 'description' => '日志内容列表。每个元素为一个JSON对象，表示一条日志。'."\n" - .'> **说明**WebTracking采集的日志时间为日志到达服务端的时间，每条日志中无需设置__time__字段，如果存在该字段，将被服务端使用日志到达的时间覆盖。', - 'type' => 'array', - 'items' => [ - 'description' => '日志内容列表。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '日志内容。', - 'example' => '{ "key1": "value1", "key2": "value2" }', - ], - ], - 'required' => true, - ], - '__tags__' => [ - 'description' => '日志标签。', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '日志标签。', - 'example' => '{ "tag1": "value1", "tag2": "value2" }', - ], - ], - ], - 'required' => true, - ], + 'schema' => ['description' => 'ES/OpenSearch 导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '通过WebTracking批量写入日志', - 'description' => '### 接口说明'."\n" - ."\n" - .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" - ."\n" - .'- 适用于在网页或者客户端采集日志的场景。'."\n" - .'- 使用Web Tracking采集日志时，单个请求只能写入一条日志。更多信息，请参见[使用Web Tracking采集日志](~~31752~~)。'."\n" - .'- 针对日志量较大的场景，可以调用PutWebTracking接口将多条日志合并为一次请求。'."\n" - .'- 使用PutWebTracking接口写入日志时，需要先为Logstore打开Web Tracking开关。更多信息，请参见[使用Web Tracking采集日志](~~31752~~)。'."\n" - .'- 该接口不支持同时写入多个Topic的日志数据。'."\n" - .'- 使用该接口则表示该Logstore打开互联网匿名写入权限，没有经过有效鉴权（不需要AccessKey），可能产生脏数据。', - 'requestParamsDescription' => '仅支持如下三个请求头，在调用PutWebTracking接口时前两个为必选，格式和含义请参见公共请求参数文档。'."\n" - ."\n" - .'- x-log-apiversion: 0.6.0'."\n" - .'- x-log-bodyrawsize: 1234'."\n" - .'- x-log-compresstype: lz4'."\n" - ."\n" - .'如果发送的数据没有经过任何压缩，不需要指定x-log-compresstype。如果需要对数据压缩发送，当前仅支持lz4和Deflate算法，其分别对应的请求头为：`x-log-compresstype: lz4`或`x-log-compresstype: deflate`。详细数据压缩步骤，请参见[数据压缩](~~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~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启动ES/OpenSearch导入任务', + 'summary' => '启动ES/OpenSearch导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'RefreshToken' => [ - 'summary' => '通过票据刷新访问令牌，用于访问控制台接口。', - 'path' => '/token/refresh', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'StartGCSIngestion' => [ + 'summary' => '启动GCP Cloud Storage文件导入任务', + 'path' => '/gcsingestions/{gcsIngestionName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ - 'name' => 'ticket', - 'in' => 'query', - 'schema' => [ - 'description' => '免登录票据。', - 'type' => 'string', - 'required' => false, - 'example' => 'eyJ***************.eyJ******************.KUT****************', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'accessTokenExpirationTime', - 'in' => 'query', - 'schema' => [ - 'description' => '- 访问令牌过期时间（秒），即用户可以访问页面接口的过期时间，默认86400秒（一天），取值0~86400秒（一天）。'."\n" - .'- 访问令牌过期时间是accessTokenExpirationTime、expirationTime的最小值。'."\n" - .'- 若通过STS调用，访问令牌过期时间是accessTokenExpirationTime、expirationTime、STS过期时间的最小值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '600', - ], + 'name' => 'gcsIngestionName', + 'in' => 'path', + 'schema' => ['title' => '任务名称', 'description' => 'gcs 导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + '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' => '返回响应的时间。', 'type' => 'string'], ], - ], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'accessToken' => [ - 'title' => 'Id of the request', - 'description' => '访问令牌。', - 'type' => 'string', - 'example' => 'eyJ***************.eyJ******************.KUT****************', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], + 'schema' => ['description' => '响应体', 'type' => 'any', 'example' => '{}'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"accessToken\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', - 'title' => '刷新令牌', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '启动gcs导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', ], - 'RemoveConfigFromMachineGroup' => [ - 'summary' => '从机器组中移除Logtail配置。', - 'path' => '/machinegroups/{machineGroup}/configs/{configName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartMaxComputeExport' => [ + 'path' => '/maxcomputeexports/{mcExportName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', + 'abilityTreeCode' => '203420', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'machineGroup', - 'in' => 'path', - 'schema' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'configName', + 'name' => 'mcExportName', 'in' => 'path', - 'schema' => [ - 'title' => 'logtail 配置名称。', - 'description' => 'Logtail配置名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logtail', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '删除机器组Logtail配置', - 'description' => 'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', - '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" + 'title' => '启动MaxCompute投递任务', + 'summary' => '启动MaxCompute投递任务。', + 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'SearchMemories' => [ - 'summary' => '搜索记忆', - 'path' => '/memorystores/{memoryStore}/search', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'StartOSSExport' => [ + 'summary' => '启动指定的OSS投递任务。', + 'path' => '/ossexports/{ossExportName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'none', + 'abilityTreeCode' => '203474', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n"], ], [ - 'name' => 'memoryStore', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n"], + ], + ], + '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'], + ], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'query' => [ - 'type' => 'string', - ], - 'user_id' => [ - 'type' => 'string', - ], - 'top_k' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'agent_id' => [ - 'type' => 'string', - ], - 'app_id' => [ - 'type' => 'string', - ], - 'run_id' => [ - 'type' => 'string', - ], - 'metadata' => [ - 'type' => 'object', - ], - 'rerank' => [ - 'type' => 'boolean', - ], - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'type' => 'string', - 'backendName' => 'id', - ], - 'memory' => [ - 'type' => 'string', - 'backendName' => 'memory', - ], - 'user_id' => [ - 'type' => 'string', - 'backendName' => 'userId', - ], - 'created_at' => [ - 'type' => 'string', - 'backendName' => 'createdAt', - ], - 'updated_at' => [ - 'type' => 'string', - 'backendName' => 'updatedAt', - ], - 'metadata' => [ - 'type' => 'object', - 'properties' => [ - 'session_id' => [ - 'type' => 'string', - 'backendName' => 'sessionId', - ], - 'timestamp' => [ - 'type' => 'integer', - 'format' => 'int64', - 'backendName' => 'timestamp', - ], - 'updated_by' => [ - 'type' => 'string', - 'backendName' => 'updatedBy', - ], - ], - 'backendName' => 'metadata', - ], - 'categories' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'backendName' => 'categories', - ], - 'immutable' => [ - 'type' => 'boolean', - 'backendName' => 'immutable', - ], - 'expiration_date' => [ - 'type' => 'string', - 'backendName' => 'expirationDate', - ], - ], - ], - 'properties' => [ - 'results' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'actorId' => [ - 'type' => 'string', - ], - 'agentId' => [ - 'type' => 'string', - ], - 'createdAt' => [ - 'type' => 'string', - ], - 'hash' => [ - 'type' => 'string', - ], - 'id' => [ - 'type' => 'string', - ], - 'memory' => [ - 'type' => 'string', - ], - 'metadata' => [ - 'type' => 'object', - ], - 'role' => [ - 'type' => 'string', - ], - 'runId' => [ - 'type' => 'string', - ], - 'score' => [ - 'type' => 'number', - 'format' => 'double', - ], - 'updatedAt' => [ - 'type' => 'string', - ], - 'userId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'relations' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'destination' => [ - 'type' => 'string', - ], - 'relationship' => [ - 'type' => 'string', - ], - 'source' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '启动OSS投递任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"results\\": [\\n {\\n \\"actorId\\": \\"\\",\\n \\"agentId\\": \\"\\",\\n \\"createdAt\\": \\"\\",\\n \\"hash\\": \\"\\",\\n \\"id\\": \\"\\",\\n \\"memory\\": \\"\\",\\n \\"metadata\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"role\\": \\"\\",\\n \\"runId\\": \\"\\",\\n \\"score\\": 0,\\n \\"updatedAt\\": \\"\\",\\n \\"userId\\": \\"\\"\\n }\\n ],\\n \\"relations\\": [\\n {\\n \\"destination\\": \\"\\",\\n \\"relationship\\": \\"\\",\\n \\"source\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'SplitShard' => [ - 'summary' => '分裂一个指定的readwrite状态的Shard。', - 'path' => '/logstores/{logstore}/shards/{shard}?action=split', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartOSSHDFSExport' => [ + 'summary' => '启动指定的OSS-HDFS投递任务。', + 'path' => '/osshdfsexports/{ossExportName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'abilityTreeCode' => '203482', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'title' => 'Logstore 名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'logstorename', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'shard', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'title' => '必须是一个 readwrite 状态的 shard 的 id。', - 'description' => 'Shard ID。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'key', - 'in' => 'query', - 'schema' => [ - 'title' => '分裂的位置。', - 'description' => '分裂位置。', - 'type' => 'string', - 'required' => false, - 'example' => 'ef000000000000000000000000000000', - ], - ], - [ - 'name' => 'shardCount', - 'in' => 'query', - 'schema' => [ - 'title' => '要分裂成的 shard 数量，默认为 2。', - 'description' => 'Shard分裂个数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], - ], - ], - 'schema' => [ - 'title' => '请求成功后，其响应Body中包含3个Shard元素组成的数组，第一个Shard为原Shard，后两个为分裂后的Shard。', - 'description' => '返回的Shard列表。例如Shard数量为2，则返回3个Shard元素组成的数组，第一个Shard为原Shard，后两个为分裂后的Shard。', - 'type' => 'array', - 'items' => [ - 'title' => 'shard 结构体。', - 'description' => 'Shard信息。', - '$ref' => '#/components/schemas/shard', + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"type":"json","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]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => '分裂Shard', - 'description' => '### 接口说明'."\n" - ."\n" - .'- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域、Logstore名称等。如何查询，请参见[管理Project](~~48984~~)和[管理Logstore](~~48990~~)。'."\n" - .'- 每个Shard均有范围，为MD5左闭右开区间`[BeginKey,EndKey)`。Shard状态包括readwrite（读写）和readonly（只读），支持分裂和合并Shard。更多信息，请参见[分区（Shard）](~~28976~~)。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" - .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" - .'| :------------ | :------------ |'."\n" - .'| `log:SplitShard` | `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 | ParameterInvalid| invalid shard id. | 无效Shard ID。 |'."\n" - .'| 400 | ParameterInvalid| invalid mid hash. | 无效分裂位置参数。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" - ."\n" - .'更多信息，请参见[错误码对照表](~~29013~~)。', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '启动OSS-HDFS投递任务', '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}', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'StartAzureBlobIngestion' => [ - 'summary' => '启动Azure blob文件导入任务', - 'path' => '/azureblobingestions/{azureBlobIngestionName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartOSSIngestion' => [ + 'summary' => '启动指定OSS导入任务。', + 'path' => '/ossingestions/{ossIngestionName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '291253', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeCode' => '203141', + 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ - 'name' => 'azureBlobIngestionName', + 'name' => 'ossIngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'OSS导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '启动OSS导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'StartETL' => [ - 'summary' => '启动指定的数据加工任务。', - 'path' => '/etls/{etlName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopAzureBlobIngestion' => [ + 'path' => '/azureblobingestions/{azureBlobIngestionName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203160', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'abilityTreeCode' => '291256', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ - 'name' => 'etlName', + 'name' => 'azureBlobIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => '数据加工名称', - 'type' => 'string', - 'required' => false, - 'example' => 'etl-123456', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '启动数据加工任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止AzureBlob导入任务', + 'summary' => '停止AzureBlob导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'StartMaxComputeExport' => [ - 'summary' => '启动MaxCompute投递任务。', - 'path' => '/maxcomputeexports/{mcExportName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopETL' => [ + 'summary' => '停止指定的数据加工任务。', + 'path' => '/etls/{etlName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203420', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'abilityTreeCode' => '203170', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], [ - 'name' => 'mcExportName', + 'name' => 'etlName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456', - ], + 'schema' => ['description' => '数据加工名称', 'type' => 'string', 'required' => false, 'example' => 'etl-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '启动MaxCompute投递任务', - 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', + 'title' => '停止数据加工任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'StartOSSExport' => [ - 'summary' => '启动指定的OSS投递任务。', - 'path' => '/ossexports/{ossExportName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopElasticsearchIngestion' => [ + 'path' => '/elasticsearchingestions/{elasticsearchIngestionName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https', 'sse'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203474', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '287680', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project'."\n", - ], + 'schema' => ['description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'ossExportName', + 'name' => 'elasticsearchIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456'."\n", - ], + 'schema' => ['description' => 'ES/OpenSearch 导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '启动OSS投递任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止ES/OpenSearch导入任务', + 'summary' => '停止ES/OpenSearch导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'StartOSSHDFSExport' => [ - 'summary' => '启动指定的OSS-HDFS投递任务。', - 'path' => '/osshdfsexports/{ossExportName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopGCSIngestion' => [ + 'summary' => '停止GCP Cloud Storage文件导入任务', + 'path' => '/gcsingestions/{gcsIngestionName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203482', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['title' => '', 'description' => 'Project 名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'ossExportName', + 'name' => 'gcsIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-osshdfs-1234567890-123456'."\n", - ], + 'schema' => ['description' => 'gcs 导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], + 'schema' => ['description' => '响应体', 'type' => 'any', 'example' => '{}'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '启动OSS-HDFS投递任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '停止gcs导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', ], - 'StartOSSIngestion' => [ - 'summary' => '启动指定OSS导入任务。', - 'path' => '/ossingestions/{ossIngestionName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopMaxComputeExport' => [ + 'summary' => '停止MC投递任务。', + 'path' => '/maxcomputeexports/{mcExportName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203141', - 'abilityTreeNodes' => [ - 'FEATUREslsDQM02M', - ], + 'abilityTreeCode' => '203421', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'ossIngestionName', + 'name' => 'mcExportName', 'in' => 'path', - 'schema' => [ - 'description' => 'OSS导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123456', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '启动OSS导入任务', + 'title' => '停止MaxCompute投递任务', + 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'StopAzureBlobIngestion' => [ - 'summary' => '启动Azure blob文件导入任务', - 'path' => '/azureblobingestions/{azureBlobIngestionName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopOSSExport' => [ + 'summary' => '停止指定的OSS投递任务。', + 'path' => '/ossexports/{ossExportName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '291256', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeCode' => '203475', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'azureBlobIngestionName', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '停止OSS投递任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'StopETL' => [ - 'summary' => '停止指定的数据加工任务。', - 'path' => '/etls/{etlName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopOSSHDFSExport' => [ + 'summary' => '停止指定的OSS-HDFS投递任务。', + 'path' => '/osshdfsexports/{ossExportName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203170', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'abilityTreeCode' => '203481', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'etlName', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => '数据加工名称', - 'type' => 'string', - 'required' => false, - 'example' => 'etl-123456', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-123456789-123456'."\n"], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '停止数据加工任务', + 'title' => '停止OSS-HDFS投递任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'StopMaxComputeExport' => [ - 'summary' => '停止MC投递任务。', - 'path' => '/maxcomputeexports/{mcExportName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopOSSIngestion' => [ + 'summary' => '停止指定OSS导入任务。', + 'path' => '/ossingestions/{ossIngestionName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203421', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'abilityTreeCode' => '203142', + 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'mcExportName', + 'name' => 'ossIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456', - ], + 'schema' => ['description' => 'OSS导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '停止MaxCompute投递任务', - 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', + 'title' => '停止OSS导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'StopOSSExport' => [ - 'summary' => '停止指定的OSS投递任务。', - 'path' => '/ossexports/{ossExportName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SubmitAsyncSql' => [ + 'summary' => '提交异步SQL请求。', + 'path' => '/asyncsql', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => [], 'produces' => [], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203475', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '292852', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数', 'type' => 'string', 'required' => false, 'example' => 'sls-demo-project'], ], [ - 'name' => 'ossExportName', - 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456'."\n", - ], + 'name' => 'Accept', + 'in' => 'header', + 'schema' => ['description' => 'accept的数据格式，固定为：application/x-protobuf', 'type' => 'string', 'required' => false, 'example' => 'application/x-protobuf', 'default' => 'application/x-protobuf'], + ], + [ + 'name' => 'Accept-Encoding', + 'in' => 'header', + 'schema' => ['description' => 'accept的压缩格式，可以固定为: lz4', 'type' => 'string', 'required' => false, 'example' => 'lz4', 'default' => 'lz4'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => ['description' => '返回的参数格式（对应protobuf格式）', 'required' => false, '$ref' => '#/components/schemas/SubmitAsyncSqlParams'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], + 'schema' => ['description' => 'body中返回的数据格式（对应protobuf格式）', '$ref' => '#/components/schemas/AsyncSqlResponseData'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '停止OSS投递任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '提交异步SQL请求', + 'responseParamsDescription' => '仅当结果中state为FAILED时，结果集中的error_code和error_message才有意义。', '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"}]', ], - 'StopOSSHDFSExport' => [ - 'summary' => '停止指定的OSS-HDFS投递任务。', - 'path' => '/osshdfsexports/{ossExportName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TagResources' => [ + 'summary' => '为Project绑定标签，每次调用API只能为一个Project绑定标签，可一次绑定多个标签。', + 'path' => '/tag', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '203481', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], - ], - [ - 'name' => 'ossExportName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'resourceType' => ['title' => '资源的类型。目前取值范围：project。', 'description' => '资源的类型。'."\n" + .'- project：项目。'."\n" + .'- logstore：日志库。'."\n" + .'- dashboard：仪表盘。'."\n" + .'- machinegroup：机器组。'."\n" + .'- logtailconfig：logtail配置。', 'type' => 'string', 'required' => true, 'example' => 'project'], + 'resourceId' => [ + 'title' => '资源的 id 列表，可以一次为多个同类型资源打上相同的标签。', + 'description' => '资源的id列表，只允许填入1个资源，只允许为单个资源绑定标签。', + 'type' => 'array', + 'items' => ['title' => '资源的 id。', 'description' => '资源ID。以日志库为例，projectName代表项目名称，#为拼接字符，logstore为日志库名称。'."\n" + .'- project：projectName'."\n" + .'- logstore：projectName#logstore'."\n" + .'- dashboard：projectName#dashboard'."\n" + .'- machinegroup：projectName#machinegroup'."\n" + .'- logtailconfig：projectName#logtailconfig', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], + 'required' => true, + ], + 'tags' => [ + 'title' => '标签列表。', + 'description' => '标签列表。一次最多支持20个标签键值对。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '标签的 key。', 'description' => '标签的键。格式要求如下：'."\n" + ."\n" + .'- 长度在` [1,128] `之间'."\n" + .'- 不允许包含` "http://"`或者` "https://" `字样'."\n" + .'- 不允许以 `"acs:" `或者` "aliyun" `开头', 'type' => 'string', 'required' => true, 'example' => 'key1'], + 'value' => ['title' => '标签的 value。', 'description' => '标签的值。格式要求如下：'."\n" + ."\n" + .'- 长度在` [1,128] `之间'."\n" + .'- 不允许包含` "http://" `或者` "https://" `字样', 'type' => 'string', 'required' => true, 'example' => 'value1'], + ], + 'required' => false, + ], + 'required' => true, + ], + ], 'required' => true, - 'example' => 'export-osshdfs-123456789-123456'."\n", ], ], ], @@ -34509,309 +20530,75 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '停止OSS-HDFS投递任务', + 'title' => '绑定标签', + 'description' => '### 接口说明'."\n" + ."\n" + .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" + .'- 鉴权规则，请参见[鉴权概览](~~29049~~)。目前支持的资源包括project、logstore、dashboard、machineGroup和logtailConfig。'."\n" + .'### 鉴权资源'."\n" + .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" + .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" + .'| :------------ | :------------ |'."\n" + .'| `log:TagResources` |
不同类型资源对应不同格式。
-`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' => [], - ], - 'StopOSSIngestion' => [ - 'summary' => '停止指定OSS导入任务。', - 'path' => '/ossingestions/{ossIngestionName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '203142', - 'abilityTreeNodes' => [ - 'FEATUREslsDQM02M', - ], - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'ossIngestionName', - 'in' => 'path', - 'schema' => [ - 'description' => 'OSS导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123456', - ], - ], - ], - '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' => '停止OSS导入任务', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - 'SubmitAsyncSql' => [ - 'summary' => '提交异步SQL请求。', - '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' => [ - 'title' => '幂等参数', - 'description' => '幂等参数', - 'type' => 'string', - 'required' => false, - 'example' => 'sls-demo-project', - ], - ], - [ - 'name' => 'Accept', - 'in' => 'header', - 'schema' => [ - 'description' => 'accept的数据格式，固定为：application/x-protobuf', - 'type' => 'string', - 'required' => false, - 'example' => 'application/x-protobuf', - 'default' => 'application/x-protobuf', - ], - ], - [ - 'name' => 'Accept-Encoding', - 'in' => 'header', - 'schema' => [ - 'description' => 'accept的压缩格式，可以固定为: lz4', - 'type' => 'string', - 'required' => false, - 'example' => 'lz4', - 'default' => 'lz4', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '返回的参数格式（对应protobuf格式）', - 'required' => false, - '$ref' => '#/components/schemas/SubmitAsyncSqlParams', - ], - ], - ], - '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', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], - 'schema' => [ - 'description' => 'body中返回的数据格式（对应protobuf格式）', - '$ref' => '#/components/schemas/AsyncSqlResponseData', - ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => '提交异步SQL请求', - 'responseParamsDescription' => '仅当结果中state为FAILED时，结果集中的error_code和error_message才有意义。', - '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' => '为Project绑定标签，每次调用API只能为一个Project绑定标签，可一次绑定多个标签。', - 'path' => '/tag', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UntagResources' => [ + 'summary' => '为指定的资源解绑标签，现仅支持日志项目的标签，可以一次性为单个日志项目解绑多个或者全部标签。', + 'path' => '/untag', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'body', @@ -34822,7 +20609,6 @@ 'type' => 'object', 'properties' => [ 'resourceType' => [ - 'title' => '资源的类型。目前取值范围：project。', 'description' => '资源的类型。'."\n" .'- project：项目。'."\n" .'- logstore：日志库。'."\n" @@ -34830,63 +20616,34 @@ .'- machinegroup：机器组。'."\n" .'- logtailconfig：logtail配置。', 'type' => 'string', - 'required' => true, + 'required' => false, + 'enumValueTitles' => ['project' => 'project'], 'example' => 'project', ], 'resourceId' => [ - 'title' => '资源的 id 列表，可以一次为多个同类型资源打上相同的标签。', - 'description' => '资源的id列表，只允许填入1个资源，只允许为单个资源绑定标签。', + 'description' => '资源的ID列表，一次只允许解绑单个资源的标签，只允许填入单个资源ID。', 'type' => 'array', - 'items' => [ - 'title' => '资源的 id。', - 'description' => '资源ID。以日志库为例，projectName代表项目名称，#为拼接字符，logstore为日志库名称。'."\n" - .'- project：projectName'."\n" - .'- logstore：projectName#logstore'."\n" - .'- dashboard：projectName#dashboard'."\n" - .'- machinegroup：projectName#machinegroup'."\n" - .'- logtailconfig：projectName#logtailconfig', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'items' => ['description' => '资源ID。以日志库为例，projectName代表项目名称，#为拼接字符，logstore为日志库名称。'."\n" + .'- project：projectName'."\n" + .'- logstore：projectName#logstore'."\n" + .'- dashboard：projectName#dashboard'."\n" + .'- machinegroup：projectName#machinegroup'."\n" + .'- logtailconfig：projectName#logtailconfig', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], 'required' => true, + 'example' => 'ali-test-project', ], + 'all' => ['description' => '是否解绑所有标签，默认为false。'."\n" + ."\n" + .'- false：仅解绑tags列表中的标签项。'."\n" + .'- true：解绑资源上绑定的所有标签。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], 'tags' => [ - 'title' => '标签列表。', - 'description' => '标签列表。一次最多支持20个标签键值对。', + 'description' => '标签键的列表。当all为false时，仅解绑列表中的标签。', 'type' => 'array', - 'items' => [ - 'description' => '资源标签。', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签的 key。', - 'description' => '标签的键。格式要求如下：'."\n" - ."\n" - .'- 长度在` [1,128] `之间'."\n" - .'- 不允许包含` "http://"`或者` "https://" `字样'."\n" - .'- 不允许以 `"acs:" `或者` "aliyun" `开头', - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '标签的 value。', - 'description' => '标签的值。格式要求如下：'."\n" - ."\n" - .'- 长度在` [1,128] `之间'."\n" - .'- 不允许包含` "http://" `或者` "https://" `字样', - 'type' => 'string', - 'required' => true, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => true, + 'items' => ['description' => '标签的键。', 'type' => 'string', 'required' => false, 'example' => 'key1'], + 'required' => false, ], ], - 'required' => true, + 'required' => false, ], ], ], @@ -34894,114 +20651,80 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '绑定标签', + 'title' => '解绑标签', 'description' => '### 接口说明'."\n" ."\n" .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" ."\n" .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。'."\n" - .'- 鉴权规则，请参见[鉴权概览](~~29049~~)。目前支持的资源包括project、logstore、dashboard、machineGroup和logtailConfig。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。- 鉴权规则，请参见[鉴权概览](~~29049~~)。目前支持的资源包括project、logstore、dashboard、machineGroup和logtailConfig。'."\n" .'### 鉴权资源'."\n" .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" .'| :------------ | :------------ |'."\n" - .'| `log:TagResources` |
不同类型资源对应不同格式。
-`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}`|', + .'| `log:UntagResources` |
不同类型资源对应不同格式。
-`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', + 'operationType' => 'delete', 'ramAction' => [ - 'action' => 'log:TagResources', + 'action' => 'log:UntagResources', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], ], ], - 'UntagResources' => [ - 'summary' => '为指定的资源解绑标签，现仅支持日志项目的标签，可以一次性为单个日志项目解绑多个或者全部标签。', - 'path' => '/untag', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateAgentInstanceConfig' => [ + 'path' => '/agentinstanceconfigs/{configType}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227394', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ @@ -35012,198 +20735,11 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'description' => '资源的类型。'."\n" - .'- project：项目。'."\n" - .'- logstore：日志库。'."\n" - .'- dashboard：仪表盘。'."\n" - .'- machinegroup：机器组。'."\n" - .'- logtailconfig：logtail配置。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'project' => 'project', - ], - 'example' => 'project', - ], - 'resourceId' => [ - 'description' => '资源的ID列表，一次只允许解绑单个资源的标签，只允许填入单个资源ID。', - 'type' => 'array', - 'items' => [ - 'description' => '资源ID。以日志库为例，projectName代表项目名称，#为拼接字符，logstore为日志库名称。'."\n" - .'- project：projectName'."\n" - .'- logstore：projectName#logstore'."\n" - .'- dashboard：projectName#dashboard'."\n" - .'- machinegroup：projectName#machinegroup'."\n" - .'- logtailconfig：projectName#logtailconfig', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], - 'required' => true, - 'example' => 'ali-test-project', - ], - 'all' => [ - 'description' => '是否解绑所有标签，默认为false。'."\n" - ."\n" - .'- false：仅解绑tags列表中的标签项。'."\n" - .'- true：解绑资源上绑定的所有标签。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'tags' => [ - 'description' => '标签键的列表。当all为false时，仅解绑列表中的标签。', - 'type' => 'array', - 'items' => [ - 'description' => '标签的键。', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - ], - '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' => '解绑标签', - 'description' => '### 接口说明'."\n" - ."\n" - .'- 请求语法中Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。- 鉴权规则，请参见[鉴权概览](~~29049~~)。目前支持的资源包括project、logstore、dashboard、machineGroup和logtailConfig。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" - .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" - .'| :------------ | :------------ |'."\n" - .'| `log:UntagResources` |
不同类型资源对应不同格式。
-`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' => [ - 'description' => '请求结构体。', - 'type' => 'object', - 'properties' => [ - 'config' => [ - 'description' => '默认配置', - 'type' => 'string', - 'required' => true, - 'example' => '{}', - ], + 'config' => ['description' => '默认配置', 'type' => 'string', 'required' => true, 'example' => '{}'], 'grayConfigs' => [ 'description' => '灰度配置', 'type' => 'array', - 'items' => [ - 'description' => '灰度配置', - 'required' => false, - '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', - ], + 'items' => ['description' => '灰度配置', 'required' => false, '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs'], 'required' => false, ], ], @@ -35218,19 +20754,8 @@ 'type' => 'string', 'required' => true, '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', + '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', ], 'example' => 'apm_biz_trace', ], @@ -35243,12 +20768,8 @@ 'description' => '进程级配置归属', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '进程级配置归属', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - ], + 'additionalProperties' => ['type' => 'string', 'description' => '进程级配置归属', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"'], ], ], ], @@ -35256,47 +20777,27 @@ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '更新进程级配置', 'summary' => '更新进程级配置', 'changeSet' => [], @@ -35309,51 +20810,32 @@ 'UpdateAlert' => [ 'summary' => '更新指定的告警规则。', 'path' => '/alerts/{alertName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '200217', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'alertName', 'in' => 'path', - 'schema' => [ - 'description' => '告警规则ID', - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456', - ], + 'schema' => ['description' => '告警规则ID', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456'], ], [ 'name' => 'body', @@ -35363,28 +20845,10 @@ 'description' => '更新告警规则的配置', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => '告警显示名称', - 'type' => 'string', - 'required' => true, - 'example' => 'this is alert', - ], - 'description' => [ - 'description' => '告警描述', - 'type' => 'string', - 'required' => false, - 'example' => 'this is description', - ], - 'configuration' => [ - 'description' => '告警详细配置', - 'required' => true, - '$ref' => '#/components/schemas/AlertConfiguration', - ], - 'schedule' => [ - 'description' => '告警调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], + 'displayName' => ['description' => '告警显示名称', 'type' => 'string', 'required' => true, 'example' => 'this is alert'], + 'description' => ['description' => '告警描述', 'type' => 'string', 'required' => false, 'example' => 'this is description'], + 'configuration' => ['description' => '告警详细配置', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration'], + 'schedule' => ['description' => '告警调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], ], 'required' => false, ], @@ -35393,55 +20857,28 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '更新告警规则', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" @@ -35461,111 +20898,64 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateAnnotationDataSet' => [ 'summary' => '更新数据集。', 'path' => '/ml/annotationdataset/{datasetId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'datasetId', 'in' => 'path', - 'schema' => [ - 'description' => '数据集唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => '数据集唯一标识', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '请求数据集结构体。', - 'required' => false, - '$ref' => '#/components/schemas/MLDataSetParam', - ], + 'schema' => ['description' => '请求数据集结构体。', 'required' => false, '$ref' => '#/components/schemas/MLDataSetParam'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新数据集', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -35578,87 +20968,49 @@ 'UpdateAnnotationLabel' => [ 'summary' => '更新标签表。更新标签集，只能更新标签集中标签的命名，其他无法更新。', 'path' => '/ml/annotationlabel', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '请求标签表结构体。', - 'required' => false, - '$ref' => '#/components/schemas/MLLabelParam', - ], + 'schema' => ['description' => '请求标签表结构体。', 'required' => false, '$ref' => '#/components/schemas/MLLabelParam'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新标签', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡。', @@ -35669,51 +21021,33 @@ 'ramActions' => [], ], 'UpdateAzureBlobIngestion' => [ - 'summary' => '更新Azure blob文件导入任务', 'path' => '/azureblobingestions/{azureBlobIngestionName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '291251', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => ''], ], [ 'name' => 'body', @@ -35722,24 +21056,10 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'displayName' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - ], - 'schedule' => [ - '$ref' => '#/components/schemas/Schedule', - 'description' => '', - ], - 'configuration' => [ - 'required' => true, - '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', - 'description' => '', - ], + 'description' => ['type' => 'string', 'description' => ''], + 'displayName' => ['type' => 'string', 'required' => true, 'description' => ''], + 'schedule' => ['$ref' => '#/components/schemas/Schedule', 'description' => ''], + 'configuration' => ['required' => true, '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', 'description' => ''], ], 'description' => '', ], @@ -35749,47 +21069,29 @@ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新AzureBlob导入任务', + 'summary' => '更新AzureBlob导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -35800,21 +21102,14 @@ 'UpdateConfig' => [ 'summary' => '修改指定的 Logtail 采集配置。', 'path' => '/configs/{configName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -35823,85 +21118,45 @@ 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '9091', - 'abilityTreeNodes' => [ - 'FEATUREslsYP6SBU', - ], + 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'description' => 'Logtail配置的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-sample', - ], + 'schema' => ['description' => 'Logtail配置的名称。', 'type' => 'string', 'required' => true, 'example' => 'test-sample'], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '请求消息体。', - 'required' => false, - '$ref' => '#/components/schemas/LogtailConfig', - ], + 'schema' => ['description' => '请求消息体。', 'required' => false, '$ref' => '#/components/schemas/LogtailConfig'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -35940,18 +21195,10 @@ 'action' => 'log:UpdateConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], ], ], ], @@ -35960,57 +21207,33 @@ 'UpdateConsumerGroup' => [ 'summary' => '修改指定消费组属性。', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'logstore-test', - ], + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'logstore-test'], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'description' => '消费组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'consumer-group-1', - ], + 'schema' => ['description' => '消费组名称。', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1'], ], [ 'name' => 'body', @@ -36020,22 +21243,11 @@ 'description' => '请求体参数。order和timeout至少一个有值。', 'type' => 'object', 'properties' => [ - 'order' => [ - 'description' => '是否按顺序消费。'."\n" - ."\n" - .'- true：在Shard中按顺序消费。Shard分裂后，先消费原Shard数据，然后同时消费由该Shard分裂的Shard数据。Shard合并后，先消费原Shard数据，然后消费由原Shard合并后的新Shard数据。'."\n" - .'- false：不按顺序消费。即所有同时开始消费，Shard分裂或者合并后产生的新Shard，也会立即消费。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'timeout' => [ - 'description' => '超时时间。在超时时间段内没有收到心跳，消费者将被删除。单位：秒。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '300', - ], + 'order' => ['description' => '是否按顺序消费。'."\n" + ."\n" + .'- true：在Shard中按顺序消费。Shard分裂后，先消费原Shard数据，然后同时消费由该Shard分裂的Shard数据。Shard合并后，先消费原Shard数据，然后消费由原Shard合并后的新Shard数据。'."\n" + .'- false：不按顺序消费。即所有同时开始消费，Shard分裂或者合并后产生的新Shard，也会立即消费。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'timeout' => ['description' => '超时时间。在超时时间段内没有收到心跳，消费者将被删除。单位：秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300'], ], 'required' => true, ], @@ -36045,46 +21257,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -36123,18 +21311,10 @@ 'action' => 'log:UpdateConsumerGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], @@ -36143,51 +21323,32 @@ 'UpdateDashboard' => [ 'summary' => '更新仪表盘。', 'path' => '/dashboards/{dashboardName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '10279', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'dashboardName', 'in' => 'path', - 'schema' => [ - 'description' => '仪表盘名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], + 'schema' => ['description' => '仪表盘名称。', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], ], [ 'name' => 'body', @@ -36197,47 +21358,21 @@ 'description' => '仪表盘数据结构。', 'type' => 'object', 'properties' => [ - 'dashboardName' => [ - 'title' => '内部名称', - 'description' => '仪表盘名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], - 'displayName' => [ - 'title' => '展示名称', - 'description' => '仪表盘显示名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'Method pv', - ], - 'description' => [ - 'title' => '描述信息', - 'description' => '仪表盘描述信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test dashboard.', - ], + 'dashboardName' => ['title' => '内部名称', 'description' => '仪表盘名称。', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], + 'displayName' => ['title' => '展示名称', 'description' => '仪表盘显示名称。', 'type' => 'string', 'required' => true, 'example' => 'Method pv'], + 'description' => ['title' => '描述信息', 'description' => '仪表盘描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test dashboard.'], 'attribute' => [ 'title' => '属性值', 'description' => '仪表盘属性值。', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '“”', - 'description' => '仪表盘的属性值。', - ], + 'additionalProperties' => ['type' => 'string', 'example' => '“”', 'description' => '仪表盘的属性值。'], ], 'charts' => [ 'title' => '包含的图表', 'description' => '包含的图表。', 'type' => 'array', - 'items' => [ - 'description' => '图表数据结构。', - 'required' => false, - '$ref' => '#/components/schemas/chart', - ], + 'items' => ['description' => '图表数据结构。', 'required' => false, '$ref' => '#/components/schemas/chart'], 'required' => true, ], ], @@ -36249,46 +21384,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -36308,172 +21419,135 @@ 'action' => 'log:UpdateDashboard', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ], ], ], ], ], - 'UpdateDataset' => [ - 'path' => '/datasets/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateETL' => [ + 'summary' => '更新指定的数据加工任务配置并重启', + 'path' => '/etls/{etlName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '296326', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '203169', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'name', + 'name' => 'etlName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => '数据加工名称', 'type' => 'string', 'required' => true, 'example' => 'etl-123456'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => '更新的数据加工配置', 'type' => 'object', 'properties' => [ - 'description' => [ - 'type' => 'string', - 'description' => '', - ], + 'displayName' => ['description' => '数据加工显示名称', 'type' => 'string', 'required' => true, 'example' => 'this is update'], + 'description' => ['description' => '数据加工描述', 'type' => 'string', 'required' => false, 'example' => 'this is description'], + 'configuration' => ['description' => '数据加工详细配置', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration'], ], - 'description' => '', + 'required' => false, ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], + ], + ], + ], ], - 'summary' => '更新数据集', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '更新数据加工任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'UpdateETL' => [ - 'summary' => '更新指定的数据加工任务配置并重启', - 'path' => '/etls/{etlName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateElasticsearchIngestion' => [ + 'path' => '/elasticsearchingestions/{elasticsearchIngestionName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '203169', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'abilityTreeCode' => '287679', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'etlName', + 'name' => 'elasticsearchIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => '数据加工名称', - 'type' => 'string', - 'required' => true, - 'example' => 'etl-123456', - ], + 'schema' => ['description' => 'ES/OpenSearch 导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '更新的数据加工配置', + 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => '数据加工显示名称', - 'type' => 'string', - 'required' => true, - 'example' => 'this is update', - ], - 'description' => [ - 'description' => '数据加工描述', - 'type' => 'string', - 'required' => false, - 'example' => 'this is description', - ], - 'configuration' => [ - 'description' => '数据加工详细配置', - 'required' => true, - '$ref' => '#/components/schemas/ETLConfiguration', - ], + 'description' => ['description' => 'ES/OpenSearch 导入任务描述', 'type' => 'string', 'required' => false, 'example' => 'es ingestion test'], + 'displayName' => ['description' => 'ES/OpenSearch 导入任务展示名称', 'type' => 'string', 'required' => true, 'example' => 'es-ingestion-test'], + 'schedule' => ['description' => '调度类型，一般默认不需要填写。如果有强定时需求，如必须是每周一八点进行一次导入，可使用 cron 形式', 'required' => false, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['description' => 'ES/OpenSearch 导入配置', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration'], ], 'required' => false, ], @@ -36482,161 +21556,174 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '更新数据加工任务', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新ES/OpenSearch导入任务', + 'summary' => '更新ES/OpenSearch导入任务', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'UpdateIndex' => [ - 'path' => '/logstores/{logstore}/index', - 'methods' => [ - 'put', + 'UpdateGCSIngestion' => [ + 'summary' => '更新GCP Cloud Storage文件导入任务', + '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' => ['title' => 'A short description of struct', 'description' => 'Project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'gcsIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'gcs 导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-123455'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'gcs 导入任务描述', 'type' => 'string', 'required' => false, 'example' => 'Gcs import'], + 'displayName' => ['description' => 'gcs 导入任务展示名称', 'type' => 'string', 'required' => true, 'example' => 'Gcs import'], + 'configuration' => ['description' => 'gcs 导入配置', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration'], + ], + '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' => ['description' => '响应体', 'type' => 'any', 'example' => '{}'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新gcs导入任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', + ], + 'UpdateIndex' => [ + 'path' => '/logstores/{logstore}/index', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '8958', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'logstore 名称。', - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['title' => 'logstore 名称。', 'description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', - 'schema' => [ - 'description' => '请求体。', - 'required' => false, - '$ref' => '#/components/schemas/index', - ], + 'schema' => ['description' => '请求体。', 'required' => false, '$ref' => '#/components/schemas/index'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], @@ -36655,51 +21742,32 @@ 'UpdateLogStore' => [ 'summary' => '更新Logstore的属性信息。', 'path' => '/logstores/{logstore}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '115728', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'body', @@ -36709,113 +21777,69 @@ 'description' => '请求体参数。', 'type' => 'object', 'properties' => [ - 'logstoreName' => [ - 'description' => 'Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'shardCount' => [ - 'description' => 'Shard分区个数。'."\n" - ."\n" - .'> 该接口不支持更新分区个数。只能通过SplitShard或MergeShards接口修改分区个数。', - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => true, - 'required' => false, - 'example' => '2', - ], - 'ttl' => [ - 'description' => '数据的保存时间，单位为天。取值范围为1~3650。如果配置为3650，表示永久保存。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '30', - ], - 'encrypt_conf' => [ - 'description' => '加密配置数据结构。', - 'required' => false, - '$ref' => '#/components/schemas/EncryptConf', - ], - 'autoSplit' => [ - 'description' => '是否自动分裂Shard。'."\n" - ."\n" - .'- true：自动分裂Shard。'."\n" - .'- false：不自动分裂Shard。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'enable_tracking' => [ - 'description' => '是否开启WebTracking功能。默认值为false。'."\n" - ."\n" - .'- true：开启WebTracking。'."\n" - .'- false：不开启WebTracking。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'appendMeta' => [ - 'description' => '是否记录外网IP地址功能。默认值为false。'."\n" - ."\n" - .'- true：记录外网IP地址。'."\n" - .'- false：不记录外网IP地址。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'maxSplitShard' => [ - 'description' => '自动分裂时最大的Shard个数，最小值是1，最大值是256。'."\n" - ."\n" - .'> 当autoSplit为true时必须指定。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'telemetryType' => [ - 'description' => '可观测数据类型。取值包括：'."\n" - ."\n" - .'- None：日志数据。默认为日志数据。'."\n" - .'- Metrics：时序数据。', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'None', - ], - 'hot_ttl' => [ - 'title' => '数据在Logstore热存储层中的存储时间，最少为7天。单位：天，取值范围：7~3000。', - 'description' => '数据在Logstore热存储层中的存储时间，最少为7天。单位：天，取值范围：7~3000。'."\n" - .'当数据的存储时间超过您所配置的热存储层数据保存时间后，数据将转为低频存储。更多信息，请参见[智能冷热分层存储](~~308645~~)。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'mode' => [ - 'description' => '日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。'."\n" - ."\n" - .'- **standard**：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。'."\n" - .'- **query**：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。'."\n" - ."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], - 'infrequentAccessTTL' => [ - 'title' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。', - 'description' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'shardingPolicy' => [ - 'title' => '哈希写入配置', - 'description' => '哈希写入配置', - 'required' => false, - '$ref' => '#/components/schemas/ShardingPolicy', - ], + 'logstoreName' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'shardCount' => ['description' => 'Shard分区个数。'."\n" + ."\n" + .'> 该接口不支持更新分区个数。只能通过SplitShard或MergeShards接口修改分区个数。', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '2'], + 'ttl' => ['description' => '数据的保存时间，单位为天。取值范围为1~3650。如果配置为3650，表示永久保存。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30'], + 'encrypt_conf' => ['description' => '加密配置数据结构。默认不开启加密。'."\n" + ."\n" + .'示例1 （开启默认加密配置）：'."\n" + .'```'."\n" + .'{'."\n" + .' "enable": true,'."\n" + .' "encrypt_conf": "default"'."\n" + .'}'."\n" + .'```'."\n" + .'示例2 （开启 BYOK 加密）:'."\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'], + 'autoSplit' => ['description' => '是否自动分裂 Shard。开启后，当日志写入流量持续超限，会触发 Shard 自动分裂，提升写入能力。开启自动分裂时必须设置 maxSplitShard （最大分裂 Shard 数）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'enable_tracking' => ['description' => '是否开启WebTracking功能。默认值为false。当需要收集和分析用户在浏览器或小程序中的行为数据（如页面浏览、购买记录、停留时长等）时，可以使用 WebTracking 功能。'."\n" + ."\n" + .'- true：开启WebTracking。'."\n" + .'- false：不开启WebTracking。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'appendMeta' => ['description' => '是否记录外网 IP 地址和日志接收时间。默认值为 false。'."\n" + ."\n" + .'- true：开启记录外网 IP 和日志接收时间功能，开启后日志服务自动把日志来源设备的公网 IP 地址和日志到达服务端的时间添加到日志的 Tag 字段中。'."\n" + .'- false：不开启记录外网 IP 和日志接收时间功能。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'maxSplitShard' => ['description' => '自动分裂时最大的Shard个数，最小值是1，最大值是256。'."\n" + ."\n" + .'> 当autoSplit为true时必须指定。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64'], + 'telemetryType' => ['description' => '可观测数据类型。默认为日志数据，可选取值包括：'."\n" + ."\n" + .'- None：日志数据。默认为日志数据。'."\n" + .'- Metrics：时序数据。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'None'], + 'hot_ttl' => ['title' => '数据在Logstore热存储层中的存储时间，最少为7天。单位：天，取值范围：7~3000。', 'description' => '数据在Logstore热存储层中的存储时间。单位：天，最小为7，最大不能超过ttl的值，默认保存时间ttl内全是热存储。'."\n" + ."\n" + .'当数据的存储时间超过您所配置的热存储层数据保存时间后，数据将转为低频存储（开启低频存储时，要求热存储时间至少为 7 天）。更多信息，请参见[智能冷热分层存储](~~308645~~)。'."\n" + ."\n" + .'示例：'."\n" + .'- 场景1 （只开启热存储 30天）：`{"ttl": 30}` 或者 `{"ttl": 30, "hot_ttl": 30}`'."\n" + .'- 场景2 （开启热存储7天，低频存储 23 天）: `{"ttl": 30, "hot_ttl": 7}`', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'], + 'mode' => ['description' => '日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。'."\n" + ."\n" + .'- **standard**：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。'."\n" + .'- **query**：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。'."\n" + ."\n", 'type' => 'string', 'required' => false, 'example' => 'standard'], + 'infrequentAccessTTL' => ['title' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。', 'description' => '低频存储。没有最少存储时间要求，至少保存30天转归档存储。'."\n" + ."\n" + .'当日志存储时间大于热存储时间与低频存储时间之和时，剩余的存储时间将转化为归档存储。'."\n" + ."\n" + .'示例：'."\n" + .'- 场景 1 （开启热存 7 天，低频存储 23 天）：`{"ttl": 30, "hot_ttl": 7}`'."\n" + .'- 场景 2 （开启热存 7天，低频存储 30 天，归档 60 天）: `{"ttl": 97, "hot_ttl": 7, "infrequentAccessTTL": 30}`'."\n" + .'- 场景 3 （开启热存 60 天，低频存储 0 天，归档 60 天）: `{"ttl": 120, "hot_ttl": 60, "infrequentAccessTTL": 0}`', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + 'shardingPolicy' => ['title' => '哈希写入配置', 'description' => '哈希写入配置。写入数据时，日志会根据配置的哈希策略选择存储的 Shard。配置前需要确保 Shard 的哈希范围均匀，可能会影响写入能力，请谨慎配置。', 'required' => false, '$ref' => '#/components/schemas/ShardingPolicy'], ], 'required' => true, ], @@ -36825,53 +21849,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新LogStore', 'description' => '### 接口说明'."\n" @@ -36895,22 +21893,10 @@ ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:07.000Z', - 'description' => '请求参数发生变更', - ], - [ - 'createdAt' => '2025-12-02T11:55:07.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI 下线', - ], + ['createdAt' => '2025-12-03T01:37:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-12-02T11:55:07.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [], @@ -36922,22 +21908,11 @@ 'action' => 'log:UpdateLogStore', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - [ - 'conditionKey' => 'log:Encrypted', - 'validationType' => 'always', - ], + ['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}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], @@ -36946,20 +21921,14 @@ 'UpdateLogStoreEncryption' => [ 'summary' => '更新日志库的加密配置。可以为日志库创建加密配置、开启或关闭日志加密功能。', 'path' => '/logstores/{logstore}/encryption', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -36968,32 +21937,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '250787', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '日志项目。', - 'description' => '日志项目。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => '日志项目。', 'description' => '日志项目。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '日志库。', - 'description' => '日志库。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['title' => '日志库。', 'description' => '日志库。', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'body', @@ -37004,60 +21959,25 @@ 'description' => '请求结构体', 'type' => 'object', 'properties' => [ - 'enable' => [ - 'title' => '是否开启日志加密。'."\n" - .'加密配置更新成功后，后续的加密配置更新请求只允许修改是否开启日志加密，不允许修改 encryptType、userCmkInfo 参数。', - 'description' => '是否开启日志加密。'."\n" - .'加密配置更新成功后，后续的加密配置更新请求只允许修改是否开启日志加密，不允许修改 encryptType、userCmkInfo 参数。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'enable' => ['title' => '是否开启日志加密。'."\n" + .'加密配置更新成功后，后续的加密配置更新请求只允许修改是否开启日志加密，不允许修改 encryptType、userCmkInfo 参数。', 'description' => '是否开启日志加密。'."\n" + .'加密配置更新成功后，后续的加密配置更新请求只允许修改是否开启日志加密，不允许修改 encryptType、userCmkInfo 参数。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], 'encryptType' => [ 'title' => '加密算法类型，支持 default、m4、sm4_ecb、sm4_cbc、sm4_gcm、aes_ecb、aes_cbc、aes_cfb、aes_ofb、aes_gcm。', 'description' => '加密算法类型，支持 default、m4、sm4_ecb、sm4_cbc、sm4_gcm、aes_ecb、aes_cbc、aes_cfb、aes_ofb、aes_gcm。', 'type' => 'string', 'required' => false, 'example' => 'default', - 'enum' => [ - 'default', - 'm4', - 'sm4_ecb', - 'sm4_cbc', - 'sm4_gcm', - 'aes_ecb', - 'aes_cbc', - 'aes_cfb', - 'aes_ofb', - 'aes_gcm', - ], + 'enum' => ['default', 'm4', 'sm4_ecb', 'sm4_cbc', 'sm4_gcm', 'aes_ecb', 'aes_cbc', 'aes_cfb', 'aes_ofb', 'aes_gcm'], ], 'userCmkInfo' => [ 'title' => '可选，当通过用户自带密钥（BYOK）加密时，请填写此选项。当通过日志服务自带的服务密钥加密时，无需填写此选项。', 'description' => '可选，当通过用户自带密钥（BYOK）加密时，请填写此选项。当通过日志服务自带的服务密钥加密时，无需填写此选项。', 'type' => 'object', 'properties' => [ - 'keyId' => [ - 'title' => 'BYOK的主密钥ID，可通过阿里云密钥管理服务创建一个主密钥。', - 'description' => 'BYOK的主密钥ID，可通过阿里云密钥管理服务创建一个主密钥，主密钥地域需要与日志服务访问接入点相同。', - 'type' => 'string', - 'required' => false, - 'example' => 'f5136b95-2420-ab31-xxxxxxxxx', - ], - 'roleArn' => [ - 'title' => 'RAM角色的ARN，格式为 acs:ram::12344***:role/xxxxx。使用 BYOK 加密需要先创建一个 RAM角色，并授予给该角色AliyunKMSReadOnlyAccess、AliyunKMSCryptoUserAccess权限。同时授予此 API 访问者该RAM 角色的 PassRole 权限。', - 'description' => 'RAM角色的ARN，格式为 acs:ram::12344***:role/xxxxx。使用 BYOK 加密需要先创建一个 RAM角色，并授予给该角色AliyunKMSReadOnlyAccess、AliyunKMSCryptoUserAccess权限。同时授予此 API 访问者该RAM 角色的 PassRole 权限。', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::12344***:role/xxxxx', - ], - 'regionId' => [ - 'title' => '地域，例如 cn-hangzhou。', - 'description' => '地域，例如 cn-hangzhou。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'keyId' => ['title' => 'BYOK的主密钥ID，可通过阿里云密钥管理服务创建一个主密钥。', 'description' => 'BYOK的主密钥ID，可通过阿里云密钥管理服务创建一个主密钥，主密钥地域需要与日志服务访问接入点相同。', 'type' => 'string', 'required' => false, 'example' => 'f5136b95-2420-ab31-xxxxxxxxx'], + 'roleArn' => ['title' => 'RAM角色的ARN，格式为 acs:ram::12344***:role/xxxxx。使用 BYOK 加密需要先创建一个 RAM角色，并授予给该角色AliyunKMSReadOnlyAccess、AliyunKMSCryptoUserAccess权限。同时授予此 API 访问者该RAM 角色的 PassRole 权限。', 'description' => 'RAM角色的ARN，格式为 acs:ram::12344***:role/xxxxx。使用 BYOK 加密需要先创建一个 RAM角色，并授予给该角色AliyunKMSReadOnlyAccess、AliyunKMSCryptoUserAccess权限。同时授予此 API 访问者该RAM 角色的 PassRole 权限。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::12344***:role/xxxxx'], + 'regionId' => ['title' => '地域，例如 cn-hangzhou。', 'description' => '地域，例如 cn-hangzhou。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], 'required' => false, ], @@ -37070,67 +21990,33 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'ProjectNotExist', - 'errorMessage' => 'The Project does not exist: xxxx.', - 'description' => '日志项目不存在.', - ], - [ - 'errorCode' => 'LogStoreNotExist', - 'errorMessage' => 'logstore xxxx does not exist.', - 'description' => '日志库不存在。', - ], + ['errorCode' => 'ProjectNotExist', 'errorMessage' => 'The Project does not exist: xxxx.', 'description' => '日志项目不存在.'], + ['errorCode' => 'LogStoreNotExist', 'errorMessage' => 'logstore xxxx does not exist.', 'description' => '日志库不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新加密配置', 'description' => '## 使用限制'."\n" @@ -37157,20 +22043,14 @@ 'UpdateLogStoreMeteringMode' => [ 'summary' => '更新Logstore计量模式。', 'path' => '/logstores/{logstore}/meteringmode', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -37178,29 +22058,18 @@ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'projectName', - ], + 'schema' => ['title' => 'Project名称', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'projectName'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'LogStore名称', - 'description' => 'LogStore名称', - 'type' => 'string', - 'required' => true, - 'example' => 'logstoreName', - ], + 'schema' => ['title' => 'LogStore名称', 'description' => 'LogStore名称', 'type' => 'string', 'required' => true, 'example' => 'logstoreName'], ], [ 'name' => 'body', @@ -37217,10 +22086,7 @@ 'required' => true, 'example' => 'ChargeByFunction', 'default' => 'ChargeByFunction', - 'enum' => [ - 'ChargeByDataIngest', - 'ChargeByFunction', - ], + 'enum' => ['ChargeByDataIngest', 'ChargeByFunction', 'ChargeByDataIngest_15', 'ChargeByDataIngest_7', 'ChargeByDataIngest_3'], ], ], 'required' => false, @@ -37230,54 +22096,28 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新LogStore计量模式', 'changeSet' => [], @@ -37291,39 +22131,25 @@ 'action' => 'log:UpdateLogStoreMeteringMode', 'authLevel' => 'operate', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], + ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], 'UpdateLogStoreProcessor' => [ - 'summary' => '更新LogStore关联的写入处理器。', 'path' => '/logstores/{logstore}/processor', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -37332,32 +22158,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '240235', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'LogStore名称。', - 'description' => 'LogStore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['title' => 'LogStore名称。', 'description' => 'LogStore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'body', @@ -37367,13 +22179,7 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'processorName' => [ - 'title' => '写入处理器标识。', - 'description' => '写入处理器标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'parse-nginx-log', - ], + 'processorName' => ['title' => '写入处理器标识。', 'description' => '写入处理器标识。', 'type' => 'string', 'required' => true, 'example' => 'parse-nginx-log'], ], 'required' => false, ], @@ -37382,90 +22188,57 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '更新LogStore关联的写入处理器', + 'summary' => '更新LogStore关联的写入处理器。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateLogging' => [ 'summary' => '更新一个Project的服务日志配置。', 'path' => '/logging', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project 名称。', - 'description' => 'Project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project 名称。', 'description' => 'Project 名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', @@ -37476,13 +22249,7 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'loggingProject' => [ - 'title' => '服务日志要保存到的 project 名称。', - 'description' => '服务日志要保存到的 project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'loggingProject' => ['title' => '服务日志要保存到的 project 名称。', 'description' => '服务日志要保存到的 project 名称。', 'type' => 'string', 'required' => true, 'example' => 'my-project'], 'loggingDetails' => [ 'title' => '服务日志配置列表。', 'description' => '服务日志配置列表。', @@ -37507,24 +22274,9 @@ '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' => '该种类服务日志要保存到的Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', + 'enum' => ['consumergroup_log', 'logtail_alarm', 'operation_log', 'logtail_profile', 'metering', 'logtail_status', 'scheduled_sql_alert', 'etl_alert'], ], + 'logstore' => ['title' => '该种类服务日志要保存到的 logstore 名称。', 'description' => '该种类服务日志要保存到的Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], ], 'required' => false, ], @@ -37539,46 +22291,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -37597,40 +22325,130 @@ 'action' => 'log:UpdateLogging', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging', - ], + ['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' => '请求体', + 'type' => 'object', + 'properties' => [ + 'from' => ['description' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185'], + 'to' => ['description' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。'."\n" + ."\n" + .'请求参数from和to定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果from和to的值相同，则为无效区间，函数直接返回错误。'."\n" + .'Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200'], + 'query' => ['description' => '可选：查询语句，用于筛选需要更新的日志。更多信息，请参见[查询概述](~~43772~~)。'."\n" + ."\n" + .'说明：本参数仅支持查询语句，不支持如SPL、SQL等分析语句。', 'type' => 'string', 'required' => false, 'example' => 'status: 401 '], + 'rowId' => ['description' => '可选：查询结果中自动返回内置字段 __rowid__的值。'."\n" + ."\n" + .'rowId和query这两个字段必须给一个，如果两个都给，rowId的优先级更高', 'type' => 'string', 'required' => false, 'example' => '0|1000001|638732499'], + 'updateMode' => ['description' => '可选:取值 full 或 partial，默认值为partial'."\n" + .' - full —— 请求体须包含该行所有字段，服务端用新值整行覆盖旧记录。'."\n" + .' - partial —— 请求体只需包含要修改的字段,未提供的字段保持原值不变。', 'type' => 'string', 'required' => false, 'example' => 'partial'], + 'data' => ['description' => '要更新的数据，json格式', 'type' => 'string', 'required' => false, 'example' => '{"status":"success"}'], + ], + 'required' => false, + ], + ], + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-project-test'], + ], + [ + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['description' => 'Logstore名称。', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore'], + ], + ], + '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' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'affectedRows' => ['description' => '更新的日志行数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '更新日志', + 'summary' => '更新指定Project下某个Logstore中的日志数据', + 'description' => 'Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"affectedRows\\": 10\\n}","type":"json"}]', ], 'UpdateLogtailPipelineConfig' => [ 'summary' => '更新Logtail流水线配置。', 'path' => '/pipelineconfigs/{configName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -37639,33 +22457,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191814', - 'abilityTreeNodes' => [ - 'FEATUREsls9GTH7Z', - ], + 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => 'Project名称', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'title' => 'Logtail流水线配置名称', - 'description' => 'Logtail流水线配置名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', - ], + 'schema' => ['title' => 'Logtail流水线配置名称', 'description' => 'Logtail流水线配置名称。', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$'], ], [ 'name' => 'body', @@ -37676,47 +22479,23 @@ 'description' => 'Logtail流水线配置内容。', 'type' => 'object', 'properties' => [ - 'configName' => [ - 'title' => '配置名称', - 'description' => '配置名称。'."\n" - ."\n" - .'>需要与外层的configName参数保持一致。>', - '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' => '日志样例。支持多条日志。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world', - ], - 'global' => [ - 'title' => '全局配置', - 'description' => '全局配置。', - 'type' => 'object', - 'required' => false, - ], + 'configName' => ['title' => '配置名称', 'description' => '配置名称。'."\n" + ."\n" + .'>需要与外层的configName参数保持一致。>', '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' => '日志样例。支持多条日志。', 'type' => 'string', 'required' => false, 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], + 'global' => ['title' => '全局配置', 'description' => '全局配置。', 'type' => 'object', 'required' => false], 'inputs' => [ 'title' => '输入插件列表', 'description' => '输入插件列表。'."\n" ."\n" .'>目前，只允许配置1个输入插件。>', 'type' => 'array', - 'items' => [ - 'title' => '输入插件', - 'description' => '输入插件。'."\n" - ."\n" - .'> 文件输入插件参数请参见[文件插件](~~65064~~)，其余输入插件参数请参见[处理插件](~~64957~~)。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "input_file",'."\n" - .' "FilePaths": ["/var/log/*.log"]'."\n" - .'}', - ], + 'items' => ['title' => '输入插件', 'description' => '输入插件。'."\n" + ."\n" + .'> 文件输入插件参数请参见[文件插件](~~65064~~)，其余输入插件参数请参见[处理插件](~~64957~~)。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "Type": "input_file",'."\n" + .' "FilePaths": ["/var/log/*.log"]'."\n" + .'}'], 'required' => true, 'minItems' => 1, ], @@ -37734,18 +22513,12 @@ .'> - 第一个处理插件必须为正则解析插件、分隔符模式解析插件、JSON解析插件、NGINX模式解析插件、Apache模式解析插件或IIS模式解析插件。'."\n" .'> - 第一个处理插件之后仅允许存在1个时间解析处理插件，1个过滤插件和多个脱敏插件。>', 'type' => 'array', - 'items' => [ - 'title' => '输入插件', - 'description' => '处理插件。'."\n" - ."\n" - .'>详情请参见[处理插件](~~64957~~)。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "processor_parse_json_native",'."\n" - .' "SourceKey": "content"'."\n" - .'}', - ], + 'items' => ['title' => '输入插件', 'description' => '处理插件。'."\n" + ."\n" + .'>详情请参见[处理插件](~~64957~~)。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "Type": "processor_parse_json_native",'."\n" + .' "SourceKey": "content"'."\n" + .'}'], 'required' => false, 'minItems' => 1, ], @@ -37755,12 +22528,7 @@ ."\n" .'>仅当使用了扩展处理插件时有效，且最多允许使用1个聚合插件。>', 'type' => 'array', - 'items' => [ - 'title' => '聚合插件', - 'description' => '聚合插件。', - 'type' => 'object', - 'required' => false, - ], + 'items' => ['title' => '聚合插件', 'description' => '聚合插件。', 'type' => 'object', 'required' => false], 'required' => false, 'minItems' => 1, ], @@ -37770,23 +22538,14 @@ ."\n" .'>目前，只允许存在1个SLS输出插件。>', 'type' => 'array', - 'items' => [ - 'title' => '输出插件', - 'description' => '输出插件。', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "flusher_sls",'."\n" - .' "Logstore": "test"'."\n" - .'}', - ], + 'items' => ['title' => '输出插件', 'description' => '输出插件。', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "Type": "flusher_sls",'."\n" + .' "Logstore": "test"'."\n" + .'}'], 'required' => true, 'minItems' => 1, ], - 'task' => [ - 'type' => 'object', - 'required' => false, - ], + 'task' => ['type' => 'object', 'required' => false], ], 'required' => false, ], @@ -37796,53 +22555,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新Logtail流水线配置', 'requestParamsDescription' => '## 全局配置'."\n" @@ -38442,17 +23175,10 @@ 'action' => 'log:UpdateLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], + ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -38461,49 +23187,28 @@ 'UpdateMachineGroup' => [ 'summary' => '修改机器组配置信息。', 'path' => '/machinegroups/{groupName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'groupName', 'in' => 'path', - 'schema' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], + 'schema' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-group'], ], [ 'name' => 'body', @@ -38514,50 +23219,19 @@ 'description' => '请求体结构。', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group', - ], - 'machineIdentifyType' => [ - 'title' => '机器组标识种类，支持 ip 、userdefined 两种。', - 'description' => '机器组标识类型。'."\n" - ."\n" - .'- ip：IP地址机器组。'."\n" - .'- userdefined：用户自定义标识机器组。', - 'type' => 'string', - 'required' => true, - 'example' => 'userdefined', - 'default' => 'ip', - ], - 'groupType' => [ - 'title' => '机器组类型，可选值，默认为空。', - 'description' => '机器组类型，固定为空字符串。', - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], + 'groupName' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group'], + 'machineIdentifyType' => ['title' => '机器组标识种类，支持 ip 、userdefined 两种。', 'description' => '机器组标识类型。'."\n" + ."\n" + .'- ip：IP地址机器组。'."\n" + .'- userdefined：用户自定义标识机器组。', 'type' => 'string', 'required' => true, 'example' => 'userdefined', 'default' => 'ip'], + 'groupType' => ['title' => '机器组类型，可选值，默认为空。', 'description' => '机器组类型，固定为空字符串。', 'type' => 'string', 'required' => false, 'example' => '""'], 'groupAttribute' => [ 'title' => '机器组属性。', 'description' => '机器组的属性，默认为空。', 'type' => 'object', 'properties' => [ - 'groupTopic' => [ - 'title' => '机器组的日志主题。', - 'description' => '机器组的日志主题。默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'testtopic2', - ], - 'externalName' => [ - 'title' => '机器组所依赖的外部管理系统标识。', - 'description' => '机器组所依赖的外部管理系统标识。默认为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup2', - ], + 'groupTopic' => ['title' => '机器组的日志主题。', 'description' => '机器组的日志主题。默认为空。', 'type' => 'string', 'required' => false, 'example' => 'testtopic2'], + 'externalName' => ['title' => '机器组所依赖的外部管理系统标识。', 'description' => '机器组所依赖的外部管理系统标识。默认为空。', 'type' => 'string', 'required' => false, 'example' => 'testgroup2'], ], 'required' => false, ], @@ -38568,13 +23242,7 @@ .'- 如果machineIdentifyType配置为ip，则此处填写服务器的IP地址。'."\n" .'- 如果machineIdentifyType配置为userdefined，则此处填写自定义的标识。', 'type' => 'array', - 'items' => [ - 'title' => '机器标识，如 ip 地址、用户自定义标识。', - 'description' => '机器标识，如IP地址、用户自定义标识。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.xx', - ], + 'items' => ['title' => '机器标识，如 ip 地址、用户自定义标识。', 'description' => '机器标识，如IP地址、用户自定义标识。', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.xx'], 'required' => true, 'example' => '[uu_id_1，uu_id_2]', ], @@ -38588,46 +23256,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -38654,18 +23298,10 @@ 'action' => 'log:UpdateMachineGroup', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['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}/machinegroup/{#MachineGroupName}'], ], ], ], @@ -38674,49 +23310,28 @@ 'UpdateMachineGroupMachine' => [ 'summary' => '修改机器组中的机器列表，支持从机器列表中增加或者删除机器。', 'path' => '/machinegroups/{machineGroup}/machines', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '机器组名称。', - 'description' => '机器组名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], + 'schema' => ['title' => '机器组名称。', 'description' => '机器组名称。', 'type' => 'string', 'required' => true, 'example' => 'test-group'], ], [ 'name' => 'body', @@ -38726,13 +23341,7 @@ 'title' => '请求结构体。要添加或删除的机器列表。', 'description' => '请求结构体。要添加或删除的机器列表。', 'type' => 'array', - 'items' => [ - 'title' => '机器标识。ip 地址或者用户自定义标识。', - 'description' => '机器标识。ip地址或者用户自定义标识。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.x', - ], + 'items' => ['title' => '机器标识。ip 地址或者用户自定义标识。', 'description' => '机器标识。ip地址或者用户自定义标识。', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.x'], 'required' => true, ], ], @@ -38746,10 +23355,7 @@ 'required' => false, 'example' => 'add', 'default' => 'add', - 'enum' => [ - 'add', - 'delete', - ], + 'enum' => ['add', 'delete'], ], ], ], @@ -38757,46 +23363,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -38815,354 +23397,189 @@ 'action' => 'log:UpdateMachineGroupMachine', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], ], ], - 'UpdateMaxComputeExport' => [ - 'summary' => '更新MaxCompute投递任务。', - 'path' => '/maxcomputeexports/{mcExportName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateMaterializedView' => [ + 'summary' => '更新物化视图 ', + 'path' => '/materializedviews/{name}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '203412', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'riskType' => 'none', + 'abilityTreeCode' => '294422', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], [ - 'name' => 'mcExportName', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456', - ], + 'schema' => ['type' => 'string', 'description' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'MaxCompute投递任务配置', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => '任务显示名', - 'type' => 'string', - 'required' => true, - 'example' => 'my-mc-job', - ], - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '更新MaxCompute投递任务', - ], - 'configuration' => [ - 'description' => '任务配置', - 'required' => true, - '$ref' => '#/components/schemas/MaxComputeExportConfiguration', - ], + 'originalSql' => ['type' => 'string', 'description' => ''], + 'aggIntervalMins' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'ttl' => ['type' => 'integer', 'format' => 'int32', 'description' => ''], + 'enable' => ['type' => 'boolean', 'description' => ''], ], - 'required' => false, + 'description' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '更新MaxCompute投递任务', - 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'UpdateMemory' => [ - 'summary' => '修改记忆', - 'path' => '/memorystores/{memoryStore}/memories/{memoryId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateMaxComputeExport' => [ + 'summary' => '更新MaxCompute投递任务。', + 'path' => '/maxcomputeexports/{mcExportName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '203412', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'metadata' => [ - 'type' => 'object', - 'properties' => [ - 'updated_by' => [ - 'type' => 'string', - ], - ], - 'description' => '', - ], - 'text' => [ - 'type' => 'string', - 'description' => '', - ], - ], - 'description' => '', - ], - ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], - ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ - 'name' => 'memoryId', + 'name' => 'mcExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - ], - 'UpdateMemoryStore' => [ - 'summary' => '修改内存库', - 'path' => '/memorystores/{memoryStore}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456'], ], - 'autoTest' => true, - ], - 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => 'MaxCompute投递任务配置', 'type' => 'object', 'properties' => [ - 'description' => [ - 'type' => 'string', - 'description' => '', - ], - 'enableGraph' => [ - 'type' => 'boolean', - 'description' => '', - ], - 'shortTermTtl' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - ], - 'strategy' => [ - 'type' => 'string', - 'description' => '', - ], - 'customInstructions' => [ - 'type' => 'string', - 'description' => '', - ], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => true, 'example' => 'my-mc-job'], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Update MaxCompute delivery task'], + 'configuration' => ['description' => '任务配置', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration'], ], - 'description' => '', - ], - ], - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', + 'required' => false, ], ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', + ], + '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'], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '更新MaxCompute投递任务', + 'description' => '- Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" + .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + ."\n" + .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" + .'- 已明确您查询日志所属的Project名称、所属地域等。如何查询，请参见[管理Project](~~48984~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateMetricStore' => [ 'summary' => '更新一个已存在的时序库的配置，时序库可用于存储时序数据。', 'path' => '/metricstores/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -39171,32 +23588,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225678', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '日志项目名称', - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['title' => '日志项目名称', 'description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'title' => '时序库名称', - 'description' => '时序库名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my_metric_store', - ], + 'schema' => ['title' => '时序库名称', 'description' => '时序库名称', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store'], ], [ 'name' => 'body', @@ -39207,61 +23610,14 @@ 'description' => '请求体', 'type' => 'object', 'properties' => [ - 'ttl' => [ - 'title' => '保存时长，单位为天，可选参数。', - 'description' => '保存时长，单位为天', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], - 'autoSplit' => [ - 'title' => '是否开启自动分裂', - 'description' => '是否开启自动分裂', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - 'maxSplitShard' => [ - 'title' => '自动分裂的最大 shard 数，仅当 autoSplit 为 true 时有效', - 'description' => '自动分裂的最大 shard 数，仅当 autoSplit 为 true 时有效', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'mode' => [ - 'title' => '时序库的类型', - 'description' => '时序库的类型', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - 'default' => 'standard', - ], - 'hot_ttl' => [ - 'title' => '数据在热存储层中的存储时间，单位为天。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => '数据在热存储层中的存储时间，单位为天。', - ], - 'infrequentAccessTTL' => [ - 'title' => '低频存储，单位为天。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => '低频存储，单位为天。', - ], - 'appendMeta' => [ - 'title' => '是否记录外网IP地址和日志接收时间', - 'type' => 'boolean', - 'default' => 'false', - ], - 'shardingPolicy' => [ - 'title' => '哈希写入配置', - '$ref' => '#/components/schemas/ShardingPolicy', - ], + 'ttl' => ['title' => '保存时长，单位为天，可选参数。', 'description' => '保存时长，单位为天', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], + 'autoSplit' => ['title' => '是否开启自动分裂', 'description' => '是否开启自动分裂', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], + 'maxSplitShard' => ['title' => '自动分裂的最大 shard 数，仅当 autoSplit 为 true 时有效', 'description' => '自动分裂的最大 shard 数，仅当 autoSplit 为 true 时有效', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64'], + 'mode' => ['title' => '时序库的类型', 'description' => '时序库的类型', 'type' => 'string', 'required' => false, 'example' => 'standard', 'default' => 'standard'], + 'hot_ttl' => ['title' => '数据在热存储层中的存储时间，单位为天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '数据在热存储层中的存储时间，单位为天。'], + 'infrequentAccessTTL' => ['title' => '低频存储，单位为天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => '低频存储，单位为天。'], + 'appendMeta' => ['title' => '是否记录外网IP地址和日志接收时间', 'type' => 'boolean', 'default' => 'false'], + 'shardingPolicy' => ['title' => '哈希写入配置', '$ref' => '#/components/schemas/ShardingPolicy'], ], 'required' => false, ], @@ -39271,62 +23627,32 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'MetricStoreNotExist', - 'errorMessage' => 'The specified metricstore xxx does not exist.', - 'description' => '参数中所指定的时序库不存在', - ], + ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => '参数中所指定的时序库不存在'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '更新时序库', 'description' => '[时序库](~~171723~~)可用于存储[时序数据](~~174965~~)。'."\n" .'- 此接口需要指定一个已存在的时序库。'."\n" @@ -39339,34 +23665,13 @@ .'- 一个Project中，最多创建 200 个 Logstore 或 MetricStore。'."\n" .'- 当时序数据保存时间达到您所设置的数据保存时间后，数据将被删除。', 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:06.000Z', - 'description' => '请求参数发生变更', - ], - [ - 'createdAt' => '2025-12-02T11:55:05.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI 下线', - ], - [ - 'createdAt' => '2025-11-24T09:35:52.000Z', - 'description' => '请求参数发生变更', - ], - [ - 'createdAt' => '2024-09-19T09:31:34.000Z', - 'description' => '请求参数发生变更', - ], - [ - 'createdAt' => '2024-08-28T13:00:54.000Z', - 'description' => 'OpenAPI 下线', - ], + ['createdAt' => '2025-12-03T01:37:06.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-12-02T11:55:05.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI 下线'], + ['createdAt' => '2025-11-24T09:35:52.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-09-19T09:31:34.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-08-28T13:00:54.000Z', 'description' => 'OpenAPI 下线'], ], 'flowControl' => [ 'flowControlList' => [], @@ -39377,20 +23682,14 @@ 'UpdateMetricStoreMeteringMode' => [ 'summary' => '更新指定时序库的计费模式。', 'path' => '/metricstores/{metricStore}/meteringmode', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -39399,32 +23698,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '213244', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '日志项目名称', - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'projectName', - ], + 'schema' => ['title' => '日志项目名称', 'description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'projectName'], ], [ 'name' => 'metricStore', 'in' => 'path', - 'schema' => [ - 'title' => 'MetricStore名称', - 'description' => '时序库名称', - 'type' => 'string', - 'required' => true, - 'example' => 'metricStoreName', - ], + 'schema' => ['title' => 'MetricStore名称', 'description' => '时序库名称', 'type' => 'string', 'required' => true, 'example' => 'metricStoreName'], ], [ 'name' => 'body', @@ -39441,10 +23726,7 @@ 'required' => true, 'example' => 'ChargeByFunction', 'default' => 'ChargeByFunction', - 'enum' => [ - 'ChargeByDataIngest', - 'ChargeByFunction', - ], + 'enum' => ['ChargeByDataIngest', 'ChargeByFunction'], ], ], 'required' => false, @@ -39455,53 +23737,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], @@ -39525,20 +23781,14 @@ 'UpdateMetricStoreProcessor' => [ 'summary' => '更新MetricStore关联的写入处理器。', 'path' => '/metricstores/{metricstore}/processor', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -39547,32 +23797,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '240240', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'metricstore', 'in' => 'path', - 'schema' => [ - 'title' => 'MetricStore名称。', - 'description' => 'MetricStore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-metricstore', - ], + 'schema' => ['title' => 'MetricStore名称。', 'description' => 'MetricStore名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-metricstore'], ], [ 'name' => 'body', @@ -39582,13 +23818,7 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'processorName' => [ - 'title' => '写入处理器标识。', - 'description' => '写入处理器标识。', - 'type' => 'string', - 'required' => true, - 'example' => 'filter-metrics', - ], + 'processorName' => ['title' => '写入处理器标识。', 'description' => '写入处理器标识。', 'type' => 'string', 'required' => true, 'example' => 'filter-metrics'], ], 'required' => false, ], @@ -39597,104 +23827,65 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '更新MetricStore关联的写入处理器', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'UpdateOSSExport' => [ 'summary' => '更新指定的OSS投递任务。', 'path' => '/ossexports/{ossExportName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '203473', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456'."\n", - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n"], ], [ 'name' => 'body', @@ -39704,23 +23895,9 @@ 'description' => 'OSS投递任务配置', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => '任务显示名', - 'type' => 'string', - 'required' => false, - 'example' => 'my-oss-job'."\n", - ], - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '更新OSS投递任务'."\n", - ], - 'configuration' => [ - 'description' => '任务配置', - 'required' => false, - '$ref' => '#/components/schemas/OSSExportConfiguration', - ], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => false, 'example' => 'my-oss-job'."\n"], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Update OSS delivery task'], + 'configuration' => ['description' => '任务配置', 'required' => false, '$ref' => '#/components/schemas/OSSExportConfiguration'], ], 'required' => false, ], @@ -39729,48 +23906,28 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新OSS投递任务', 'changeSet' => [], @@ -39782,51 +23939,32 @@ 'UpdateOSSHDFSExport' => [ 'summary' => '更新指定的OSS-HDFS投递任务。', 'path' => '/osshdfsexports/{ossExportName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '203477', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'export-osshdfs-1234567890-123456'."\n", - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n"], ], [ 'name' => 'body', @@ -39836,23 +23974,9 @@ 'description' => 'OSS-HDFS投递任务配置', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => '任务显示名', - 'type' => 'string', - 'required' => true, - 'example' => 'my-oss-hdfs-job'."\n", - ], - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '更新OSS-HDFS投递任务'."\n", - ], - 'configuration' => [ - 'description' => '任务配置', - 'required' => true, - '$ref' => '#/components/schemas/OSSExportConfiguration', - ], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => true, 'example' => 'my-oss-hdfs-job'."\n"], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Update OSS-HDFS delivery task'], + 'configuration' => ['description' => '任务配置', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration'], ], 'required' => false, ], @@ -39861,41 +23985,23 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], @@ -39911,51 +24017,32 @@ 'UpdateOSSIngestion' => [ 'summary' => '更新指定的OSS导入任务。', 'path' => '/ossingestions/{ossIngestionName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '203139', - 'abilityTreeNodes' => [ - 'FEATUREslsDQM02M', - ], + 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'ossIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'OSS导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123455', - ], + 'schema' => ['description' => 'OSS导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123455'], ], [ 'name' => 'body', @@ -39965,28 +24052,10 @@ 'description' => '请求体。', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'OSS导入任务描述', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS导入', - ], - 'displayName' => [ - 'description' => 'OSS导入任务展示名称', - 'type' => 'string', - 'required' => true, - 'example' => 'OSS导入', - ], - 'schedule' => [ - 'description' => '调度类型，一般默认不需要填写。如果有强定时需求，如必须是每周一八点进行一次导入，可使用cron形式', - 'required' => false, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'description' => 'OSS导入配置', - 'required' => true, - '$ref' => '#/components/schemas/OSSIngestionConfiguration', - ], + 'description' => ['description' => 'OSS导入任务描述', 'type' => 'string', 'required' => false, 'example' => 'OSS import'], + 'displayName' => ['description' => 'OSS导入任务展示名称', 'type' => 'string', 'required' => true, 'example' => 'OSS import'], + 'schedule' => ['description' => '调度类型，一般默认不需要填写。如果有强定时需求，如必须是每周一八点进行一次导入，可使用cron形式', 'required' => false, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['description' => 'OSS导入配置', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration'], ], 'required' => false, ], @@ -39995,48 +24064,28 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', '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', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新OSS导入任务', 'changeSet' => [], @@ -40048,30 +24097,21 @@ 'UpdateProject' => [ 'summary' => '更新一个 Project 信息。', 'path' => '/', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '8870', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -40084,21 +24124,12 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => 'Project description', - 'description' => 'Project的描述。默认为空字符串。', - 'type' => 'string', - 'required' => true, - 'example' => 'Description of my-project-test', - ], + 'description' => ['title' => 'Project description', 'description' => 'Project的描述。默认为空字符串。', 'type' => 'string', 'required' => true, 'example' => 'Description of my-project-test'], 'recycleBinEnabled' => [ 'description' => '是否打开回收站', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'example' => 'true', ], ], @@ -40108,53 +24139,29 @@ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project name', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-project-test', - ], + 'schema' => ['title' => 'Project name', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['type' => 'string', 'example' => 'nginx'], ], 'Content-Length' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['type' => 'string', 'example' => 'close'], ], 'Access-Control-Allow-Origin' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '*', - ], + 'schema' => ['type' => 'string', 'example' => '*'], ], 'Date' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], 'x-log-requestid' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -40203,18 +24210,10 @@ 'action' => 'log:UpdateProject', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], @@ -40223,48 +24222,28 @@ 'UpdateSavedSearch' => [ 'summary' => '调用UpdateSavedSearch接口更新快速查询。', 'path' => '/savedsearches/{savedsearchName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'Project 名称。', - 'description' => 'Project名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['title' => 'Project 名称。', 'description' => 'Project名称。', 'type' => 'string', 'required' => true, 'example' => 'my-project'], ], [ 'name' => 'savedsearchName', 'in' => 'path', - 'schema' => [ - 'description' => '要更新的快速查询的名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'savedsearch-name', - ], + 'schema' => ['description' => '要更新的快速查询的名称。', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name'], ], [ 'name' => 'body', @@ -40274,36 +24253,11 @@ 'description' => '快速查询结构体。', 'type' => 'object', 'properties' => [ - 'savedsearchName' => [ - 'description' => '快速查询的名称。名称长度为3~63个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'savedsearch-name', - ], - 'searchQuery' => [ - 'description' => '快速查询的查询和分析语句。由查询语句和分析语句构成，格式为查询语句|分析语句。更多信息，请参见[查询语法](~~43772~~)和[分析语法](~~53608~~)。', - 'type' => 'string', - 'required' => true, - 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time', - ], - 'logstore' => [ - 'description' => '快速查询所属的Logstore名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - ], - 'topic' => [ - 'description' => '日志主题。', - 'type' => 'string', - 'required' => false, - 'example' => 'theme', - ], - 'displayName' => [ - 'description' => '显示名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'displayname', - ], + 'savedsearchName' => ['description' => '快速查询的名称。名称长度为3~63个字符。', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name'], + 'searchQuery' => ['description' => '快速查询的查询和分析语句。由查询语句和分析语句构成，格式为查询语句|分析语句。更多信息，请参见[查询语法](~~43772~~)和[分析语法](~~53608~~)。', 'type' => 'string', 'required' => true, 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time'], + 'logstore' => ['description' => '快速查询所属的Logstore名称。', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore'], + 'topic' => ['description' => '日志主题。', 'type' => 'string', 'required' => false, 'example' => 'theme'], + 'displayName' => ['description' => '显示名称。', 'type' => 'string', 'required' => true, 'example' => 'displayname'], ], 'required' => false, ], @@ -40313,46 +24267,22 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -40382,18 +24312,10 @@ 'action' => 'log:UpdateSavedSearch', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], ], ], ], @@ -40402,21 +24324,14 @@ 'UpdateScheduledSQL' => [ 'summary' => '更新指定的定时 SQL 任务。', 'path' => '/scheduledsqls/{scheduledSQLName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -40425,31 +24340,18 @@ 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '209793', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'Project名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'Project名称', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', - 'schema' => [ - 'description' => '已存在的唯一任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456', - ], + 'schema' => ['description' => '已存在的唯一任务名称', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'], ], [ 'name' => 'body', @@ -40459,28 +24361,10 @@ 'description' => '定时SQL任务配置', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => '任务显示名', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-scheduled-sql', - ], - 'description' => [ - 'description' => '任务描述', - 'type' => 'string', - 'required' => false, - 'example' => '更新定时SQL任务'."\n", - ], - 'schedule' => [ - 'description' => '任务调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'description' => '任务配置', - 'required' => true, - '$ref' => '#/components/schemas/ScheduledSQLConfiguration', - ], + 'displayName' => ['description' => '任务显示名', 'type' => 'string', 'required' => true, 'example' => 'ali-test-scheduled-sql'], + 'description' => ['description' => '任务描述', 'type' => 'string', 'required' => false, 'example' => 'Update scheduled SQL task'], + 'schedule' => ['description' => '任务调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['description' => '任务配置', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration'], ], 'required' => false, ], @@ -40490,45 +24374,26 @@ 200 => [ 'headers' => [ 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '没有访问权限，需要进行用户身份认证', - ], + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => '没有访问权限，需要进行用户身份认证'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', @@ -40545,12 +24410,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -40559,20 +24419,14 @@ 'UpdateSqlInstance' => [ 'summary' => '当您使用SQL分析时，如果数据量较大，SQL普通版无法在一次查询中完整扫描指定时间段内的所有日志，返回的结果可能不包括所有匹配的数据，增加Shard可以提升读写能力，但只对新写入的数据生效。您可以通过开启SQL独享版，增加计算资源，提升单次分析的数据量。', 'path' => '/sqlinstance', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -40581,20 +24435,13 @@ 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '212425', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => '需要开启 SQL 独享版的 Project 名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => '需要开启 SQL 独享版的 Project 名称。', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], [ 'name' => 'body', @@ -40604,20 +24451,8 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'cu' => [ - 'title' => '独享sql能使用的最大cu', - 'description' => 'CU（ComputeUnit）是 SQL 独享版运行过程中可以并行使用的计算核数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'useAsDefault' => [ - 'title' => '是否默认开启', - 'description' => '是否为 Project 默认开启 SQL 独享版。 如果为 true，当前 Project 下的所有查询和分析操作（包括告警、仪表盘等），都使用 SQL 独享版。', - 'type' => 'boolean', - 'required' => true, - ], + 'cu' => ['title' => '独享sql能使用的最大cu', 'description' => 'CU（ComputeUnit）是 SQL 独享版运行过程中可以并行使用的计算核数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], + 'useAsDefault' => ['title' => '是否默认开启', 'description' => '是否为 Project 默认开启 SQL 独享版。 如果为 true，当前 Project 下的所有查询和分析操作（包括告警、仪表盘等），都使用 SQL 独享版。', 'type' => 'boolean', 'required' => true], ], 'required' => false, ], @@ -40627,53 +24462,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新SQL 独享实例', 'description' => '**请确保在使用该接口前，已充分了解独享SQL的收费方式和[价格](~~223777~~)。**', @@ -40689,12 +24498,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], ], ], ], @@ -40703,20 +24507,14 @@ 'UpdateStoreView' => [ 'summary' => '更新指定数据集配置。', 'path' => '/storeviews/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -40725,30 +24523,18 @@ 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '208677', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => '日志项目名称', - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - ], + 'schema' => ['description' => '日志项目名称', 'type' => 'string', 'required' => true, 'example' => 'example-project'], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => '数据集名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - ], + 'schema' => ['description' => '数据集名称。', 'type' => 'string', 'required' => true, 'example' => 'my_storeview'], ], [ 'name' => 'body', @@ -40762,20 +24548,13 @@ 'description' => '数据集类型', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'metricstore' => 'metricstore', - 'logstore' => 'logstore', - ], + 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'example' => 'logstore', ], 'stores' => [ 'description' => '日志库或者时序库列表。', 'type' => 'array', - 'items' => [ - 'description' => '日志库或者时序库。', - 'required' => true, - '$ref' => '#/components/schemas/StoreViewStore', - ], + 'items' => ['description' => '日志库或者时序库。', 'required' => true, '$ref' => '#/components/schemas/StoreViewStore'], 'required' => true, ], ], @@ -40787,53 +24566,27 @@ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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', - ], + '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' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '更新数据集配置', 'changeSet' => [], @@ -40848,12 +24601,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => '全部资源', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], @@ -40862,20 +24610,14 @@ 'UpsertCollectionPolicy' => [ 'summary' => '创建云产品日志采集的采集规则，从而实现云产品日志的自动化采集。', 'path' => '/collectionpolicy', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, @@ -40884,9 +24626,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192469', - 'abilityTreeNodes' => [ - 'FEATUREsls9NGCVR', - ], + 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ @@ -40897,36 +24637,13 @@ 'description' => '请求结构体。', 'type' => 'object', 'properties' => [ - 'policyName' => [ - 'description' => '其命名规则如下：'."\n" - .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" - .'- 必须以字母开头。'."\n" - .'- 长度为 3-63 字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'your_log_policy', - 'maxLength' => 63, - 'minLength' => 3, - ], - 'productCode' => [ - 'description' => '产品编码。', - 'type' => 'string', - 'required' => true, - 'example' => 'oss', - ], - 'dataCode' => [ - 'description' => '日志类型编码。', - 'type' => 'string', - 'required' => true, - 'example' => 'access_log', - ], - 'enabled' => [ - 'description' => '是否开启。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - ], + 'policyName' => ['description' => '其命名规则如下：'."\n" + .'- 只能包括小写字母、数字、短划线（-）和下划线（_）。'."\n" + .'- 必须以字母开头。'."\n" + .'- 长度为 3-63 字符。', 'type' => 'string', 'required' => true, 'example' => 'your_log_policy', 'maxLength' => 63, 'minLength' => 3], + 'productCode' => ['description' => '产品编码。', 'type' => 'string', 'required' => true, 'example' => 'oss'], + 'dataCode' => ['description' => '日志类型编码。', 'type' => 'string', 'required' => true, 'example' => 'access_log'], + 'enabled' => ['description' => '是否开启。', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'false'], 'policyConfig' => [ 'description' => '采集规则配置。', 'type' => 'object', @@ -40937,81 +24654,35 @@ 'required' => true, 'example' => 'all', 'default' => 'all', - 'enum' => [ - 'all', - 'instanceMode', - 'attributeMode', - ], - ], - 'resourceTags' => [ - 'description' => '资源标签，当且仅当resourceMode为attributeMode时有效。'."\n" - .'如果资源标签过滤项为空，表示无需按照资源标签过滤，实例全部满足资源标签这一过滤条件，否则只采集资源标签属性全部满足该资源标签配置的实例。'."\n" - .'资源标签和实例所属的地域集合，共同作用，只有全部满足时才会采集该实例对象。', - 'type' => 'object', - 'required' => false, - 'example' => '{"tag1":"value1",“tag2":"value2"}', + 'enum' => ['all', 'instanceMode', 'attributeMode'], ], + 'resourceTags' => ['description' => '资源标签，当且仅当resourceMode为attributeMode时有效。'."\n" + .'如果资源标签过滤项为空，表示无需按照资源标签过滤，实例全部满足资源标签这一过滤条件，否则只采集资源标签属性全部满足该资源标签配置的实例。'."\n" + .'资源标签和实例所属的地域集合，共同作用，只有全部满足时才会采集该实例对象。', 'type' => 'object', 'required' => false, 'example' => '{"tag1":"value1",“tag2":"value2"}'], 'regions' => [ 'description' => '实例所属的地域集合，当且仅当resourceMode为attributeMode时有效，支持通配符。如果地域集合过滤项为空数组，表示无需按照地域过滤，实例全部满足地域集合这一过滤条件，否则只采集地域属性在该地域集合中的实例。实例所属的地域集合和资源标签，共同作用，只有全部满足时才会采集该实例对象。', 'type' => 'array', - 'items' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'items' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], 'required' => false, ], 'instanceIds' => [ 'description' => '实例ID集合，当且仅当resourceMode为instanceMode时有效。只采集实例ID在该实例ID集合中的实例。', 'type' => 'array', - 'items' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'your-test-bucket1', - ], + 'items' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'your-test-bucket1'], 'required' => false, ], ], 'required' => true, ], - 'centralizeEnabled' => [ - 'description' => '是否开启中心化转投，默认false。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'centralizeEnabled' => ['description' => '是否开启中心化转投，默认false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], 'centralizeConfig' => [ 'description' => '中心化转投配置。', 'type' => 'object', 'properties' => [ - 'destRegion' => [ - 'description' => '中心化转投目的地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'destProject' => [ - 'description' => '中心化转投目的项目，其地域属性应和destRegion保持一致。', - 'type' => 'string', - 'required' => false, - 'example' => 'your-sls-project-in-beijing', - ], - 'destLogstore' => [ - 'description' => '中心化转投目的日志库，其地域属性应和destRegion保持一致，并且归属destProject下。', - 'type' => 'string', - 'required' => false, - 'example' => 'your-sls-logstore-in-beijing', - ], - 'destTTL' => [ - 'description' => '中心化转投目的天数，当且仅当中心化转投目的日志库不存在首次创建时有效。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'your-sls-logstore-ttl', - ], + 'destRegion' => ['description' => '中心化转投目的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + 'destProject' => ['description' => '中心化转投目的项目，其地域属性应和destRegion保持一致。', 'type' => 'string', 'required' => false, 'example' => 'your-sls-project-in-beijing'], + 'destLogstore' => ['description' => '中心化转投目的日志库，其地域属性应和destRegion保持一致，并且归属destProject下。', 'type' => 'string', 'required' => false, 'example' => 'your-sls-logstore-in-beijing'], + 'destTTL' => ['description' => '中心化转投目的天数，当且仅当中心化转投目的日志库不存在首次创建时有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'your-sls-logstore-ttl'], ], 'required' => false, ], @@ -41019,12 +24690,7 @@ 'description' => '当且仅当日志类型为全局日志类型时支持配置，例如productCode为sls时的场景，表示首次配置时全局日志将被采集到对应地域等。', 'type' => 'object', 'properties' => [ - 'dataRegion' => [ - 'description' => '当且仅当日志类型为全局日志类型时支持配置，例如productCode为sls时的场景，表示首次配置时全局日志将被采集到对应地域。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'dataRegion' => ['description' => '当且仅当日志类型为全局日志类型时支持配置，例如productCode为sls时的场景，表示首次配置时全局日志将被采集到对应地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], 'required' => false, ], @@ -41032,21 +24698,11 @@ 'description' => '资源目录配置，账号必须已经开通资源目录，且为管理员或者委派管理员身份', 'type' => 'object', 'properties' => [ - 'accountGroupType' => [ - 'description' => '支持该资源目录下，全选模式all和自定义模式custom', - 'type' => 'string', - 'required' => false, - 'example' => 'all,custom', - ], + 'accountGroupType' => ['description' => '支持该资源目录下，全选模式all和自定义模式custom', 'type' => 'string', 'required' => false, 'example' => 'all,custom'], 'members' => [ 'description' => '当资源目录配置为custom模式时，对应的成员账号列表', 'type' => 'array', - 'items' => [ - 'description' => '成员账号阿里云Uid', - 'type' => 'string', - 'required' => false, - 'example' => '165***********50', - ], + 'items' => ['description' => '成员账号阿里云Uid', 'type' => 'string', 'required' => false, 'example' => '165***********50'], 'required' => false, ], ], @@ -41061,47 +24717,27 @@ 200 => [ 'headers' => [ 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], ], 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => '创建云产品日志采集的采集规则', 'description' => '该接口服务地址只能是华东 2（上海）、新加坡、河源专属云汽车合规（cn-heyuan-acdr-1）。', @@ -41114,1085 +24750,1736 @@ ], ], 'endpoints' => [ + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-qingdao.log.aliyuncs.com', 'endpoint' => 'cn-qingdao.log.aliyuncs.com', 'vpc' => 'cn-qingdao-internal.log.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-beijing.log.aliyuncs.com', 'endpoint' => 'cn-beijing.log.aliyuncs.com', 'vpc' => 'cn-beijing-internal.log.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-zhangjiakou.log.aliyuncs.com', 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com', 'vpc' => 'cn-zhangjiakou-internal.log.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-huhehaote.log.aliyuncs.com', 'endpoint' => 'cn-huhehaote.log.aliyuncs.com', 'vpc' => 'cn-huhehaote-internal.log.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-wulanchabu.log.aliyuncs.com', 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com', 'vpc' => 'cn-wulanchabu-internal.log.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-hangzhou.log.aliyuncs.com', 'endpoint' => 'cn-hangzhou.log.aliyuncs.com', 'vpc' => 'cn-hangzhou-internal.log.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-shanghai.log.aliyuncs.com', 'endpoint' => 'cn-shanghai.log.aliyuncs.com', 'vpc' => 'cn-shanghai-internal.log.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => '华东5（南京-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-nanjing.log.aliyuncs.com', 'endpoint' => 'cn-nanjing.log.aliyuncs.com', 'vpc' => 'cn-nanjing-internal.log.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'regionName' => '华东6（福州-本地地域）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-fuzhou.log.aliyuncs.com', 'endpoint' => 'cn-fuzhou.log.aliyuncs.com', 'vpc' => 'cn-fuzhou-internal.log.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-shenzhen.log.aliyuncs.com', 'endpoint' => 'cn-shenzhen.log.aliyuncs.com', 'vpc' => 'cn-shenzhen-internal.log.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => '华南2（河源）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-heyuan.log.aliyuncs.com', 'endpoint' => 'cn-heyuan.log.aliyuncs.com', 'vpc' => 'cn-heyuan-internal.log.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-guangzhou.log.aliyuncs.com', 'endpoint' => 'cn-guangzhou.log.aliyuncs.com', 'vpc' => 'cn-guangzhou-internal.log.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-chengdu.log.aliyuncs.com', 'endpoint' => 'cn-chengdu.log.aliyuncs.com', 'vpc' => 'cn-chengdu-internal.log.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-hongkong.log.aliyuncs.com', 'endpoint' => 'cn-hongkong.log.aliyuncs.com', 'vpc' => 'cn-hongkong-internal.log.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '韩国（首尔）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '澳大利亚（悉尼）已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '泰国（曼谷）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '美国（亚特兰大）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', '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' => '印度（孟买）已关停', 'areaId' => 'middleEast', 'areaName' => '中东', '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' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', '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' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', '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' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '河源专属云汽车合规', 'areaId' => 'industryCloud', 'areaName' => '行业云', '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' => '未授权'], + ['code' => 'AlertNotExist', 'message' => '%s.', 'http_code' => 404, 'description' => '告警不存在'], + ['code' => 'AlreadyExist', 'message' => 'App already exist.', 'http_code' => 400, 'description' => '应用已存在'], + ['code' => 'AppNotExist', 'message' => 'The App not exist.', 'http_code' => 400, 'description' => '应用不存在'], + ['code' => 'AuthorizationRequired', 'message' => 'Authorization Required', 'http_code' => 401, 'description' => '没有访问权限，需要进行用户身份认证'], + ['code' => 'ClientError', 'message' => '%s.', 'http_code' => 400, 'description' => '内部服务异常'], + ['code' => 'ConfigServiceNotEnabled', 'message' => '%s.', 'http_code' => 400, 'description' => '配置服务未开启'], + ['code' => 'CreateError', 'message' => 'Create app failed.', 'http_code' => 400, 'description' => '创建应用失败'], + ['code' => 'CreateFailed', 'message' => 'Create app failed.', 'http_code' => 400, 'description' => '创建应用失败'], + ['code' => 'CreateOrderError', 'message' => '%s.', 'http_code' => 200, 'description' => '创建订单错误'], + ['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' => '创建项目失败'], + ['code' => 'DashboardError', 'message' => 'Failed to create or update the dashboard: %s.', 'http_code' => 400, 'description' => '创建或更新仪表盘失败'], + ['code' => 'DeleteFailed', 'message' => 'Delete app failed.', 'http_code' => 400, 'description' => '删除应用失败'], + ['code' => 'DescribeUserBusinessStatusFailed', 'message' => 'Failed to describe user business status.', 'http_code' => 500, 'description' => '查询用户业务状态失败'], + ['code' => 'EntityNotExist.Role', 'message' => '%s.', 'http_code' => 400, 'description' => '角色不存在'], + ['code' => 'EtlMetaAlreadyExist', 'message' => '%s.', 'http_code' => 400, 'description' => '元信息已经存在'], + ['code' => 'EventBridgeNotEnabled', 'message' => '%s.', 'http_code' => 400, 'description' => '服务未开启'], + ['code' => 'ExceedQuota', 'message' => 'The %s quota exceed.', 'http_code' => 400, 'description' => '额度超限'], + ['code' => 'ExceedQuota', 'message' => '%s.', 'http_code' => 400, 'description' => '额度超限'], + ['code' => 'FLOWLOG_INSTANCE_NOT_FOUND', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的实例'], + ['code' => 'GetAlertHistoriesError', 'message' => '%s.', 'http_code' => 400, 'description' => '获取告警历史失败'], + ['code' => 'GetAppFailed', 'message' => 'Get app failed.', 'http_code' => 400, 'description' => '获取应用失败'], + ['code' => 'GetConfigError', 'message' => 'Failed to get configuration information.', 'http_code' => 500, 'description' => '获取配置信息失败。'], + ['code' => 'GetProjectFailed', 'message' => 'Failed to get project.', 'http_code' => 400, 'description' => '获取项目失败'], + ['code' => 'GetProjectFailed', 'message' => 'Failed to get project: %s.', 'http_code' => 400, 'description' => '获取项目失败'], + ['code' => 'GetSpecificationsFailed', 'message' => 'Failed to get specifications of commodity.', 'http_code' => 500, 'description' => '查询商品规格失败'], + ['code' => 'GetSpecificationsFailed', 'message' => '%s.', 'http_code' => 500, 'description' => '获取商品失败'], + ['code' => 'IncorrectStatus.LoadBalancer', 'message' => '%s.', 'http_code' => 400, 'description' => '异常状态'], + ['code' => 'IndexError', 'message' => 'Failed to create or update index.', 'http_code' => 400, 'description' => '创建或更新索引失败'], + ['code' => 'IndexError', 'message' => 'Failed to create or update index: %s.', 'http_code' => 400, 'description' => '创建或更新索引失败'], + ['code' => 'InputParaError', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '输入参数错误'], + ['code' => 'InputParaError', 'message' => '%s.', 'http_code' => 400, 'description' => '输入参数错误'], + ['code' => 'InternalException', 'message' => 'Internal service upexpected exception', 'http_code' => 400, 'description' => '内部服务异常'], + ['code' => 'InternalException', 'message' => 'Internal service upexpected exception.', 'http_code' => 400, 'description' => '内部服务异常'], + ['code' => 'InvalidAppName', 'message' => 'The appName is invalid.', 'http_code' => 400, 'description' => '无效的应用名'], + ['code' => 'InvalidDataType', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的产品类型'], + ['code' => 'InvalidDisplayName', 'message' => 'Display name length exceeds limit.', 'http_code' => 400, 'description' => '显示名称超过长度'], + ['code' => 'InvalidInstance', 'message' => 'The instance is invalid.', 'http_code' => 400, 'description' => '无效的实例'], + ['code' => 'InvalidInstance', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的实例'], + ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The instance does not exist.', 'http_code' => 400, 'description' => '实例不存在'], + ['code' => 'InvalidLang', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的语言'], + ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid: %s', 'http_code' => 400, 'description' => '参数不合法'], + ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid: %s.', 'http_code' => 400, 'description' => '参数不合法'], + ['code' => 'InvalidRAM', 'message' => 'Permission denied.', 'http_code' => 400, 'description' => '鉴权不通过'], + ['code' => 'InvalidRegion', 'message' => 'The region is invalid.', 'http_code' => 400, 'description' => '无效的地域'], + ['code' => 'InvalidVpcId.NotFound', 'message' => 'The vpdId does not exist.', 'http_code' => 400, 'description' => 'VpcId 不存在'], + ['code' => 'JobAlreadyExist', 'message' => 'The job already exists.', 'http_code' => 400, 'description' => '任务已存在'], + ['code' => 'JobError', 'message' => 'Failed to create or update the job.', 'http_code' => 400, 'description' => '任务失败'], + ['code' => 'JobError', 'message' => 'Failed to create or update the job: %s.', 'http_code' => 400, 'description' => '任务失败'], + ['code' => 'LogstoreError', 'message' => 'Failed to create or update the logstore.', 'http_code' => 400, 'description' => '日志库创建或更新失败'], + ['code' => 'LogstoreError', 'message' => 'Failed to create or update the logstore: %s.', 'http_code' => 400, 'description' => '日志库创建或更新失败'], + ['code' => 'LogStoreNotExist', 'message' => 'logstore xxxx does not exist.', 'http_code' => 404, 'description' => '日志库不存在。'], + ['code' => 'LogstoreProductTypeConflict', 'message' => 'The product type doesn\'t match : %s.', 'http_code' => 400, 'description' => '日志库类型不匹配'], + ['code' => 'LogstoreProductTypeConflict', 'message' => '%s.', 'http_code' => 400, 'description' => '日志库类型不匹配'], + ['code' => 'MetricStoreAlreadyExist', 'message' => 'The specified metricstore xxx already exists.', 'http_code' => 400, 'description' => '参数所指定的时序库已存在'], + ['code' => 'MetricStoreNotExist', 'message' => 'The specified metricstore xxx does not exist.', 'http_code' => 404, 'description' => '参数中所指定的时序库不存在'], + ['code' => 'ParameterInvalid', 'message' => '%s.', 'http_code' => 400, 'description' => '参数错误'], + ['code' => 'ParamMissing', 'message' => 'The app name is required.', 'http_code' => 400, 'description' => '参数不合法'], + ['code' => 'ParamsIsNull', 'message' => '%s.', 'http_code' => 400, 'description' => '参数为空'], + ['code' => 'PermissionDenied', 'message' => 'You are not authorized to activate Log Service.', 'http_code' => 400, 'description' => '没有开通SLS服务的权限'], + ['code' => 'PermissionDenied', 'message' => '%s.', 'http_code' => 401, 'description' => '无权限'], + ['code' => 'PostBodyInvalid', 'message' => 'Loggroup contains zero logs.', 'http_code' => 400, 'description' => 'LogGroup中没有日志。'], + ['code' => 'PostBodyInvalid', 'message' => 'Fail to parse protobuf.', 'http_code' => 400, 'description' => 'Protobuffer内容不合法，无法解析。 '], + ['code' => 'PostBodyTooLarge', 'message' => 'Body size must little than 10485760.', 'http_code' => 413, 'description' => '请求body （压缩前）不能超过10MB。'], + ['code' => 'PostBodyUncompressError', 'message' => 'Post body uncompressed fail.', 'http_code' => 400, 'description' => '日志内容解压失败。'], + ['code' => 'ProductDataCollectionNoExist', 'message' => 'failed to find product data collection for this instance', 'http_code' => 400, 'description' => '未找到此实例的采集配置'], + ['code' => 'ProductDataCollectionNoExist', 'message' => 'Failed to find product data collection for this instance.', 'http_code' => 400, 'description' => '未找到此实例的采集配置'], + ['code' => 'ProjectExist', 'message' => '%s.', 'http_code' => 400, 'description' => '项目已存在'], + ['code' => 'ProjectForbidden', 'message' => '%s.', 'http_code' => 400, 'description' => '项目禁止访问'], + ['code' => 'ProjectNotExist', 'message' => '%s.', 'http_code' => 400, 'description' => '项目不存在'], + ['code' => 'ProjectNotExist', 'message' => 'The Project does not exist: xxxx.', 'http_code' => 404, 'description' => '日志项目不存在.'], + ['code' => 'ProjectRegionInvalid', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的地域'], + ['code' => 'RequestError', 'message' => 'Internal Error.', 'http_code' => 400, 'description' => '内部服务异常'], + ['code' => 'ResourceCreating', 'message' => '%s.', 'http_code' => 400, 'description' => '创建资源失败'], + ['code' => 'ResourceNotExist', 'message' => '%s.', 'http_code' => 404, 'description' => '资源不存在'], + ['code' => 'ResourceRecordNotExist', 'message' => 'The resource record is not found because CloudLens has not been enabled.', 'http_code' => 400, 'description' => '没有开通lens，所以查找不到 lens对应的资源记录（resource record）'], + ['code' => 'ResourceRecordNotExist', 'message' => '%s.', 'http_code' => 400, 'description' => '资源记录不存在'], + ['code' => 'SavedSearchError', 'message' => '%s.', 'http_code' => 400, 'description' => '快速查询创建或更新失败'], + ['code' => 'Service.Status.Illeagal', 'message' => '%s.', 'http_code' => 400, 'description' => '非法的服务状态'], + ['code' => 'SetAlertCenterResourceError', 'message' => '%s.', 'http_code' => 400, 'description' => '设置告警资源失败'], + ['code' => 'ShardNotExist', 'message' => 'shard xxx is not exist.', 'http_code' => 404, 'description' => 'Shard不存在。'], + ['code' => 'Unauthorized', 'message' => 'The AccessKeyId is unauthorized.', 'http_code' => null, 'description' => '提供的 AccessKeyId 值未授权。'], + ['code' => 'UnAuthorized', 'message' => '%s.', 'http_code' => 401, 'description' => '未授权'], + ['code' => 'Unauthorized', 'message' => 'Unauthorized: %s.', 'http_code' => 401, 'description' => '未授权'], + ['code' => 'UnRegisterProduct', 'message' => '%s.', 'http_code' => 400, 'description' => '云产品未注册'], + ['code' => 'UpdateFailed', 'message' => 'Update app failed.', 'http_code' => 400, 'description' => '更新应用失败'], + ['code' => 'VerifyInstanceFailed', 'message' => '%s.', 'http_code' => 400, 'description' => '无效的实例'], + ], + 'changeSet' => [ [ - 'regionId' => 'cn-qingdao', - 'regionName' => '华北1（青岛）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-qingdao.log.aliyuncs.com', - 'endpoint' => 'cn-qingdao.log.aliyuncs.com', - 'vpc' => 'cn-qingdao-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'regionName' => '华北2（北京）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-beijing.log.aliyuncs.com', - 'endpoint' => 'cn-beijing.log.aliyuncs.com', - 'vpc' => 'cn-beijing-intranet.log.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UpdateMetricStore'], + ['description' => '响应参数发生变更', 'api' => 'GetMetricStore'], + ['description' => '请求参数发生变更', 'api' => 'CreateMetricStore'], + ['description' => '请求参数发生变更', 'api' => 'UpdateLogStore'], + ['description' => '请求参数发生变更', 'api' => 'CreateLogStore'], + ], + 'createdAt' => '2025-12-03T01:37:06.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-zhangjiakou', - 'regionName' => '华北3（张家口）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-zhangjiakou.log.aliyuncs.com', - 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com', - 'vpc' => 'cn-zhangjiakou-intranet.log.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'UpdateMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'GetMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateLogStore'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateLogStore'], + ['description' => 'OpenAPI 下线', 'api' => 'GetMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateLogStore'], + ['description' => 'OpenAPI 下线', 'api' => 'CreateLogStore'], + ], + 'createdAt' => '2025-12-02T07:21:18.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-huhehaote', - 'regionName' => '华北5（呼和浩特）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-huhehaote.log.aliyuncs.com', - 'endpoint' => 'cn-huhehaote.log.aliyuncs.com', - 'vpc' => 'cn-huhehaote-intranet.log.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateIndexString'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateIndexString'], + ['description' => 'OpenAPI 下线', 'api' => 'GetIndexString'], + ], + 'createdAt' => '2025-12-01T08:34:55.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-wulanchabu', - 'regionName' => '华北6（乌兰察布）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-wulanchabu.log.aliyuncs.com', - 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com', - 'vpc' => 'cn-wulanchabu-intranet.log.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateIndexString'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateIndexString'], + ['description' => 'OpenAPI 下线', 'api' => 'GetIndexString'], + ], + 'createdAt' => '2025-12-01T08:34:55.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou', - 'regionName' => '华东1（杭州）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-hangzhou.log.aliyuncs.com', - 'endpoint' => 'cn-hangzhou.log.aliyuncs.com', - 'vpc' => 'cn-hangzhou-intranet.log.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetMetricStore'], + ['description' => '请求参数发生变更', 'api' => 'CreateMetricStore'], + ['description' => '请求参数发生变更', 'api' => 'UpdateMetricStore'], + ], + 'createdAt' => '2025-11-24T09:35:51.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'regionName' => '华东2（上海）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-shanghai.log.aliyuncs.com', - 'endpoint' => 'cn-shanghai.log.aliyuncs.com', - 'vpc' => 'cn-shanghai-intranet.log.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateMetricStore'], + ['description' => '响应参数发生变更', 'api' => 'GetMetricStoreMeteringMode'], + ['description' => '响应参数发生变更', 'api' => 'ListMetricStores'], + ['description' => '请求参数发生变更', 'api' => 'UpdateMetricStore'], + ], + 'createdAt' => '2024-09-19T09:32:12.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-nanjing', - 'regionName' => '华东5（南京-本地地域）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-nanjing.log.aliyuncs.com', - 'endpoint' => 'cn-nanjing.log.aliyuncs.com', - 'vpc' => 'cn-nanjing-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fuzhou', - 'regionName' => '华东6（福州-本地地域）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-fuzhou.log.aliyuncs.com', - 'endpoint' => 'cn-fuzhou.log.aliyuncs.com', - 'vpc' => 'cn-fuzhou-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'regionName' => '华南1（深圳）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-shenzhen.log.aliyuncs.com', - 'endpoint' => 'cn-shenzhen.log.aliyuncs.com', - 'vpc' => 'cn-shenzhen-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'regionName' => '华南2（河源）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-heyuan.log.aliyuncs.com', - 'endpoint' => 'cn-heyuan.log.aliyuncs.com', - 'vpc' => 'cn-heyuan-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'regionName' => '华南3（广州）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-guangzhou.log.aliyuncs.com', - 'endpoint' => 'cn-guangzhou.log.aliyuncs.com', - 'vpc' => 'cn-guangzhou-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'regionName' => '西南1（成都）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-chengdu.log.aliyuncs.com', - 'endpoint' => 'cn-chengdu.log.aliyuncs.com', - 'vpc' => 'cn-chengdu-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'regionName' => '中国香港', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'cn-hongkong.log.aliyuncs.com', - 'endpoint' => 'cn-hongkong.log.aliyuncs.com', - 'vpc' => 'cn-hongkong-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'regionName' => '日本（东京）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'ap-northeast-1.log.aliyuncs.com', - 'endpoint' => 'ap-northeast-1.log.aliyuncs.com', - 'vpc' => 'ap-northeast-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'regionName' => '韩国（首尔）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'ap-northeast-2.log.aliyuncs.com', - 'endpoint' => 'ap-northeast-2.log.aliyuncs.com', - 'vpc' => 'ap-northeast-2-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'regionName' => '新加坡', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'ap-southeast-1.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-1.log.aliyuncs.com', - 'vpc' => 'ap-southeast-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'regionName' => '澳大利亚（悉尼）已关停', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'ap-southeast-2.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-2.log.aliyuncs.com', - 'vpc' => 'ap-southeast-2-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'regionName' => '马来西亚（吉隆坡）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'ap-southeast-3.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-3.log.aliyuncs.com', - 'vpc' => 'ap-southeast-3-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'regionName' => '印度尼西亚（雅加达）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'ap-southeast-5.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-5.log.aliyuncs.com', - 'vpc' => 'ap-southeast-5-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'regionName' => '菲律宾（马尼拉）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'ap-southeast-6.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-6.log.aliyuncs.com', - 'vpc' => 'ap-southeast-6-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'regionName' => '泰国（曼谷）', - 'areaId' => 'asiaPacific', - 'areaName' => '亚太', - 'public' => 'ap-southeast-7.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-7.log.aliyuncs.com', - 'vpc' => 'ap-southeast-7-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-southeast-1', - 'regionName' => '美国（亚特兰大）', - 'areaId' => 'europeAmerica', - 'areaName' => '欧洲与美洲', - 'public' => 'us-southeast-1.log.aliyuncs.com', - 'endpoint' => 'us-southeast-1.log.aliyuncs.com', - 'vpc' => '', - ], - [ - 'regionId' => 'eu-central-1', - 'regionName' => '德国（法兰克福）', - 'areaId' => 'europeAmerica', - 'areaName' => '欧洲与美洲', - 'public' => 'eu-central-1.log.aliyuncs.com', - 'endpoint' => 'eu-central-1.log.aliyuncs.com', - 'vpc' => 'eu-central-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'regionName' => '英国（伦敦）', - 'areaId' => 'europeAmerica', - 'areaName' => '欧洲与美洲', - 'public' => 'eu-west-1.log.aliyuncs.com', - 'endpoint' => 'eu-west-1.log.aliyuncs.com', - 'vpc' => 'eu-west-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'regionName' => '美国（硅谷）', - 'areaId' => 'europeAmerica', - 'areaName' => '欧洲与美洲', - 'public' => 'us-west-1.log.aliyuncs.com', - 'endpoint' => 'us-west-1.log.aliyuncs.com', - 'vpc' => 'us-west-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'regionName' => '美国（弗吉尼亚）', - 'areaId' => 'europeAmerica', - 'areaName' => '欧洲与美洲', - 'public' => 'us-east-1.log.aliyuncs.com', - 'endpoint' => 'us-east-1.log.aliyuncs.com', - 'vpc' => 'us-east-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'regionName' => '沙特（利雅得）', - 'areaId' => 'middleEast', - 'areaName' => '中东', - 'public' => 'me-central-1.log.aliyuncs.com', - 'endpoint' => 'me-central-1.log.aliyuncs.com', - 'vpc' => 'me-central-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'regionName' => '阿联酋（迪拜）', - 'areaId' => 'middleEast', - 'areaName' => '中东', - 'public' => 'me-east-1.log.aliyuncs.com', - 'endpoint' => 'me-east-1.log.aliyuncs.com', - 'vpc' => 'me-east-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'regionName' => '印度（孟买）已关停', - 'areaId' => 'middleEast', - 'areaName' => '中东', - 'public' => 'ap-south-1.log.aliyuncs.com', - 'endpoint' => 'ap-south-1.log.aliyuncs.com', - 'vpc' => 'ap-south-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan-acdr-1', - 'regionName' => '河源专属云汽车合规', - 'areaId' => 'industryCloud', - 'areaName' => '行业云', - 'public' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', - 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', - 'vpc' => '', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'regionName' => '华北2 金融云（邀测）', - 'areaId' => 'industryCloud', - 'areaName' => '行业云', - 'public' => 'cn-beijing-finance-1.log.aliyuncs.com', - 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com', - 'vpc' => 'cn-beijing-finance-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'regionName' => '华南1 金融云', - 'areaId' => 'industryCloud', - 'areaName' => '行业云', - 'public' => 'cn-shenzhen-finance-1.log.aliyuncs.com', - 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com', - 'vpc' => '', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'regionName' => '华东2 金融云', - 'areaId' => 'industryCloud', - 'areaName' => '行业云', - 'public' => 'cn-shanghai-finance-1.log.aliyuncs.com', - 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com', - 'vpc' => 'cn-shanghai-finance-1-intranet.log.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'PullLogs'], + ['description' => '请求参数发生变更', 'api' => 'PutLogs'], + ], + 'createdAt' => '2024-09-06T05:59:15.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou-finance', - 'regionName' => '华东1 金融云', - 'areaId' => 'industryCloud', - 'areaName' => '行业云', - 'public' => 'cn-hangzhou-finance.log.aliyuncs.com', - 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com', - 'vpc' => 'cn-hangzhou-finance-intranet.log.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'DeleteMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'GetMetricStore'], + ['description' => 'OpenAPI 下线', 'api' => 'ListMetricStores'], + ['description' => 'OpenAPI 下线', 'api' => 'UpdateMetricStore'], + ], + 'createdAt' => '2024-08-28T13:01:13.000Z', + 'description' => '', ], ], - 'errorCodes' => [ - [ - 'code' => 'AccessDenied', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '未授权', - ], - [ - 'code' => 'AlertNotExist', - 'message' => '%s.', - 'http_code' => 404, - 'description' => '告警不存在', - ], - [ - 'code' => 'AlreadyExist', - 'message' => 'App already exist.', - 'http_code' => 400, - 'description' => '应用已存在', - ], - [ - 'code' => 'AppNotExist', - 'message' => 'The App not exist.', - 'http_code' => 400, - 'description' => '应用不存在', - ], - [ - 'code' => 'AuthorizationRequired', - 'message' => 'Authorization Required', - 'http_code' => 401, - 'description' => '没有访问权限，需要进行用户身份认证', - ], - [ - 'code' => 'ClientError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '内部服务异常', - ], - [ - 'code' => 'ConfigServiceNotEnabled', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '配置服务未开启', - ], - [ - 'code' => 'CreateError', - 'message' => 'Create app failed.', - 'http_code' => 400, - 'description' => '创建应用失败', - ], - [ - 'code' => 'CreateFailed', - 'message' => 'Create app failed.', - 'http_code' => 400, - 'description' => '创建应用失败', - ], - [ - 'code' => 'CreateOrderError', - 'message' => '%s.', - 'http_code' => 200, - 'description' => '创建订单错误', - ], - [ - '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' => '创建项目失败', - ], - [ - 'code' => 'DashboardError', - 'message' => 'Failed to create or update the dashboard: %s.', - 'http_code' => 400, - 'description' => '创建或更新仪表盘失败', - ], - [ - 'code' => 'DeleteFailed', - 'message' => 'Delete app failed.', - 'http_code' => 400, - 'description' => '删除应用失败', - ], - [ - 'code' => 'DescribeUserBusinessStatusFailed', - 'message' => 'Failed to describe user business status.', - 'http_code' => 500, - 'description' => '查询用户业务状态失败', - ], - [ - 'code' => 'EntityNotExist.Role', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '角色不存在', - ], - [ - 'code' => 'EtlMetaAlreadyExist', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '元信息已经存在', - ], - [ - 'code' => 'EventBridgeNotEnabled', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '服务未开启', - ], - [ - 'code' => 'ExceedQuota', - 'message' => 'The %s quota exceed.', - 'http_code' => 400, - 'description' => '额度超限', - ], - [ - 'code' => 'ExceedQuota', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '额度超限', - ], - [ - 'code' => 'FLOWLOG_INSTANCE_NOT_FOUND', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '无效的实例', - ], - [ - 'code' => 'GetAlertHistoriesError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '获取告警历史失败', - ], - [ - 'code' => 'GetAppFailed', - 'message' => 'Get app failed.', - 'http_code' => 400, - 'description' => '获取应用失败', - ], - [ - 'code' => 'GetConfigError', - 'message' => 'Failed to get configuration information.', - 'http_code' => 500, - 'description' => '获取配置信息失败。', - ], - [ - 'code' => 'GetProjectFailed', - 'message' => 'Failed to get project.', - 'http_code' => 400, - 'description' => '获取项目失败', - ], - [ - 'code' => 'GetProjectFailed', - 'message' => 'Failed to get project: %s.', - 'http_code' => 400, - 'description' => '获取项目失败', - ], - [ - 'code' => 'GetSpecificationsFailed', - 'message' => 'Failed to get specifications of commodity.', - 'http_code' => 500, - 'description' => '查询商品规格失败', - ], - [ - 'code' => 'GetSpecificationsFailed', - 'message' => '%s.', - 'http_code' => 500, - 'description' => '获取商品失败', - ], - [ - 'code' => 'IncorrectStatus.LoadBalancer', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '异常状态', - ], - [ - 'code' => 'IndexError', - 'message' => 'Failed to create or update index.', - 'http_code' => 400, - 'description' => '创建或更新索引失败', - ], - [ - 'code' => 'IndexError', - 'message' => 'Failed to create or update index: %s.', - 'http_code' => 400, - 'description' => '创建或更新索引失败', - ], - [ - 'code' => 'InputParaError', - 'message' => 'The specified parameter is invalid.', - 'http_code' => 400, - 'description' => '输入参数错误', - ], - [ - 'code' => 'InputParaError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '输入参数错误', - ], - [ - 'code' => 'InternalException', - 'message' => 'Internal service upexpected exception', - 'http_code' => 400, - 'description' => '内部服务异常', - ], - [ - 'code' => 'InternalException', - 'message' => 'Internal service upexpected exception.', - 'http_code' => 400, - 'description' => '内部服务异常', - ], - [ - 'code' => 'InvalidAppName', - 'message' => 'The appName is invalid.', - 'http_code' => 400, - 'description' => '无效的应用名', - ], - [ - 'code' => 'InvalidDataType', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '无效的产品类型', - ], - [ - 'code' => 'InvalidDisplayName', - 'message' => 'Display name length exceeds limit.', - 'http_code' => 400, - 'description' => '显示名称超过长度', - ], - [ - 'code' => 'InvalidInstance', - 'message' => 'The instance is invalid.', - 'http_code' => 400, - 'description' => '无效的实例', - ], - [ - 'code' => 'InvalidInstance', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '无效的实例', - ], - [ - 'code' => 'InvalidInstanceId.NotFound', - 'message' => 'The instance does not exist.', - 'http_code' => 400, - 'description' => '实例不存在', - ], - [ - 'code' => 'InvalidLang', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '无效的语言', - ], - [ - 'code' => 'InvalidParameter', - 'message' => 'The parameter is invalid: %s', - 'http_code' => 400, - 'description' => '参数不合法', - ], - [ - 'code' => 'InvalidParameter', - 'message' => 'The parameter is invalid: %s.', - 'http_code' => 400, - 'description' => '参数不合法', - ], - [ - 'code' => 'InvalidRAM', - 'message' => 'Permission denied.', - 'http_code' => 400, - 'description' => '鉴权不通过', - ], - [ - 'code' => 'InvalidRegion', - 'message' => 'The region is invalid.', - 'http_code' => 400, - 'description' => '无效的地域', - ], - [ - 'code' => 'InvalidVpcId.NotFound', - 'message' => 'The vpdId does not exist.', - 'http_code' => 400, - 'description' => 'VpcId 不存在', - ], - [ - 'code' => 'JobAlreadyExist', - 'message' => 'The job already exists.', - 'http_code' => 400, - 'description' => '任务已存在', - ], - [ - 'code' => 'JobError', - 'message' => 'Failed to create or update the job.', - 'http_code' => 400, - 'description' => '任务失败', - ], - [ - 'code' => 'JobError', - 'message' => 'Failed to create or update the job: %s.', - 'http_code' => 400, - 'description' => '任务失败', - ], - [ - 'code' => 'LogstoreError', - 'message' => 'Failed to create or update the logstore.', - 'http_code' => 400, - 'description' => '日志库创建或更新失败', - ], - [ - 'code' => 'LogstoreError', - 'message' => 'Failed to create or update the logstore: %s.', - 'http_code' => 400, - 'description' => '日志库创建或更新失败', - ], - [ - 'code' => 'LogStoreNotExist', - 'message' => 'logstore xxxx does not exist.', - 'http_code' => 404, - 'description' => '日志库不存在。', - ], - [ - 'code' => 'LogstoreProductTypeConflict', - 'message' => 'The product type doesn\'t match : %s.', - 'http_code' => 400, - 'description' => '日志库类型不匹配', - ], - [ - 'code' => 'LogstoreProductTypeConflict', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '日志库类型不匹配', - ], - [ - 'code' => 'MetricStoreAlreadyExist', - 'message' => 'The specified metricstore xxx already exists.', - 'http_code' => 400, - 'description' => '参数所指定的时序库已存在', - ], - [ - 'code' => 'MetricStoreNotExist', - 'message' => 'The specified metricstore xxx does not exist.', - 'http_code' => 404, - 'description' => '参数中所指定的时序库不存在', - ], - [ - 'code' => 'ParameterInvalid', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '参数错误', - ], - [ - 'code' => 'ParamMissing', - 'message' => 'The app name is required.', - 'http_code' => 400, - 'description' => '参数不合法', - ], - [ - 'code' => 'ParamsIsNull', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '参数为空', - ], - [ - 'code' => 'PermissionDenied', - 'message' => 'You are not authorized to activate Log Service.', - 'http_code' => 400, - 'description' => '没有开通SLS服务的权限', - ], - [ - 'code' => 'PermissionDenied', - 'message' => '%s.', - 'http_code' => 401, - 'description' => '无权限', - ], - [ - 'code' => 'PostBodyInvalid', - 'message' => 'Loggroup contains zero logs.', - 'http_code' => 400, - 'description' => 'LogGroup中没有日志。', - ], - [ - 'code' => 'PostBodyInvalid', - 'message' => 'Fail to parse protobuf.', - 'http_code' => 400, - 'description' => 'Protobuffer内容不合法，无法解析。 ', - ], - [ - 'code' => 'PostBodyTooLarge', - 'message' => 'Body size must little than 10485760.', - 'http_code' => 413, - 'description' => '请求body （压缩前）不能超过10MB。', - ], - [ - 'code' => 'PostBodyUncompressError', - 'message' => 'Post body uncompressed fail.', - 'http_code' => 400, - 'description' => '日志内容解压失败。', - ], - [ - 'code' => 'ProductDataCollectionNoExist', - 'message' => 'failed to find product data collection for this instance', - 'http_code' => 400, - 'description' => '未找到此实例的采集配置', - ], - [ - 'code' => 'ProductDataCollectionNoExist', - 'message' => 'Failed to find product data collection for this instance.', - 'http_code' => 400, - 'description' => '未找到此实例的采集配置', - ], - [ - 'code' => 'ProjectExist', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '项目已存在', - ], - [ - 'code' => 'ProjectForbidden', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '项目禁止访问', - ], - [ - 'code' => 'ProjectNotExist', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '项目不存在', - ], - [ - 'code' => 'ProjectNotExist', - 'message' => 'The Project does not exist: xxxx.', - 'http_code' => 404, - 'description' => '日志项目不存在.', - ], - [ - 'code' => 'ProjectRegionInvalid', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '无效的地域', - ], - [ - 'code' => 'RequestError', - 'message' => 'Internal Error.', - 'http_code' => 400, - 'description' => '内部服务异常', - ], - [ - 'code' => 'ResourceCreating', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '创建资源失败', - ], - [ - 'code' => 'ResourceNotExist', - 'message' => '%s.', - 'http_code' => 404, - 'description' => '资源不存在', - ], - [ - 'code' => 'ResourceRecordNotExist', - 'message' => 'The resource record is not found because CloudLens has not been enabled.', - 'http_code' => 400, - 'description' => '没有开通lens，所以查找不到 lens对应的资源记录（resource record）', - ], - [ - 'code' => 'ResourceRecordNotExist', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '资源记录不存在', - ], - [ - 'code' => 'SavedSearchError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '快速查询创建或更新失败', - ], - [ - 'code' => 'Service.Status.Illeagal', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '非法的服务状态', - ], - [ - 'code' => 'SetAlertCenterResourceError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '设置告警资源失败', - ], - [ - 'code' => 'ShardNotExist', - 'message' => 'shard xxx is not exist.', - 'http_code' => 404, - 'description' => 'Shard不存在。', - ], - [ - 'code' => 'Unauthorized', - 'message' => 'The AccessKeyId is unauthorized.', - 'http_code' => null, - 'description' => '提供的 AccessKeyId 值未授权。', - ], - [ - 'code' => 'UnAuthorized', - 'message' => '%s.', - 'http_code' => 401, - 'description' => '未授权', - ], - [ - 'code' => 'Unauthorized', - 'message' => 'Unauthorized: %s.', - 'http_code' => 401, - 'description' => '未授权', - ], - [ - 'code' => 'UnRegisterProduct', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '云产品未注册', - ], - [ - 'code' => 'UpdateFailed', - 'message' => 'Update app failed.', - 'http_code' => 400, - 'description' => '更新应用失败', - ], - [ - 'code' => 'VerifyInstanceFailed', - 'message' => '%s.', - 'http_code' => 400, - 'description' => '无效的实例', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ], ], - 'changeSet' => [ - [ - 'apis' => [ - [ - 'description' => '请求参数发生变更', - 'api' => 'UpdateMetricStore', + 'ram' => [ + 'productCode' => 'SLS', + 'productName' => '日志服务', + 'ramCodes' => ['log'], + 'ramLevel' => '资源级', + 'ramConditions' => [ + [ + 'name' => 'log:TLSVersion', + 'schema' => [ + 'type' => 'String', + 'description' => 'TLS的版本', + 'enums' => ['TLSv1', 'TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + ], + ], + [ + 'name' => 'log:Encrypted', + 'schema' => [ + 'type' => 'Boolean', + 'description' => '创建或者修改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' => '列出OSS导入任务', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListOSSIngestions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', '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' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLogStoreMeteringMode', + 'description' => '查询LogStore计量模式', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetLogStoreMeteringMode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', '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' => '列出OSS-HDFS投递任务', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListOSSHDFSExports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAlert', + 'description' => '创建告警规则', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateLogStore', + 'description' => '更新LogStore', + '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' => '全部资源', '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' => '删除指定Project', + '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' => '列出定时SQL任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:ListScheduledSQLs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCursor', + 'description' => '通过时间查询Cursor', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLogStore', + 'description' => '创建LogStore', + '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' => '通过Logtail配置获取已绑定的机器组', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLogtailPipelineConfig', + 'description' => '创建Logtail流水线配置', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateLogtailPipelineConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteConfig', + 'description' => '删除Logtail配置', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLogStore', + 'description' => '查看Logstore信息', + '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' => '更新Logtail采集配置', + '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' => '罗列Logtail流水线配置', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListLogtailPipelineConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCursorTime', + 'description' => '通过Cursor查询服务器端时间', + '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' => '查询Logtail配置列表', + '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' => '全部资源', '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' => '关闭定时SQL', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:DisableScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSqlInstance', + 'description' => '查询SQL 独享实例', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSqlInstance', + 'description' => '创建SQL独享实例', + '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' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetScheduledSQL', + 'description' => '获取定时SQL任务', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateStoreView', + 'description' => '更新数据集配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateStoreView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListProject', + 'description' => '列出Project信息', + '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' => '全部资源', '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' => '全部资源', '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' => '创建定时SQL任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', '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' => '查询Project下的机器组', + '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' => '删除定时SQL任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteScheduledSQL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListShards', + 'description' => '查询shard列表', + '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' => '创建Logtail采集配置', + '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}'], + ], ], - [ - 'description' => '响应参数发生变更', - 'api' => 'GetMetricStore', + ], + [ + 'apiName' => 'UpdateLogStoreMeteringMode', + 'description' => '更新LogStore计量模式', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateLogStoreMeteringMode', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => '请求参数发生变更', - 'api' => 'CreateMetricStore', + ], + [ + '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}'], + ], ], - [ - 'description' => '请求参数发生变更', - 'api' => 'UpdateLogStore', + ], + [ + 'apiName' => 'DeleteAlert', + 'description' => '删除告警规则', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => '请求参数发生变更', - 'api' => 'CreateLogStore', + ], + [ + 'apiName' => 'GetConfig', + 'description' => '获取Logtail采集配置', + '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}'], + ], ], ], - 'createdAt' => '2025-12-03T01:37:06.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'OpenAPI 下线', - 'api' => 'UpdateMetricStore', + [ + '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}'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'GetMetricStore', + ], + [ + 'apiName' => 'UpdateScheduledSQL', + 'description' => '更新定时SQL任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'UpdateLogStore', + ], + [ + 'apiName' => 'GetLogtailPipelineConfig', + 'description' => '获取Logtail流水线配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetLogtailPipelineConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'CreateMetricStore', + ], + [ + '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}'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'CreateLogStore', + ], + [ + '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/*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'GetMetricStore', + ], + [ + 'apiName' => 'MergeShard', + 'description' => '合并shard', + '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}'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'UpdateMetricStore', + ], + [ + 'apiName' => 'GetStoreViewIndex', + 'description' => '查询指定数据集索引配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetStoreViewIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'CreateMetricStore', + ], + [ + 'apiName' => 'GetProject', + 'description' => '获取指定Project', + '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}'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'UpdateLogStore', + ], + [ + 'apiName' => 'DeleteStoreView', + 'description' => '删除数据集', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteStoreView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'CreateLogStore', + ], + [ + 'apiName' => 'UpdateSqlInstance', + 'description' => '更新SQL 独享实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateSqlInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], ], ], - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'OpenAPI 下线', - 'api' => 'CreateIndexString', + [ + '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'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'UpdateIndexString', + ], + [ + 'apiName' => 'CreateDashboard', + 'description' => '创建仪表盘', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateDashboard', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'GetIndexString', + ], + [ + 'apiName' => 'DeleteLogStore', + 'description' => '删除LogStore', + '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}'], + ], ], ], - 'createdAt' => '2025-12-01T08:34:55.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'OpenAPI 下线', - 'api' => 'CreateIndexString', + [ + '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}'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'UpdateIndexString', + ], + [ + 'apiName' => 'UpdateLogtailPipelineConfig', + 'description' => '更新Logtail流水线配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateLogtailPipelineConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'GetIndexString', + ], + [ + 'apiName' => 'UpdateProject', + 'description' => '更新Project', + '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}'], + ], ], ], - 'createdAt' => '2025-12-01T08:34:55.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => '响应参数发生变更', - 'api' => 'GetMetricStore', + [ + 'apiName' => 'ConsumerGroupHeartBeat', + 'description' => '消费者发送心跳到服务端', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:ConsumerGroupHeartBeat', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => '请求参数发生变更', - 'api' => 'CreateMetricStore', + ], + [ + 'apiName' => 'CreateProject', + 'description' => '创建Project', + '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}'], + ], ], - [ - 'description' => '请求参数发生变更', - 'api' => 'UpdateMetricStore', + ], + [ + 'apiName' => 'DisableAlert', + 'description' => '关闭告警规则', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:DisableAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'createdAt' => '2025-11-24T09:35:51.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => '请求参数发生变更', - 'api' => 'CreateMetricStore', + [ + 'apiName' => 'ListLogStores', + 'description' => '列出LogStore', + '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/*'], + ], ], - [ - 'description' => '响应参数发生变更', - 'api' => 'GetMetricStoreMeteringMode', + ], + [ + 'apiName' => 'UpdateMachineGroupMachine', + 'description' => '修改机器组机器列表', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateMachineGroupMachine', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => '响应参数发生变更', - 'api' => 'ListMetricStores', + ], + [ + 'apiName' => 'DeleteProjectPolicy', + 'description' => '删除Project授权策略', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => '请求参数发生变更', - 'api' => 'UpdateMetricStore', + ], + [ + '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/*'], + ], ], ], - 'createdAt' => '2024-09-19T09:32:12.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'OpenAPI 下线', - 'api' => 'PullLogs', + [ + 'apiName' => 'EnableScheduledSQL', + 'description' => '开启定时SQL', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:EnableScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => '请求参数发生变更', - 'api' => 'PutLogs', + ], + [ + 'apiName' => 'PutProjectPolicy', + 'description' => '创建Project授权策略', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:PutProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'createdAt' => '2024-09-06T05:59:15.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'OpenAPI 下线', - 'api' => 'CreateMetricStore', + [ + 'apiName' => 'ApplyConfigToMachineGroup', + 'description' => '应用Logtail配置到机器组', + '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}'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'DeleteMetricStore', + ], + [ + 'apiName' => 'GetProjectPolicy', + 'description' => '查询Project授权策略', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'GetMetricStore', + ], + [ + '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/*'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'ListMetricStores', + ], + [ + 'apiName' => 'SplitShard', + 'description' => '分裂Shard', + '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}'], + ], ], - [ - 'description' => 'OpenAPI 下线', - 'api' => 'UpdateMetricStore', + ], + [ + 'apiName' => 'ListETLs', + 'description' => '列出数据加工任务', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListETLs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'createdAt' => '2024-08-28T13:01:13.000Z', - 'description' => '', - ], - ], - 'flowControl' => [ - 'flowControlList' => [ [ - 'threshold' => '-1', - 'countWindow' => 1, - 'regionId' => '*', + 'apiName' => 'ListOSSExports', + 'description' => '列出OSS投递任务', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListOSSExports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - ], - ], - 'ram' => [ - 'productCode' => 'SLS', - 'productName' => '日志服务', - 'ramCodes' => [ - 'log', - ], - 'ramLevel' => '服务级', - 'ramConditions' => [ [ - 'name' => 'log:TLSVersion', - 'schema' => [ - 'type' => 'String', - 'description' => 'TLS的版本', - 'enums' => [ - 'TLSv1', - 'TLSv1.1', - 'TLSv1.2', - 'TLSv1.3', + '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}'], ], ], ], [ - 'name' => 'log:Encrypted', - 'schema' => [ - 'type' => 'Boolean', - 'description' => '创建或者修改Logstore时是否指定加密配置', - 'enums' => [ - 'true', - 'false', + 'apiName' => 'GetAlert', + 'description' => '获取告警规则', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], + [ + 'apiName' => 'GetAppliedConfigs', + 'description' => '获取已应用的Logtail配置列表', + '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/*'], ], - 'ramActions' => [], - 'resourceTypes' => [], ], ]; -- cgit v1.2.3