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/en_us/sls/2018-06-13/api-docs.php | 350 +- data/en_us/sls/2019-10-23/api-docs.php | 1899 +- data/en_us/sls/2020-12-30/api-docs.php | 42035 +++++++++---------------------- 3 files changed, 12912 insertions(+), 31372 deletions(-) (limited to 'data/en_us/sls') diff --git a/data/en_us/sls/2018-06-13/api-docs.php b/data/en_us/sls/2018-06-13/api-docs.php index bdfb046..2a9505c 100644 --- a/data/en_us/sls/2018-06-13/api-docs.php +++ b/data/en_us/sls/2018-06-13/api-docs.php @@ -1,18 +1,12 @@ '1.0', - 'info' => [ - 'style' => 'SLS', - 'product' => 'Sls', - 'version' => '2018-06-13', - ], + 'info' => ['style' => 'SLS', 'product' => 'Sls', 'version' => '2018-06-13'], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', - 'children' => [ - 'AnalyzeProductLog', - ], + 'children' => ['AnalyzeProductLog'], ], ], 'components' => [ @@ -21,14 +15,8 @@ 'apis' => [ 'AnalyzeProductLog' => [ 'summary' => '操作云产品日志服务资源', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41,97 +29,59 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84924', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Logstore', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'CloudProduct', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'TTL', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'ResourceQuota', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Overwrite', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'true'], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'VariableMap', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - ], + 'schema' => ['type' => 'object', 'required' => false], ], ], 'responses' => [ @@ -139,234 +89,74 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CreateProjectFailed', - 'errorMessage' => 'Failed to create the project: %s.', - ], - [ - 'errorCode' => 'ParamsIsNull', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The region is invalid.', - ], - [ - 'errorCode' => 'ProjectExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'LogstoreError', - 'errorMessage' => 'Failed to create or update the logstore: %s.', - ], - [ - 'errorCode' => 'DashboardError', - 'errorMessage' => 'Failed to create or update the dashboard: %s.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The parameter is invalid: %s.', - ], - [ - 'errorCode' => 'ProjectRegionInvalid', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'UnRegisterProduct', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'GetProjectFailed', - 'errorMessage' => 'Failed to get project: %s.', - ], - [ - 'errorCode' => 'InvalidLang', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'SavedSearchError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'IndexError', - 'errorMessage' => 'Failed to create or update index: %s.', - ], - [ - 'errorCode' => 'JobError', - 'errorMessage' => 'Failed to create or update the job: %s.', - ], + ['errorCode' => 'CreateProjectFailed', 'errorMessage' => 'Failed to create the project: %s.'], + ['errorCode' => 'ParamsIsNull', 'errorMessage' => '%s.'], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The region is invalid.'], + ['errorCode' => 'ProjectExist', 'errorMessage' => '%s.'], + ['errorCode' => 'LogstoreError', 'errorMessage' => 'Failed to create or update the logstore: %s.'], + ['errorCode' => 'DashboardError', 'errorMessage' => 'Failed to create or update the dashboard: %s.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The parameter is invalid: %s.'], + ['errorCode' => 'ProjectRegionInvalid', 'errorMessage' => '%s.'], + ['errorCode' => 'UnRegisterProduct', 'errorMessage' => '%s.'], + ['errorCode' => 'GetProjectFailed', 'errorMessage' => 'Failed to get project: %s.'], + ['errorCode' => 'InvalidLang', 'errorMessage' => '%s.'], + ['errorCode' => 'SavedSearchError', 'errorMessage' => '%s.'], + ['errorCode' => 'IndexError', 'errorMessage' => 'Failed to create or update index: %s.'], + ['errorCode' => 'JobError', 'errorMessage' => 'Failed to create or update the job: %s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => null, ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'cn-qingdao.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'cn-beijing.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'cn-huhehaote.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'cn-hangzhou.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'cn-shanghai.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'cn-nanjing.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fuzhou', - 'endpoint' => 'cn-fuzhou.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'cn-shenzhen.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'cn-heyuan.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'cn-guangzhou.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'cn-chengdu.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'cn-hongkong.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'ap-northeast-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'ap-northeast-2.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ap-southeast-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'ap-southeast-2.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'ap-southeast-3.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'ap-southeast-5.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'ap-southeast-6.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'ap-southeast-7.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'us-east-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'us-west-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'eu-west-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'eu-central-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-southeast-1', - 'endpoint' => 'us-southeast-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'ap-south-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'me-east-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'me-central-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan-acdr-1', - 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', - ], + ['regionId' => 'cn-qingdao', 'endpoint' => 'cn-qingdao.log.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'cn-beijing.log.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'endpoint' => 'cn-huhehaote.log.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'endpoint' => 'cn-hangzhou.log.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'endpoint' => 'cn-shanghai.log.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'endpoint' => 'cn-nanjing.log.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'endpoint' => 'cn-fuzhou.log.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'endpoint' => 'cn-shenzhen.log.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'endpoint' => 'cn-heyuan.log.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'endpoint' => 'cn-guangzhou.log.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'endpoint' => 'cn-chengdu.log.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'endpoint' => 'cn-hongkong.log.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'endpoint' => 'ap-northeast-1.log.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'endpoint' => 'ap-northeast-2.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'endpoint' => 'ap-southeast-1.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'endpoint' => 'ap-southeast-2.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'endpoint' => 'ap-southeast-3.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'endpoint' => 'ap-southeast-5.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'endpoint' => 'ap-southeast-6.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'endpoint' => 'ap-southeast-7.log.aliyuncs.com'], + ['regionId' => 'us-southeast-1', 'endpoint' => 'us-southeast-1.log.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'endpoint' => 'eu-central-1.log.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'endpoint' => 'eu-west-1.log.aliyuncs.com'], + ['regionId' => 'us-west-1', 'endpoint' => 'us-west-1.log.aliyuncs.com'], + ['regionId' => 'us-east-1', 'endpoint' => 'us-east-1.log.aliyuncs.com'], + ['regionId' => 'me-central-1', 'endpoint' => 'me-central-1.log.aliyuncs.com'], + ['regionId' => 'me-east-1', 'endpoint' => 'me-east-1.log.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'endpoint' => 'ap-south-1.log.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com'], ], ]; diff --git a/data/en_us/sls/2019-10-23/api-docs.php b/data/en_us/sls/2019-10-23/api-docs.php index 743a354..915ee81 100644 --- a/data/en_us/sls/2019-10-23/api-docs.php +++ b/data/en_us/sls/2019-10-23/api-docs.php @@ -1,44 +1,15 @@ '1.0', - 'info' => [ - 'style' => 'SLS', - 'product' => 'Sls', - 'version' => '2019-10-23', - ], - 'directories' => [ - 'AnalyzeAppLog', - 'AnalyzeProductLog', - 'CreateApp', - 'DeleteApp', - 'DescribeApp', - 'DisableAlert', - 'EnableAlert', - 'GetAlert', - 'GetAlertHistories', - 'GetSlsService', - 'OpenSlsService', - 'SetAlertActionPolicy', - 'SetAlertCenterResource', - 'SyncAlertGroups', - 'SyncAlertUsers', - 'UpdateApp', - 'InitUserAlertResource', - 'InitProjectAlertResource', - ], + 'info' => ['style' => 'SLS', 'product' => 'Sls', 'version' => '2019-10-23'], + 'directories' => ['AnalyzeAppLog', 'AnalyzeProductLog', 'CreateApp', 'DeleteApp', 'DescribeApp', 'DisableAlert', 'EnableAlert', 'GetAlert', 'GetAlertHistories', 'GetSlsService', 'OpenSlsService', 'SetAlertActionPolicy', 'SetAlertCenterResource', 'SyncAlertGroups', 'SyncAlertUsers', 'UpdateApp', 'InitUserAlertResource', 'InitProjectAlertResource'], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AnalyzeAppLog' => [ 'summary' => '创建或更新应用', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51,44 +22,29 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84948', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'AppType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'VariableMap', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'object', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -96,107 +52,43 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CreateProjectFailed', - 'errorMessage' => 'Failed to create the project: %s.', - ], - [ - 'errorCode' => 'JobError', - 'errorMessage' => 'Failed to create or update the job: %s.', - ], - [ - 'errorCode' => 'LogstoreError', - 'errorMessage' => 'Failed to create or update the logstore: %s.', - ], - [ - 'errorCode' => 'ParamsIsNull', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ProjectExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The region is invalid.', - ], - [ - 'errorCode' => 'DashboardError', - 'errorMessage' => 'Failed to create or update the dashboard: %s.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The parameter is invalid: %s.', - ], - [ - 'errorCode' => 'ProjectRegionInvalid', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'UnRegisterProduct', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'GetProjectFailed', - 'errorMessage' => 'Failed to get project: %s.', - ], - [ - 'errorCode' => 'InvalidLang', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'SavedSearchError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'IndexError', - 'errorMessage' => 'Failed to create or update index: %s.', - ], - ], - [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + ['errorCode' => 'CreateProjectFailed', 'errorMessage' => 'Failed to create the project: %s.'], + ['errorCode' => 'JobError', 'errorMessage' => 'Failed to create or update the job: %s.'], + ['errorCode' => 'LogstoreError', 'errorMessage' => 'Failed to create or update the logstore: %s.'], + ['errorCode' => 'ParamsIsNull', 'errorMessage' => '%s.'], + ['errorCode' => 'ProjectExist', 'errorMessage' => '%s.'], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The region is invalid.'], + ['errorCode' => 'DashboardError', 'errorMessage' => 'Failed to create or update the dashboard: %s.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The parameter is invalid: %s.'], + ['errorCode' => 'ProjectRegionInvalid', 'errorMessage' => '%s.'], + ['errorCode' => 'UnRegisterProduct', 'errorMessage' => '%s.'], + ['errorCode' => 'GetProjectFailed', 'errorMessage' => 'Failed to get project: %s.'], + ['errorCode' => 'InvalidLang', 'errorMessage' => '%s.'], + ['errorCode' => 'SavedSearchError', 'errorMessage' => '%s.'], + ['errorCode' => 'IndexError', 'errorMessage' => 'Failed to create or update index: %s.'], + ], + [ + ['errorCode' => 'PermissionDenied', 'errorMessage' => '%s.'], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => null, ], 'AnalyzeProductLog' => [ 'summary' => '操作云产品日志服务资源', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -209,120 +101,74 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84949', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'Project', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Logstore', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'CloudProduct', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Lang', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'TTL', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'ResourceQuota', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Overwrite', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'default' => 'true', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'true'], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'VariableMap', 'in' => 'query', 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - ], + 'schema' => ['type' => 'object', 'required' => false], ], [ 'name' => 'HotTTL', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32'], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], [ 'name' => 'InternalConfigOnly', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'default' => 'false', - ], + 'schema' => ['type' => 'boolean', 'default' => 'false'], ], ], 'responses' => [ @@ -330,103 +176,42 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CreateProjectFailed', - 'errorMessage' => 'Failed to create the project: %s.', - ], - [ - 'errorCode' => 'ParamsIsNull', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'InvalidLang', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'InvalidRegion', - 'errorMessage' => 'The region is invalid.', - ], - [ - 'errorCode' => 'ProjectExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'LogstoreError', - 'errorMessage' => 'Failed to create or update the logstore: %s.', - ], - [ - 'errorCode' => 'DashboardError', - 'errorMessage' => 'Failed to create or update the dashboard: %s.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The parameter is invalid: %s.', - ], - [ - 'errorCode' => 'ProjectRegionInvalid', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'GetProjectFailed', - 'errorMessage' => 'Failed to get project: %s.', - ], - [ - 'errorCode' => 'UnRegisterProduct', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'IndexError', - 'errorMessage' => 'Failed to create or update index: %s.', - ], - [ - 'errorCode' => 'SavedSearchError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'JobError', - 'errorMessage' => 'Failed to create or update the job: %s.', - ], - ], - [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + ['errorCode' => 'CreateProjectFailed', 'errorMessage' => 'Failed to create the project: %s.'], + ['errorCode' => 'ParamsIsNull', 'errorMessage' => '%s.'], + ['errorCode' => 'InvalidLang', 'errorMessage' => '%s.'], + ['errorCode' => 'InvalidRegion', 'errorMessage' => 'The region is invalid.'], + ['errorCode' => 'ProjectExist', 'errorMessage' => '%s.'], + ['errorCode' => 'LogstoreError', 'errorMessage' => 'Failed to create or update the logstore: %s.'], + ['errorCode' => 'DashboardError', 'errorMessage' => 'Failed to create or update the dashboard: %s.'], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The parameter is invalid: %s.'], + ['errorCode' => 'ProjectRegionInvalid', 'errorMessage' => '%s.'], + ['errorCode' => 'GetProjectFailed', 'errorMessage' => 'Failed to get project: %s.'], + ['errorCode' => 'UnRegisterProduct', 'errorMessage' => '%s.'], + ['errorCode' => 'IndexError', 'errorMessage' => 'Failed to create or update index: %s.'], + ['errorCode' => 'SavedSearchError', 'errorMessage' => '%s.'], + ['errorCode' => 'JobError', 'errorMessage' => 'Failed to create or update the job: %s.'], + ], + [ + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => null, ], 'CreateApp' => [ 'summary' => '创建应用', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -439,59 +224,38 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84954', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'k8s-event'], ], [ 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'k8s-event'], ], [ 'name' => 'Config', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\'Status\': 1, \'CreatedTime\': \'2021-07-21T09:29:17Z\', \'CycleType\': \'Week\', \'CycleTime\': \'2,4\', \'ModifiedTime\': \'2024-10-29T10:27:07Z\'}'], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '123.103.9.177'], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'ADsFsFWQ*****'], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'ASVadFWQ*****'], ], ], 'responses' => [ @@ -499,78 +263,36 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'AppName' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'AppName' => ['description' => '', 'type' => 'string', 'example' => 'k8s-event'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '88E6BA9F-7DD1-5544-B2C3-71D00E07271B'], + 'Success' => ['description' => '', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAppName', - 'errorMessage' => 'The appName is invalid.', - ], - [ - 'errorCode' => 'InvalidDisplayName', - 'errorMessage' => 'Display name length exceeds limit.', - ], - [ - 'errorCode' => 'ParamMissing', - 'errorMessage' => 'The app name is required.', - ], - [ - 'errorCode' => 'AlreadyExist', - 'errorMessage' => 'App already exist.', - ], - [ - 'errorCode' => 'GetAppFailed', - 'errorMessage' => 'Get app failed.', - ], - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The App not exist.', - ], - [ - 'errorCode' => 'CreateFailed', - 'errorMessage' => 'Create app failed.', - ], + ['errorCode' => 'InvalidAppName', 'errorMessage' => 'The appName is invalid.'], + ['errorCode' => 'InvalidDisplayName', 'errorMessage' => 'Display name length exceeds limit.'], + ['errorCode' => 'ParamMissing', 'errorMessage' => 'The app name is required.'], + ['errorCode' => 'AlreadyExist', 'errorMessage' => 'App already exist.'], + ['errorCode' => 'GetAppFailed', 'errorMessage' => 'Get app failed.'], + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The App not exist.'], + ['errorCode' => 'CreateFailed', 'errorMessage' => 'Create app failed.'], ], [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"AppName\\": \\"k8s-event\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"88E6BA9F-7DD1-5544-B2C3-71D00E07271B\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'DeleteApp' => [ 'summary' => '删除应用', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -583,34 +305,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84959', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -618,71 +329,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAppName', - 'errorMessage' => 'The appName is invalid.', - ], - [ - 'errorCode' => 'GetAppFailed', - 'errorMessage' => 'Get app failed.', - ], - [ - 'errorCode' => 'ParamMissing', - 'errorMessage' => 'The app name is required.', - ], - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The App not exist.', - ], - [ - 'errorCode' => 'DeleteFailed', - 'errorMessage' => 'Delete app failed.', - ], - [ - 'errorCode' => 'InvalidDisplayName', - 'errorMessage' => 'Display name length exceeds limit.', - ], + ['errorCode' => 'InvalidAppName', 'errorMessage' => 'The appName is invalid.'], + ['errorCode' => 'GetAppFailed', 'errorMessage' => 'Get app failed.'], + ['errorCode' => 'ParamMissing', 'errorMessage' => 'The app name is required.'], + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The App not exist.'], + ['errorCode' => 'DeleteFailed', 'errorMessage' => 'Delete app failed.'], + ['errorCode' => 'InvalidDisplayName', 'errorMessage' => 'Display name length exceeds limit.'], ], [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => null, ], 'DescribeApp' => [ 'summary' => '获取应用', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -695,34 +369,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84962', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -730,34 +393,17 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'string'], 'AppModel' => [ 'type' => 'object', 'properties' => [ - 'DisplayName' => [ - 'type' => 'string', - ], - 'AppName' => [ - 'type' => 'string', - ], - 'Config' => [ - 'type' => 'string', - ], - 'Uid' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'DisplayName' => ['type' => 'string'], + 'AppName' => ['type' => 'string'], + 'Config' => ['type' => 'string'], + 'Uid' => ['type' => 'integer', 'format' => 'int64'], ], ], ], @@ -766,48 +412,23 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAppName', - 'errorMessage' => 'The appName is invalid.', - ], - [ - 'errorCode' => 'GetAppFailed', - 'errorMessage' => 'Get app failed.', - ], - [ - 'errorCode' => 'ParamMissing', - 'errorMessage' => 'The app name is required.', - ], - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The App not exist.', - ], - [ - 'errorCode' => 'InvalidDisplayName', - 'errorMessage' => 'Display name length exceeds limit.', - ], + ['errorCode' => 'InvalidAppName', 'errorMessage' => 'The appName is invalid.'], + ['errorCode' => 'GetAppFailed', 'errorMessage' => 'Get app failed.'], + ['errorCode' => 'ParamMissing', 'errorMessage' => 'The app name is required.'], + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The App not exist.'], + ['errorCode' => 'InvalidDisplayName', 'errorMessage' => 'Display name length exceeds limit.'], ], [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => null, ], 'DisableAlert' => [ 'summary' => '禁用告警任务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -820,53 +441,33 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84964', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'Endpoint', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'AlertId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -874,59 +475,32 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InputParaError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ProjectNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'InputParaError', 'errorMessage' => '%s.'], + ['errorCode' => 'ProjectNotExist', 'errorMessage' => '%s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], 404 => [ - [ - 'errorCode' => 'AlertNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'AlertNotExist', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], ], 'EnableAlert' => [ 'summary' => '启用告警任务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -939,96 +513,58 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84965', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'Endpoint', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'AlertId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Language', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Tokens', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'RuleVersion', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'RuleId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1036,68 +572,35 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ProjectNotExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'InputParaError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ProjectForbidden', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'JobAlreadyExist', - 'errorMessage' => 'The job already exists.', - ], + ['errorCode' => 'ProjectNotExist', 'errorMessage' => '%s.'], + ['errorCode' => 'InputParaError', 'errorMessage' => '%s.'], + ['errorCode' => 'ProjectForbidden', 'errorMessage' => '%s.'], + ['errorCode' => 'JobAlreadyExist', 'errorMessage' => 'The job already exists.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], 404 => [ - [ - 'errorCode' => 'AlertNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'AlertNotExist', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => null, ], 'GetAlert' => [ 'summary' => '获取告警任务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1110,53 +613,33 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84966', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'Endpoint', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'AlertId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1164,63 +647,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ProjectNotExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'InputParaError', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'ProjectNotExist', 'errorMessage' => '%s.'], + ['errorCode' => 'InputParaError', 'errorMessage' => '%s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], 404 => [ - [ - 'errorCode' => 'AlertNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'AlertNotExist', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => null, ], 'GetAlertHistories' => [ 'summary' => '获取历史告警任务', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1233,100 +687,58 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84967', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'AlertId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Offset', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'Line', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false], ], [ 'name' => 'FromTs', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ToTs', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true], ], [ 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Endpoint', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1334,67 +746,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InputParaError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ProjectNotExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'GetAlertHistoriesError', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'InputParaError', 'errorMessage' => '%s.'], + ['errorCode' => 'ProjectNotExist', 'errorMessage' => '%s.'], + ['errorCode' => 'GetAlertHistoriesError', 'errorMessage' => '%s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], 404 => [ - [ - 'errorCode' => 'AlertNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'AlertNotExist', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetSlsService' => [ 'summary' => '查询日志服务的开通状态', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1407,17 +786,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84971', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1425,56 +800,30 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Enabled' => [ - 'type' => 'boolean', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Enabled' => ['type' => 'boolean'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Status' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 401 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => '%s.'], ], 500 => [ - [ - 'errorCode' => 'DescribeUserBusinessStatusFailed', - 'errorMessage' => 'Failed to describe user business status.', - ], + ['errorCode' => 'DescribeUserBusinessStatusFailed', 'errorMessage' => 'Failed to describe user business status.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], ], 'OpenSlsService' => [ 'summary' => '开通日志服务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1487,17 +836,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84975', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'LTAI4Fw12345*******'], ], ], 'responses' => [ @@ -1505,60 +850,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => '1CCC2B8E-4FF3-4755-A96C-8CE2E4BF27DF'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 200 => [ - [ - 'errorCode' => 'CreateOrderError', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'CreateOrderError', 'errorMessage' => '%s.'], ], 401 => [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => '%s.'], ], 500 => [ - [ - 'errorCode' => 'GetSpecificationsFailed', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'CreateOrderFailed', - 'errorMessage' => 'Failed to create an order.', - ], + ['errorCode' => 'GetSpecificationsFailed', 'errorMessage' => '%s.'], + ['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Failed to create an order.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1CCC2B8E-4FF3-4755-A96C-8CE2E4BF27DF\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SetAlertActionPolicy' => [ 'summary' => ' 设置告警策略', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1571,49 +889,33 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84977', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'PolicyId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Policy', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'PolicyName', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1621,59 +923,32 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InputParaError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ProjectNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'InputParaError', 'errorMessage' => '%s.'], + ['errorCode' => 'ProjectNotExist', 'errorMessage' => '%s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], 404 => [ - [ - 'errorCode' => 'ResourceNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'ResourceNotExist', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], ], 'SetAlertCenterResource' => [ 'summary' => '设置告警资源', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1686,43 +961,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84978', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'Language', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1730,63 +990,33 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InputParaError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ProjectNotExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'SetAlertCenterResourceError', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'InputParaError', 'errorMessage' => '%s.'], + ['errorCode' => 'ProjectNotExist', 'errorMessage' => '%s.'], + ['errorCode' => 'SetAlertCenterResourceError', 'errorMessage' => '%s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], 404 => [ - [ - 'errorCode' => 'AlertNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'AlertNotExist', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], ], 'SyncAlertGroups' => [ 'summary' => '同步告警用户组', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1799,35 +1029,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84981', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Groups', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1835,67 +1053,35 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InputParaError', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ResourceRecordNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'InputParaError', 'errorMessage' => '%s.'], + ['errorCode' => 'ResourceRecordNotExist', 'errorMessage' => '%s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], 404 => [ - [ - 'errorCode' => 'AlertNotExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ResourceNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'AlertNotExist', 'errorMessage' => '%s.'], + ['errorCode' => 'ResourceNotExist', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => null, ], 'SyncAlertUsers' => [ 'summary' => '同步告警用户', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1908,35 +1094,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84982', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'Users', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -1944,67 +1118,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string'], + 'Data' => ['type' => 'string'], + 'Message' => ['type' => 'string'], + 'RequestId' => ['type' => 'string'], + 'Success' => ['type' => 'boolean'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ResourceRecordNotExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'InputParaError', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'ResourceRecordNotExist', 'errorMessage' => '%s.'], + ['errorCode' => 'InputParaError', 'errorMessage' => '%s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], 404 => [ - [ - 'errorCode' => 'AlertNotExist', - 'errorMessage' => '%s.', - ], - [ - 'errorCode' => 'ResourceNotExist', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'AlertNotExist', 'errorMessage' => '%s.'], + ['errorCode' => 'ResourceNotExist', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], ], 'UpdateApp' => [ 'summary' => '更新应用', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2017,51 +1158,33 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84983', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'datalab'], ], [ 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'k8s-event'], ], [ 'name' => 'Config', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{\'Status\': 1, \'CreatedTime\': \'2023-10-23T02:16:05Z\', \'CycleType\': \'Week\', \'CycleTime\': \'7\', \'ModifiedTime\': \'2025-04-11T05:16:54Z\'}'], ], [ 'name' => 'ClientIp', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => '59.82.66.154'], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'ASVadFWQ*****'], ], ], 'responses' => [ @@ -2069,70 +1192,34 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'F24A3C08-0B45-5EB4-8B44-F30E034E40B4'], + 'Success' => ['description' => '', 'type' => 'string', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidAppName', - 'errorMessage' => 'The appName is invalid.', - ], - [ - 'errorCode' => 'InvalidDisplayName', - 'errorMessage' => 'Display name length exceeds limit.', - ], - [ - 'errorCode' => 'GetAppFailed', - 'errorMessage' => 'Get app failed.', - ], - [ - 'errorCode' => 'ParamMissing', - 'errorMessage' => 'The app name is required.', - ], - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The App not exist.', - ], - [ - 'errorCode' => 'UpdateFailed', - 'errorMessage' => 'Update app failed.', - ], + ['errorCode' => 'InvalidAppName', 'errorMessage' => 'The appName is invalid.'], + ['errorCode' => 'InvalidDisplayName', 'errorMessage' => 'Display name length exceeds limit.'], + ['errorCode' => 'GetAppFailed', 'errorMessage' => 'Get app failed.'], + ['errorCode' => 'ParamMissing', 'errorMessage' => 'The app name is required.'], + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The App not exist.'], + ['errorCode' => 'UpdateFailed', 'errorMessage' => 'Update app failed.'], ], [ - [ - 'errorCode' => 'PermissionDenied', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'PermissionDenied', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F24A3C08-0B45-5EB4-8B44-F30E034E40B4\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'InitUserAlertResource' => [ 'summary' => '初始化告警资源', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2145,49 +1232,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84973', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'Language', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => false, 'example' => 'cn'], ], [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ 'name' => 'App', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'none', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'none'], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -2195,41 +1261,20 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE3A9553-2CBB-59CD-96DA-9EE3EED48969', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'successful'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'EE3A9553-2CBB-59CD-96DA-9EE3EED48969'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'SetAlertCenterResourceError', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'SetAlertCenterResourceError', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE3A9553-2CBB-59CD-96DA-9EE3EED48969\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"successful\\nEE3A9553-2CBB-59CD-96DA-9EE3EED48969\\n200\\ntrue","errorExample":""}]', 'title' => 'InitUserAlertResource', 'requestParamsDescription' => ' ', @@ -2238,13 +1283,8 @@ ], 'InitProjectAlertResource' => [ 'summary' => '初始化告警资源', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2257,39 +1297,23 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '84972', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'Region', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => '', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-project'], ], [ 'name' => 'SlsAccessToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string'], ], ], 'responses' => [ @@ -2297,47 +1321,23 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D39895CE-1769-5485-BEF6-6B5A9DDEE75D', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => '', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => '', 'type' => 'string', 'example' => 'Success'], + 'RequestId' => ['description' => '', 'type' => 'string', 'example' => 'D39895CE-1769-5485-BEF6-6B5A9DDEE75D'], + 'Success' => ['description' => '', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'LogstoreError', - 'errorMessage' => 'Failed to create or update the logstore: %s.', - ], + ['errorCode' => 'LogstoreError', 'errorMessage' => 'Failed to create or update the logstore: %s.'], ], [ - [ - 'errorCode' => 'UnAuthorized', - 'errorMessage' => '%s.', - ], + ['errorCode' => 'UnAuthorized', 'errorMessage' => '%s.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"D39895CE-1769-5485-BEF6-6B5A9DDEE75D\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"Success\\nD39895CE-1769-5485-BEF6-6B5A9DDEE75D\\n200\\ntrue","errorExample":""}]', 'title' => 'InitProjectAlertResource', 'requestParamsDescription' => ' ', @@ -2346,145 +1346,40 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'cn-qingdao.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'cn-beijing.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'cn-huhehaote.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'cn-hangzhou.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'cn-shanghai.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'cn-nanjing.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fuzhou', - 'endpoint' => 'cn-fuzhou.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'cn-shenzhen.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'cn-heyuan.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'cn-guangzhou.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'cn-chengdu.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'cn-hongkong.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'ap-northeast-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'ap-northeast-2.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ap-southeast-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'ap-southeast-2.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'ap-southeast-3.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'ap-southeast-5.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'ap-southeast-6.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'ap-southeast-7.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'us-east-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'us-west-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'eu-west-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'eu-central-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-southeast-1', - 'endpoint' => 'us-southeast-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'ap-south-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'me-east-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'me-central-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan-acdr-1', - 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', - ], + ['regionId' => 'cn-qingdao', 'endpoint' => 'cn-qingdao.log.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'cn-beijing.log.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'endpoint' => 'cn-huhehaote.log.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'endpoint' => 'cn-hangzhou.log.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'endpoint' => 'cn-shanghai.log.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'endpoint' => 'cn-nanjing.log.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'endpoint' => 'cn-fuzhou.log.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'endpoint' => 'cn-shenzhen.log.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'endpoint' => 'cn-heyuan.log.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'endpoint' => 'cn-guangzhou.log.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'endpoint' => 'cn-chengdu.log.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'endpoint' => 'cn-hongkong.log.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'endpoint' => 'ap-northeast-1.log.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'endpoint' => 'ap-northeast-2.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'endpoint' => 'ap-southeast-1.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'endpoint' => 'ap-southeast-2.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'endpoint' => 'ap-southeast-3.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'endpoint' => 'ap-southeast-5.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'endpoint' => 'ap-southeast-6.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'endpoint' => 'ap-southeast-7.log.aliyuncs.com'], + ['regionId' => 'us-southeast-1', 'endpoint' => 'us-southeast-1.log.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'endpoint' => 'eu-central-1.log.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'endpoint' => 'eu-west-1.log.aliyuncs.com'], + ['regionId' => 'us-west-1', 'endpoint' => 'us-west-1.log.aliyuncs.com'], + ['regionId' => 'us-east-1', 'endpoint' => 'us-east-1.log.aliyuncs.com'], + ['regionId' => 'me-central-1', 'endpoint' => 'me-central-1.log.aliyuncs.com'], + ['regionId' => 'me-east-1', 'endpoint' => 'me-east-1.log.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'endpoint' => 'ap-south-1.log.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com'], ], ]; diff --git a/data/en_us/sls/2020-12-30/api-docs.php b/data/en_us/sls/2020-12-30/api-docs.php index 2cc0a9d..f57f68f 100644 --- a/data/en_us/sls/2020-12-30/api-docs.php +++ b/data/en_us/sls/2020-12-30/api-docs.php @@ -1,406 +1,170 @@ '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' => 'Logstore', ], [ - 'children' => [ - 'ListMetricStores', - 'CreateMetricStore', - 'DeleteMetricStore', - 'UpdateMetricStore', - 'UpdateMetricStoreMeteringMode', - 'GetMetricStore', - 'GetMetricStoreMeteringMode', - ], + 'children' => ['ListMetricStores', 'CreateMetricStore', 'DeleteMetricStore', 'UpdateMetricStore', 'UpdateMetricStoreMeteringMode', 'GetMetricStore', 'GetMetricStoreMeteringMode'], 'type' => 'directory', - 'title' => 'MetricStore', + 'title' => 'Metricstore', ], [ - 'children' => [ - 'CreateStoreView', - 'DeleteStoreView', - 'UpdateStoreView', - 'GetStoreView', - 'GetStoreViewIndex', - 'ListStoreViews', - ], + 'children' => ['CreateStoreView', 'DeleteStoreView', 'UpdateStoreView', 'GetStoreView', 'GetStoreViewIndex', 'ListStoreViews'], 'type' => 'directory', - 'title' => 'StoreView', + 'title' => 'Storeview', ], [ - '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' => 'Machine Group', + 'title' => 'Machine group', ], [ - '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' => 'Logtail Configuration', + 'title' => 'Collection configuration', ], [ - 'children' => [ - 'CreateDashboard', - 'DeleteDashboard', - 'UpdateDashboard', - 'GetDashboard', - 'ListDashboard', - ], + 'children' => ['CreateDashboard', 'DeleteDashboard', 'UpdateDashboard', 'GetDashboard', 'ListDashboard'], 'type' => 'directory', 'title' => 'Dashboard', ], [ - 'children' => [ - 'CreateConsumerGroup', - 'DeleteConsumerGroup', - 'ConsumerGroupUpdateCheckPoint', - 'UpdateConsumerGroup', - 'ConsumerGroupHeartBeat', - 'ListConsumerGroup', - 'GetCheckPoint', - ], + 'children' => ['CreateConsumerGroup', 'DeleteConsumerGroup', 'ConsumerGroupUpdateCheckPoint', 'UpdateConsumerGroup', 'ConsumerGroupHeartBeat', 'ListConsumerGroup', 'GetCheckPoint'], 'type' => 'directory', - 'title' => 'Consumer Group', + 'title' => 'Consumer group', ], [ - 'children' => [ - 'CreateSavedSearch', - 'DeleteSavedSearch', - 'UpdateSavedSearch', - 'ListSavedSearch', - 'GetSavedSearch', - ], + 'children' => ['CreateSavedSearch', 'DeleteSavedSearch', 'UpdateSavedSearch', 'ListSavedSearch', 'GetSavedSearch'], 'type' => 'directory', - 'title' => 'Saved Search', + 'title' => 'Saved search', ], [ - 'children' => [ - 'CreateAlert', - 'DeleteAlert', - 'UpdateAlert', - 'EnableAlert', - 'DisableAlert', - 'GetAlert', - 'ListAlerts', - ], + 'children' => ['CreateAlert', 'DeleteAlert', 'UpdateAlert', 'EnableAlert', 'DisableAlert', 'GetAlert'], 'type' => 'directory', 'title' => 'Alerting', ], [ 'children' => [ [ - 'children' => [ - 'StopAzureBlobIngestion', - 'StartAzureBlobIngestion', - 'DeleteAzureBlobIngestion', - 'UpdateAzureBlobIngestion', - 'ListAzureBlobIngestion', - 'CreateAzureBlobIngestion', - 'GetAzureBlobIngestion', - ], + 'children' => ['UpdateGCSIngestion', 'StopGCSIngestion', 'StartGCSIngestion', 'ListGCSIngestions', 'GetGCSIngestion', 'CreateGCSIngestion'], 'type' => 'directory', - 'title' => 'Azure BLOB Import', + 'title' => 'GCS import', ], [ - 'children' => [ - 'ListS3Ingestions', - 'GetS3Ingestion', - 'DeleteS3Ingestion', - 'CreateS3Ingestion', - ], + 'children' => ['UpdateElasticsearchIngestion', 'StopElasticsearchIngestion', 'StartElasticsearchIngestion', 'CreateElasticsearchIngestion', 'ListElasticsearchIngestions', 'GetElasticsearchIngestion', 'DeleteElasticsearchIngestion'], + 'type' => 'directory', + 'title' => 'Elasticsearch import', + ], + [ + 'children' => ['CreateS3Ingestion', 'ListS3Ingestions', 'GetS3Ingestion', 'DeleteS3Ingestion'], 'type' => 'directory', 'title' => 'S3 import', ], [ - 'children' => [ - 'CreateOSSIngestion', - 'GetOSSIngestion', - 'ListOSSIngestions', - 'StopOSSIngestion', - 'StartOSSIngestion', - 'UpdateOSSIngestion', - 'DeleteOSSIngestion', - ], + 'children' => ['StopAzureBlobIngestion', 'StartAzureBlobIngestion', 'DeleteAzureBlobIngestion', 'UpdateAzureBlobIngestion', 'ListAzureBlobIngestion', 'CreateAzureBlobIngestion', 'GetAzureBlobIngestion'], + 'type' => 'directory', + 'title' => 'AzureBlob import', + ], + [ + 'children' => ['CreateOSSIngestion', 'GetOSSIngestion', 'ListOSSIngestions', 'StopOSSIngestion', 'StartOSSIngestion', 'UpdateOSSIngestion', 'DeleteOSSIngestion'], 'type' => 'directory', 'title' => 'OSS import', ], ], 'type' => 'directory', - 'title' => 'Data Import', + 'title' => 'Data import', ], [ - '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' => 'Log Export', + 'title' => 'LogShipper', ], [ - 'children' => [ - 'CreateETL', - 'DeleteETL', - 'UpdateETL', - 'StartETL', - 'StopETL', - 'ListETLs', - 'GetETL', - ], + 'children' => ['CreateETL', 'DeleteETL', 'UpdateETL', 'StartETL', 'StopETL', 'ListETLs', 'GetETL'], 'type' => 'directory', - 'title' => 'Data Transformation', + 'title' => 'Data transformation', ], [ - 'children' => [ - 'CreateScheduledSQL', - 'DeleteScheduledSQL', - 'UpdateScheduledSQL', - 'EnableScheduledSQL', - 'DisableScheduledSQL', - 'ListScheduledSQLs', - 'GetScheduledSQL', - ], + 'children' => ['CreateScheduledSQL', 'DeleteScheduledSQL', 'UpdateScheduledSQL', 'EnableScheduledSQL', 'DisableScheduledSQL', 'ListScheduledSQLs', 'GetScheduledSQL'], 'type' => 'directory', - 'title' => 'Scheduled SQL', + 'title' => 'Scheduled query', ], [ - 'children' => [ - 'CreateDownloadJob', - 'DeleteDownloadJob', - 'GetDownloadJob', - 'ListDownloadJobs', - ], + 'children' => ['CreateDownloadJob', 'DeleteDownloadJob', 'GetDownloadJob', 'ListDownloadJobs'], 'type' => 'directory', - 'title' => 'Log Download', + 'title' => 'Log download', ], [ - 'children' => [ - 'PutIngestProcessor', - 'GetIngestProcessor', - 'ListIngestProcessors', - 'DeleteIngestProcessor', - 'UpdateLogStoreProcessor', - 'UpdateMetricStoreProcessor', - ], + 'children' => ['PutIngestProcessor', 'GetIngestProcessor', 'ListIngestProcessors', 'DeleteIngestProcessor', 'UpdateLogStoreProcessor', 'UpdateMetricStoreProcessor'], 'type' => 'directory', - 'title' => 'Ingest processor', + 'title' => 'Write processor', ], [ - 'children' => [ - 'PutConsumeProcessor', - 'GetConsumeProcessor', - 'ListConsumeProcessors', - 'DeleteConsumeProcessor', - ], + 'children' => ['PutConsumeProcessor', 'GetConsumeProcessor', 'ListConsumeProcessors', 'DeleteConsumeProcessor'], 'type' => 'directory', - 'title' => 'Consumer Processor', + 'title' => 'Consum processor', ], [ - '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' => 'Machine Learning', + 'title' => 'Machine learning', ], [ - 'children' => [ - 'TagResources', - 'UntagResources', - 'ListTagResources', - ], + 'children' => ['PutProjectPolicy', 'DeleteProjectPolicy', 'GetProjectPolicy'], 'type' => 'directory', - 'title' => 'Resource', + 'title' => 'Authorization policy', ], [ - 'children' => [ - 'PutProjectPolicy', - 'DeleteProjectPolicy', - 'GetProjectPolicy', - ], + 'children' => ['UpsertCollectionPolicy', 'DeleteCollectionPolicy', 'ListCollectionPolicies', 'GetCollectionPolicy'], 'type' => 'directory', - 'title' => 'Authorization Policy', + 'title' => 'Cloud service collection rule', ], [ - 'children' => [ - 'ChangeResourceGroup', - ], + 'children' => ['CreateSqlInstance', 'UpdateSqlInstance', 'GetSqlInstance'], 'type' => 'directory', - 'title' => 'Resource Group', + 'title' => 'Dedicated SQL instance', ], [ - 'children' => [ - 'UpsertCollectionPolicy', - 'DeleteCollectionPolicy', - 'ListCollectionPolicies', - 'GetCollectionPolicy', - ], + 'children' => ['OpenSlsService'], 'type' => 'directory', - 'title' => 'Collection Rules Of Cloud Services', + 'title' => 'Service activation', ], [ - 'children' => [ - 'CreateSqlInstance', - 'UpdateSqlInstance', - 'GetSqlInstance', - ], + 'children' => ['RefreshToken'], 'type' => 'directory', - 'title' => 'Dedicated SQL Instance', + 'title' => 'Console embedding', ], [ - 'children' => [ - 'OpenSlsService', - 'GetSlsService', - ], + 'children' => ['CreateAgentInstanceConfig', 'DeleteAgentInstanceConfig', 'GetAgentInstanceConfig', 'ListAgentInstanceConfigs', 'UpdateAgentInstanceConfig'], 'type' => 'directory', - 'title' => 'Service Opening', + 'title' => 'Process-level configuration', ], [ - 'children' => [ - 'CreateTicket', - 'RefreshToken', - ], + 'children' => ['GetMaxComputeExport', 'CreateMaxComputeExport', 'DeleteMaxComputeExport', 'ListMaxComputeExports', 'StartMaxComputeExport', 'StopMaxComputeExport', 'UpdateMaxComputeExport'], 'type' => 'directory', - 'title' => 'Embed Console Pages', + 'title' => 'MaxCompute shipping', ], [ - 'children' => [ - 'CreateAgentInstanceConfig', - 'DeleteAgentInstanceConfig', - 'GetAgentInstanceConfig', - 'ListAgentInstanceConfigs', - 'UpdateAgentInstanceConfig', - ], + 'children' => ['UntagResources', 'TagResources', 'ListTagResources'], 'type' => 'directory', - 'title' => 'Process-level configuration', + 'title' => 'Tag', + ], + [ + 'children' => ['CreateProject', 'DeleteProject', 'GetProject', 'ListProject', 'UpdateProject', 'GetProjectLogs'], + 'type' => 'directory', + 'title' => 'Project', ], [ 'children' => [ - 'DescribeRegions', - 'GetMaxComputeExport', - 'CreateMaxComputeExport', - 'DeleteMaxComputeExport', - 'ListMaxComputeExports', - 'StartMaxComputeExport', - 'StopMaxComputeExport', - 'UpdateMaxComputeExport', - 'CreateDomain', - 'CreateLogging', - 'CreateProject', - 'DeleteDomain', - 'DeleteLogging', - 'DeleteProject', - 'GetLogging', - 'GetProject', - 'GetProjectLogs', - 'ListDomains', - 'ListProject', - 'PutProjectTransferAcceleration', - 'UpdateLogging', - 'UpdateProject', - 'AddMemories', - 'CreateDataset', - 'CreateMemoryStore', - 'DeleteDataset', - 'DeleteMemories', - 'DeleteMemory', - 'DeleteMemoryStore', - 'ExecuteQuery', - 'GetDataset', - 'GetMemories', - 'GetMemory', - 'GetMemoryHistory', - 'GetMemoryStore', - 'ListDatasets', - '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' => 'Others', @@ -412,18 +176,8 @@ 'title' => 'AgentInstanceConfigGrayConfigs', 'type' => 'object', 'properties' => [ - 'condition' => [ - 'title' => 'condition', - 'description' => 'The matching rule.', - 'type' => 'string', - 'example' => 'appVersion="1.0.0"', - ], - 'content' => [ - 'title' => 'content', - 'description' => 'The content of the canary release configuration.', - 'type' => 'string', - 'example' => '{"enable":true}', - ], + 'condition' => ['title' => 'condition', 'description' => 'The matching rule.', 'type' => 'string', 'example' => 'appVersion="1.0.0"'], + 'content' => ['title' => 'content', 'description' => 'The content of the canary release configuration.', 'type' => 'string', 'example' => '{"enable":true}'], ], 'description' => 'The process-level canary release configuration.', 'example' => '', @@ -433,356 +187,106 @@ 'description' => 'The response for the alert rule.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '告警规则ID', - 'description' => 'The ID of the alert rule.', - 'type' => 'string', - 'required' => true, - 'example' => 'alert-123456', - ], - 'displayName' => [ - 'title' => '告警规则名称', - 'description' => 'The name of the alert rule.', - 'type' => 'string', - 'required' => true, - 'example' => 'alertNameExample', - ], - 'description' => [ - 'title' => '告警规则描述', - 'description' => 'The description of the alert rule.', - 'type' => 'string', - 'example' => 'Alert Desc', - ], - 'configuration' => [ - 'title' => '告警规则配置', - 'description' => 'The configuration of the alert rule.', - 'required' => true, - '$ref' => '#/components/schemas/AlertConfiguration', - 'example' => '', - ], - 'schedule' => [ - 'title' => '调度配置', - 'description' => 'The scheduling configuration.', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - 'example' => '', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the alert rule was created.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'description' => 'The time when the alert rule was last modified.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714274900', - ], - 'status' => [ - 'title' => '告警状态', - 'description' => 'The status of the alert rule.', - 'type' => 'string', - 'example' => 'ENABLED/DISABLED', - ], + 'name' => ['title' => '告警规则ID', 'description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-123456'], + 'displayName' => ['title' => '告警规则名称', 'description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alertNameExample'], + 'description' => ['title' => '告警规则描述', 'description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'Alert Desc'], + 'configuration' => ['title' => '告警规则配置', 'description' => 'The configuration of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration', 'example' => ''], + 'schedule' => ['title' => '调度配置', 'description' => 'The scheduling configuration.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the alert rule was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => 'The time when the alert rule was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274900'], + 'status' => ['title' => '告警状态', 'description' => 'The status of the alert rule.', 'type' => 'string', 'example' => 'ENABLED/DISABLED'], ], 'example' => '', ], 'AlertConfiguration' => [ - 'title' => '告警规则配置', + 'title' => '', 'description' => 'The alert configuration.', 'type' => 'object', 'properties' => [ - 'muteUntil' => [ - 'title' => '临时关闭时间', - 'description' => 'The time until which the alert is muted.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1698907508', - ], - 'version' => [ - 'title' => '版本', - 'description' => 'The version.', - 'type' => 'string', - 'required' => true, - 'default' => '2.0', - 'example' => '2.0', - ], - 'type' => [ - 'title' => '告警规则类型', - 'description' => 'The type of the alert rule.', - 'type' => 'string', - 'example' => 'default', - ], - 'templateConfiguration' => [ - 'title' => '告警模板配置', - 'description' => 'The alert template configuration.', - '$ref' => '#/components/schemas/TemplateConfiguration', - 'example' => '', - ], - 'dashboard' => [ - 'title' => '告警绑定的dashboardId', - 'description' => 'The ID of the dashboard to which the alert is attached.', - 'type' => 'string', - 'example' => 'DasnboardExample', - ], - 'threshold' => [ - 'title' => '连续触发阈值', - 'description' => 'The consecutive trigger threshold.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'noDataFire' => [ - 'title' => '是否开启无数据告警', - 'description' => 'Specifies whether to enable no-data alerts.', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'noDataSeverity' => [ - 'title' => '无数据告警严重度', - 'description' => 'The severity of no-data alerts.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'sendResolved' => [ - 'title' => '是否发送恢复告警', - 'description' => 'Specifies whether to send recovery alerts.', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'muteUntil' => ['title' => '', 'description' => 'The time until which the alert is muted.', 'type' => 'integer', 'format' => 'int64', 'example' => '1698907508'], + 'version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'required' => true, 'default' => '2.0', 'example' => '2.0'], + 'type' => ['title' => '', 'description' => 'The type of the alert rule.', 'type' => 'string', 'example' => 'default'], + 'templateConfiguration' => ['title' => '', 'description' => 'The alert template configuration.', '$ref' => '#/components/schemas/TemplateConfiguration', 'example' => ''], + 'dashboard' => ['title' => '', 'description' => 'The ID of the dashboard to which the alert is attached.', 'type' => 'string', 'example' => 'DasnboardExample'], + 'threshold' => ['title' => '', 'description' => 'The consecutive trigger threshold.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'noDataFire' => ['title' => '', 'description' => 'Specifies whether to enable no-data alerts.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'noDataSeverity' => ['title' => '', 'description' => 'The severity of no-data alerts.', 'type' => 'integer', 'format' => 'int32', 'example' => '6'], + 'sendResolved' => ['title' => '', 'description' => 'Specifies whether to send recovery alerts.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], 'queryList' => [ - 'title' => '查询语句列表', + 'title' => '', 'description' => 'The list of query statements.', 'type' => 'array', - 'items' => [ - 'description' => 'The query statement.', - '$ref' => '#/components/schemas/AlertQuery', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The query statement.', '$ref' => '#/components/schemas/AlertQuery', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], 'annotations' => [ - 'title' => '告警标注', + 'title' => '', 'description' => 'The alert annotations.', 'type' => 'array', - 'items' => [ - 'description' => 'The annotation information.', - '$ref' => '#/components/schemas/AlertTag', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The annotation information.', '$ref' => '#/components/schemas/AlertTag', 'title' => '', 'example' => ''], 'example' => '', ], 'labels' => [ - 'title' => '告警标签', + 'title' => '', 'description' => 'The alert labels.', 'type' => 'array', - 'items' => [ - 'description' => 'The alert label.', - '$ref' => '#/components/schemas/AlertTag', - 'title' => '', - 'example' => '', - ], - 'example' => '', - ], - 'conditionConfiguration' => [ - 'title' => '告警触发条件', - 'description' => 'The alert trigger condition.', - '$ref' => '#/components/schemas/ConditionConfiguration', + 'items' => ['description' => 'The alert label.', '$ref' => '#/components/schemas/AlertTag', 'title' => '', 'example' => ''], 'example' => '', ], + 'conditionConfiguration' => ['title' => '', 'description' => 'The alert trigger condition.', '$ref' => '#/components/schemas/ConditionConfiguration', 'example' => ''], 'severityConfigurations' => [ - 'title' => '告警严重度配置', + 'title' => '', 'description' => 'The alert severity configurations.', 'type' => 'array', - 'items' => [ - 'description' => 'The alert severity configuration.', - '$ref' => '#/components/schemas/SeverityConfiguration', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The alert severity configuration.', '$ref' => '#/components/schemas/SeverityConfiguration', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], 'joinConfigurations' => [ - 'title' => '告警查询分析语句集合操作配置', + 'title' => '', 'description' => 'The configurations for joining the results of query statements.', 'type' => 'array', - 'items' => [ - 'description' => 'The configuration for joining the results of query statements.', - '$ref' => '#/components/schemas/JoinConfiguration', - 'title' => '', - 'example' => '', - ], - 'example' => '', - ], - 'groupConfiguration' => [ - 'title' => '分组评估配置', - 'description' => 'The group evaluation configuration.', - 'required' => true, - '$ref' => '#/components/schemas/GroupConfiguration', - 'example' => '', - ], - 'policyConfiguration' => [ - 'title' => 'SLS告警通知服务配置', - 'description' => 'The configuration for the SLS alert notification service.', - '$ref' => '#/components/schemas/PolicyConfiguration', - 'example' => '', - ], - 'autoAnnotation' => [ - 'title' => '是否开启自动标注', - 'description' => 'Specifies whether to enable automatic annotation.', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'sinkEventStore' => [ - 'title' => '发送给EventStore配置', - 'description' => 'The configuration for sending alerts to the eventstore.', - '$ref' => '#/components/schemas/SinkEventStoreConfiguration', - 'example' => '', - ], - 'sinkCms' => [ - 'title' => '发送给云监控配置', - 'description' => 'The configuration for sending alerts to Cloud Monitor.', - '$ref' => '#/components/schemas/SinkCmsConfiguration', - 'example' => '', - ], - 'sinkAlerthub' => [ - 'title' => '发送给SLS告警管理服务配置', - 'description' => 'The configuration for sending alerts to the SLS alert management service.', - 'required' => false, - '$ref' => '#/components/schemas/SinkAlerthubConfiguration', + 'items' => ['description' => 'The configuration for joining the results of query statements.', '$ref' => '#/components/schemas/JoinConfiguration', 'title' => '', 'example' => ''], 'example' => '', ], + 'groupConfiguration' => ['title' => '', 'description' => 'The group evaluation configuration.', 'required' => true, '$ref' => '#/components/schemas/GroupConfiguration', 'example' => ''], + 'policyConfiguration' => ['title' => '', 'description' => 'The configuration for the SLS alert notification service.', '$ref' => '#/components/schemas/PolicyConfiguration', 'example' => ''], + 'autoAnnotation' => ['title' => '', 'description' => 'Specifies whether to enable automatic annotation.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'sinkEventStore' => ['title' => '', 'description' => 'The configuration for sending alerts to the eventstore.', '$ref' => '#/components/schemas/SinkEventStoreConfiguration', 'example' => ''], + 'sinkCms' => ['title' => '', 'description' => 'The configuration for sending alerts to Cloud Monitor.', '$ref' => '#/components/schemas/SinkCmsConfiguration', 'example' => ''], + 'sinkAlerthub' => ['title' => '', 'description' => 'The configuration for sending alerts to the SLS alert management service.', 'required' => false, '$ref' => '#/components/schemas/SinkAlerthubConfiguration', 'example' => ''], 'tags' => [ - 'title' => '告警自定义标签', + 'title' => '', 'description' => 'The custom alert tags.', 'type' => 'array', - 'items' => [ - 'description' => 'The tag information.', - 'type' => 'string', - 'title' => '', - 'example' => 'host', - ], + 'items' => ['description' => 'The tag information.', 'type' => 'string', 'title' => '', 'example' => 'host'], 'example' => '', ], ], 'example' => '', ], 'AlertQuery' => [ - 'title' => '告警查询分析配置', - 'description' => 'The alert query statement configurations.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'Configuration of the alert query and analysis statement', 'type' => 'object', 'properties' => [ - 'chartTitle' => [ - 'title' => '图表名称', - 'description' => 'The name of the chart.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'chartExmaple', - ], - 'query' => [ - 'title' => '查询分析语句', - 'description' => 'The query statement.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '* | select *', - ], - 'timeSpanType' => [ - 'title' => '时间片类型', - 'description' => 'The type of the time span.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Relative', - ], - 'start' => [ - 'title' => '开始时间', - 'description' => 'The beginning of the time range to query.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '-5m', - ], - 'end' => [ - 'title' => '结束时间', - 'description' => 'The end of the time range to query.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'now', - ], - 'storeType' => [ - 'title' => 'store类型', - 'description' => 'The storage type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'log', - ], - 'project' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'projectExample', - ], - 'store' => [ - 'title' => 'store名称', - 'description' => 'The name of the storage.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'store Example', - ], - 'region' => [ - 'title' => '区域', - 'description' => 'The region.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'roleArn' => [ - 'title' => '角色ARN', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - ], - 'dashboardId' => [ - 'title' => '仪表盘ID', - 'description' => 'The ID of the dashboard.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dashboardExample', - ], - 'powerSqlMode' => [ - 'title' => '是否开启独享SQL', - 'description' => 'Specifies whether to enable Dedicated SQL.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'auto', - ], - 'ui' => [ - 'title' => '特定场景告警前端使用', - 'description' => 'The page on which you can record frontend configurations in specified scenarios.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - ], + 'chartTitle' => ['title' => '', 'description' => 'Chart name', 'type' => 'string', 'example' => 'chartExmaple', 'visibility' => 'Public'], + 'query' => ['title' => '', 'description' => 'Query and analysis statement', 'type' => 'string', 'required' => true, 'example' => '* | select *', 'visibility' => 'Public'], + 'timeSpanType' => ['title' => '', 'description' => 'Time span type', 'type' => 'string', 'required' => true, 'example' => 'Relative', 'visibility' => 'Public'], + 'start' => ['title' => '', 'description' => 'Start time', 'type' => 'string', 'required' => true, 'example' => '-5m', 'visibility' => 'Public'], + 'end' => ['title' => '', 'description' => 'End time', 'type' => 'string', 'required' => true, 'example' => 'now', 'visibility' => 'Public'], + 'storeType' => ['title' => '', 'description' => 'Store type', 'type' => 'string', 'required' => true, 'example' => 'log', 'visibility' => 'Public'], + 'project' => ['title' => '', 'description' => 'Project name', 'type' => 'string', 'required' => true, 'example' => 'projectExample', 'visibility' => 'Public'], + 'store' => ['title' => '', 'description' => 'Store name', 'type' => 'string', 'required' => true, 'example' => 'store Example', 'visibility' => 'Public'], + 'region' => ['title' => '', 'description' => 'Region', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'visibility' => 'Public'], + 'roleArn' => ['title' => '', 'description' => 'Role ARN', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], + 'dashboardId' => ['title' => '', 'description' => 'Dashboard ID', 'type' => 'string', 'example' => 'dashboardExample', 'visibility' => 'Public'], + 'powerSqlMode' => ['title' => '', 'description' => 'Whether to enable Dedicated SQL', 'type' => 'string', 'example' => 'auto', 'visibility' => 'Public'], + 'ui' => ['title' => '', 'description' => 'Used by the frontend for specific-scenario alerts', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'AlertTag' => [ 'title' => 'alertTag', @@ -790,20 +294,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '键名', - 'description' => 'The key name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'title', - ], - 'value' => [ - 'title' => '值', - 'description' => 'The key value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'example value', - ], + 'key' => ['title' => '键名', 'description' => 'The key name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'title'], + 'value' => ['title' => '值', 'description' => 'The key value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'example value'], ], ], 'AsyncSqlResponseData' => [ @@ -811,93 +303,36 @@ 'description' => 'The data structure for the response of an asynchronous SQL query.', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '异步SQL的ID', - 'type' => 'string', - 'required' => true, - 'description' => 'The ID of the asynchronous SQL query.', - 'example' => '690C4F2A16FBD65C40000484_14', - ], - 'state' => [ - 'title' => '异步SQL的当前执行状态，可以为以下三个状态: ● RUNNING ● FINISHED ● FAILED ● CANCELLED 其中，RUNNING是临时状态, 表示SQL还在执行过程中。仅当状态为FINISHED时，才表示请求执行成功，可以读取结果了。', - 'type' => 'string', - 'required' => true, - 'description' => 'The current execution state of the asynchronous SQL query. Valid values are:'."\n" - ."\n" - .'- RUNNING'."\n" - ."\n" - .'- FINISHED'."\n" - ."\n" - .'- FAILED'."\n" - ."\n" - .'- CANCELLED'."\n" - ."\n" - .'RUNNING is a temporary state that indicates the SQL query is still running. You can read the results only when the state is FINISHED. The error\\_code and error\\_message parameters are valid only when the state is FAILED.', - 'example' => 'FINISHED', - ], + 'id' => ['title' => '异步SQL的ID', 'type' => 'string', 'required' => true, 'description' => 'The ID of the asynchronous SQL query.', 'example' => '690C4F2A16FBD65C40000484_14'], + 'state' => ['title' => '异步SQL的当前执行状态，可以为以下三个状态: ● RUNNING ● FINISHED ● FAILED ● CANCELLED 其中，RUNNING是临时状态, 表示SQL还在执行过程中。仅当状态为FINISHED时，才表示请求执行成功，可以读取结果了。', 'type' => 'string', 'required' => true, 'description' => 'The current execution state of the asynchronous SQL query. Valid values are:'."\n" + ."\n" + .'- RUNNING'."\n" + ."\n" + .'- FINISHED'."\n" + ."\n" + .'- FAILED'."\n" + ."\n" + .'- CANCELLED'."\n" + ."\n" + .'RUNNING is a temporary state that indicates the SQL query is still running. You can read the results only when the state is FINISHED. The error\\_code and error\\_message parameters are valid only when the state is FAILED.', 'example' => 'FINISHED'], 'AsyncSqlMetaPB' => [ 'title' => 'SQL相关的meta信息', 'type' => 'object', 'properties' => [ - 'result_rows' => [ - 'title' => '结果总行数。读取结果是，offset值不应该超过这个值。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'The total number of rows in the result. When you read the results, the offset value must not exceed this value.', - 'example' => '12000', - ], - 'processed_rows' => [ - 'title' => '处理的原始数据行数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'description' => 'The number of raw data rows processed.', - 'example' => '10000000', - ], - 'elapsed_milli' => [ - 'title' => 'SQL执行时间（毫秒）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'description' => 'The SQL query running time in milliseconds.', - 'example' => '30000', - ], - 'cpu_sec' => [ - 'title' => '消耗的cpu总时间（秒）', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'description' => 'The total CPU time consumed in seconds.', - 'example' => '0.2', - ], - 'cpu_cores' => [ - 'title' => '使用了多少个cpu core', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'description' => 'The number of CPU cores used.', - 'example' => '10', - ], - 'progress' => [ - 'title' => 'SQL结果是否精确，它可以为以下两个值: ● Complete (表示结果精确) ● Incomplete (表示结果不精确)', - 'type' => 'string', - 'description' => 'Indicates whether the SQL result is accurate. Valid values are:'."\n" - ."\n" - .'- Complete: The result is accurate.'."\n" - ."\n" - .'- Incomplete: The result is not accurate.', - 'example' => 'Complete', - ], + 'result_rows' => ['title' => '结果总行数。读取结果是，offset值不应该超过这个值。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => 'The total number of rows in the result. When you read the results, the offset value must not exceed this value.', 'example' => '12000'], + 'processed_rows' => ['title' => '处理的原始数据行数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => 'The number of raw data rows processed.', 'example' => '10000000'], + 'elapsed_milli' => ['title' => 'SQL执行时间（毫秒）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => 'The SQL query running time in milliseconds.', 'example' => '30000'], + 'cpu_sec' => ['title' => '消耗的cpu总时间（秒）', 'type' => 'number', 'format' => 'double', 'required' => false, 'description' => 'The total CPU time consumed in seconds.', 'example' => '0.2'], + 'cpu_cores' => ['title' => '使用了多少个cpu core', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => 'The number of CPU cores used.', 'example' => '10'], + 'progress' => ['title' => 'SQL结果是否精确，它可以为以下两个值: ● Complete (表示结果精确) ● Incomplete (表示结果不精确)', 'type' => 'string', 'description' => 'Indicates whether the SQL result is accurate. Valid values are:'."\n" + ."\n" + .'- Complete: The result is accurate.'."\n" + ."\n" + .'- Incomplete: The result is not accurate.', 'example' => 'Complete'], 'keys' => [ 'title' => 'SQL结果对应的column名称，这里的keys和select中的字段是一一对应的。', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'The column name.', - 'title' => '', - 'example' => '["name", "age", "gender"]', - ], + 'items' => ['type' => 'string', 'description' => 'The column name.', 'title' => '', 'example' => '["name", "age", "gender"]'], 'description' => 'The names of the columns in the SQL result. The keys correspond one-to-one with the fields in the SELECT statement.', 'example' => '', ], @@ -911,12 +346,7 @@ 'type' => 'array', 'items' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => 'A column of the result.', - 'title' => '', - 'example' => '["Jimmy", "20", "male"]', - ], + 'items' => ['type' => 'string', 'description' => 'A column of the result.', 'title' => '', 'example' => '["Jimmy", "20", "male"]'], 'description' => 'A row of the result.', 'title' => '', 'example' => '', @@ -924,163 +354,72 @@ 'description' => 'The SQL result. Each element in the array is also an array that corresponds to a specific row of the result.', 'example' => '', ], - 'error_code' => [ - 'title' => 'SQL执行失败后，error_code中包含了具体的错误码', - 'type' => 'string', - 'description' => 'If the SQL query fails to execute, this parameter contains the specific error code.', - 'example' => 'InvalidQuery', - ], - 'error_message' => [ - 'title' => 'SQL执行失败后，error_message中包含了具体的错误信息', - 'type' => 'string', - 'description' => 'If the SQL query fails to execute, this parameter contains the specific error message.', - 'example' => 'line 37:14: Column \'xyz\' cannot be resolved', - ], + 'error_code' => ['title' => 'SQL执行失败后，error_code中包含了具体的错误码', 'type' => 'string', 'description' => 'If the SQL query fails to execute, this parameter contains the specific error code.', 'example' => 'InvalidQuery'], + 'error_message' => ['title' => 'SQL执行失败后，error_message中包含了具体的错误信息', 'type' => 'string', 'description' => 'If the SQL query fails to execute, this parameter contains the specific error message.', 'example' => 'line 37:14: Column \'xyz\' cannot be resolved'], ], 'example' => '', ], - 'AzureBlobIngestionConfiguration' => [ + 'AzureBlobIngestion' => [ + 'title' => 'A short description of struct', + 'description' => 'AzureBlob数据导入配置', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-azure-blob-123456'], + 'description' => ['title' => 'job description', 'type' => 'string', 'example' => 'azure blob ingestion'], + 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'azure blob ingestion'], + 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['title' => 'azure blob文件导入配置', 'required' => true, '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration'], + 'createTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'status' => ['title' => '导入状态', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], + 'processorId' => ['title' => '写入处理器ID', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + ], + ], + 'AzureBlobIngestionConfiguration' => [ 'title' => 'A short description of struct', 'description' => 'S3导入配置', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'type' => 'string', - 'example' => 'myLogstore', - ], - 'source' => [ - '$ref' => '#/components/schemas/AzureBlobIngestionConfigurationSource', - ], + 'logstore' => ['title' => 'logstore', 'type' => 'string', 'example' => 'myLogstore'], + 'source' => ['$ref' => '#/components/schemas/AzureBlobIngestionConfigurationSource'], ], ], 'AzureBlobIngestionConfigurationSource' => [ 'title' => 'A short description of struct', - 'description' => 'Azure BLOB import configuration', + 'description' => 'Contains the configuration for ingesting data from Azure Blob Storage.', 'type' => 'object', 'properties' => [ - 'compressionCodec' => [ - 'title' => '压缩类型：none,snappy,gzip', - 'description' => 'The compression type. Valid values: none, snappy, and gzip.', - 'type' => 'string', - 'example' => 'none', - 'required' => true, - ], - 'encoding' => [ - 'title' => '编码类型', - 'description' => 'The encoding type.', - 'type' => 'string', - 'example' => 'UTF-8', - 'required' => true, - ], - 'interval' => [ - 'title' => '检查新文件周期', - 'description' => 'The interval to check for new files.', - 'type' => 'string', - 'example' => '30m', - 'required' => true, - ], - 'pattern' => [ - 'title' => '文件路径正则过滤', - 'description' => 'The regular expression to filter file paths.', - 'type' => 'string', - 'example' => '.*', - ], - 'prefix' => [ - 'title' => '文件路径前缀过滤', - 'description' => 'The prefix to filter file paths.', - 'type' => 'string', - 'example' => 'prefix', - ], - 'tagPackId' => [ - 'title' => '支持上下文浏览', - 'description' => 'Enables context-aware browsing.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'startTime' => [ - 'title' => '某个时间点后修改过的文件', - 'description' => 'Files modified after a specific point in time.', - 'type' => 'integer', - 'example' => '1714274081', - 'format' => 'int64', - ], - 'endTime' => [ - 'title' => '某个时间点前修改过的文件', - 'description' => 'Files modified before a specific point in time.', - 'type' => 'integer', - 'example' => '1714360481', - 'format' => 'int64', - ], - 'timeField' => [ - 'title' => '提取时间字段', - 'description' => 'The field from which to extract the time.', - 'type' => 'string', - 'example' => '__time__', - ], - 'timeFormat' => [ - 'title' => '时间字段格式', - 'description' => 'The format of the time field.', - 'type' => 'string', - 'example' => 'yyyy-MM-dd HH:mm:ss', - ], - 'timePattern' => [ - 'title' => '提取时间正则', - 'description' => 'The regular expression to extract the time.', - 'type' => 'string', - 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+', - ], - 'timeZone' => [ - 'title' => '时间字段分区', - 'description' => 'Time field partition', - 'type' => 'string', - 'example' => 'GMT+08:00', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'description' => 'The ingest processor ID.', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - ], - 'accountName' => [ - 'title' => '账户名', - 'description' => 'The account name.', - 'type' => 'string', - 'example' => 'test001', - 'required' => true, - ], - 'accountKey' => [ - 'title' => '账户密钥', - 'description' => 'The account key.', - 'type' => 'string', - 'example' => 'dGVzdGtleQ==', - 'required' => true, - ], - 'containerName' => [ - 'title' => '容器名', - 'description' => 'The container name.', - 'type' => 'string', - 'example' => 'test-container', - 'required' => true, - ], - 'endpoint' => [ - 'description' => 'The service endpoint.', - 'type' => 'string', - 'title' => '', - 'example' => 'https://your-storage.blob.core.windows.net', - 'required' => false, - ], + 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => 'The compression codec for the source data. Valid values are `none`, `snappy`, and `gzip`.', 'type' => 'string', 'example' => 'none', 'required' => true], + 'encoding' => ['title' => '编码类型', 'description' => 'The character encoding of the source files.', 'type' => 'string', 'example' => 'UTF-8', 'required' => true], + 'interval' => ['title' => '检查新文件周期', 'description' => 'The interval at which to check for new files to ingest.', 'type' => 'string', 'example' => '30m', 'required' => true], + 'pattern' => ['title' => '文件路径正则过滤', 'description' => 'A pattern used to filter files by path.', 'type' => 'string', 'example' => '.*'], + 'prefix' => ['title' => '文件路径前缀过滤', 'description' => 'The file path prefix used to filter files.', 'type' => 'string', 'example' => 'prefix'], + 'tagPackId' => ['title' => '支持上下文浏览', 'description' => 'Specifies whether to enable context query.', 'type' => 'boolean', 'example' => 'false'], + 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => 'Ingests only files modified after this time, specified as a Unix timestamp.', 'type' => 'integer', 'example' => '1714274081', 'format' => 'int64'], + 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => 'Ingests only files modified before this time, specified as a Unix timestamp.', 'type' => 'integer', 'example' => '1714360481', 'format' => 'int64'], + 'timeField' => ['title' => '提取时间字段', 'description' => 'The source field for the time value.', 'type' => 'string', 'example' => '__time__'], + 'timeFormat' => ['title' => '时间字段格式', 'description' => 'The format of the time field.', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], + 'timePattern' => ['title' => '提取时间正则', 'description' => 'The pattern used to extract the time value.', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], + 'timeZone' => ['title' => '时间字段分区', 'description' => 'The time zone of the time field.', 'type' => 'string', 'example' => 'GMT+08:00'], + 'processorId' => ['title' => '写入处理器ID', 'description' => 'The ID of the processor that receives the data.', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + 'accountName' => ['title' => '账户名', 'description' => 'The name of the Azure Blob Storage account.', 'type' => 'string', 'example' => 'test001', 'required' => true], + 'accountKey' => ['title' => '账户密钥', 'description' => 'The access key for the Azure Blob Storage account.', 'type' => 'string', 'example' => 'dGVzdGtleQ==', 'required' => true], + 'containerName' => ['title' => '容器名', 'description' => 'The name of the container in Azure Blob Storage.', 'type' => 'string', 'example' => 'test-container', 'required' => true], + 'endpoint' => ['description' => 'The service endpoint for Azure Blob Storage.', 'type' => 'string', 'title' => '', 'example' => 'https://your-storage.blob.core.windows.net', 'required' => false], 'format' => [ 'title' => '格式', 'type' => 'object', 'required' => true, - 'additionalProperties' => [ - 'description' => 'The data format.', - 'type' => 'any', - 'title' => '', - 'example' => '{"type": "line"}', - ], - 'description' => 'The format.', + 'additionalProperties' => ['description' => 'Defines the properties of the data format.', 'type' => 'any', 'title' => '', 'example' => '{"type": "line"}'], + 'description' => 'The format of the source data.', + 'example' => '', + ], + 'advancedParameters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'Additional advanced parameters, specified as key-value pairs.', 'type' => 'any', 'title' => '', 'example' => ''], + 'description' => 'Advanced configuration options.', + 'title' => '', 'example' => '', ], ], @@ -1092,44 +431,11 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'title' => [ - 'title' => '图表标题。支持大小写英文字母、数字、下划线_、连字符-，连字符与下划线不能作为名称开头与结尾，长度必须在[2,64] 之间。', - 'description' => 'The title of the chart.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-chart', - ], - 'type' => [ - 'title' => '图表的类型。', - 'description' => 'The type of the chart.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'linepro', - ], - 'search' => [ - 'title' => '查询配置', - 'description' => 'The query statement.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - 'example' => '(*)| SELECT date_format(__time__ - __time__ % 60, \'%H:%i:%s\') as time, count(1) as count GROUP BY time ORDER BY time', - ], - 'display' => [ - 'title' => '图表的显示配置', - 'description' => 'The display configuration of the chart.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - ], - 'action' => [ - 'title' => 'action', - 'description' => 'The action.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - ], + 'title' => ['title' => '图表标题。支持大小写英文字母、数字、下划线_、连字符-，连字符与下划线不能作为名称开头与结尾，长度必须在[2,64] 之间。', 'description' => 'The title of the chart.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-chart'], + 'type' => ['title' => '图表的类型。', 'description' => 'The type of the chart.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'linepro'], + 'search' => ['title' => '查询配置', 'description' => 'The query statement.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'example' => '(*)| SELECT date_format(__time__ - __time__ % 60, \'%H:%i:%s\') as time, count(1) as count GROUP BY time ORDER BY time'], + 'display' => ['title' => '图表的显示配置', 'description' => 'The display configuration of the chart.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true], + 'action' => ['title' => 'action', 'description' => 'The action.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true], ], ], 'ConditionConfiguration' => [ @@ -1138,20 +444,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'condition' => [ - 'title' => '评估表达式', - 'description' => 'The evaluate expression.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cnt > 100', - ], - 'countCondition' => [ - 'title' => '满足评估表达式的结果条数', - 'description' => 'The number of entries that match the evaluate expression to return.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '__count__ > 5', - ], + 'condition' => ['title' => '评估表达式', 'description' => 'The evaluate expression.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cnt > 100'], + 'countCondition' => ['title' => '满足评估表达式的结果条数', 'description' => 'The number of entries that match the evaluate expression to return.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '__count__ > 5'], ], ], 'ConsumeProcessor' => [ @@ -1160,53 +454,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', - 'example' => '', - ], - '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', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1717171200'], + 'updateTime' => ['title' => '更新时间', 'description' => '更新时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1717171200'], ], 'example' => '', ], @@ -1216,14 +469,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'spl' => [ - 'title' => 'SPL语句', - 'description' => 'SPL statement'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '* | project content', - ], + 'spl' => ['title' => 'SPL语句', 'description' => 'SPL statement'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | project content'], ], ], 'ConsumerGroup' => [ @@ -1232,31 +478,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '消费者名称。', - 'description' => 'The name of the consumer group.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test-consumer-group', - ], - 'timeout' => [ - 'title' => '消费超时时长，单位为秒', - 'description' => 'The timeout period. If Simple Log Service does not receive heartbeats from a consumer within the timeout period, Simple Log Service deletes the consumer. Unit: seconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'order' => [ - 'title' => '是否有序消费', - 'description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" - ."\n" - .'* true: If a shard is split, the data in the original shard is consumed first. Then, the data in the new shards is consumed at the same time. If shards are merged, the data in the original shards is consumed first. Then, the data in the new shard is consumed.'."\n" - .'* false: The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or shards are merged, the data in the new shard is immediately consumed.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], + 'name' => ['title' => '消费者名称。', 'description' => 'The name of the consumer group.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test-consumer-group'], + 'timeout' => ['title' => '消费超时时长，单位为秒', 'description' => 'The timeout period. If Simple Log Service does not receive heartbeats from a consumer within the timeout period, Simple Log Service deletes the consumer. Unit: seconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'order' => ['title' => '是否有序消费', 'description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" + ."\n" + .'* true: If a shard is split, the data in the original shard is consumed first. Then, the data in the new shards is consumed at the same time. If shards are merged, the data in the original shards is consumed first. Then, the data in the new shard is consumed.'."\n" + .'* false: The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or shards are merged, the data in the new shard is immediately consumed.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'], ], ], 'dashboard' => [ @@ -1265,42 +492,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'dashboardName' => [ - 'title' => '仪表盘ID。同一个Project下，仪表盘ID唯一，不可重复。', - 'description' => 'The internal display name of the dashboard.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], - 'displayName' => [ - 'title' => '仪表盘的展示名称。', - 'description' => 'The display name of the dashboard.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-alert', - ], - 'description' => [ - 'title' => '描述信息。', - 'description' => 'The description of the dashboard.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a dashboard', - ], + 'dashboardName' => ['title' => '仪表盘ID。同一个Project下，仪表盘ID唯一，不可重复。', 'description' => 'The internal display name of the dashboard.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], + 'displayName' => ['title' => '仪表盘的展示名称。', 'description' => 'The display name of the dashboard.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-alert'], + 'description' => ['title' => '描述信息。', 'description' => 'The description of the dashboard.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'this is a dashboard'], 'attribute' => [ 'title' => '属性值，可用于修改仪表盘的布局等属性，例如 "type": "free" 自由布局， "type":"grid" 网格布局。', 'description' => 'The properties of the dashboard.', 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The value of the property.', - 'visibility' => 'Public', - 'type' => 'string', - 'title' => '', - 'example' => 'yyy', - ], + 'additionalProperties' => ['description' => 'The value of the property.', 'visibility' => 'Public', 'type' => 'string', 'title' => '', 'example' => 'yyy'], 'example' => '', ], 'charts' => [ @@ -1308,14 +508,7 @@ 'description' => 'The charts in the dashboard.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The data structure of the chart.', - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/chart', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The data structure of the chart.', 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/chart', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], @@ -1326,53 +519,13 @@ 'title' => '软删除任务', 'type' => 'object', 'properties' => [ - 'progress' => [ - 'title' => '进度', - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => '', - ], - 'taskId' => [ - 'title' => 'id', - 'type' => 'string', - 'required' => false, - 'description' => '', - 'example' => '', - ], - 'query' => [ - 'title' => '使用的query', - 'type' => 'string', - 'description' => '', - 'example' => '', - ], - 'errorCode' => [ - 'title' => '出错时的errorCode', - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => '', - ], - 'from' => [ - 'title' => '起始时间', - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => '', - ], - 'to' => [ - 'title' => '结束时间', - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'example' => '', - ], - 'errorMessage' => [ - 'title' => '出错时的errorMessage', - 'type' => 'string', - 'description' => '', - 'example' => '', - ], + 'progress' => ['title' => '进度', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'taskId' => ['title' => 'id', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + 'query' => ['title' => '使用的query', 'type' => 'string', 'description' => '', 'example' => ''], + 'errorCode' => ['title' => '出错时的errorCode', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'from' => ['title' => '起始时间', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'to' => ['title' => '结束时间', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'errorMessage' => ['title' => '出错时的errorMessage', 'type' => 'string', 'description' => '', 'example' => ''], ], 'description' => 'The soft delete task.', 'example' => '', @@ -1383,18 +536,10 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enable' => [ - 'title' => 'enable', - 'description' => 'Specifies whether to enable data encryption. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'true', - ], + 'enable' => ['title' => 'enable', 'description' => 'Specifies whether to enable data encryption. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'default' => 'true'], 'encrypt_type' => [ 'title' => '加密算法，只支持default和m4。当 enable 为 true 时，此项必选。', 'description' => 'The encryption algorithm. Valid values: default and sm4. If enable is set to true, you must configure this parameter.'."\n", @@ -1403,25 +548,9 @@ 'required' => false, 'example' => 'default', 'default' => 'default', - 'enumValueTitles' => [ - 'default' => 'default', - 'aes_ecb' => 'aes_ecb', - 'aes_cbc' => 'aes_cbc', - 'aes_gcm' => 'aes_gcm', - 'm4' => 'm4', - 'aes_cfb' => 'aes_cfb', - 'sm4_ecb' => 'sm4_ecb', - 'sm4_cbc' => 'sm4_cbc', - 'sm4_gcm' => 'sm4_gcm', - 'aes_ofb' => 'aes_ofb', - ], - ], - 'user_cmk_info' => [ - 'description' => 'Optional. If you configure this parameter, the bring-your-own-key (BYOK) key is used. If you do not configure this parameter, the service key of Simple Log Service is used.'."\n", - 'visibility' => 'Public', - 'example' => ' { "cmk_key_id" : "f5136b95-2420-ab31-xxxxxxxxx" "arn" : "acs:ram::13234:role/logsource" "region_id" : "cn-hangzhou" }', - '$ref' => '#/components/schemas/EncryptUserCmkConf', + 'enumValueTitles' => ['default' => 'default', 'aes_ecb' => 'aes_ecb', 'aes_cbc' => 'aes_cbc', 'aes_gcm' => 'aes_gcm', 'm4' => 'm4', 'aes_cfb' => 'aes_cfb', 'sm4_ecb' => 'sm4_ecb', 'sm4_cbc' => 'sm4_cbc', 'sm4_gcm' => 'sm4_gcm', 'aes_ofb' => 'aes_ofb'], ], + 'user_cmk_info' => ['description' => 'Optional. If you configure this parameter, the bring-your-own-key (BYOK) key is used. If you do not configure this parameter, the service key of Simple Log Service is used.'."\n", 'visibility' => 'Public', 'example' => ' { "cmk_key_id" : "f5136b95-2420-ab31-xxxxxxxxx" "arn" : "acs:ram::13234:role/logsource" "region_id" : "cn-hangzhou" }', '$ref' => '#/components/schemas/EncryptUserCmkConf'], ], ], 'EncryptUserCmkConf' => [ @@ -1430,96 +559,24 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'cmk_key_id' => [ - 'title' => 'cmk_key_id', - 'description' => 'The ID of the customer master key (CMK) if you use the bring-your-own-key (BYOK) key.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'f5136b95-2420-ab31-xxxxxxxxx', - ], - 'arn' => [ - 'title' => 'arn', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::13234:role/logsource', - ], - 'region_id' => [ - 'title' => 'region_id', - 'description' => 'The ID of the region where the CMK resides.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'cmk_key_id' => ['title' => 'cmk_key_id', 'description' => 'The ID of the customer master key (CMK) if you use the bring-your-own-key (BYOK) key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'f5136b95-2420-ab31-xxxxxxxxx'], + 'arn' => ['title' => 'arn', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logsource'], + 'region_id' => ['title' => 'region_id', 'description' => 'The ID of the region where the CMK resides.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'ESIngestion' => [ 'title' => 'es ingestion job', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-es-123456', - 'description' => '', - ], - 'description' => [ - 'title' => 'job description', - 'type' => 'string', - 'example' => 'es ingestion', - 'description' => '', - ], - 'displayName' => [ - 'title' => 'job displayName', - 'type' => 'string', - 'required' => true, - 'example' => 'es ingestion', - 'description' => '', - ], - 'schedule' => [ - 'title' => '调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - 'description' => '', - 'example' => '', - ], - 'configuration' => [ - 'title' => 'es导入配置', - 'required' => true, - '$ref' => '#/components/schemas/ESIngestionConfiguration', - 'description' => '', - 'example' => '', - ], - 'createTime' => [ - 'title' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - 'description' => '', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - 'description' => '', - ], - 'status' => [ - 'title' => '导入状态', - 'type' => 'string', - 'example' => 'RUNNING', - 'description' => '', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'type' => 'string', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - 'description' => '', - ], + 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-es-123456', 'description' => ''], + 'description' => ['title' => 'job description', 'type' => 'string', 'example' => 'es ingestion', 'description' => ''], + 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'es ingestion', 'description' => ''], + 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'description' => '', 'example' => ''], + 'configuration' => ['title' => 'es导入配置', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration', 'description' => '', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481', 'description' => ''], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481', 'description' => ''], + 'status' => ['title' => '导入状态', 'type' => 'string', 'example' => 'RUNNING', 'description' => ''], + 'scheduleId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010', 'description' => ''], ], 'description' => 'ES ingestion job', 'example' => '', @@ -1529,20 +586,8 @@ 'description' => 'ES import configuration.', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'description' => 'The Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'source' => [ - 'description' => 'The source.', - 'required' => true, - '$ref' => '#/components/schemas/ESIngestionConfigurationSource', - 'title' => '', - 'example' => '', - ], + 'logstore' => ['title' => 'logstore', 'description' => 'The Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'source' => ['description' => 'The source.', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfigurationSource', 'title' => '', 'example' => ''], ], 'example' => '', ], @@ -1551,1073 +596,409 @@ 'description' => 'The resource configuration for ES data import.', 'type' => 'object', 'properties' => [ - 'BootstrapServers' => [ - 'title' => '服务实例URL', - 'type' => 'string', + 'BootstrapServers' => ['title' => '服务实例URL', 'type' => 'string', 'required' => true, 'description' => 'The URL of the service instance.', 'example' => ''], + 'Index' => ['title' => 'ES索引列表', 'type' => 'string', 'required' => true, 'description' => 'The list of ES indexes.', 'example' => ''], + 'Username' => ['title' => 'ES用户名称', 'type' => 'string', 'required' => false, 'description' => 'The username for ES.', 'example' => ''], + 'Password' => ['title' => 'ES用户密码', 'type' => 'string', 'required' => false, 'description' => 'The password for the ES user.', 'example' => ''], + 'TimeFieldName' => ['title' => '时间字段', 'type' => 'string', 'description' => 'The time field.', 'example' => ''], + 'TimeFormat' => ['title' => '时间字段格式', 'type' => 'string', 'description' => 'The format of the time field.', 'example' => ''], + 'TimeZone' => ['title' => '时间字段时区', 'type' => 'string', 'description' => 'The time zone of the time field.', 'example' => ''], + 'Query' => ['title' => 'ES查询', 'type' => 'string', 'required' => true, 'description' => 'The ES query.', 'example' => ''], + 'ConnectorMode' => ['title' => '导入模式', 'type' => 'string', 'required' => true, 'description' => 'The import mode.', 'example' => ''], + 'StartTime' => ['title' => '起始时间', 'type' => 'integer', 'format' => 'int64', 'description' => 'The start time.', 'example' => ''], + 'EndTime' => ['title' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'description' => 'The end time.', 'example' => ''], + 'MaxDataDelaySec' => ['title' => '数据最大延迟秒数', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => 'The maximum data delay in seconds.', 'example' => ''], + 'MinFragRangeSec' => ['title' => '检查新数据周期（秒）', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => 'The interval in seconds for checking new data.', 'example' => ''], + 'VpcId' => ['title' => 'VPC实例ID', 'type' => 'string', 'description' => 'The ID of the VPC instance.', 'example' => ''], + ], + 'example' => '', + ], + 'ETL' => [ + 'title' => 'ETL', + 'description' => 'ETL'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '任务名称', 'description' => 'job name'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ETL'], + 'description' => ['title' => '任务描述', 'description' => 'job description'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ETL'], + 'displayName' => ['title' => '显示名称', 'description' => 'job displayName'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ETL'], + 'configuration' => ['title' => '数据加工配置', 'description' => 'The configurations of the data transformation job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the data transformation job was created.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1714274900'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => 'The time when the data transformation job was last modified.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1714274900'], + 'status' => ['title' => '加工状态', 'description' => 'The status of the data transformation job. Valid values:'."\n" + ."\n" + .'1. RUNNING'."\n" + .'2. STOPPING'."\n" + .'3. STOPPED'."\n" + .'4. SUCCEEDED'."\n" + .'5. FAILED'."\n" + .'6. STARTING'."\n" + .'7. RESTARTING'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '调度ID', 'description' => 'The ID of the scheduler.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'f0eb655e501a8780808d1970ef6d04c4'], + ], + ], + 'ETLConfiguration' => [ + 'title' => 'A short description of struct', + 'description' => 'ETLConfiguration', + 'type' => 'object', + 'properties' => [ + 'script' => ['title' => '加工脚本', 'description' => 'The data transformation script.', 'type' => 'string', 'required' => true, 'example' => '* | extend key=\'value\'', 'visibility' => 'Public'], + 'lang' => ['title' => '数据加工语法类型', 'description' => 'The language of the data transformation script.', 'type' => 'string', 'example' => 'SPL', 'visibility' => 'Public'], + 'logstore' => ['title' => '源Logstore名称', 'description' => 'The name of the source Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'visibility' => 'Public'], + 'roleArn' => ['title' => '授权读取源Logstore的角色ARN', 'description' => 'The ARN of the RAM role that is authorized to read data from the source Logstore.', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logtarget', 'visibility' => 'Public'], + 'accessKeyId' => ['title' => '授权读取源Logstore的AccessKey ID，必填。使用角色授权时，填入空字符串', 'description' => 'The AccessKey ID that is required to read data from the source Logstore. This parameter is required. If you use a RAM role for authorization, set this parameter to an empty string.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '', 'visibility' => 'Public'], + 'accessKeySecret' => ['title' => '授权读取源Logstore的AccessKey Secret，必填。使用角色授权时，填入空字符串。', 'description' => 'The AccessKey secret that is required to read data from the source Logstore. This parameter is required. If you use a RAM role for authorization, set this parameter to an empty string.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '', 'visibility' => 'Public'], + 'fromTime' => ['title' => '加工时间起点时间戳（精确到秒），必填。从源Logstore中最早接收到的第一条日志开始消费时，填入0', 'description' => 'The start time of the data transformation. The value is a UNIX timestamp. Unit: seconds. This parameter is required. To start the data transformation from the earliest log in the source Logstore, set this parameter to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'visibility' => 'Public'], + 'toTime' => ['title' => '加工时间结束时间戳（精确到秒），必填。持续消费至手动停止时，填入0', 'description' => 'The end time of the data transformation. The value is a UNIX timestamp. Unit: seconds. This parameter is required. To continuously perform the data transformation until you manually stop it, set this parameter to 0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'visibility' => 'Public'], + 'sinks' => [ + 'title' => '加工结果输出目标列表', + 'description' => 'The output destinations of the data transformation.', + 'type' => 'array', + 'items' => ['$ref' => '#/components/schemas/ETLConfigurationSink', 'description' => '', 'title' => '', 'example' => '', 'visibility' => 'Public', 'extendType' => 'true'], 'required' => true, - 'description' => 'The URL of the service instance.', 'example' => '', 'visibility' => 'Public', ], - 'Index' => [ - 'title' => 'ES索引列表', - 'type' => 'string', - 'required' => true, - 'description' => 'The list of ES indexes.', - 'example' => '', - 'visibility' => 'Public', - ], - 'Username' => [ - 'title' => 'ES用户名称', - 'type' => 'string', - 'required' => false, - 'description' => 'The username for ES.', - 'example' => '', - 'visibility' => 'Public', - ], - 'Password' => [ - 'title' => 'ES用户密码', - 'type' => 'string', - 'required' => false, - 'description' => 'The password for the ES user.', - 'example' => '', - 'visibility' => 'Public', - ], - 'TimeFieldName' => [ - 'title' => '时间字段', - 'type' => 'string', - 'description' => 'The time field.', - 'example' => '', - 'visibility' => 'Public', - ], - 'TimeFormat' => [ - 'title' => '时间字段格式', - 'type' => 'string', - 'description' => 'The format of the time field.', - 'example' => '', - 'visibility' => 'Public', - ], - 'TimeZone' => [ - 'title' => '时间字段时区', - 'type' => 'string', - 'description' => 'The time zone of the time field.', - 'example' => '', - 'visibility' => 'Public', - ], - 'Query' => [ - 'title' => 'ES查询', - 'type' => 'string', - 'required' => true, - 'description' => 'The ES query.', - 'example' => '', - 'visibility' => 'Public', - ], - 'ConnectorMode' => [ - 'title' => '导入模式', - 'type' => 'string', - 'required' => true, - 'description' => 'The import mode.', - 'example' => '', - 'visibility' => 'Public', - ], - 'StartTime' => [ - 'title' => '起始时间', - 'type' => 'integer', - 'format' => 'int64', - 'description' => 'The start time.', - 'example' => '', - 'visibility' => 'Public', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'type' => 'integer', - 'format' => 'int64', - 'description' => 'The end time.', - 'example' => '', - 'visibility' => 'Public', - ], - 'MaxDataDelaySec' => [ - 'title' => '数据最大延迟秒数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'description' => 'The maximum data delay in seconds.', - 'example' => '', - 'visibility' => 'Public', - ], - 'MinFragRangeSec' => [ - 'title' => '检查新数据周期（秒）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'description' => 'The interval in seconds for checking new data.', - 'example' => '', - 'visibility' => 'Public', - ], - 'VpcId' => [ - 'title' => 'VPC实例ID', - 'type' => 'string', - 'description' => 'The ID of the VPC instance.', + 'parameters' => ['title' => '高级参数配置', 'description' => 'Advanced parameters.', 'type' => 'object', 'example' => 'config.vpc.vpc_id.test1：vpc-uf6mskb0b****n9yj', 'visibility' => 'Public'], + ], + 'example' => '', + 'visibility' => 'Public', + ], + 'ETLConfigurationSink' => [ + 'title' => 'A short description of struct', + 'description' => 'The sink configuration.', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '输出目标名称', 'description' => 'The sink name.', 'type' => 'string', 'required' => true, 'example' => 'test-etljob', 'visibility' => 'Public'], + 'endpoint' => ['title' => '目标Project所在区域的endpoint', 'description' => 'The endpoint of the destination Project\'s region.', 'type' => 'string', 'example' => '', 'visibility' => 'Public'], + 'project' => ['title' => '目标Project名称', 'description' => 'The destination Project name.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'visibility' => 'Public'], + 'logstore' => ['title' => '目标Logstore名称', 'description' => 'The destination Logstore name.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'visibility' => 'Public'], + 'datasets' => [ + 'title' => '写入结果集', + 'description' => 'The datasets to write to the sink.', + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => true, 'example' => '__UNNAMED__', 'description' => '', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'minItems' => 1, 'example' => '', 'visibility' => 'Public', ], + 'roleArn' => ['title' => '授权写入目标Logstore的角色ARN', 'description' => 'The role ARN used to write to the destination Logstore.', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13234:role/logtarget', 'visibility' => 'Public'], + 'accessKeyId' => ['title' => '授权写入目标Logstore的AccessKey ID', 'description' => 'The AccessKey ID used to write to the destination Logstore.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '', 'visibility' => 'Public'], + 'accessKeySecret' => ['title' => '授权写入目标Logstore的AccessKey Secret', 'description' => 'The AccessKey Secret used to write to the destination Logstore.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '', 'visibility' => 'Public'], ], 'example' => '', - 'alibabaCloud' => 'alibabaCloud:1.0.0', - 'info' => [ - 'runtimeType' => 'none', - 'namespace' => 'Sls::2020-12-30', - 'apiStyle' => 'restful', - ], - 'components' => [ - 'schemas' => [ - 'ESIngestionConfigurationSource' => [ - 'title' => 'A short description of struct', - 'description' => 'es导入资源配置', - 'type' => 'object', - 'properties' => [ - 'BootstrapServers' => [ - 'title' => '服务实例URL', - 'type' => 'string', - 'required' => true, - ], - 'Index' => [ - 'title' => 'ES索引列表', - 'type' => 'string', - 'required' => true, - ], - 'Username' => [ - 'title' => 'ES用户名称', - 'type' => 'string', - 'required' => false, - ], - 'Password' => [ - 'title' => 'ES用户密码', - 'type' => 'string', - 'required' => false, - ], - 'TimeFieldName' => [ - 'title' => '时间字段', - 'type' => 'string', - ], - 'TimeFormat' => [ - 'title' => '时间字段格式', - 'type' => 'string', - ], - 'TimeZone' => [ - 'title' => '时间字段时区', - 'type' => 'string', - ], - 'Query' => [ - 'title' => 'ES查询', - 'type' => 'string', - 'required' => true, - ], - 'ConnectorMode' => [ - 'title' => '导入模式', - 'type' => 'string', - 'required' => true, - ], - 'StartTime' => [ - 'title' => '起始时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'type' => 'integer', - 'format' => 'int64', - ], - 'MaxDataDelaySec' => [ - 'title' => '数据最大延迟秒数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], - 'MinFragRangeSec' => [ - 'title' => '检查新数据周期（秒）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], - 'VpcId' => [ - 'title' => 'VPC实例ID', - 'type' => 'string', - ], - ], - ], - ], - ], 'visibility' => 'Public', ], - 'ETL' => [ - 'title' => 'ETL', - 'description' => 'ETL'."\n", + 'etlJob' => [ + 'title' => 'A short description of struct', + 'description' => '数据加工任务数据结构。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '任务名称', - 'description' => 'job name'."\n", + 'etlJobName' => ['title' => '任务名称', 'description' => '数据加工任务名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'etl-name'], + 'sourceConfig' => [ + 'title' => '配置数据来源', + 'description' => '配置数据来源。', 'visibility' => 'Public', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'logstoreName' => ['title' => 'logstore 名称', 'description' => 'Logstore名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], + ], 'required' => true, - 'example' => 'ETL', - ], - 'description' => [ - 'title' => '任务描述', - 'description' => 'job description'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ETL', ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => 'job displayName'."\n", + 'triggerConfig' => [ + 'title' => '触发器配置', + 'description' => '加工任务触发器配置。', 'visibility' => 'Public', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'roleArn' => ['title' => '角色授权配置', 'description' => '角色授权配置，例如角色ARN为`acs:ram::13791******44:role/aliyunlogetlrole`。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::13791******44:role/aliyunlogetlrole'], + 'triggerInterval' => ['title' => '触发间隔，单位为秒，必须在 [3,600] 之间', 'description' => '触发间隔。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5'], + 'maxRetryTime' => ['title' => '最大重试次数，必须在[0,100] 之间', 'description' => '最大重试次数。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], + 'startingPosition' => ['title' => '开始位置，可选 latest、at-unixtime， 默认 latest。', 'description' => '开始位置。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'at-unixtime'], + 'startingUnixtime' => ['title' => '开始时间', 'description' => '开始时间。当startingPosition为at-unixtime时生效。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], + ], 'required' => true, - 'example' => 'ETL', ], - 'configuration' => [ - 'title' => '数据加工配置', - 'description' => 'The configurations of the data transformation job.'."\n", + 'functionConfig' => [ + 'title' => '运行函数配置', + 'description' => '运行函数配置。', 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'functionProvider' => ['title' => '函数 provider，可选值为 FunctionCompute 、CloudProdLogDispatch。当值为 FunctionCompute 时，endpoint、accountid 、regionName 、serviceName 、functionName 必选。', 'description' => '函数provider。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'FunctionCompute'], + 'endpoint' => ['title' => 'endpoint', 'description' => '服务入口Endpoint。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou.log.aliyuncs.com'], + 'accountId' => ['title' => '账户 id', 'description' => '阿里云账号ID。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '13791******44'], + 'regionName' => ['title' => '地域', 'description' => '地域。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + 'serviceName' => ['title' => '服务名', 'description' => '服务名。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'my-service'], + 'functionName' => ['title' => '函数名', 'description' => '函数名。', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'hello-world'], + 'roleArn' => ['title' => '角色授权', 'description' => '角色授权配置，例如角色ARN为`acs:ram::13791******44:role/aliyunlogetlrole`。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:ram::13791******44:role/aliyunlogetlrole'], + ], 'required' => true, - '$ref' => '#/components/schemas/ETLConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the data transformation job was created.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1714274900', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'description' => 'The time when the data transformation job was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1714274900', - ], - 'status' => [ - 'title' => '加工状态', - 'description' => 'The status of the data transformation job. Valid values:'."\n" - ."\n" - .'1. RUNNING'."\n" - .'2. STOPPING'."\n" - .'3. STOPPED'."\n" - .'4. SUCCEEDED'."\n" - .'5. FAILED'."\n" - .'6. STARTING'."\n" - .'7. RESTARTING'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', ], - 'scheduleId' => [ - 'title' => '调度ID', - 'description' => 'The ID of the scheduler.'."\n", + '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' => 'string', - 'example' => 'f0eb655e501a8780808d1970ef6d04c4', + 'type' => 'object', + 'properties' => [ + 'endpoint' => ['title' => 'endpoint', 'description' => '服务入口Endpoint。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou.log.aliyuncs.com'], + 'projectName' => ['title' => 'project 名称', 'description' => 'Project名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + 'logstoreName' => ['title' => 'logstore 名称', 'description' => 'Logstore名称。', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], + ], + 'required' => true, ], ], ], - 'ETLConfiguration' => [ + 'etlMeta' => [ 'title' => 'A short description of struct', - 'description' => 'ETLConfiguration'."\n", + 'description' => 'etlMeta数据结构。', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'script' => [ - 'title' => '加工脚本', - 'description' => 'The transformation script.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'e_set("key","value")', - ], - 'lang' => [ - 'title' => '数据加工语法类型', - 'description' => 'The type of the data transformation syntax.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPL', - ], - 'logstore' => [ - 'title' => '源Logstore名称', - 'description' => 'The name of the source logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'roleArn' => [ - 'title' => '授权读取源Logstore的角色ARN', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role that is used to grant the permissions to read data from the source logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::13234:role/logtarget', - ], - 'accessKeyId' => [ - 'title' => '授权读取源Logstore的AccessKey ID，必填。使用角色授权时，填入空字符串', - 'description' => 'The AccessKey ID used to grant the permissions to read data from the source logstore. This parameter is required. If you use a role to grant the required permissions, specify an empty string.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - ], - 'accessKeySecret' => [ - 'title' => '授权读取源Logstore的AccessKey Secret，必填。使用角色授权时，填入空字符串。', - 'description' => 'The AccessKey secret used to grant the permissions to read data from the source logstore. This parameter is required. If you use a role to grant the required permissions, specify an empty string.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - ], - 'fromTime' => [ - 'title' => '加工时间起点时间戳（精确到秒），必填。从源Logstore中最早接收到的第一条日志开始消费时，填入0', - 'description' => 'The beginning of the time range for transformation. Specify a Unix timestamp that is accurate to the second. This parameter is required. If you want to transform data from the first log in the source logstore, enter 0.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - 'toTime' => [ - 'title' => '加工时间结束时间戳（精确到秒），必填。持续消费至手动停止时，填入0', - 'description' => 'The end of the time range for transformation. Specify a Unix timestamp that is accurate to the second. This parameter is required. If you want to transform data until the data transformation job is manually stopped, enter 0.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - 'sinks' => [ - 'title' => '加工结果输出目标列表', - 'description' => 'The storage destinations.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ETLConfigurationSink', - 'description' => '', - ], - 'required' => true, - ], - 'parameters' => [ - 'title' => '高级参数配置', - 'description' => 'The advanced parameter settings.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'example' => 'config.vpc.vpc_id.test1:vpc-uf6mskb0b****n9yj', - ], + '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'], ], ], - 'ETLConfigurationSink' => [ + 'externalStore' => [ 'title' => 'A short description of struct', - 'description' => 'The ETL sink object.'."\n", + 'description' => 'The data structure of the external store.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '输出目标名称', - 'description' => 'The name of the storage destination.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-etljob', - ], - 'endpoint' => [ - 'title' => '目标Project所在区域的endpoint', - 'description' => 'The Simple Log Service endpoint for the region where the destination project resides.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - ], - 'project' => [ - 'title' => '目标Project名称', - 'description' => 'The name of the destination project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'externalStoreName' => ['title' => '外部存储的名称。', 'description' => 'The name of the external store. The name must be unique in a project and must be different from Logstore names.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'rds_store'], + 'storeType' => ['title' => '类型。可选 rds-vpc 或者 oss', 'description' => 'The storage type. Set the value to rds-vpc, which indicates a database on an ApsaraDB RDS for MySQL instance in a virtual private cloud (VPC).'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'rds-vpc'], + 'parameter' => ['title' => '参数', 'description' => 'The parameters that are configured for the external store.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'example' => '{ "vpc-id": "vpc-bp1aevy8sofi8mh1q****", "instance-id": "i-bp1b6c719dfa08exf****", "host": "192.168.XX.XX", "port": "3306", "username": "root", "password": "sfdsfldsfksfls****", "db": "meta", "table": "join_meta", "region": "cn-qingdao" }'], + ], + ], + 'GCSIngestion' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '导入任务名称', 'description' => 'The job name.', 'type' => 'string', 'example' => 'ingest-gcs-123456', 'required' => true], + 'description' => ['title' => 'job description', 'description' => 'A user-friendly description for the job.', 'type' => 'string', 'example' => 'gcs ingestion'], + 'displayName' => ['title' => 'job displayName', 'description' => 'The display name for the job.', 'type' => 'string', 'example' => 'gcs ingestion', 'required' => true], + 'configuration' => ['title' => 'gcs导入配置', 'description' => 'The GCS ingestion configuration.', 'example' => '', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => 'Output only. The creation time of the job, as a Unix timestamp.', 'type' => 'integer', 'example' => '1714360481', 'format' => 'int64'], + 'status' => ['title' => '导入状态', 'description' => 'Output only. The ingestion status.', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => 'The job ID.', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], + 'lastModifiedTime' => ['description' => 'Output only. The last modified time of the job, as a Unix timestamp.', 'type' => 'integer', 'title' => '', 'example' => '1714360581', 'format' => 'int64'], + ], + 'description' => 'Represents a data ingestion job that imports data from Google Cloud Storage (GCS).', + 'example' => '', + ], + 'GCSIngestionConfiguration' => [ + 'type' => 'object', + 'properties' => [ + 'logstore' => ['title' => 'logstore', 'description' => 'The name of the destination logstore.', 'type' => 'string', 'example' => 'myLogstore', 'required' => true], + 'source' => ['description' => 'The data source configuration.', 'title' => '', 'example' => '', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfigurationSource'], + ], + 'description' => 'The GCS ingestion configuration.', + 'title' => '', + 'example' => '', + ], + 'GCSIngestionConfigurationSource' => [ + 'title' => 'A short description of struct', + 'type' => 'object', + 'properties' => [ + 'endpoint' => ['title' => 'gcs endpoint', 'description' => 'The service endpoint for GCS. You can use a custom endpoint for private or accelerated connections.', 'type' => 'string', 'example' => 'oss-cn-hangzhou.aliyuncs.com', 'required' => false], + 'bucket' => ['title' => 'gcs bucket', 'description' => 'The name of the GCS bucket that contains the source data files.', 'type' => 'string', 'example' => 'gcsbucket', 'required' => true], + 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => 'The compression format of the source files. Supported values are `none`, `gzip`, and `zstd`. If not specified, the system infers the format from the file extension.', 'type' => 'string', 'example' => 'none', 'required' => true], + 'encoding' => ['title' => '编码类型', 'description' => 'The character encoding of the source files. The default value is `UTF-8`.', 'type' => 'string', 'example' => 'UTF-8', 'required' => true], + 'interval' => ['title' => '检查新文件周期', 'description' => 'The interval for checking for new data. Specify the value in a duration format, such as `15m` for 15 minutes. Set to `never` to perform a one-time ingestion.', 'type' => 'string', 'example' => 'never', 'required' => true], + 'pattern' => ['title' => '文件路径正则过滤', 'description' => 'A regular expression that specifies which files to ingest. The pattern is matched against the full object key within the specified prefix.', 'type' => 'string', 'example' => '.*'], + 'prefix' => ['title' => '文件路径前缀过滤', 'description' => 'The object key prefix used to discover files. This limits the scope of ingestion to a specific "folder" within the bucket.', 'type' => 'string', 'example' => 'prefix'], + 'restoreObjectEnabled' => ['title' => '导入归档文件', 'description' => 'Specifies whether to automatically restore objects from archival storage classes before ingestion. Set to `true` to enable this feature. The default is `false`.', 'type' => 'boolean', 'example' => '', 'required' => false, 'default' => 'true'], + 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => 'The start of the time range for data ingestion, specified as a Unix timestamp (in seconds). Only objects modified at or after this time are ingested.', 'type' => 'integer', 'example' => '1714274081', 'format' => 'int64'], + 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => 'The end of the time range for data ingestion, specified as a Unix timestamp (in seconds). Only objects modified before this time are ingested.', 'type' => 'integer', 'example' => '1714360481', 'format' => 'int64'], + 'timeField' => ['title' => '提取时间字段', 'description' => 'The name of the field in your data that contains the timestamp. This timestamp is used as the event time for the ingested records.', 'type' => 'string', 'example' => '__time__'], + 'timeFormat' => ['title' => '时间字段格式', 'description' => 'The format of the timestamp in the `timeField`, specified using the Java `SimpleDateFormat` pattern. For example: `yyyy-MM-dd\'T\'HH:mm:ss.SSSZ`.', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], + 'timePattern' => ['title' => '提取时间正则', 'description' => 'A regular expression used to extract a timestamp from unstructured data, such as a log entry or filename, if a structured `timeField` is not available.', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], + 'timeZone' => ['title' => '时间字段分区', 'description' => 'The time zone for parsing timestamps that lack explicit time zone information. Specify a valid time zone identifier, such as `UTC` or `America/Los_Angeles`.', 'type' => 'string', 'example' => 'GMT+08:00'], + 'tagPackId' => ['title' => '启动上下文检索', 'description' => 'The ID of a predefined tag pack to apply to the ingested data. Tag packs contain rules for data enrichment and categorization.', 'type' => 'boolean', 'example' => '', 'default' => 'true'], + 'processorId' => ['title' => '写入处理器id', 'description' => 'The unique ID of the processor or pipeline that handles the ingested data.', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + 'accessKeyId' => ['description' => 'The access key ID for authenticating with the GCS service. This parameter is required.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => true], + 'accessKeySecret' => ['description' => 'The secret access key corresponding to the `accessKeyId`. This value is sensitive and must be managed securely.', 'type' => 'string', 'title' => '', 'example' => '', 'required' => true], + 'format' => [ + 'title' => '格式', + 'type' => 'object', 'required' => true, - 'example' => 'test-project', + 'additionalProperties' => ['description' => 'Specifies format-specific properties as key-value pairs. For example, you can set a `delimiter` for CSV files.', 'type' => 'any', 'title' => '', 'example' => ''], + 'description' => 'A nested object that defines the format of the source data, such as CSV, JSON, or Parquet.', + 'example' => '', ], - 'logstore' => [ - 'title' => '目标Logstore名称', - 'description' => 'The name of the destination Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', + 'advancedParameters' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'Specifies additional advanced parameters as key-value pairs.', 'type' => 'any', 'title' => '', 'example' => ''], + 'description' => 'A nested object for specifying advanced configuration options as key-value pairs.', + 'title' => '', + 'example' => '', ], - 'datasets' => [ - 'title' => '写入结果集', - 'description' => 'The result data to write.'."\n", - 'visibility' => 'Public', + ], + 'description' => 'Specifies the configuration for ingesting data from a Google Cloud Storage (GCS) data source.', + 'example' => '', + ], + 'GroupConfiguration' => [ + 'title' => '告警分组评估配置.', + 'description' => 'The configuration for alert group evaluation.', + 'type' => 'object', + 'properties' => [ + 'type' => ['title' => '分组评估类型', 'description' => 'The group evaluation type.', 'type' => 'string', 'required' => true, 'example' => 'custom'], + 'fields' => [ + 'title' => '分组评估字段', + 'description' => 'The group evaluation fields.', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '__UNNAMED__', - 'extendType' => 'true', - 'description' => '', - ], - 'minItems' => 1, - ], - 'roleArn' => [ - 'title' => '授权写入目标Logstore的角色ARN', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role that is used to grant the permissions to write data to the destination Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::13234:role/logtarget', - ], - 'accessKeyId' => [ - 'title' => '授权写入目标Logstore的AccessKey ID', - 'description' => 'The AccessKey ID that is used to grant the permissions to write data to the destination Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - ], - 'accessKeySecret' => [ - 'title' => '授权写入目标Logstore的AccessKey Secret', - 'description' => 'The AccessKey secret that is used to grant the permissions to write data to the destination Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'required' => false, + 'items' => ['type' => 'string', 'example' => 'id', 'description' => '', 'title' => ''], + 'example' => '', ], ], + 'example' => '', ], - 'etlJob' => [ + 'Histogram' => [ 'title' => 'A short description of struct', - 'description' => '数据加工任务数据结构。', + 'description' => 'The data structure of log distribution.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'etlJobName' => [ - 'title' => '任务名称', - 'description' => '数据加工任务名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'etl-name', - ], - 'sourceConfig' => [ - 'title' => '配置数据来源', - 'description' => '配置数据来源。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'logstoreName' => [ - 'title' => 'logstore 名称', - 'description' => 'Logstore名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - ], - 'required' => true, - ], - 'triggerConfig' => [ - 'title' => '触发器配置', - 'description' => '加工任务触发器配置。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'roleArn' => [ - 'title' => '角色授权配置', - 'description' => '角色授权配置，例如角色ARN为`acs:ram::13791******44:role/aliyunlogetlrole`。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::13791******44:role/aliyunlogetlrole', - ], - 'triggerInterval' => [ - 'title' => '触发间隔，单位为秒，必须在 [3,600] 之间', - 'description' => '触发间隔。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '5', - ], - 'maxRetryTime' => [ - 'title' => '最大重试次数，必须在[0,100] 之间', - 'description' => '最大重试次数。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - 'startingPosition' => [ - 'title' => '开始位置，可选 latest、at-unixtime， 默认 latest。', - 'description' => '开始位置。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'at-unixtime', - ], - 'startingUnixtime' => [ - 'title' => '开始时间', - 'description' => '开始时间。当startingPosition为at-unixtime时生效。', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], - ], - 'required' => true, - ], - 'functionConfig' => [ - 'title' => '运行函数配置', - 'description' => '运行函数配置。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'functionProvider' => [ - 'title' => '函数 provider，可选值为 FunctionCompute 、CloudProdLogDispatch。当值为 FunctionCompute 时，endpoint、accountid 、regionName 、serviceName 、functionName 必选。', - 'description' => '函数provider。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'FunctionCompute', - ], - 'endpoint' => [ - 'title' => 'endpoint', - 'description' => '服务入口Endpoint。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou.log.aliyuncs.com', - ], - 'accountId' => [ - 'title' => '账户 id', - 'description' => '阿里云账号ID。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '13791******44', - ], - 'regionName' => [ - 'title' => '地域', - 'description' => '地域。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'serviceName' => [ - 'title' => '服务名', - 'description' => '服务名。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'my-service', - ], - 'functionName' => [ - 'title' => '函数名', - 'description' => '函数名。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'hello-world', - ], - 'roleArn' => [ - 'title' => '角色授权', - 'description' => '角色授权配置，例如角色ARN为`acs:ram::13791******44:role/aliyunlogetlrole`。', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ram::13791******44:role/aliyunlogetlrole', - ], - ], - 'required' => true, - ], - 'functionParameter' => [ - 'title' => '参数列表', - 'description' => '参数列表。', - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => '是否启用。', - 'visibility' => 'Public', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'logConfig' => [ - 'title' => '日志配置', - 'description' => '日志配置。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'endpoint' => [ - 'title' => 'endpoint', - 'description' => '服务入口Endpoint。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou.log.aliyuncs.com', - ], - 'projectName' => [ - 'title' => 'project 名称', - 'description' => 'Project名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - 'logstoreName' => [ - 'title' => 'logstore 名称', - 'description' => 'Logstore名称。', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], - ], - 'required' => true, - ], - ], - ], - 'etlMeta' => [ - 'title' => 'A short description of struct', - 'description' => 'etlMeta数据结构。', - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'etlMetaName' => [ - 'title' => '名字', - 'description' => 'MetaName', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'MetaName', - ], - 'etlMetaKey' => [ - 'title' => 'key', - 'description' => 'MetaKey', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'MetaKey', - ], - 'etlMetaTag' => [ - 'title' => 'tag', - 'description' => 'MetaTag', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MetaTag', - ], - 'enable' => [ - 'title' => '是否启用', - 'description' => 'Enable', - 'visibility' => 'Public', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'etlMetaValue' => [ - 'title' => 'value', - 'description' => 'MetaValue', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MetaValue', - ], - ], - ], - 'externalStore' => [ - 'title' => 'A short description of struct', - 'description' => 'The data structure of the external store.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'externalStoreName' => [ - 'title' => '外部存储的名称。', - 'description' => 'The name of the external store. The name must be unique in a project and must be different from Logstore names.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'rds_store', - ], - 'storeType' => [ - 'title' => '类型。可选 rds-vpc 或者 oss', - 'description' => 'The storage type. Set the value to rds-vpc, which indicates a database on an ApsaraDB RDS for MySQL instance in a virtual private cloud (VPC).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'rds-vpc', - ], - 'parameter' => [ - 'title' => '参数', - 'description' => 'The parameters that are configured for the external store.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - 'example' => '{ "vpc-id": "vpc-bp1aevy8sofi8mh1q****", "instance-id": "i-bp1b6c719dfa08exf****", "host": "192.168.XX.XX", "port": "3306", "username": "root", "password": "sfdsfldsfksfls****", "db": "meta", "table": "join_meta", "region": "cn-qingdao" }', - ], - ], - ], - 'GroupConfiguration' => [ - 'title' => '告警分组评估配置', - 'description' => 'The group evaluation configurations of the alert rule.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'title' => '分组评估类型', - 'description' => 'The type of group evaluation.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'custom', - ], - 'fields' => [ - 'title' => '分组评估字段', - 'description' => 'The fields of group evaluation.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'id', - 'extendType' => 'true', - 'description' => '', - ], - ], - ], - ], - 'Histogram' => [ - 'title' => 'A short description of struct', - 'description' => 'The data structure of log distribution.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'from' => [ - 'title' => '开始', - 'description' => 'The start time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1409529600', - ], - 'to' => [ - 'title' => '结束', - 'description' => 'The end time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1409569200', - ], - 'count' => [ - 'title' => 'count', - 'description' => 'The number of logs that are generated during the subinterval.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'progress' => [ - 'title' => 'progress', - 'description' => 'Indicates whether the query result in the subinterval is complete. Valid values:'."\n" - ."\n" - .'* Complete: The query is successful, and the complete result is returned.'."\n" - .'* Incomplete: The query is successful, but the query result is incomplete. To obtain the complete result, you must repeat the request.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Complete', - ], + 'from' => ['title' => '开始', 'description' => 'The start time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1409529600'], + 'to' => ['title' => '结束', 'description' => 'The end time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1409569200'], + 'count' => ['title' => 'count', 'description' => 'The number of logs that are generated during the subinterval.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'progress' => ['title' => 'progress', 'description' => 'Indicates whether the query result in the subinterval is complete. Valid values:'."\n" + ."\n" + .'* Complete: The query is successful, and the complete result is returned.'."\n" + .'* Incomplete: The query is successful, but the query result is incomplete. To obtain the complete result, you must repeat the request.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Complete'], ], ], 'index' => [ - 'title' => '日志索引', + 'title' => '', 'description' => 'The data structure for the index configuration.', 'type' => 'object', 'properties' => [ - 'max_text_len' => [ - 'title' => '统计字段最大长度', - 'description' => 'The default maximum length of a field value in Simple Log Service is 2,048 bytes (2 KB). To change this limit, set the maximum length for a text field. The value must be between 64 and 16,384 bytes.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', - ], + 'max_text_len' => ['title' => '', 'description' => 'The default maximum length of a field value in Simple Log Service is 2,048 bytes (2 KB). To change this limit, set the maximum length for a text field. The value must be between 64 and 16,384 bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048'], 'log_reduce_white_list' => [ - 'title' => '日志聚类的聚类字段过滤白名单，仅当日志聚类开启时有效', + 'title' => '', 'description' => 'The whitelist of fields for log clustering. This parameter is valid only when log clustering is enabled.', 'type' => 'array', - 'items' => [ - 'description' => 'A field in the whitelist.', - 'type' => 'string', - 'title' => '', - 'example' => 'name', - ], + 'items' => ['description' => 'A field in the whitelist.', 'type' => 'string', 'title' => '', 'example' => 'name'], 'example' => '', ], 'log_reduce_black_list' => [ - 'title' => '日志聚类的聚类字段过滤黑名单，仅当日志聚类开启时有效', + 'title' => '', 'description' => 'The blacklist of fields for log clustering. This parameter is valid only when log clustering is enabled.', 'type' => 'array', - 'items' => [ - 'description' => 'A field in the blacklist.', - 'type' => 'string', - 'title' => '', - 'example' => 'time', - ], + 'items' => ['description' => 'A field in the blacklist.', 'type' => 'string', 'title' => '', 'example' => 'time'], 'example' => '', ], 'line' => [ - 'title' => '全文索引', + 'title' => '', 'description' => 'The full-text index configuration. You must specify either this parameter or the \\`keys\\` parameter.', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'title' => '包含中文', - 'description' => 'Specifies whether the logs contain Chinese characters.'."\n" - ."\n" - .'- true: The logs contain Chinese characters.'."\n" - ."\n" - .'- false (default): The logs do not contain Chinese characters.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'caseSensitive' => [ - 'title' => '大小写敏感', - 'description' => 'Specifies whether the index is case-sensitive.'."\n" - ."\n" - .'- true: The index is case-sensitive.'."\n" - ."\n" - .'- false (default): The index is not case-sensitive.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'chn' => ['title' => '', 'description' => 'Specifies whether the logs contain Chinese characters.'."\n" + ."\n" + .'- true: The logs contain Chinese characters.'."\n" + ."\n" + .'- false (default): The logs do not contain Chinese characters.', 'type' => 'boolean', 'example' => 'false'], + 'caseSensitive' => ['title' => '', 'description' => 'Specifies whether the index is case-sensitive.'."\n" + ."\n" + .'- true: The index is case-sensitive.'."\n" + ."\n" + .'- false (default): The index is not case-sensitive.', 'type' => 'boolean', 'example' => 'true'], 'token' => [ - 'title' => '分词符', + 'title' => '', 'description' => 'The list of delimiters for tokenization. This parameter specifies how the field is tokenized.', 'type' => 'array', - 'items' => [ - 'description' => 'A delimiter. Examples: ",", ".", "'."\r".'", and "'."\n" - .'".', - 'type' => 'string', - 'title' => '', - 'example' => ',', - ], + 'items' => ['description' => 'A delimiter. Examples: ",", ".", "'."\r".'", and "'."\n" + .'".', 'type' => 'string', 'title' => '', 'example' => ','], 'required' => true, 'example' => '', ], 'include_keys' => [ - 'title' => '包含的字段列表，不能与exclude_keys同时指定。', + 'title' => '', 'description' => 'The list of fields to include in the full-text index. This parameter cannot be specified at the same time as \\`exclude\\_keys\\`.', 'type' => 'array', - 'items' => [ - 'description' => 'The fields to include.', - 'type' => 'string', - 'title' => '', - 'example' => 'includeField', - ], + 'items' => ['description' => 'The fields to include.', 'type' => 'string', 'title' => '', 'example' => 'includeField'], 'example' => '', ], 'exclude_keys' => [ - 'title' => '排除的字段列表，不能与include_keys同时指定。', + 'title' => '', 'description' => 'The list of fields to exclude from the full-text index. This parameter cannot be specified at the same time as \\`include\\_keys\\`.', 'type' => 'array', - 'items' => [ - 'description' => 'The fields to exclude.', - 'type' => 'string', - 'title' => '', - 'example' => 'excludeField', - ], + 'items' => ['description' => 'The fields to exclude.', 'type' => 'string', 'title' => '', 'example' => 'excludeField'], 'example' => '', ], ], 'example' => '', ], 'keys' => [ - 'title' => '字段索引', + 'title' => '', 'description' => 'The field index configuration. The key is the field name and the value is the index configuration for the field. You must specify either this parameter or the \\`line\\` parameter.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The field index configuration. The key is the field name and the value is the index configuration for the field.', - '$ref' => '#/components/schemas/IndexKey', - 'title' => '', - 'example' => '', - ], + 'additionalProperties' => ['description' => 'The field index configuration. The key is the field name and the value is the index configuration for the field.', '$ref' => '#/components/schemas/IndexKey', 'title' => '', 'example' => ''], 'example' => '', ], - 'log_reduce' => [ - 'title' => '是否开启日志聚类', - 'description' => 'Specifies whether to enable log clustering. If enabled, either the whitelist or the blacklist can be active, but not both.'."\n" - ."\n" - .'- true: Enable log clustering.'."\n" - ."\n" - .'- false (default): Do not enable log clustering.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'scan_index' => [ - 'title' => '是否开启扫描索引', - 'description' => 'Specifies whether to enable the scan index.', - 'type' => 'boolean', - 'default' => 'false', - 'example' => 'false', - ], + 'log_reduce' => ['title' => '', 'description' => 'Specifies whether to enable log clustering. If enabled, either the whitelist or the blacklist can be active, but not both.'."\n" + ."\n" + .'- true: Enable log clustering.'."\n" + ."\n" + .'- false (default): Do not enable log clustering.', 'type' => 'boolean', 'example' => 'true'], + 'scan_index' => ['title' => '', 'description' => 'Specifies whether to enable the scan index.', 'type' => 'boolean', 'default' => 'false', 'example' => 'false'], ], 'example' => '', ], 'IndexJsonKey' => [ 'title' => 'index of json type', - 'description' => 'The index key of the JSON type.'."\n", - 'visibility' => 'Public', + 'description' => 'The index configuration for a key within a JSON field.', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'title' => '是否包含中文', - 'description' => 'Whether the field contains Chinese characters.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'caseSensitive' => [ - 'title' => '大小写敏感', - 'description' => 'Case sensitivity.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], + 'chn' => ['title' => '是否包含中文', 'description' => 'Specifies whether to enable Chinese tokenization for the field.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], + 'caseSensitive' => ['title' => '大小写敏感', 'description' => 'Specifies whether queries on this field are case-sensitive.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], 'token' => [ 'title' => '分词符', - 'description' => 'Delimiter.'."\n", - 'visibility' => 'Public', + 'description' => 'The delimiters used for tokenization.', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '|', - 'extendType' => 'true', - 'description' => '', - ], - ], - 'alias' => [ - 'title' => '别名', - 'description' => 'Alias.'."\n", + 'items' => ['description' => 'A delimiter.', 'type' => 'string', 'example' => '|', 'title' => '', 'visibility' => 'Public', 'extendType' => 'true'], + 'example' => '', 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'myAlias', - ], - 'type' => [ - 'title' => '字段类型', - 'description' => 'The data type of the field.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'text', - ], - 'doc_value' => [ - 'title' => '开启统计', - 'description' => 'Whether to enable statistics.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', ], + 'alias' => ['title' => '别名', 'description' => 'The alias of the field.', 'type' => 'string', 'example' => 'myAlias', 'visibility' => 'Public'], + 'type' => ['title' => '字段类型', 'description' => 'Specifies the field type.', 'type' => 'string', 'required' => true, 'example' => 'text', 'visibility' => 'Public'], + 'doc_value' => ['title' => '开启统计', 'description' => 'Specifies whether to enable doc\\_value for the field. This enables sorting, aggregation, and statistical analysis on the field.', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public'], ], + 'example' => '', + 'visibility' => 'Public', ], 'IndexKey' => [ 'title' => 'A short description of struct', 'description' => 'The index key.', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'title' => '是否包含中文', - 'description' => 'Specifies whether the field contains Chinese characters.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'caseSensitive' => [ - 'title' => '大小写敏感', - 'description' => 'Specifies whether the field is case-sensitive.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'alias' => [ - 'title' => '别名', - 'description' => 'The alias of the field.', - 'type' => 'string', - 'example' => 'myAlias', - ], - 'type' => [ - 'title' => '字段类型', - 'description' => 'The type of the field.', - 'type' => 'string', - 'required' => true, - 'example' => 'text', - ], - 'doc_value' => [ - 'title' => '开启统计', - 'description' => 'Specifies whether to enable statistics for the field.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'index_all' => [ - 'title' => '是否对Json内所有文本字段自动索引', - 'description' => 'Specifies whether to automatically create an index for all text fields in the JSON object.', - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'max_depth' => [ - 'title' => '最大深度', - 'description' => 'The maximum depth.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '', - ], - 'embedding' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'vector_index' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'chn' => ['title' => '是否包含中文', 'description' => 'Specifies whether the field contains Chinese characters.', 'type' => 'boolean', 'example' => 'true'], + 'caseSensitive' => ['title' => '大小写敏感', 'description' => 'Specifies whether the field is case-sensitive.', 'type' => 'boolean', 'example' => 'true'], + 'alias' => ['title' => '别名', 'description' => 'The alias of the field.', 'type' => 'string', 'example' => 'myAlias'], + 'type' => ['title' => '字段类型', 'description' => 'The type of the field.', 'type' => 'string', 'required' => true, 'example' => 'text'], + 'doc_value' => ['title' => '开启统计', 'description' => 'Specifies whether to enable statistics for the field.', 'type' => 'boolean', 'example' => 'true'], + 'index_all' => ['title' => '是否对Json内所有文本字段自动索引', 'description' => 'Specifies whether to automatically create an index for all text fields in the JSON object.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true'], + 'max_depth' => ['title' => '最大深度', 'description' => 'The maximum depth.', 'type' => 'integer', 'format' => 'int64', 'example' => ''], + 'embedding' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'vector_index' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'token' => [ 'title' => '分词符', 'description' => 'The delimiters used for tokenization.', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => '|', - 'description' => '', - 'title' => '', - ], + 'items' => ['type' => 'string', 'example' => '|', 'description' => '', 'title' => ''], 'example' => '', ], 'json_keys' => [ 'title' => 'json key', 'description' => 'The JSON key.', 'type' => 'object', - 'additionalProperties' => [ - '$ref' => '#/components/schemas/IndexJsonKey', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'additionalProperties' => ['$ref' => '#/components/schemas/IndexJsonKey', 'description' => '', 'title' => '', 'example' => ''], 'example' => '', ], ], @@ -2645,94 +1026,25 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => '集合操作类型', - 'description' => 'The type of the set operation.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'left_join', - ], - 'condition' => [ - 'title' => '集合操作条件', - 'description' => 'The condition of the set operation.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '$0.id == $1.id', - ], + 'type' => ['title' => '集合操作类型', 'description' => 'The type of the set operation.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'left_join'], + 'condition' => ['title' => '集合操作条件', 'description' => 'The condition of the set operation.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '$0.id == $1.id'], ], ], 'KafkaIngestion' => [ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '导入任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-kafka-123456', - 'description' => '', - ], - 'description' => [ - 'title' => 'job description', - 'type' => 'string', - 'example' => 'kafka ingestion', - 'description' => '', - ], - 'displayName' => [ - 'title' => 'job displayName', - 'type' => 'string', - 'required' => true, - 'example' => 'kafka ingestion', - 'description' => '', - ], - 'schedule' => [ - 'title' => '调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - 'description' => '', - 'example' => '', - ], - 'configuration' => [ - 'title' => 'kafka导入配置', - 'required' => true, - '$ref' => '#/components/schemas/KafkaIngestionConfiguration', - 'description' => '', - 'example' => '', - ], - 'createTime' => [ - 'title' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - 'description' => '', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - 'description' => '', - ], - 'status' => [ - 'title' => '导入状态', - 'type' => 'string', - 'example' => 'RUNNING', - 'description' => '', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'type' => 'string', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - 'description' => '', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - 'description' => '', - ], - ], - 'description' => '', + 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'example' => 'ingest-kafka-123456', 'description' => ''], + 'description' => ['title' => 'job description', 'type' => 'string', 'example' => 'kafka ingestion', 'description' => ''], + 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'example' => 'kafka ingestion', 'description' => ''], + 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'description' => '', 'example' => ''], + 'configuration' => ['title' => 'kafka导入配置', 'required' => true, '$ref' => '#/components/schemas/KafkaIngestionConfiguration', 'description' => '', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481', 'description' => ''], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481', 'description' => ''], + 'status' => ['title' => '导入状态', 'type' => 'string', 'example' => 'RUNNING', 'description' => ''], + 'scheduleId' => ['title' => '任务ID', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010', 'description' => ''], + ], + 'description' => 'A short description of struct ', 'example' => '', ], 'KafkaIngestionConfiguration' => [ @@ -2740,171 +1052,67 @@ 'description' => 'The configuration of the Kafka data import source.', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'type' => 'string', - 'required' => true, - 'example' => 'logstore', - 'description' => '', - ], - 'source' => [ - 'required' => true, - '$ref' => '#/components/schemas/KafkaIngestionConfigurationSource', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'logstore' => ['title' => 'logstore', 'type' => 'string', 'required' => true, 'example' => 'logstore', 'description' => ''], + 'source' => ['required' => true, '$ref' => '#/components/schemas/KafkaIngestionConfigurationSource', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'KafkaIngestionConfigurationSource' => [ 'title' => 'A short description of struct', - 'description' => 'The configuration of the Kafka import source.', + 'description' => 'Kafka ingestion source configuration.', 'type' => 'object', 'properties' => [ - 'bootstrapServers' => [ - 'title' => '服务地址', - 'type' => 'string', - 'required' => true, - 'example' => '192.168.1.28:9092', - 'description' => '', - ], - 'topics' => [ - 'title' => 'Topic列表', - 'type' => 'string', - 'required' => true, - 'example' => 'topic1,topic2', - 'description' => '', - ], - 'fromPosition' => [ - 'title' => '起始位置', - 'type' => 'string', - 'required' => true, - 'example' => 'earliest,latest', - 'description' => '', - ], - 'consumerGroup' => [ - 'title' => '消费组', - 'type' => 'string', - 'example' => 'consumer', - 'description' => '', - ], - 'valueType' => [ - 'title' => '数据格式', - 'type' => 'string', - 'required' => true, - 'example' => 'text,json', - 'description' => '', - ], - 'encoding' => [ - 'title' => '编码格式', - 'type' => 'string', - 'required' => true, - 'example' => 'UTF-8', - 'description' => '', - ], - 'parseArray' => [ - 'title' => '解析数组元素', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'description' => '', - ], - 'vpcId' => [ - 'title' => 'vpcId', - 'type' => 'string', - 'required' => false, - 'description' => '', + 'topics' => ['title' => 'Topic列表', 'description' => 'The Kafka topics to subscribe to. Separate multiple topics with a comma (`,`).', 'type' => 'string', 'example' => 'topic1,topic2', 'required' => true], + 'fromPosition' => ['title' => '起始位置', 'description' => 'The starting position for data consumption. Valid values: `earliest` and `latest`.', 'type' => 'string', 'example' => 'earliest,latest', 'required' => true], + 'consumerGroup' => ['title' => '消费组', 'description' => 'The ID of the Kafka consumer group.', 'type' => 'string', 'example' => 'consumer'], + 'valueType' => ['title' => '数据格式', 'description' => 'The format of the message value. Valid values: `text` and `json`.', 'type' => 'string', 'example' => 'text,json', 'required' => true], + 'encoding' => ['title' => '编码格式', 'description' => 'The character encoding of the message. This parameter applies only when `valueType` is `text`.', 'type' => 'string', 'example' => 'UTF-8', 'required' => true], + 'parseArray' => ['title' => '解析数组元素', 'description' => 'Specifies whether to parse a message as a JSON array. If `true`, each element in the array becomes a separate log entry. This parameter applies only when `valueType` is `json`.', 'type' => 'boolean', 'example' => 'true', 'required' => true], + 'vpcId' => ['title' => 'vpcId', 'description' => 'The ID of the VPC that contains the Kafka cluster.', 'type' => 'string', 'example' => '', 'required' => false], + 'timeField' => ['title' => '时间字段', 'description' => 'The field that contains the log timestamp. This parameter applies only when `valueType` is `json`.', 'type' => 'string', 'example' => '__time__'], + 'timePattern' => ['title' => '提取时间正则', 'description' => 'The regular expression for extracting the timestamp from the field specified by `timeField`.', 'type' => 'string', 'example' => '\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}'], + 'timeFormat' => ['title' => '时间字段格式', 'description' => 'The format of the timestamp. For example, you can set this to `epoch` for a Unix timestamp.', 'type' => 'string', 'example' => 'epoch'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone of the timestamp, such as `+0800`.', 'type' => 'string', 'example' => '+0800'], + 'defaultTimeSource' => ['title' => '默认时间来源', 'description' => 'The default time source to use if timestamp extraction from the log data fails. Valid values are `system` (the time of the ingestion server) and `kafka` (the timestamp from the Kafka message).', 'type' => 'string', 'example' => 'system,kafka'], + 'enableSlsContext' => ['title' => '日志上下文', 'description' => 'Specifies whether to add Simple Log Service (SLS) context fields, such as `__topic__` and `__partition__`, to each log entry.', 'type' => 'boolean', 'example' => 'true'], + 'nameResolutions' => ['title' => '私网域名解析', 'description' => 'Custom DNS resolutions in JSON format. Use this parameter to map hostnames to IP addresses.', 'type' => 'string', 'example' => '{"hostname": "192.168.1.28"}'], + 'communication' => ['title' => '通信协议', 'description' => 'The authentication and communication protocol settings in JSON format. For example, you can use this parameter to configure SASL authentication.', 'type' => 'string', 'example' => '{ "protocol":"SASL_PLAINTEXT", "sasl":{ "mechanism":"PLAIN", "username":"用户名", "password":"密码" } }'], + 'processorId' => ['title' => '写入处理器ID', 'description' => 'The ID of the ingestion processor.', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + 'enableVpcNat' => ['title' => '是否使用vpc-nat', 'description' => 'Specifies whether to enable NAT for VPC connections. Set this to `true` if your Kafka cluster is in a VPC and requires NAT for access.', 'type' => 'boolean', 'example' => ''], + 'securityGroups' => ['title' => '安全组', 'description' => 'The ID of the security group to associate with the ingestion source. This parameter is required when connecting to a Kafka cluster in a VPC. Separate multiple IDs with a comma (`,`).', 'type' => 'string', 'example' => ''], + 'vswitchId' => ['title' => 'Vswitch Id', 'description' => 'The ID of the VSwitch in the specified VPC. This parameter is required when connecting to a Kafka cluster in a VPC.', 'type' => 'string', 'example' => ''], + 'bootstrapServers' => ['title' => '服务地址', 'description' => 'A list of bootstrap servers for the Kafka cluster, formatted as `host1:port1,host2:port2`.', 'type' => 'string', 'example' => '192.168.1.28:9092', 'required' => true], + 'format' => [ + 'title' => '格式', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Additional format-specific properties. The supported properties depend on the `valueType`.', 'type' => 'any', 'title' => '', 'example' => ''], + 'description' => 'The data format configuration.', 'example' => '', ], - 'timeField' => [ - 'title' => '时间字段', - 'type' => 'string', - 'example' => '__time__', - 'description' => '', - ], - 'timePattern' => [ - 'title' => '提取时间正则', - 'type' => 'string', - 'example' => '\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}', - 'description' => '', - ], - 'timeFormat' => [ - 'title' => '时间字段格式', - 'type' => 'string', - 'example' => 'epoch', - 'description' => '', - ], - 'timeZone' => [ - 'title' => '时区', - 'type' => 'string', - 'example' => '+0800', - 'description' => '', - ], - 'defaultTimeSource' => [ - 'title' => '默认时间来源', - 'type' => 'string', - 'example' => 'system,kafka', - 'description' => '', - ], - 'enableSlsContext' => [ - 'title' => '日志上下文', - 'type' => 'boolean', - 'example' => 'true', - 'description' => '', - ], - 'nameResolutions' => [ - 'title' => '私网域名解析', - 'type' => 'string', - 'example' => '{"hostname": "192.168.1.28"}', - 'description' => '', - ], - 'communication' => [ - 'title' => '通信协议', - 'type' => 'string', - 'example' => '{ "protocol":"SASL_PLAINTEXT", "sasl":{ "mechanism":"PLAIN", "username":"用户名", "password":"密码" } }', - 'description' => '', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - 'description' => '', - ], ], 'example' => '', ], 'ListAgentInstanceConfigs' => [ + 'description' => 'List of process-level configurations ', 'title' => '进程级配置列表', 'type' => 'array', 'items' => [ + 'description' => 'Process-level configuration ', 'type' => 'object', 'properties' => [ - 'configType' => [ - 'title' => '进程级配置类型', - 'type' => 'string', - 'description' => '', - 'example' => 'apm_biz_trace', - ], + 'configType' => ['description' => 'Type of the process-level configuration ', 'title' => '进程级配置类型', 'type' => 'string', 'example' => 'apm_biz_trace'], 'attributes' => [ + 'description' => 'Ownership of the process-level configuration ', + 'additionalProperties' => ['description' => 'Ownership of the process-level configuration ', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"', 'title' => ''], 'title' => '进程级配置归属', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - 'title' => '', - ], - 'description' => '', 'example' => '{"workspace": "test-workspace","service": "test-service"}', ], ], - 'description' => '', 'title' => '', 'example' => '', ], - 'description' => '', 'example' => '', ], 'LogContent' => [ @@ -2913,22 +1121,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '自定义Key名称。', - 'description' => 'The name of the custom key.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'key-test', - ], - 'Value' => [ - 'title' => '自定义Key对应的值。', - 'description' => 'The value of the custom key.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'value-test', - ], + 'Key' => ['title' => '自定义Key名称。', 'description' => 'The name of the custom key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'key-test'], + 'Value' => ['title' => '自定义Key对应的值。', 'description' => 'The value of the custom key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'value-test'], ], ], 'logging' => [ @@ -2937,14 +1131,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'loggingProject' => [ - 'title' => 'project 名称。', - 'description' => 'The name of the project to which service logs are stored.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'loggingProject' => ['title' => 'project 名称。', 'description' => 'The name of the project to which service logs are stored.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-project'], 'loggingDetails' => [ 'title' => 'logging 配置项', 'description' => 'The settings of the service log feature.'."\n", @@ -2971,25 +1158,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' => 'The logstore name.'."\n", - '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' => 'The logstore name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], ], 'extendType' => 'true', ], @@ -3002,29 +1173,13 @@ 'description' => 'Log group', 'type' => 'object', 'properties' => [ - 'Topic' => [ - 'title' => '日志主题，用户自定义字段，用于区分不同特征的日志数据。', - 'description' => 'The topic of the log. This is a user-defined field that distinguishes log data with different features.', - 'type' => 'string', - 'required' => false, - 'example' => 'topic-test', - ], - 'Source' => [ - 'title' => '日志的来源。例如产生该日志的机器的IP地址。', - 'description' => 'The source of the log. For example, the IP address of the machine that generated the log.', - 'type' => 'string', - 'example' => '192.1.1.1', - ], + 'Topic' => ['title' => '日志主题，用户自定义字段，用于区分不同特征的日志数据。', 'description' => 'The topic of the log. This is a user-defined field that distinguishes log data with different features.', 'type' => 'string', 'required' => false, 'example' => 'topic-test'], + 'Source' => ['title' => '日志的来源。例如产生该日志的机器的IP地址。', 'description' => 'The source of the log. For example, the IP address of the machine that generated the log.', 'type' => 'string', 'example' => '192.1.1.1'], 'LogTags' => [ 'title' => '日志的标签列表', 'description' => 'The list of tags for the log.', 'type' => 'array', - 'items' => [ - 'description' => 'A tag for the log.', - '$ref' => '#/components/schemas/LogTag', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'A tag for the log.', '$ref' => '#/components/schemas/LogTag', 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], @@ -3032,12 +1187,7 @@ 'title' => '日志列表', 'description' => 'A list of logs.', 'type' => 'array', - 'items' => [ - 'description' => 'A log.', - '$ref' => '#/components/schemas/LogItem', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'A log.', '$ref' => '#/components/schemas/LogItem', 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], @@ -3052,12 +1202,7 @@ 'LogGroupList' => [ 'title' => 'logGroup 列表', 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/LogGroup', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'items' => ['$ref' => '#/components/schemas/LogGroup', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, 'description' => '', 'example' => '', @@ -3068,369 +1213,137 @@ ], 'LogItem' => [ 'title' => '日志', - 'description' => 'The log.'."\n", - 'visibility' => 'Public', + 'description' => 'A log entry.', 'type' => 'object', 'properties' => [ - 'Time' => [ - 'title' => '日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => 'The log time. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1690254376', - ], + 'Time' => ['title' => '日志时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => 'The time of the log, formatted as a Unix timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1690254376'], 'Contents' => [ 'title' => '日志字段列表。', - 'description' => 'The log fields.'."\n", - 'visibility' => 'Public', + 'description' => 'A list of log fields.', 'type' => 'array', - 'items' => [ - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/LogContent', - 'description' => '', - ], + 'items' => ['$ref' => '#/components/schemas/LogContent', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, + 'example' => '', ], ], + 'example' => '', ], 'logstore' => [ + 'title' => '', + 'description' => 'The Logstore data structure.', + 'type' => 'object', + 'properties' => [ + 'logstoreName' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'my-logstore'], + 'ttl' => ['description' => 'The data retention period in days. Valid values: 1 to 3,650. A value of 3,650 indicates permanent storage.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'required' => true, 'example' => '1'], + 'shardCount' => ['description' => 'The number of shards in the Logstore.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'required' => true, 'example' => '2'], + 'enable_tracking' => ['description' => 'Specifies whether to enable WebTracking. The default value is false.'."\n" + ."\n" + .'- true: Enables WebTracking.'."\n" + ."\n" + .'- false: Disables WebTracking.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'autoSplit' => ['description' => 'Specifies whether to enable auto split.'."\n" + ."\n" + .'- true: Enables auto split.'."\n" + ."\n" + .'- false: Disables auto split.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'maxSplitShard' => ['description' => 'The maximum number of shards that an auto split can create. Valid values: 1 to 64.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '6'], + 'appendMeta' => ['description' => 'Specifies whether to include the client\'s public IP address in the log data. The default is false.'."\n" + ."\n" + .'- true: Records the public IP address.'."\n" + ."\n" + .'- false: Does not record the public IP address.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'telemetryType' => ['description' => 'The type of log data. Valid values:'."\n" + ."\n" + .'- Metrics: The Logstore is optimized for time-series storage.'."\n" + ."\n" + .'- None: The Logstore uses standard storage for logs.', 'type' => 'string', 'title' => '', 'example' => 'Metrics'], + 'createTime' => ['description' => 'The creation time of the Logstore, specified as a UNIX timestamp (the number of seconds since January 1, 1970, 00:00:00 UTC).', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '1453949705'], + 'lastModifyTime' => ['description' => 'The time the Logstore was last modified, specified as a UNIX timestamp (the number of seconds since January 1, 1970, 00:00:00 UTC).', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '1524155379'], + 'encrypt_conf' => ['description' => 'The data encryption configuration.', 'title' => '', '$ref' => '#/components/schemas/EncryptConf', 'example' => ''], + 'hot_ttl' => ['description' => 'The number of days to retain data in the hot storage tier. The minimum value is 30.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '60'], + 'infrequentAccessTTL' => ['description' => 'The number of days to retain data in the infrequent access storage tier.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '30'], + 'mode' => ['description' => 'Log Service provides two types of Logstores: Standard and Query.'."\n" + ."\n" + .'- **Standard**: Supports the full suite of Log Service data analysis features. This mode is ideal for real-time monitoring, interactive analysis, and building complete observability solutions.'."\n" + ."\n" + .'- **Query**: Optimized for high-performance queries with indexing traffic costs that are approximately half those of the Standard mode. This mode does not support SQL analysis and is best for use cases involving large data volumes and long retention periods, where complex log analysis is not a requirement.', 'type' => 'string', 'title' => '', 'example' => 'standard'], + 'productType' => ['description' => 'The product type of the logs.', 'type' => 'string', 'title' => '', 'example' => 'aliyun'], + 'processorId' => ['description' => 'The IngestProcessor ID.', 'type' => 'string', 'title' => '', 'example' => ''], + 'shardingPolicy' => ['title' => '', '$ref' => '#/components/schemas/ShardingPolicy', 'description' => '', 'example' => ''], + 'resourceGroupId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''], + 'enableModify' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + 'LogTag' => [ + 'title' => '日志标签', + 'description' => 'The log tag.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '自定义Key名称。', 'description' => 'The name of the custom key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'key-test'], + 'Value' => ['title' => '自定义Key对应的值。', 'description' => 'The value of the custom key.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'value-test'], + ], + ], + 'LogtailConfig' => [ 'title' => 'A short description of struct', - 'description' => 'The data structure of a Logstore.', + 'description' => 'The data structure of the Logtail configuration.'."\n", + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'logstoreName' => [ - 'title' => 'logstore 的名称。', - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - 'ttl' => [ - 'title' => '数据保存的天数。', - 'description' => 'The data retention period in days. The valid range is 1 to 3650. A value of 3650 indicates permanent retention.', - 'type' => 'integer', - 'format' => 'int32', + 'configName' => ['title' => 'logtail 配置的名称。', 'description' => 'The name of the Logtail configuration. The name must be unique in the project to which the Logtail configuration belongs. After the Logtail configuration is created, you cannot change the name of the Logtail configuration. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + .'* The name must start and end with a lowercase letter or a digit.'."\n" + .'* The name must be 2 to 128 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-config'], + 'logSample' => ['title' => '日志样例，可以用于自动生成正则捕获字段。', 'description' => 'The sample log.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], + 'inputType' => ['title' => 'logtail 读取日志的输入类型。', 'description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* **plugin**: Logs such as MySQL binary logs are collected by using Logtail plug-ins.'."\n" + .'* **file**: Logs from text files are collected by using existing modes, including the full regex mode and delimiter mode.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'file'], + 'inputDetail' => ['title' => 'logtail 输入的详细配置。', 'description' => 'The detailed settings of the data source. For more information, see [inputDetail](~~29058~~).'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'example' => '"logType": "common_reg_log", "logPath": "/var/log/httpd/", "filePattern": "access*.log", "localStorage": true, "timeFormat": "%Y/%m/%d %H:%M:%S", "logBeginRegex": ".*", "regex": "(\\w+)(\\s+)", "key" :["key1", "key2"], "filterKey":["key1"], "filterRegex":["regex1"], "fileEncoding":"utf8", "topicFormat": "none"'], + 'outputType' => ['title' => 'logtail 输出的目标类型。这里固定选择 LogService。', 'description' => 'The type of the data destination. Set the value to LogService. Collected logs can be uploaded to only Simple Log Service.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'LogService'], + 'outputDetail' => [ + 'title' => 'logtail 输出的详细配置。', + 'description' => 'The detailed settings of the data destination. For more information, see [outputDetail](~~29058~~).'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'endpoint' => ['title' => '日志项目的 endpoint。', 'description' => 'The endpoint. For more information, see [Endpoints](~~29008~~).'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com'], + 'logstoreName' => ['title' => '输出的目标 logstore 名称。', 'description' => 'The name of the Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'region' => ['title' => '地域。', 'description' => 'The ID of the region.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'telemetryType' => ['title' => '目标 Logstore 的可观测数据类型。', 'description' => 'The type of observable data in the Logstore.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'logs'], + ], 'required' => true, - 'example' => '1', ], - 'shardCount' => [ - 'title' => 'shard 数量。', - 'description' => 'The number of shards.', - 'type' => 'integer', - 'format' => 'int32', + 'createTime' => ['title' => '创建时间，unix 时间戳。', 'description' => 'The time at which the Logtail configuration was created. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], + 'lastModifyTime' => ['title' => '最后一次修改时间，unix 时间戳。', 'description' => 'The time at which the Logtail configuration was last modified. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], + ], + ], + 'LogtailPipelineConfig' => [ + 'title' => 'Logtail流水线配置', + 'description' => 'The Logtail pipeline configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'configName' => ['title' => '配置名称', 'description' => 'The name of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z_-]{0,126}[0-9a-zA-Z]$'], + 'logSample' => ['title' => '日志样例', 'description' => 'The sample log.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '127.0.0.1 - - [10/Jun/2022:12:36:49 +0800] "GET /index.html HTTP/1.1" 200'], + 'global' => ['title' => '全局信息', 'description' => 'The global configuration.'."\n", 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "TopicType": "custom", "TopicFormat": "aaa", "EnableAlwaysOnline": true, "EnableTimestampNanosecond": true, "UsingOldContentTag": true }'], + 'inputs' => [ + 'title' => '输入插件', + 'description' => 'The data source plug-ins.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => ['description' => 'The data source plug-in.'."\n", 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "input_file", "FilePaths": [ "/home/**/*.log" ], "MaxDirSearchDepth": 10, "Multiline": { "StartPattern": "\\\\d+" }, "TailSizeKB": 1024 }', 'extendType' => 'true'], 'required' => true, - 'example' => '2', - ], - 'enable_tracking' => [ - 'title' => 'WebTracking功能支持快速采集各种浏览器以及iOS/Android/APP访问信息，默认关闭', - 'description' => 'Specifies whether to enable web tracking. The default value is false.'."\n" - ."\n" - .'- true: Enables web tracking.'."\n" - ."\n" - .'- false: Disables web tracking.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'autoSplit' => [ - 'title' => '是否开启 shard 自动分裂。当写入数据量超过已有分区（Shard）写入服务能力且持续5分钟以上时，开启自动分裂功能可自动根据数据量增加分区数量', - 'description' => 'Specifies whether to automatically split shards.'."\n" - ."\n" - .'- true: Automatically splits shards.'."\n" - ."\n" - .'- false: Does not automatically split shards.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'maxSplitShard' => [ - 'title' => '最大 shard 数量。', - 'description' => 'The maximum number of shards for an automatic split. The minimum value is 1 and the maximum value is 64.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'appendMeta' => [ - 'title' => '接收日志后，自动添加客户端外网IP和日志到达时间', - 'description' => 'Specifies whether to record public IP addresses. The default value is false.'."\n" - ."\n" - .'- true: Records public IP addresses.'."\n" - ."\n" - .'- false: Does not record public IP addresses.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'telemetryType' => [ - 'title' => 'telemetryType', - 'description' => 'The log type to query. Valid values:'."\n" - ."\n" - .'- Metrics: time series storage.'."\n" - ."\n" - .'- None: non-time series storage.', - 'type' => 'string', - 'example' => 'Metrics', - ], - 'createTime' => [ - 'title' => '创建时间。', - 'description' => 'The time when the Logstore was created. The value is a UNIX timestamp that represents the number of seconds since 00:00:00 UTC on January 1, 1970.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1453949705', - ], - 'lastModifyTime' => [ - 'title' => '最后修改时间。', - 'description' => 'The time when the Logstore was last updated. The value is a UNIX timestamp that represents the number of seconds since 00:00:00 UTC on January 1, 1970.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1524155379', - ], - 'encrypt_conf' => [ - 'title' => '加密配置', - 'description' => 'The data encryption configuration.', - '$ref' => '#/components/schemas/EncryptConf', - 'example' => '', - ], - 'hot_ttl' => [ - 'title' => '必须在 (30, ttl) 之间', - 'description' => 'The retention period of data in the hot tier of the Logstore, in days. The minimum value is 30.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'infrequentAccessTTL' => [ - 'title' => '低频存储时间', - 'description' => 'The retention period for the IA storage class.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'mode' => [ - 'title' => '[ standard | query ]', - 'description' => 'Simple Log Service provides two types of Logstores: Standard and Query.'."\n" - ."\n" - .'- **standard**: Supports the one-stop data analytics feature of Simple Log Service. This type is suitable for scenarios such as real-time monitoring, interactive analysis, and building complete observability systems.'."\n" - ."\n" - .'- **query**: Supports high-performance queries. The index traffic cost is about half that of the Standard type. However, this type does not support SQL analysis. It is suitable for scenarios with large data volumes, long storage periods such as weeks or months, and no log analysis requirements.', - 'type' => 'string', - 'example' => 'standard', - ], - 'productType' => [ - 'title' => '日志所属产品类型', - 'description' => 'The product type to which the logs belong.', - 'type' => 'string', - 'example' => 'aliyun', - ], - 'processorId' => [ - 'title' => 'IngestProcessor ID', - 'description' => 'The IngestProcessor ID.', - 'type' => 'string', - 'example' => '', - ], - 'shardingPolicy' => [ - 'title' => '哈希写入配置', - '$ref' => '#/components/schemas/ShardingPolicy', - 'description' => '', - 'example' => '', - ], - 'resourceGroupId' => [ - 'title' => '资源组', - 'type' => 'string', - 'description' => '', - 'example' => '', - ], - ], - 'example' => '', - ], - 'LogTag' => [ - 'title' => '日志标签', - 'description' => 'The log tag.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '自定义Key名称。', - 'description' => 'The name of the custom key.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'key-test', - ], - 'Value' => [ - 'title' => '自定义Key对应的值。', - 'description' => 'The value of the custom key.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'value-test', - ], - ], - ], - 'LogtailConfig' => [ - 'title' => 'A short description of struct', - 'description' => 'The data structure of the Logtail configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'configName' => [ - 'title' => 'logtail 配置的名称。', - 'description' => 'The name of the Logtail configuration. The name must be unique in the project to which the Logtail configuration belongs. After the Logtail configuration is created, you cannot change the name of the Logtail configuration. The name must meet the following requirements:'."\n" - ."\n" - .'* The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - .'* The name must start and end with a lowercase letter or a digit.'."\n" - .'* The name must be 2 to 128 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - ], - 'logSample' => [ - 'title' => '日志样例，可以用于自动生成正则捕获字段。', - 'description' => 'The sample log.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world', - ], - 'inputType' => [ - 'title' => 'logtail 读取日志的输入类型。', - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* **plugin**: Logs such as MySQL binary logs are collected by using Logtail plug-ins.'."\n" - .'* **file**: Logs from text files are collected by using existing modes, including the full regex mode and delimiter mode.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'file', - ], - 'inputDetail' => [ - 'title' => 'logtail 输入的详细配置。', - 'description' => 'The detailed settings of the data source. For more information, see [inputDetail](~~29058~~).'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - 'example' => '"logType": "common_reg_log", "logPath": "/var/log/httpd/", "filePattern": "access*.log", "localStorage": true, "timeFormat": "%Y/%m/%d %H:%M:%S", "logBeginRegex": ".*", "regex": "(\\w+)(\\s+)", "key" :["key1", "key2"], "filterKey":["key1"], "filterRegex":["regex1"], "fileEncoding":"utf8", "topicFormat": "none"', - ], - 'outputType' => [ - 'title' => 'logtail 输出的目标类型。这里固定选择 LogService。', - 'description' => 'The type of the data destination. Set the value to LogService. Collected logs can be uploaded to only Simple Log Service.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'LogService', - ], - 'outputDetail' => [ - 'title' => 'logtail 输出的详细配置。', - 'description' => 'The detailed settings of the data destination. For more information, see [outputDetail](~~29058~~).'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'endpoint' => [ - 'title' => '日志项目的 endpoint。', - 'description' => 'The endpoint. For more information, see [Endpoints](~~29008~~).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com', - ], - 'logstoreName' => [ - 'title' => '输出的目标 logstore 名称。', - 'description' => 'The name of the Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'region' => [ - 'title' => '地域。', - 'description' => 'The ID of the region.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'telemetryType' => [ - 'title' => '目标 Logstore 的可观测数据类型。', - 'description' => 'The type of observable data in the Logstore.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'logs', - ], - ], - 'required' => true, - ], - 'createTime' => [ - 'title' => '创建时间，unix 时间戳。', - 'description' => 'The time at which the Logtail configuration was created. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], - 'lastModifyTime' => [ - 'title' => '最后一次修改时间，unix 时间戳。', - 'description' => 'The time at which the Logtail configuration was last modified. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], - ], - ], - 'LogtailPipelineConfig' => [ - 'title' => 'Logtail流水线配置', - 'description' => 'The Logtail pipeline configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'properties' => [ - 'configName' => [ - 'title' => '配置名称', - 'description' => 'The name of the configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z_-]{0,126}[0-9a-zA-Z]$', - ], - 'logSample' => [ - 'title' => '日志样例', - 'description' => 'The sample log.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '127.0.0.1 - - [10/Jun/2022:12:36:49 +0800] "GET /index.html HTTP/1.1" 200', - ], - 'global' => [ - 'title' => '全局信息', - 'description' => 'The global configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "TopicType": "custom", "TopicFormat": "aaa", "EnableAlwaysOnline": true, "EnableTimestampNanosecond": true, "UsingOldContentTag": true }', - ], - 'inputs' => [ - 'title' => '输入插件', - 'description' => 'The data source plug-ins.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'The data source plug-in.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "Type": "input_file", "FilePaths": [ "/home/**/*.log" ], "MaxDirSearchDepth": 10, "Multiline": { "StartPattern": "\\\\d+" }, "TailSizeKB": 1024 }', - 'extendType' => 'true', - ], - 'required' => true, - 'minItems' => 1, + 'minItems' => 1, ], 'processors' => [ 'title' => '处理插件', 'description' => 'The processing plug-ins.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The processing plug-in.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "Type": "processor_regex", "SourceKey": "content", "Regex": "(\\\\d+).*([^;])", "Keys": [ "k1", "k2" ] }', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The processing plug-in.'."\n", 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "processor_regex", "SourceKey": "content", "Regex": "(\\\\d+).*([^;])", "Keys": [ "k1", "k2" ] }', 'extendType' => 'true'], 'minItems' => 1, ], 'aggregators' => [ @@ -3438,13 +1351,7 @@ 'description' => 'The aggregation plug-ins.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The aggregation plug-in.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'extendType' => 'true', - 'example' => '{ "Type": "aggregator_shardhash", "SourceKeys": [ "__source__" ] }', - ], + 'items' => ['description' => 'The aggregation plug-in.'."\n", 'visibility' => 'Public', 'type' => 'object', 'extendType' => 'true', 'example' => '{ "Type": "aggregator_shardhash", "SourceKeys": [ "__source__" ] }'], 'minItems' => 1, ], 'flushers' => [ @@ -3452,88 +1359,28 @@ 'description' => 'The data output plug-ins.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The data output plug-in.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{ "Type": "flusher_sls", "Logstore": "test_logstore", "Endpoint": "cn-hangzhou-intranet.aliyuncs.com", "Region": "cn-hangzhou", "FlowControlExpireTime": 2, "MaxSendRate": 3, "EnableShardHash": true, "TelemetryType": "log" }', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The data output plug-in.'."\n", 'visibility' => 'Public', 'type' => 'object', 'example' => '{ "Type": "flusher_sls", "Logstore": "test_logstore", "Endpoint": "cn-hangzhou-intranet.aliyuncs.com", "Region": "cn-hangzhou", "FlowControlExpireTime": 2, "MaxSendRate": 3, "EnableShardHash": true, "TelemetryType": "log" }', 'extendType' => 'true'], 'required' => true, 'minItems' => 1, ], - 'createTime' => [ - 'title' => '创建时间，UNIX时间戳', - 'description' => 'The creation time. The value is a UNIX timestamp.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], - 'lastModifyTime' => [ - 'title' => '最后修改时间，UNIX时间戳', - 'description' => 'The last modification time. The value is a UNIX timestamp.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1655176807', - ], - 'task' => [ - 'title' => '任务配置', - 'description' => '任务配置', - 'visibility' => 'Public', - 'type' => 'object', - 'example' => '{"Type": "task_example"}', - ], + 'createTime' => ['title' => '创建时间，UNIX时间戳', 'description' => 'The creation time. The value is a UNIX timestamp.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], + 'lastModifyTime' => ['title' => '最后修改时间，UNIX时间戳', 'description' => 'The last modification time. The value is a UNIX timestamp.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1655176807'], + 'task' => ['title' => '任务配置', 'description' => '任务配置', 'visibility' => 'Public', 'type' => 'object', 'example' => '{"Type": "task_example"}'], ], ], 'machine' => [ 'title' => 'A short description of struct', 'description' => 'The data structure of a machine.', - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ip' => [ - 'title' => '机器 ip 地址。', - 'description' => 'The IP address of the machine.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.x', - ], - 'machine-uniqueid' => [ - 'title' => '机器的唯一标识。', - 'description' => 'The unique identifier of the machine.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '3B70F4F1-80F7-46C4-A6C1-100****EE647', - ], - 'lastHeartbeatTime' => [ - 'title' => '最后一次心跳时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => 'The time of the last heartbeat. The value is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1447182247', - ], - 'userdefined-id' => [ - 'title' => '机器的用户自定义标识。', - 'description' => 'The custom identifier of the machine. This parameter is valid only when the identity type of the machine group is set to custom.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '无', - ], - 'host-id' => [ - 'title' => '机器的主机id。', - 'description' => 'The host ID of the machine.', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test', - ], + 'ip' => ['title' => '机器 ip 地址。', 'description' => 'The IP address of the machine.', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.x', 'visibility' => 'Public'], + 'machine-uniqueid' => ['title' => '机器的唯一标识。', 'description' => 'The unique identifier of the machine.', 'type' => 'string', 'required' => false, 'example' => '3B70F4F1-80F7-46C4-A6C1-100****EE647', 'visibility' => 'Public'], + 'lastHeartbeatTime' => ['title' => '最后一次心跳时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => 'The time of the last heartbeat. The value is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1447182247', 'visibility' => 'Public'], + 'userdefined-id' => ['title' => '机器的用户自定义标识。', 'description' => 'The custom identifier of the machine. This parameter is valid only when the identity type of the machine group is set to custom.', 'type' => 'string', 'example' => '无', 'visibility' => 'Public'], + 'host-id' => ['title' => '机器的主机id。', 'description' => 'The host ID of the machine.', 'type' => 'string', 'example' => 'test', 'visibility' => 'Public'], ], 'example' => '', + 'visibility' => 'Public', ], 'machineGroup' => [ 'title' => '机器组结构定义。', @@ -3541,56 +1388,21 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'title' => '机器组名称。', - 'description' => 'The name of the machine group.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'machineGroup-test', - ], - 'groupType' => [ - 'title' => '机器组种类。目前固定为空字符串。', - 'description' => 'The type of the machine group. This parameter is currently an empty string.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '“”', - ], - 'machineIdentifyType' => [ - 'title' => '机器组标识种类，支持 IP 标识或者用户自定义标识，即 ip 、userdefined 、 host-id。', - 'description' => 'The machine identity type.'."\n" - ."\n" - .'- ip: The machine group is identified by IP addresses.'."\n" - ."\n" - .'- userdefined: The machine group is identified by custom identifiers.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ip', - ], + 'groupName' => ['title' => '机器组名称。', 'description' => 'The name of the machine group.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'machineGroup-test'], + 'groupType' => ['title' => '机器组种类。目前固定为空字符串。', 'description' => 'The type of the machine group. This parameter is currently an empty string.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '“”'], + 'machineIdentifyType' => ['title' => '机器组标识种类，支持 IP 标识或者用户自定义标识，即 ip 、userdefined 、 host-id。', 'description' => 'The machine identity type.'."\n" + ."\n" + .'- ip: The machine group is identified by IP addresses.'."\n" + ."\n" + .'- userdefined: The machine group is identified by custom identifiers.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'ip'], 'groupAttribute' => [ 'title' => '机器组属性。', 'description' => 'The properties of the machine group.', 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'groupTopic' => [ - 'title' => '机器组的日志主题。', - 'description' => 'The topic of the machine group.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'testtopic', - ], - 'externalName' => [ - 'title' => '机器组所依赖的外部管理系统标识。', - 'description' => 'The identifier of the external management system that the machine group depends on.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup', - ], + 'groupTopic' => ['title' => '机器组的日志主题。', 'description' => 'The topic of the machine group.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'testtopic'], + 'externalName' => ['title' => '机器组所依赖的外部管理系统标识。', 'description' => 'The identifier of the external management system that the machine group depends on.', 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'testgroup'], ], 'example' => '', ], @@ -3599,14 +1411,7 @@ 'description' => 'The list of machines.', 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The IP address or custom ID of the machine.', - 'visibility' => 'Public', - 'type' => 'string', - 'extendType' => 'true', - 'title' => '', - 'example' => '47.100.XX.XX', - ], + 'items' => ['description' => 'The IP address or custom ID of the machine.', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'title' => '', 'example' => '47.100.XX.XX'], 'required' => true, 'example' => '', ], @@ -3619,258 +1424,77 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '任务名称', - 'description' => 'job name'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxComputeExport', - ], - 'description' => [ - 'title' => '任务描述', - 'description' => 'job description'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MaxComputeExport', - ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => 'job displayName'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'MaxComputeExport', - ], - 'configuration' => [ - 'title' => 'MaxCompute投递配置', - 'description' => 'The setting of the MaxCompute data shipping job.'."\n", - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/MaxComputeExportConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718787534'."\n", - ], - 'lastModifiedTime' => [ - 'title' => '修改时间', - 'description' => 'The last modification time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1718787681'."\n", - ], - 'status' => [ - 'title' => 'MaxCompute投递任务状态', - 'description' => 'The status of the MaxCompute data shipping job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'description' => 'The ID of the MaxCompute data shipping job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - ], + 'name' => ['title' => '任务名称', 'description' => 'job name'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'MaxComputeExport'], + 'description' => ['title' => '任务描述', 'description' => 'job description'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'MaxComputeExport'], + 'displayName' => ['title' => '显示名称', 'description' => 'job displayName'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'MaxComputeExport'], + 'configuration' => ['title' => 'MaxCompute投递配置', 'description' => 'The setting of the MaxCompute data shipping job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1718787534'."\n"], + 'lastModifiedTime' => ['title' => '修改时间', 'description' => 'The last modification time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1718787681'."\n"], + 'status' => ['title' => 'MaxCompute投递任务状态', 'description' => 'The status of the MaxCompute data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => 'The ID of the MaxCompute data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], ], 'MaxComputeExportConfiguration' => [ 'title' => 'MaxCompute投递配置', 'description' => 'The configurations of the MaxCompute data shipping job.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'Logstore名称', - 'description' => 'The name of the Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - 'roleArn' => [ - 'title' => '角色roleArn', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that is used to read data from Simple Log Service.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'."\n", - ], - 'sink' => [ - 'title' => '投递配MaxCompute置', - 'description' => 'The configuration of the MaxCompute data shipping job.'."\n", - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/MaxComputeExportConfigurationSink', - ], - 'fromTime' => [ - 'title' => '开始时间', - 'description' => 'The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1718380800'."\n", - ], - 'toTime' => [ - 'title' => '结束时间', - 'description' => 'The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1718390800', - ], + 'logstore' => ['title' => 'Logstore名称', 'description' => 'The name of the Logstore.'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], + 'roleArn' => ['title' => '角色roleArn', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that is used to read data from Simple Log Service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'."\n"], + 'sink' => ['title' => '投递配MaxCompute置', 'description' => 'The configuration of the MaxCompute data shipping job.'."\n", 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfigurationSink', 'example' => ''], + 'fromTime' => ['title' => '开始时间', 'description' => 'The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1718380800'."\n"], + 'toTime' => ['title' => '结束时间', 'description' => 'The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1718390800'], ], + 'example' => '', ], 'MaxComputeExportConfigurationSink' => [ 'title' => 'MaxCompute投递配置', 'description' => 'The MaxCompute data shipping job.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'odpsEndpoint' => [ - 'title' => 'MaxCompute Endpoint', - 'description' => 'The endpoint of MaxCompute.'."\n" - ."\n" - .'* ⚠️Note: The endpoint of MaxCompute must be the same as that of the Simple Log Service project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api', - ], - 'odpsTunnelEndpoint' => [ - 'title' => 'Tunnel Endpoint', - 'description' => 'The Tunnel endpoint of MaxCompute.'."\n" - ."\n" - .'* ⚠️Note: The Tunnel endpoint of MaxCompute must be the same as that of the Simple Log Service project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com', - ], - 'odpsProject' => [ - 'title' => 'MaxCompute项目名', - 'description' => 'The name of the MaxCompute project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'demo_project', - ], - 'odpsTable' => [ - 'title' => 'MaxCompute表名', - 'description' => 'The name of the MaxCompute table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'demo_table', - ], - 'odpsRolearn' => [ - 'title' => '写MaxCompute ram角色', - 'description' => 'The Resource Access Management (RAM) role the data shipping job assumes to write data to MaxCompute.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::xxxxxxx', - ], - 'odpsAccessKeyId' => [ - 'title' => '写数据ak id', - 'description' => 'The AccessKey ID used to write data to MaxCompute.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'example' => 'axxxxxxxxxxxb', - ], - 'odpsAccessSecret' => [ - 'title' => '写数据ak secret', - 'description' => 'The AccessKey secret used to write data to MaxCompute.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'deprecated' => true, - 'example' => 'aaxxxxxxxxxxxxxxxxxxxxxbb', - ], - 'partitionTimeFormat' => [ - 'title' => '时间分区格式', - 'description' => 'The time partition format.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '%Y_%m_%d', - ], - 'timeZone' => [ - 'title' => '时区', - 'description' => 'The time zone.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '+0800', - ], - 'fields' => [ - 'title' => 'MaxCompute普通列', - 'description' => 'The fields that you want to ship.'."\n", - 'visibility' => 'Public', - 'type' => 'array', - 'items' => [ - 'description' => 'The Simple Log Service log field.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '\'f1\'', - 'extendType' => 'true', - ], + 'odpsEndpoint' => ['title' => 'MaxCompute Endpoint', 'description' => 'The endpoint of MaxCompute.'."\n" + ."\n" + .'* ⚠️Note: The endpoint of MaxCompute must be the same as that of the Simple Log Service project.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api'], + 'odpsTunnelEndpoint' => ['title' => 'Tunnel Endpoint', 'description' => 'The Tunnel endpoint of MaxCompute.'."\n" + ."\n" + .'* ⚠️Note: The Tunnel endpoint of MaxCompute must be the same as that of the Simple Log Service project.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com'], + 'odpsProject' => ['title' => 'MaxCompute项目名', 'description' => 'The name of the MaxCompute project.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo_project'], + 'odpsTable' => ['title' => 'MaxCompute表名', 'description' => 'The name of the MaxCompute table.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo_table'], + 'odpsRolearn' => ['title' => '写MaxCompute ram角色', 'description' => 'The Resource Access Management (RAM) role the data shipping job assumes to write data to MaxCompute.'."\n", 'type' => 'string', 'required' => true, 'example' => 'acs:ram::xxxxxxx'], + 'odpsAccessKeyId' => ['title' => '写数据ak id', 'description' => 'The AccessKey ID used to write data to MaxCompute.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'axxxxxxxxxxxb'], + 'odpsAccessSecret' => ['title' => '写数据ak secret', 'description' => 'The AccessKey secret used to write data to MaxCompute.'."\n", 'type' => 'string', 'deprecated' => true, 'example' => 'aaxxxxxxxxxxxxxxxxxxxxxbb'], + 'partitionTimeFormat' => ['title' => '时间分区格式', 'description' => 'The time partition format.'."\n", 'type' => 'string', 'required' => true, 'example' => '%Y_%m_%d'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone.'."\n", 'type' => 'string', 'required' => true, 'example' => '+0800'], + 'fields' => [ + 'title' => 'MaxCompute普通列', + 'description' => 'The fields that you want to ship.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The Simple Log Service log field.'."\n", 'type' => 'string', 'example' => '\'f1\'', 'title' => ''], 'required' => true, + 'example' => '', ], 'partitionColumn' => [ 'title' => 'MaxCompute分区列', 'description' => 'The partition key columns that you want to ship.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The Simple Log Service log field or reserved field. The reserved field \\__partition_time\\_\\_ is used as a partition key column.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '\'p1\'', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The Simple Log Service log field or reserved field. The reserved field \\__partition_time\\_\\_ is used as a partition key column.'."\n", 'type' => 'string', 'example' => '\'p1\'', 'title' => ''], 'required' => true, + 'example' => '', ], - 'filterInvalid' => [ - 'title' => '过滤无效内容', - 'description' => 'Specifies whether to filter the invalid content.'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'timeFormatType' => [ - 'title' => '分区时间类型', - 'description' => 'The time partition type. Valid values:'."\n" - ."\n" - .'* StrfTimeFormat (default)'."\n" - .'* JavaSimpleDateFormat'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'StrfTimeFormat', - ], - 'bufferInterval' => [ - 'title' => '计算投递时间分区时的最小时间粒度', - 'description' => 'Specifies the minimum time granularity between two data shipping jobs. Unit: seconds. Valid values:'."\n" - ."\n" - .'* 1800 (default)'."\n" - .'* 3600'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1800', - ], + 'filterInvalid' => ['title' => '过滤无效内容', 'description' => 'Specifies whether to filter the invalid content.'."\n" + ."\n" + .'* true (default)'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'timeFormatType' => ['title' => '分区时间类型', 'description' => 'The time partition type. Valid values:'."\n" + ."\n" + .'* StrfTimeFormat (default)'."\n" + .'* JavaSimpleDateFormat'."\n", 'type' => 'string', 'example' => 'StrfTimeFormat'], + 'bufferInterval' => ['title' => '计算投递时间分区时的最小时间粒度', 'description' => 'Specifies the minimum time granularity between two data shipping jobs. Unit: seconds. Valid values:'."\n" + ."\n" + .'* 1800 (default)'."\n" + .'* 3600'."\n", 'type' => 'string', 'example' => '1800'], ], + 'example' => '', ], 'MLDataParam' => [ 'title' => 'A short description of struct', @@ -3878,57 +1502,17 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'annotationdataId' => [ - 'title' => '数据的唯一标识', - 'description' => 'The unique identifier of the data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dc74b0f569126bb310e1ba6454c351ac', - 'backendName' => 'annotationdataId', - ], - 'dataHash' => [ - 'title' => '数据内容的hash值', - 'description' => 'The hash value of the data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '59db060bd89468245d76416a68a510ac', - 'backendName' => 'dataHash', - ], - 'datasetId' => [ - 'title' => '关联的数据集的id', - 'description' => 'The ID of the associated dataset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - 'backendName' => 'datasetId', - ], - 'value' => [ - 'title' => '数据来源', - 'description' => 'The data source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xxx/xxx/xxx/', - 'backendName' => 'value', - ], - 'valueType' => [ - 'title' => '数据来源格式', - 'description' => 'The type of the data source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss', - 'backendName' => 'valueType', - ], + 'annotationdataId' => ['title' => '数据的唯一标识', 'description' => 'The unique identifier of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'dc74b0f569126bb310e1ba6454c351ac', 'backendName' => 'annotationdataId'], + 'dataHash' => ['title' => '数据内容的hash值', 'description' => 'The hash value of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '59db060bd89468245d76416a68a510ac', 'backendName' => 'dataHash'], + 'datasetId' => ['title' => '关联的数据集的id', 'description' => 'The ID of the associated dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'backendName' => 'datasetId'], + 'value' => ['title' => '数据来源', 'description' => 'The data source.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxx/xxx/xxx/', 'backendName' => 'value'], + 'valueType' => ['title' => '数据来源格式', 'description' => 'The type of the data source.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss', 'backendName' => 'valueType'], 'config' => [ 'title' => '数据的配置信息', 'description' => 'The configurations of the data.'."\n", 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The configuration of the data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'simulator-nginx-demo', - ], + 'additionalProperties' => ['description' => 'The configuration of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'simulator-nginx-demo'], 'backendName' => 'config', ], 'annotations' => [ @@ -3941,23 +1525,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'annotatedBy' => [ - 'title' => '标注人', - 'description' => 'The Alibaba Cloud account ID of the annotator.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xxxx', - 'backendName' => 'annotatedBy', - ], - 'updateTime' => [ - 'title' => '更新的时间', - 'description' => 'The update time. The value is a UNIX timestamp.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1694761550', - 'backendName' => 'updateTime', - ], + 'annotatedBy' => ['title' => '标注人', 'description' => 'The Alibaba Cloud account ID of the annotator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxxx', 'backendName' => 'annotatedBy'], + 'updateTime' => ['title' => '更新的时间', 'description' => 'The update time. The value is a UNIX timestamp.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1694761550', 'backendName' => 'updateTime'], 'results' => [ 'title' => '标注的结果', 'description' => 'The annotation results.'."\n", @@ -3967,12 +1536,7 @@ 'description' => 'The annotation result.'."\n", 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The annotation result.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPIKE_UP_TYPE', - ], + 'additionalProperties' => ['description' => 'The annotation result.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SPIKE_UP_TYPE'], 'extendType' => 'true', ], 'backendName' => 'results', @@ -3991,23 +1555,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'annotatedBy' => [ - 'title' => '标注人', - 'description' => 'The annotator.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'xxx', - 'backendName' => 'annotatedBy', - ], - 'updateTime' => [ - 'title' => '更新的时间', - 'description' => 'The update time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1694761550', - 'backendName' => 'updateTime', - ], + 'annotatedBy' => ['title' => '标注人', 'description' => 'The annotator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'xxx', 'backendName' => 'annotatedBy'], + 'updateTime' => ['title' => '更新的时间', 'description' => 'The update time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1694761550', 'backendName' => 'updateTime'], 'results' => [ 'title' => '模型预览结果', 'description' => 'The results.'."\n", @@ -4017,12 +1566,7 @@ 'description' => 'The model preview result.'."\n", 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The model preview result.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SPIKE_UP_TYPE', - ], + 'additionalProperties' => ['description' => 'The model preview result.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SPIKE_UP_TYPE'], 'extendType' => 'true', ], 'backendName' => 'results', @@ -4031,22 +1575,8 @@ ], 'backendName' => 'predictions', ], - 'createTime' => [ - 'title' => '创建的时间', - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695094335', - ], - 'lastModifyTime' => [ - 'title' => '最后一次修改的时间', - 'description' => 'The last modification time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695094335', - ], + 'createTime' => ['title' => '创建的时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695094335'], + 'lastModifyTime' => ['title' => '最后一次修改的时间', 'description' => 'The last modification time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695094335'], ], ], 'MLDataSetParam' => [ @@ -4055,71 +1585,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'datasetId' => [ - 'title' => '数据集的唯一标识', - 'description' => 'The unique identifier of the dataset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'd9bd488f6dd42d294495fb780858e83d', - ], - 'name' => [ - 'title' => '数据集的名称', - 'description' => 'The name of the dataset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sls_builtin_dataset_metric.shapeclassification.anomalydetection', - ], - 'description' => [ - 'title' => '数据集的描述', - 'description' => 'The description of the dataset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '数据集A', - ], - 'dataType' => [ - 'title' => '数据类型', - 'description' => 'The type of the data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Metric', - ], - 'labelId' => [ - 'title' => '数据集对应的标签系统id', - 'description' => 'The ID of the tag system that corresponds to the dataset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'a191ae4ca615b0ccb93c211fc8a998af', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], - 'lastModifyTime' => [ - 'title' => '最终修改时间', - 'description' => 'The last modification time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], - 'createBy' => [ - 'title' => '创建的对象', - 'description' => 'The creator.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sls-console', - ], - 'settingType' => [ - 'title' => 'label表配置类型', - 'description' => 'The configuration type of the tag table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Metric.ShapeClassification.AnomalyDetection', - ], + 'datasetId' => ['title' => '数据集的唯一标识', 'description' => 'The unique identifier of the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'd9bd488f6dd42d294495fb780858e83d'], + 'name' => ['title' => '数据集的名称', 'description' => 'The name of the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls_builtin_dataset_metric.shapeclassification.anomalydetection'], + 'description' => ['title' => '数据集的描述', 'description' => 'The description of the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '数据集A'], + 'dataType' => ['title' => '数据类型', 'description' => 'The type of the data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Metric'], + 'labelId' => ['title' => '数据集对应的标签系统id', 'description' => 'The ID of the tag system that corresponds to the dataset.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'a191ae4ca615b0ccb93c211fc8a998af'], + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], + 'lastModifyTime' => ['title' => '最终修改时间', 'description' => 'The last modification time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], + 'createBy' => ['title' => '创建的对象', 'description' => 'The creator.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls-console'], + 'settingType' => ['title' => 'label表配置类型', 'description' => 'The configuration type of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Metric.ShapeClassification.AnomalyDetection'], ], ], 'MLLabelParam' => [ @@ -4128,38 +1602,10 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'labelId' => [ - 'title' => '标签表的唯一标识', - 'description' => 'The unique identifier of the tag table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'abbd488f6dd42d294495fb780858e83d', - ], - 'name' => [ - 'title' => '标签表的名称', - 'description' => 'The name of the tag table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '标签表', - ], - 'description' => [ - 'title' => '标签表的描述信息', - 'description' => 'The description of the tag table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '默认表', - ], - 'type' => [ - 'title' => '标签表的类型', - 'description' => 'The type of the tag table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'xxx', - ], + 'labelId' => ['title' => '标签表的唯一标识', 'description' => 'The unique identifier of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'abbd488f6dd42d294495fb780858e83d'], + 'name' => ['title' => '标签表的名称', 'description' => 'The name of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '标签表'], + 'description' => ['title' => '标签表的描述信息', 'description' => 'The description of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => '默认表'], + 'type' => ['title' => '标签表的类型', 'description' => 'The type of the tag table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'settings' => [ 'title' => '标签表的配置', 'description' => 'The configurations of the tag tables.'."\n", @@ -4170,54 +1616,16 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'mode' => [ - 'title' => '配置的模式', - 'description' => 'The mode of the configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'builtin', - ], - 'type' => [ - 'title' => '配置的任务类型', - 'description' => 'The task type of the configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Trace.RCA', - ], - 'config' => [ - 'title' => '配置的具体信息', - 'description' => 'The details of the configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - ], - 'version' => [ - 'title' => '配置的版本号', - 'description' => 'The version number of the configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.01', - ], + 'mode' => ['title' => '配置的模式', 'description' => 'The mode of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'builtin'], + 'type' => ['title' => '配置的任务类型', 'description' => 'The task type of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Trace.RCA'], + 'config' => ['title' => '配置的具体信息', 'description' => 'The details of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '""'], + 'version' => ['title' => '配置的版本号', 'description' => 'The version number of the configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0.01'], ], 'extendType' => 'true', ], ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], - 'lastModifyTime' => [ - 'title' => '最后修改时间', - 'description' => 'The last modification time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - ], + 'createTime' => ['title' => '创建时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], + 'lastModifyTime' => ['title' => '最后修改时间', 'description' => 'The last modification time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1695090077'], ], 'required' => false, ], @@ -4232,12 +1640,7 @@ 'description' => 'The parameter.'."\n", 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The parameter.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'parameter', - ], + 'additionalProperties' => ['description' => 'The parameter.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'parameter'], ], 'input' => [ 'title' => 'input', @@ -4248,12 +1651,7 @@ 'description' => 'The input data.'."\n", 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The input data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'data', - ], + 'additionalProperties' => ['description' => 'The input data.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'data'], 'extendType' => 'true', ], ], @@ -4263,53 +1661,17 @@ 'title' => 'A short description of struct', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '微服务名称', - 'type' => 'string', - 'example' => 'service_name', - 'description' => '', - ], - 'description' => [ - 'title' => '微服务描述', - 'type' => 'string', - 'example' => '某某服务', - 'description' => '', - ], - 'serviceType' => [ - 'title' => '微服务类型', - 'type' => 'string', - 'example' => 'sls_builtin', - 'description' => '', - ], - 'status' => [ - 'title' => '微服务状态', - 'type' => 'string', - 'example' => 'running', - 'description' => '', - ], - 'updateTimestamp' => [ - 'title' => '微服务更新时间', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1695090077', - 'description' => '', - ], + 'name' => ['title' => '微服务名称', 'type' => 'string', 'description' => '', 'example' => 'service_name'], + 'description' => ['title' => '微服务描述', 'type' => 'string', 'description' => '', 'example' => '某某服务'], + 'serviceType' => ['title' => '微服务类型', 'type' => 'string', 'description' => '', 'example' => 'sls_builtin'], + 'status' => ['title' => '微服务状态', 'type' => 'string', 'description' => '', 'example' => 'running'], + 'updateTimestamp' => ['title' => '微服务更新时间', 'type' => 'integer', 'description' => '', 'example' => '1695090077', 'format' => 'int64'], 'model' => [ 'title' => '微服务依赖的模型配置', 'type' => 'object', 'properties' => [ - 'modelResourceId' => [ - 'title' => '模型资源ID', - 'type' => 'string', - 'example' => 'xxxx', - 'description' => '', - ], - 'modelResourceType' => [ - 'title' => '模型资源类型', - 'type' => 'string', - 'example' => 'xxx_type', - 'description' => '', - ], + 'modelResourceId' => ['title' => '模型资源ID', 'type' => 'string', 'description' => '', 'example' => 'xxxx'], + 'modelResourceType' => ['title' => '模型资源类型', 'type' => 'string', 'description' => '', 'example' => 'xxx_type'], ], 'description' => '', 'example' => '', @@ -4318,40 +1680,16 @@ 'title' => '微服务资源配置', 'type' => 'object', 'properties' => [ - 'cpuLimit' => [ - 'title' => '所需要CPU资源上限', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'description' => '', - ], - 'memoryLimit' => [ - 'title' => '所需要内存资源上限', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - 'description' => '', - ], - 'replica' => [ - 'title' => '微服务的副本数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'description' => '', - ], - 'gpu' => [ - 'title' => '需要的GPU显存大小', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'description' => '', - ], + 'cpuLimit' => ['title' => '所需要CPU资源上限', 'type' => 'integer', 'description' => '', 'example' => '2', 'format' => 'int32'], + 'memoryLimit' => ['title' => '所需要内存资源上限', 'type' => 'integer', 'description' => '', 'example' => '64', 'format' => 'int32'], + 'replica' => ['title' => '微服务的副本数', 'type' => 'integer', 'description' => '', 'example' => '2', 'format' => 'int32'], + 'gpu' => ['title' => '需要的GPU显存大小', 'type' => 'integer', 'description' => '', 'example' => '20', 'format' => 'int32'], ], 'description' => '', 'example' => '', ], ], - 'description' => '', + 'description' => 'A short description of struct ', 'example' => '', ], 'OSSExport' => [ @@ -4360,372 +1698,211 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '任务名称', - 'description' => 'The name of the OSS data shipping job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'myossexportjob', - ], - 'description' => [ - 'title' => '任务描述', - 'description' => 'The description of the OSS data shipping job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a oss export', - ], - 'displayName' => [ - 'title' => '显示名称', - 'description' => 'The display name of the OSS data shipping job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a oss export', - ], - 'configuration' => [ - 'title' => 'OSS投递配置', - 'description' => 'The OSS export configuration.'."\n", - 'visibility' => 'Public', - 'required' => false, - '$ref' => '#/components/schemas/OSSExportConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the OSS data shipping job was created.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456789', - ], - 'lastModifiedTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the OSS data shipping job was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456789', - ], - 'status' => [ - 'title' => 'OSS投递任务状态', - 'description' => 'The status of the OSS data shipping job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'description' => 'The ID of the OSS data shipping job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - ], + 'name' => ['title' => '任务名称', 'description' => 'The name of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'myossexportjob'], + 'description' => ['title' => '任务描述', 'description' => 'The description of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'This is a oss export'], + 'displayName' => ['title' => '显示名称', 'description' => 'The display name of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'This is a oss export'], + 'configuration' => ['title' => 'OSS投递配置', 'description' => 'The OSS export configuration.'."\n", 'visibility' => 'Public', 'required' => false, '$ref' => '#/components/schemas/OSSExportConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the OSS data shipping job was created.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789'], + 'lastModifiedTime' => ['title' => '修改时间', 'description' => 'The time when the OSS data shipping job was last modified.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456789'], + 'status' => ['title' => 'OSS投递任务状态', 'description' => 'The status of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => 'The ID of the OSS data shipping job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], 'required' => true, ], 'OSSExportConfiguration' => [ 'title' => 'OSS投递配置', - 'description' => 'OSSExportConfiguration'."\n", - 'visibility' => 'Public', + 'description' => 'The configuration for exporting data to Object Storage Service (OSS).', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'Logstore名称', - 'description' => 'The name of the Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'logstore-demo', - ], - 'roleArn' => [ - 'title' => '角色roleArn', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that is used to read data from Simple Log Service.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::123456789:role/aliyunlogdefaultrole', - ], + 'logstore' => ['title' => 'Logstore名称', 'description' => 'The name of the source Logstore.', 'type' => 'string', 'required' => false, 'example' => 'my-logstore'], + 'roleArn' => ['title' => '角色roleArn', 'description' => 'The ARN of the Resource Access Management (RAM) role that Log Service assumes to read data from the Logstore. You must specify the ARN of your role.', 'type' => 'string', 'required' => false, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'], 'sink' => [ 'title' => '投递OSS配置', - 'description' => 'The configurations of the OSS data shipping job.'."\n", - 'visibility' => 'Public', + 'description' => 'The configuration of the destination OSS sink.', 'type' => 'object', 'properties' => [ - 'endpoint' => [ - 'title' => 'OSS Endpoint', - 'description' => '* The endpoint that is used to access OSS. You can specify only an internal OSS endpoint for the region where the Simple Log Service project resides. The value is in the `http://+OSS endpoint` format. For more information, see [OSS regions and endpoints](~~31837~~).'."\n" - .'* The endpoint that is used to access OSS-HDFS. You can specify only an internal OSS-HDFS endpoint for the region where the Simple Log Service project resides.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'http://xxxxxxxx', - ], - 'bucket' => [ - 'title' => 'OSS Bucket', - 'description' => 'The OSS bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-bucket', - ], - 'prefix' => [ - 'title' => '文件前缀', - 'description' => 'The prefix of the OSS object.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'prefixxxx/', - ], - 'suffix' => [ - 'title' => '文件后缀', - 'description' => 'The suffix of the OSS object.'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'endpoint' => ['title' => 'OSS Endpoint', 'description' => '- For Object Storage Service (OSS): The OSS internal endpoint. You must use an endpoint in the same region as the Logstore. For more information, see [OSS access domains and data centers](~~31837~~). The endpoint must use the HTTPS protocol.'."\n" + ."\n" + .'- For OSS-HDFS: The OSS-HDFS internal endpoint. You must use an endpoint in the same region as the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'https://oss-cn-hangzhou-internal.aliyuncs.com'], + 'bucket' => ['title' => 'OSS Bucket', 'description' => 'The name of the destination OSS bucket.', 'type' => 'string', 'required' => true, 'example' => 'my-bucket'], + 'prefix' => ['title' => '文件前缀', 'description' => 'The prefix for files exported to the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'prefix-demo/'], + 'suffix' => ['title' => '文件后缀', 'description' => 'The suffix for the exported files.', 'type' => 'string', 'required' => false, 'example' => '.json'], + 'roleArn' => ['title' => '写角色roleArn', 'description' => 'The ARN of the RAM role that Log Service assumes to write data to the OSS bucket. You must specify the ARN of your role.', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::1234567890:role/aliyunlogdefaultrole'], + 'pathFormat' => ['title' => '分区格式', 'description' => 'The path format for exported files. For more information, see [Path format](~~371934~~).', 'type' => 'string', 'required' => true, 'example' => '%Y/%m/%d/%H/%M'], + 'pathFormatType' => ['title' => '分区格式类型', 'description' => 'The type of the path format.', 'type' => 'string', 'required' => true, 'example' => 'time'], + 'timeZone' => ['title' => '时区', 'description' => 'The time zone used for the path format. For more information, see [Time zones](~~375323~~).', 'type' => 'string', 'required' => false, 'example' => '+0800'], + 'contentType' => ['title' => '存储格式', 'description' => 'The format of the files stored in OSS. Valid values: `json`, `parquet`, `csv`, and `orc`.', 'type' => 'string', 'required' => false, 'example' => 'csv'], + 'contentDetail' => [ + 'title' => '内容详情', + 'description' => 'Format-specific settings. The structure of this JSON object depends on the `contentType` value.', + 'type' => 'object', 'required' => false, - 'example' => '.json', - ], - 'roleArn' => [ - 'title' => '写角色roleArn', - 'description' => 'The ARN of the RAM role that is used to write data to OSS.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::xxxxxxx', - ], - 'pathFormat' => [ - 'title' => '分区格式', - 'description' => 'The partition format. For more information, see [Partition formats](~~371934~~).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '%Y_%m_%d/good/bad', - ], - 'pathFormatType' => [ - 'title' => '分区格式类型', - 'description' => 'The partition format type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'only support time', - ], - 'timeZone' => [ - 'title' => '时区', - 'description' => 'The time zone. For more information, see [Time zones](~~375323~~).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '+0800', - ], - 'contentType' => [ - 'title' => '存储格式', - 'description' => 'The storage format of the OSS object. Valid values: json, parquet, csv, and orc.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'json/parquet/csv/orc', - ], - 'contentDetail' => [ - 'title' => '内容详情', - 'description' => 'The details of the OSS object. Note: The value of this parameter is in the JSON format and varies based on the value of contentType.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'description' => 'If the value of contentType is json, specify contentDetail based on the following descriptions:'."\n" - ."\n" - .'* If tag fields can be shipped, set enableTag to true. Example: {"enableTag": true}.'."\n" - .'* If tag fields cannot be shipped, set enableTag to false. Example: {"enableTag": false}.'."\n" - ."\n" - .'If the value of contentType is csv, specify contentDetail based on the following descriptions:'."\n" - ."\n" - .'* columns specifies the keys of fields in logs of the source Logstore. Example: \\["bucket", "bucket_location", "cdn_in", "cdn_out"].'."\n" - .'* delimiter specifies the delimiters that are used. Valid values: ,, |, \\t, and space.'."\n" - .'* header specifies whether to retain the headers of the OSS object. Valid values: true and false.'."\n" - .'* lineFeed specifies the line feeds that are used. Valid values: \\t, \\n, and space.'."\n" - .'* null specifies the data that is shipped when the specified field name does not exist. Example: -.'."\n" - .'* quote specifies the escape characters that are used. Valid values: ", \', and space.'."\n" - ."\n" - .'If the value of contentType is parquet, specify contentDetail based on the following description:'."\n" - ."\n" - .'* columns specifies the keys of fields in logs of the source Logstore. You must also specify the data types of the keys. Example: {\'columns\': \\[{\'name\': "bucket", \'type\': "string"}, {\'name\': "bucket_location", \'type\': "string"}, {\'name\': "cdn_in", \'type\': "string"},{\'name\': "cdn_out", \'type\': "string"}].'."\n" - ."\n" - .'If the value of contentType is orc, specify contentDetail based on the following description:'."\n" - ."\n" - .'* columns specifies the keys of fields in logs of the source Logstore. You must also specify the data types of the keys. Example: {\'columns\': \\[{\'name\': "bucket", \'type\': "string"}, {\'name\': "bucket_location", \'type\': "string"}, {\'name\': "cdn_in", \'type\': "string"},{\'name\': "cdn_out", \'type\': "string"}].'."\n", - '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' => 'The compression type. Valid values: snappy, gizp, zstd, and none.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'snappy/gizp/zstd/none', - ], - 'bufferInterval' => [ - 'title' => '投递时间', - 'description' => 'The interval between two data shipping operations. Valid values: 300 to 900. Unit: seconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], - 'bufferSize' => [ - 'title' => '投递大小', - 'description' => 'The size of the OSS object to which data is shipped. Valid values: 5 to 256. Unit: MB.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '256', - ], - 'delaySec' => [ - 'title' => '废弃', - 'description' => 'The latency of data shipping.'."\n" + 'additionalProperties' => ['description' => '**If `contentType` is `json`, `contentDetail` supports the following parameter:**'."\n" ."\n" - .'> '."\n" + .'- `enableTag`'."\n" ."\n" - .'* This parameter is deprecated.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '123', - ], - 'delaySeconds' => [ - 'title' => '延迟投递', - 'description' => 'The latency of data shipping. The value of this parameter cannot exceed the data retention period of the source Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '900', + .' - **Required**: Yes'."\n" + ."\n" + .' - **Type**: Boolean'."\n" + ."\n" + .' - **Description**: Specifies whether to include the log tags in the output.'."\n" + ."\n" + .' - **Valid values**:'."\n" + ."\n" + .' - `true`'."\n" + ."\n" + .' - **Description**: Includes the log tags.'."\n" + ."\n" + .' - **Example**: `{"enableTag": true}`'."\n" + ."\n" + .' - `false`'."\n" + ."\n" + .' - **Description**: Excludes the log tags.'."\n" + ."\n" + .' - **Example**: `{"enableTag": false}`'."\n" + ."\n" + .'**If `contentType` is `csv`, `contentDetail` supports the following parameters:**'."\n" + ."\n" + .'- `columns`'."\n" + ."\n" + .' - **Required**: Yes'."\n" + ."\n" + .' - **Type**: Array'."\n" + ."\n" + .' - **Description**: The log keys to export from the source Logstore.'."\n" + ."\n" + .' - **Example**: `{"columns":["a", "b", "c", "d"]}`'."\n" + ."\n" + .'- `delimiter`'."\n" + ."\n" + .' - **Required**: Yes'."\n" + ."\n" + .' - **Type**: String'."\n" + ."\n" + .' - **Description**: The delimiter to use between fields.'."\n" + ."\n" + .' - **Valid values**: `","`, `"|"`, `" "`, or `" "`'."\n" + ."\n" + .'- `header`'."\n" + ."\n" + .' - **Required**: Yes'."\n" + ."\n" + .' - **Type**: Boolean'."\n" + ."\n" + .' - **Description**: Specifies whether to write a header row with the key names.'."\n" + ."\n" + .' - **Valid values**:'."\n" + ."\n" + .' - `true`'."\n" + ."\n" + .' - `false`'."\n" + ."\n" + .'- `lineFeed`'."\n" + ."\n" + .' - **Required**: No'."\n" + ."\n" + .' - **Type**: String'."\n" + ."\n" + .' - **Description**: The character to use for line breaks.'."\n" + ."\n" + .' - **Valid values**: `" "`, `"'."\n" + .'"`, or `""`'."\n" + ."\n" + .' - **Default**: `"'."\n" + .'"`'."\n" + ."\n" + .'- `null`'."\n" + ."\n" + .' - **Required**: No'."\n" + ."\n" + .' - **Type**: String'."\n" + ."\n" + .' - **Description**: The string to use for fields with null values.'."\n" + ."\n" + .' - **Default**: `""`'."\n" + ."\n" + .'- `quote`'."\n" + ."\n" + .' - **Required**: Yes'."\n" + ."\n" + .' - **Type**: String'."\n" + ."\n" + .' - **Description**: The quote character to use for enclosing fields.'."\n" + ."\n" + .' - **Valid values**: `"\\""`, `"\'"`, or `""`.'."\n" + .' A complete example for a `csv` `contentDetail` is: `{"null": "-", "header": false, "lineFeed": "'."\n" + .'", "quote": "", "delimiter": ",", "columns": ["a", "b", "c", "d"]}`'."\n" + ."\n" + .'**If `contentType` is `parquet`, `contentDetail` supports the following parameter:**'."\n" + ."\n" + .'- `columns`'."\n" + ."\n" + .' - **Required**: Yes'."\n" + ."\n" + .' - **Type**: Array of objects'."\n" + ."\n" + .' - **Description**: The log keys and their corresponding data types to export from the source Logstore.'."\n" + ."\n" + .' - **Example**: `{"columns": [{"name": "a", "type": "string"}, {"name": "b", "type": "string"}, {"name": "c", "type": "string"},{"name": "d", "type": "string"}]}`'."\n" + ."\n" + .'**If `contentType` is `orc`, `contentDetail` supports the following parameter:**'."\n" + ."\n" + .'- `columns`'."\n" + ."\n" + .' - **Required**: Yes'."\n" + ."\n" + .' - **Type**: Array of objects'."\n" + ."\n" + .' - **Description**: The log keys and their corresponding data types to export from the source Logstore.'."\n" + ."\n" + .' - **Example**: `{"columns": [{"name": "a", "type": "string"}, {"name": "b", "type": "string"}, {"name": "c", "type": "string"},{"name": "d", "type": "string"}]}`', 'type' => 'any', 'example' => '{'."\n" + .' "columns": ['."\n" + .' "your log key1",'."\n" + .' "your log key2",'."\n" + .' "your log key3",'."\n" + .' ],'."\n" + .' "delimiter": " ",'."\n" + .' "header": true,'."\n" + .' "lineFeed": "\\n",'."\n" + .' "null": "-",'."\n" + .' "quote": "\\""'."\n" + .'},', 'title' => ''], + 'example' => '', ], + 'compressionType' => ['title' => '压缩类型', 'description' => 'The compression type for the exported files. Valid values: `snappy`, `gzip`, `zstd`, and `none` (no compression).', 'type' => 'string', 'required' => false, 'example' => 'snappy'], + 'bufferInterval' => ['title' => '投递时间', 'description' => 'The time in seconds to buffer data before exporting. The value must be an integer from 300 to 900.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'], + 'bufferSize' => ['title' => '投递大小', 'description' => 'The amount of data in MB to buffer before exporting. The value must be an integer from 5 to 256.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '256'], + 'delaySec' => ['title' => '废弃', 'description' => 'The delivery delay.'."\n" + ."\n" + .'> - This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '123'], + 'delaySeconds' => ['title' => '延迟投递', 'description' => 'The delivery delay, in seconds. This value cannot exceed the data retention period of the source Logstore.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900'], ], 'required' => false, + 'example' => '', ], - 'fromTime' => [ - 'title' => '时间范围开始', - 'description' => 'The beginning of the time range to ship data. The value 1 specifies that the data shipping job ships data from the first log in the Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456789', - ], - 'toTime' => [ - 'title' => '时间范围结束', - 'description' => 'The end of the time range to ship data. The value 0 specifies that the data shipping job continuously ships data until the job is manually stopped.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456789', - ], + 'fromTime' => ['title' => '时间范围开始', 'description' => 'The start time for the export, specified as a Unix timestamp. Set to 1 to export from the earliest available data in the Logstore.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718380800'], + 'toTime' => ['title' => '时间范围结束', 'description' => 'The end time for the export, specified as a Unix timestamp. Set to 0 to run the task continuously until it is stopped.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1718380800'], + 'sourceSecureTransport' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => '', 'default' => 'false'], ], 'required' => false, + 'example' => '', ], 'OSSIngestion' => [ 'title' => 'oss ingestion job', 'description' => 'The Object Storage Service (OSS) data import job.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '导入任务名称', - 'description' => 'The name of the data import job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123456', - ], - 'description' => [ - 'title' => 'job description', - 'description' => 'The description of the data import job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss ingestion', - ], - 'displayName' => [ - 'title' => 'job displayName', - 'description' => 'The display name of the data import job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'oss ingestion', - ], - 'schedule' => [ - 'title' => '调度配置', - 'description' => 'The scheduling settings.'."\n", - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'title' => 'oss导入配置', - 'description' => 'The configurations of the OSS data import job.'."\n", - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/OSSIngestionConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the data import job was created.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'description' => 'The time when the data import job was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - ], - 'status' => [ - 'title' => '导入状态', - 'description' => 'The status of the data import job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'description' => 'The ID of the data import job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - ], - 'processorId' => [ - 'title' => '写入处理器Id', - 'description' => '写入处理器Id', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - ], + 'name' => ['title' => '导入任务名称', 'description' => 'The name of the data import job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456'], + 'description' => ['title' => 'job description', 'description' => 'The description of the data import job.'."\n", 'type' => 'string', 'example' => 'oss ingestion'], + 'displayName' => ['title' => 'job displayName', 'description' => 'The display name of the data import job.'."\n", 'type' => 'string', 'required' => true, 'example' => 'oss ingestion'], + 'schedule' => ['title' => '调度配置', 'description' => 'The scheduling settings.'."\n", 'required' => true, '$ref' => '#/components/schemas/Schedule', 'example' => ''], + 'configuration' => ['title' => 'oss导入配置', 'description' => 'The configurations of the OSS data import job.'."\n", 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the data import job was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'description' => 'The time when the data import job was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'status' => ['title' => '导入状态', 'description' => 'The status of the data import job.'."\n", 'type' => 'string', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'description' => 'The ID of the data import job.'."\n", 'type' => 'string', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], ], + 'example' => '', ], 'OSSIngestionConfiguration' => [ 'title' => 'A short description of struct', @@ -4733,208 +1910,87 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'description' => 'The Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'myLogstore', - ], - 'source' => [ - 'description' => 'The source that you specify for the configurations of the OSS data import job.'."\n", - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/OSSIngestionConfigurationSource', - ], + 'logstore' => ['title' => 'logstore', 'description' => 'The Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'myLogstore'], + 'source' => ['description' => 'The source that you specify for the configurations of the OSS data import job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfigurationSource'], ], ], 'OSSIngestionConfigurationSource' => [ 'title' => 'A short description of struct', - 'description' => 'The configurations of the Object Storage Service (OSS) data import job.'."\n", - 'visibility' => 'Public', + 'description' => 'The configuration for ingesting data from OSS.', 'type' => 'object', 'properties' => [ - 'endpoint' => [ - 'title' => 'oss endpoint', - 'description' => 'The OSS endpoint.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'oss-cn-hangzhou.aliyuncs.com', - ], - 'bucket' => [ - 'title' => 'oss bucket', - 'description' => 'The OSS bucket.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ossbucket', - ], - 'compressionCodec' => [ - 'title' => '压缩类型：none,snappy,gzip', - 'description' => 'The compression type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'none,snappy,gzip', - ], - 'encoding' => [ - 'title' => '编码类型', - 'description' => 'The encoding type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'UTF-8', - ], + 'endpoint' => ['title' => 'oss endpoint', 'description' => 'The OSS endpoint.', 'type' => 'string', 'required' => true, 'example' => 'oss-cn-hangzhou.aliyuncs.com'], + 'bucket' => ['title' => 'oss bucket', 'description' => 'The name of the OSS bucket.', 'type' => 'string', 'required' => true, 'example' => 'ossbucket'], + 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => 'The compression type of the source files.', 'type' => 'string', 'required' => true, 'example' => 'none'], + 'encoding' => ['title' => '编码类型', 'description' => 'The encoding of the source files.', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], + 'interval' => ['title' => '检查新文件周期', 'description' => 'The check interval for new files.', 'type' => 'string', 'required' => true, 'example' => 'never'], + 'pattern' => ['title' => '文件路径正则过滤', 'description' => 'A regular expression to filter files by path.', 'type' => 'string', 'example' => '.*'], + 'prefix' => ['title' => '文件路径前缀过滤', 'description' => 'The path prefix for filtering files.', 'type' => 'string', 'example' => 'prefix'], + 'restoreObjectEnabled' => ['title' => '导入归档文件', 'description' => 'Specifies whether to import archived files.', 'type' => 'boolean', 'example' => 'true'], + 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => 'Imports only files modified after this time. The value is a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274081'], + 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => 'Imports only files modified before this time. The value is a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'timeField' => ['title' => '提取时间字段', 'description' => 'The field containing the log time.', 'type' => 'string', 'example' => '__time__'], + 'timeFormat' => ['title' => '时间字段格式', 'description' => 'The format of the time field.', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], + 'timePattern' => ['title' => '提取时间正则', 'description' => 'The regular expression to extract the time value from a log.', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], + 'timeZone' => ['title' => '时间字段分区', 'description' => 'The time zone of the timestamp in the source data.', 'type' => 'string', 'example' => 'GMT+08:00'], + 'useMetaIndex' => ['title' => '使用OSS元数据索引', 'description' => 'Specifies whether to use the OSS metadata index to accelerate file discovery.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'roleARN' => ['title' => 'roleArn', 'description' => 'The Role ARN to use for accessing the OSS bucket.', 'type' => 'string', 'example' => 'acs:ram::12345:role/aliyunlogdefaultrole'], + 'tagPackId' => ['title' => '启动上下文检索', 'description' => 'Specifies whether to enable context retrieval.', 'type' => 'boolean', 'example' => 'true'], + 'processorId' => ['title' => '写入处理器id', 'description' => 'The ID of the writer processor.', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], 'format' => [ 'title' => '格式', - 'description' => 'The format.'."\n", - 'visibility' => 'Public', + 'description' => 'Defines the format of the source data.', 'type' => 'object', 'required' => true, - 'additionalProperties' => [ - 'description' => 'The data format of the OSS object. Valid values:'."\n" - ."\n" - .'* Single-line text log: `{"type":"Line"}`'."\n" - .'* CSV:'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "type": "CSV",'."\n" - .' "fieldDelimiter": ",", // The delimiter.'."\n" - .' "quoteChar": "\\"", // The quotation mark.'."\n" - .' "escapeChar": "\\\\", // The escape character.'."\n" - .' "firstRowAsHeader": true, // Specifies whether the first line is used as the field name.'."\n" - .' "maxLines": 1, // The maximum number of log lines.'."\n" - .' "skipLeadingRows": 0 // The number of skipped lines.'."\n" - .' }'."\n" - ."\n" - .'* Single-line JSON: `{"type": "JSON"}`'."\n" - .'* Multi-line text log:'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "type": "Multiline",'."\n" - .' "match": "after", // The position at which the regular expression is used to match data.'."\n" - .' "pattern": "\\\\d+", // The regular expression.'."\n" - .' "maxLines": 10 // The maximum number of lines.'."\n" - .' }'."\n" - ."\n" - .'* ORC: `{"type": "ORC"}`'."\n" - .'* Parquet: `{"type": "Parquet"}`'."\n" - .'* Alibaba Cloud OSS access log: `{"type": "ossAccessLog"}`'."\n" - .'* Alibaba Cloud CDN download log: `{"type": "cdnDownloadedLog"}`'."\n", - 'visibility' => 'Public', - 'type' => 'any', - 'example' => '{"type": "line"}', - ], - ], - 'interval' => [ - 'title' => '检查新文件周期', - 'description' => 'The interval at which the system checks for new files.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'never', - ], - 'pattern' => [ - 'title' => '文件路径正则过滤', - 'description' => 'The regular expression that is used to filter OSS objects by directory.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '.*', - ], - 'prefix' => [ - 'title' => '文件路径前缀过滤', - 'description' => 'The directory of the OSS objects.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'prefix', - ], - 'restoreObjectEnabled' => [ - 'title' => '导入归档文件', - 'description' => 'Specifies whether to import OSS objects of the Archive class.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'startTime' => [ - 'title' => '某个时间点后修改过的文件', - 'description' => 'The point in time after which modified OSS objects are imported.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714274081', - ], - 'endTime' => [ - 'title' => '某个时间点前修改过的文件', - 'description' => 'The point in time before which modified OSS objects are imported.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714360481', - ], - 'timeField' => [ - 'title' => '提取时间字段', - 'description' => 'The time field to extract.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '__time__', - ], - 'timeFormat' => [ - 'title' => '时间字段格式', - 'description' => 'The format of the time field.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'yyyy-MM-dd HH:mm:ss', - ], - 'timePattern' => [ - 'title' => '提取时间正则', - 'description' => 'The regular expression that is used to extract time.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+', - ], - 'timeZone' => [ - 'title' => '时间字段分区', - 'description' => 'The time zone of the time field.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'GMT+08:00', - ], - 'useMetaIndex' => [ - 'title' => '使用OSS元数据索引', - 'description' => 'Specifies whether to enable OSS metadata indexing.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'roleARN' => [ - 'title' => 'roleArn', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ram::12345:role/aliyunlogdefaultrole', - ], - 'tagPackId' => [ - 'title' => '启动上下文检索', - 'description' => '启动上下文检索', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', + 'additionalProperties' => ['description' => 'The data format of the objects in OSS.'."\n" + ."\n" + .'- Single-line Text Log: `{"type":"Line"}`'."\n" + ."\n" + .'- CSV:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "type": "CSV",'."\n" + .' "fieldDelimiter": ",", // Delimiter'."\n" + .' "quoteChar": "\\"", // Quote character'."\n" + .' "escapeChar": "\\", // Escape character'."\n" + .' "firstRowAsHeader": true, // Use first row as header'."\n" + .' "maxLines": 1, // Max lines per log'."\n" + .' "skipLeadingRows": 0 // Rows to skip at the beginning'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- Single-line JSON: `{"type": "JSON"}`'."\n" + ."\n" + .'- Multi-line Text Log:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "type": "Multiline",'."\n" + .' "match": "after", // Pattern matching position'."\n" + .' "pattern": "\\d+", // Regular expression'."\n" + .' "maxLines": 10 // Max lines per log'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'- ORC: `{"type": "ORC"}`'."\n" + ."\n" + .'- Parquet: `{"type": "Parquet"}`'."\n" + ."\n" + .'- Alibaba Cloud OSS Access Log: `{"type": "ossAccessLog"}`'."\n" + ."\n" + .'- Alibaba Cloud CDN Download Log: `{"type": "cdnDownloadedLog"}`', 'type' => 'any', 'example' => '{"type": "Line"}', 'title' => ''], + 'example' => '', ], - 'processorId' => [ - 'title' => '写入处理器id', - 'description' => '写入处理器id', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', + 'advancedParameters' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], 'PolicyConfiguration' => [ 'title' => '告警通知策略配置', @@ -4942,27 +1998,9 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'alertPolicyId' => [ - 'title' => '告警策略', - 'description' => 'The alert policy.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'sls.builtin.dynamic', - ], - 'actionPolicyId' => [ - 'title' => '行动策略', - 'description' => 'The action policy.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'example_action_policy', - ], - 'repeatInterval' => [ - 'title' => '重复等待时间', - 'description' => 'The repeat interval.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10m', - ], + 'alertPolicyId' => ['title' => '告警策略', 'description' => 'The alert policy.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'sls.builtin.dynamic'], + 'actionPolicyId' => ['title' => '行动策略', 'description' => 'The action policy.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'example_action_policy'], + 'repeatInterval' => ['title' => '重复等待时间', 'description' => 'The repeat interval.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '10m'], ], ], 'ProcessorAssociate' => [ @@ -4970,165 +2008,51 @@ 'description' => 'ProcessorAssociate', 'type' => 'object', 'properties' => [ - 'processorId' => [ - 'title' => 'Processor ID', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-processor-1', - 'description' => '', - ], + 'processorId' => ['title' => 'Processor ID', 'type' => 'string', 'required' => true, 'example' => 'ingest-processor-1', 'description' => ''], ], 'example' => '', ], 'project' => [ - 'title' => 'A short description of struct', - 'description' => 'The data structure of the Simple Log Service project.'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The data structure of a Simple Log Service project.', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time at which the project was created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2021-07-07 14:08:09', - ], - 'lastModifyTime' => [ - 'title' => '最后更新时间', - 'description' => 'The time at which the project was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '2022-04-18 13:30:19', - ], - 'description' => [ - 'title' => '描述', - 'description' => 'The description of the project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Description of my-project', - ], - 'owner' => [ - 'title' => 'project owner', - 'description' => 'The ID of the Alibaba Cloud account that is used to create the project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '""', - ], - 'projectName' => [ - 'title' => 'Project名称', - 'description' => 'The name of the project. The name is included in the value of the Host header. The name must be unique in a region. You cannot change the name after the project is created.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - 'region' => [ - 'title' => '所在区域', - 'description' => 'The region to which the project belongs.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'status' => [ - 'title' => '状态', - 'description' => 'The status of the project. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* Disable'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Normal', - ], - 'resourceGroupId' => [ - 'title' => '资源组Id', - 'description' => 'The ID of the resource group to which the project belongs.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'rg-acf******sq', - ], - 'dataRedundancyType' => [ - 'title' => '数据冗余类型', - 'description' => 'The data redundancy type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'LRS', - ], + 'createTime' => ['title' => '', 'description' => 'The time when the project was created.', 'type' => 'string', 'example' => '2021-07-07 14:08:09'], + 'lastModifyTime' => ['title' => '', 'description' => 'The time when the project was last modified.', 'type' => 'string', 'example' => '2022-04-18 13:30:19'], + 'description' => ['title' => '', 'description' => 'The description of the project.', 'type' => 'string', 'required' => true, 'example' => 'Description of my-project'], + 'owner' => ['title' => '', 'description' => 'The Alibaba Cloud account to which the project belongs.', 'type' => 'string', 'example' => '""'], + 'projectName' => ['title' => '', 'description' => 'The name of the project, which is used as part of the host. The project name is globally unique within an Alibaba Cloud region and cannot be modified after creation.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + 'region' => ['title' => '', 'description' => 'The region to which the project belongs.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'status' => ['title' => '', 'description' => 'The status of the project. Valid values:'."\n" + ."\n" + .'- Normal: Normal.'."\n" + .'- Disable: Disabled.', 'type' => 'string', 'example' => 'Normal'], + 'resourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group to which the project belongs.', 'type' => 'string', 'example' => 'rg-acf******sq'], + 'dataRedundancyType' => ['title' => '', 'description' => 'The data redundancy type.', 'type' => 'string', 'example' => 'LRS'], + 'recycleBinEnabled' => ['title' => '', 'description' => 'Indicates whether the recycle bin is enabled.', 'type' => 'boolean', 'example' => 'false'], + 'internetEndpoint' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'internalEndpoint' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], 'quota' => [ - 'title' => 'project quota', - 'description' => 'project quota'."\n", - 'visibility' => 'Public', + 'title' => '', + 'description' => 'The project quota.', 'type' => 'object', - 'additionalProperties' => [ - 'visibility' => 'Public', - 'type' => 'any', - 'description' => '', - ], - ], - 'recycleBinEnabled' => [ - 'title' => '是否打开回收站', - 'description' => '是否打开回收站', - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], - 'location' => [ - 'title' => 'project 所在的具体地域', - 'description' => 'project 所在的具体地域', - 'visibility' => 'Public', - 'type' => 'string', + 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'ProjectSummary' => [ 'title' => 'Project', 'description' => 'Project information.', 'type' => 'object', 'properties' => [ - 'projectName' => [ - 'title' => 'Project名称', - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - 'description' => [ - 'title' => 'Project描述', - 'description' => 'The description of the project.', - 'type' => 'string', - 'required' => true, - 'example' => '描述信息', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the project was created.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1714360481', - ], - 'updateTime' => [ - 'title' => '更新时间', - 'description' => 'The time when the project was last updated.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1710230272', - ], - 'region' => [ - 'title' => '所在Region', - 'description' => 'The region where the project resides.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'resourceGroupId' => [ - 'title' => '资源组ID', - 'description' => 'The ID of the resource group.', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acf******sq', - ], + 'projectName' => ['title' => 'Project名称', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + 'description' => ['title' => 'Project描述', 'description' => 'The description of the project.', 'type' => 'string', 'required' => true, 'example' => '描述信息'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the project was created.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1714360481'], + 'updateTime' => ['title' => '更新时间', 'description' => 'The time when the project was last updated.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710230272'], + 'region' => ['title' => '所在Region', 'description' => 'The region where the project resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + 'resourceGroupId' => ['title' => '资源组ID', 'description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-acf******sq'], ], 'example' => '', ], @@ -5136,74 +2060,17 @@ 'title' => 's3 ingestion job', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '导入任务名称', - 'type' => 'string', - 'required' => true, - 'description' => '', - 'example' => 'ingest-s3-123456', - ], - 'description' => [ - 'title' => 'job description', - 'type' => 'string', - 'description' => '', - 'example' => 's3 ingestion', - ], - 'displayName' => [ - 'title' => 'job displayName', - 'type' => 'string', - 'required' => true, - 'description' => '', - 'example' => 's3 ingestion', - ], - 'schedule' => [ - 'title' => '调度配置', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - 'description' => '', - 'example' => '', - ], - 'configuration' => [ - 'title' => 's3导入配置', - 'required' => true, - '$ref' => '#/components/schemas/S3IngestionConfigurationSource', - 'description' => '', - 'example' => '', - ], - 'createTime' => [ - 'title' => '创建时间', - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'example' => '1714360481', - ], - 'lastModifiedTime' => [ - 'title' => '最近一次修改时间', - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'example' => '1714360481', - ], - 'status' => [ - 'title' => '导入状态', - 'type' => 'string', - 'description' => '', - 'example' => 'RUNNING', - ], - 'scheduleId' => [ - 'title' => '任务ID', - 'type' => 'string', - 'description' => '', - 'example' => 'c7f01719d9feb105fc9d8df92af62010', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'type' => 'string', - 'description' => '', - 'example' => 'ingest-processor-1756802123-953901', - ], - ], - 'description' => '', + 'name' => ['title' => '导入任务名称', 'type' => 'string', 'required' => true, 'description' => 'Task Name ', 'example' => 'ingest-s3-123456'], + 'description' => ['title' => 'job description', 'type' => 'string', 'description' => 'Job description ', 'example' => 's3 ingestion'], + 'displayName' => ['title' => 'job displayName', 'type' => 'string', 'required' => true, 'description' => 'Job display name ', 'example' => 's3 ingestion'], + 'schedule' => ['title' => '调度配置', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'description' => 'Scan Configuration ', 'example' => ''], + 'createTime' => ['title' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'description' => 'Creation Time ', 'example' => '1714360481'], + 'lastModifiedTime' => ['title' => '最近一次修改时间', 'type' => 'integer', 'format' => 'int64', 'description' => 'Updated At ', 'example' => '1714360481'], + 'status' => ['title' => '导入状态', 'type' => 'string', 'description' => 'Import Status ', 'example' => 'RUNNING'], + 'scheduleId' => ['title' => '任务ID', 'type' => 'string', 'description' => 'Job ID ', 'example' => 'c7f01719d9feb105fc9d8df92af62010'], + 'configuration' => ['title' => 's3导入配置', 'required' => true, '$ref' => '#/components/schemas/S3IngestionConfiguration', 'description' => 'S3 import configuration ', 'example' => ''], + ], + 'description' => 'S3 ingestion job ', 'example' => '', ], 'S3IngestionConfiguration' => [ @@ -5211,340 +2078,57 @@ 'description' => 'S3 ingestion configuration.', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore', - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'example' => 'myLogstore', - ], - 'source' => [ - 'description' => 'The source.', - '$ref' => '#/components/schemas/S3IngestionConfigurationSource', - 'title' => '', - 'example' => '', - ], + 'logstore' => ['title' => 'logstore', 'description' => 'The name of the Logstore.', 'type' => 'string', 'example' => 'myLogstore'], + 'source' => ['description' => 'The source.', '$ref' => '#/components/schemas/S3IngestionConfigurationSource', 'title' => '', 'example' => ''], ], 'example' => '', ], 'S3IngestionConfigurationSource' => [ 'title' => 'A short description of struct', - 'description' => 'S3 import configuration.', + 'description' => 'S3 ingestion configuration', 'type' => 'object', 'properties' => [ - 'awsRegion' => [ - 'title' => 's3 region', - 'type' => 'string', - 'required' => true, - 'description' => 'The S3 region.', - 'example' => 'ap-northeast-1', - 'visibility' => 'Public', - ], - 'awsAccessKey' => [ - 'title' => 'aws access key', - 'type' => 'string', - 'required' => true, - 'description' => 'The AWS AccessKey ID.', - 'example' => 'AKIxxxxxxxxxxYJE', - 'visibility' => 'Public', - ], - 'awsAccessKeySecret' => [ - 'title' => 'aws access key secret', - 'type' => 'string', - 'required' => true, - 'description' => 'The AWS Secret Access Key.', - 'example' => '123xxxxxxxxxxfjf', - 'visibility' => 'Public', - ], - 'bucket' => [ - 'title' => 's3 bucket', - 'type' => 'string', - 'required' => true, - 'description' => 'The S3 bucket name.', - 'example' => 's3bucket', - 'visibility' => 'Public', - ], - 'compressionCodec' => [ - 'title' => '压缩类型：none,snappy,gzip', - 'type' => 'string', - 'required' => true, - 'description' => 'The compression type. Valid values: none, snappy, and gzip.', - 'example' => 'none', - 'visibility' => 'Public', - ], - 'encoding' => [ - 'title' => '编码类型', - 'type' => 'string', - 'required' => true, - 'description' => 'The encoding format.', - 'example' => 'UTF-8', - 'visibility' => 'Public', - ], + 'awsRegion' => ['title' => 's3 region', 'description' => 'Amazon S3 region', 'type' => 'string', 'required' => true, 'example' => 'ap-northeast-1'], + 'awsAccessKey' => ['title' => 'aws access key', 'description' => 'Amazon Web Services (AWS) access key ID', 'type' => 'string', 'required' => true, 'example' => 'AKIxxxxxxxxxxYJE'], + 'awsAccessKeySecret' => ['title' => 'aws access key secret', 'description' => 'Amazon Web Services (AWS) secret access key', 'type' => 'string', 'required' => true, 'example' => '123xxxxxxxxxxfjf'], + 'bucket' => ['title' => 's3 bucket', 'description' => 'Amazon S3 bucket name', 'type' => 'string', 'required' => true, 'example' => 's3bucket'], + 'compressionCodec' => ['title' => '压缩类型：none,snappy,gzip', 'description' => 'Compression codec. Valid values: none, snappy, gzip', 'type' => 'string', 'required' => true, 'example' => 'none'], + 'encoding' => ['title' => '编码类型', 'description' => 'Character encoding', 'type' => 'string', 'required' => true, 'example' => 'UTF-8'], + 'interval' => ['title' => '检查新文件周期', 'description' => 'Polling interval for new files', 'type' => 'string', 'required' => true, 'example' => '30m'], + 'pattern' => ['title' => '文件路径正则过滤', 'description' => 'Regular expression to filter file paths', 'type' => 'string', 'example' => '.*'], + 'prefix' => ['title' => '文件路径前缀过滤', 'description' => 'Prefix to filter file paths', 'type' => 'string', 'example' => 'prefix'], + 'awsUseSQS' => ['title' => '使用sqs', 'description' => 'Specifies whether to use SQS.', 'type' => 'boolean', 'example' => 'false'], + 'awsSQSQueueUrl' => ['title' => 'sqs queue url', 'description' => 'Amazon SQS queue URL', 'type' => 'string', 'example' => 'https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan'], + 'useAwsSQSOnly' => ['title' => '仅使用sqs获取新文件', 'description' => 'Use only Amazon SQS to detect new files', 'type' => 'boolean', 'example' => 'false'], + 'tagPackId' => ['title' => '支持上下文浏览', 'description' => 'Enable context browsing', 'type' => 'boolean', 'example' => 'false'], + 'startTime' => ['title' => '某个时间点后修改过的文件', 'description' => 'Include only files modified after this Unix timestamp', 'type' => 'integer', 'format' => 'int64', 'example' => '1714274081'], + 'endTime' => ['title' => '某个时间点前修改过的文件', 'description' => 'Include only files modified before this Unix timestamp', 'type' => 'integer', 'format' => 'int64', 'example' => '1714360481'], + 'timeField' => ['title' => '提取时间字段', 'description' => 'Name of the field that contains event timestamps', 'type' => 'string', 'example' => '__time__'], + 'timeFormat' => ['title' => '时间字段格式', 'description' => 'Timestamp format in the time field', 'type' => 'string', 'example' => 'yyyy-MM-dd HH:mm:ss'], + 'timePattern' => ['title' => '提取时间正则', 'description' => 'Regular expression to extract timestamps from file names or content', 'type' => 'string', 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+'], + 'timeZone' => ['title' => '时间字段分区', 'description' => 'Time zone for the time field', 'type' => 'string', 'example' => 'GMT+08:00'], + 'processorId' => ['title' => '写入处理器ID', 'description' => 'Ingest processor ID', 'type' => 'string', 'example' => 'ingest-processor-1756802123-953901'], + 'endpoint' => ['title' => 's3 endpoint', 'description' => 'Amazon S3 endpoint', 'type' => 'string', 'example' => 's3.us-east-1.amazonaws.com'], + 'cloudFrontEndpoint' => ['description' => 'The endpoint for the CloudFront distribution.', 'type' => 'string', 'title' => '', 'example' => 'dtfsb7voqy76q.cloudfront.net '], + 'cloudFrontToken' => ['description' => 'The authentication token for accessing the CloudFront endpoint.', 'type' => 'string', 'title' => '', 'example' => '@test-s3-access/ABS'], + 'useCloudFront' => ['title' => '使用CloudFront', 'description' => 'Specifies whether to access S3 through a CloudFront distribution.', 'type' => 'boolean', 'example' => ''], 'format' => [ 'title' => '格式', 'type' => 'object', 'required' => true, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The data format.', - 'title' => '', - 'example' => '{"type": "line"}', - 'visibility' => 'Public', - ], - 'description' => 'The data format.', + 'additionalProperties' => ['description' => 'Format', 'type' => 'any', 'title' => '', 'example' => '{"type": "line"}'], + 'description' => 'Format', 'example' => '', - 'visibility' => 'Public', - ], - 'interval' => [ - 'title' => '检查新文件周期', - 'type' => 'string', - 'required' => true, - 'description' => 'The interval to check for new files.', - 'example' => '30m', - 'visibility' => 'Public', - ], - 'pattern' => [ - 'title' => '文件路径正则过滤', - 'type' => 'string', - 'description' => 'A regular expression to filter file paths.', - 'example' => '.*', - 'visibility' => 'Public', - ], - 'prefix' => [ - 'title' => '文件路径前缀过滤', - 'type' => 'string', - 'description' => 'A prefix to filter file paths.', - 'example' => 'prefix', - 'visibility' => 'Public', - ], - 'awsUseSQS' => [ - 'title' => '使用sqs', - 'type' => 'boolean', - 'description' => 'Specifies whether to use Amazon Simple Queue Service (SQS).', - 'example' => 'false', - 'visibility' => 'Public', - ], - 'awsSQSQueueUrl' => [ - 'title' => 'sqs queue url', - 'type' => 'string', - 'description' => 'The SQS queue URL.', - 'example' => 'https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan', - 'visibility' => 'Public', - ], - 'useAwsSQSOnly' => [ - 'title' => '仅使用sqs获取新文件', - 'type' => 'boolean', - 'description' => 'Specifies whether to use only SQS to fetch new files.', - 'example' => 'false', - 'visibility' => 'Public', - ], - 'tagPackId' => [ - 'title' => '支持上下文浏览', - 'type' => 'boolean', - 'description' => 'Specifies whether to enable context-aware browsing.', - 'example' => 'false', - 'visibility' => 'Public', - ], - 'startTime' => [ - 'title' => '某个时间点后修改过的文件', - 'type' => 'integer', - 'format' => 'int64', - 'description' => 'Ingest files modified after this time.', - 'example' => '1714274081', - 'visibility' => 'Public', ], - 'endTime' => [ - 'title' => '某个时间点前修改过的文件', - 'type' => 'integer', - 'format' => 'int64', - 'description' => 'Ingest files modified before this time.', - 'example' => '1714360481', - 'visibility' => 'Public', - ], - 'timeField' => [ - 'title' => '提取时间字段', - 'type' => 'string', - 'description' => 'The field from which to extract the time.', - 'example' => '__time__', - 'visibility' => 'Public', - ], - 'timeFormat' => [ - 'title' => '时间字段格式', - 'type' => 'string', - 'description' => 'The format of the time field.', - 'example' => 'yyyy-MM-dd HH:mm:ss', - 'visibility' => 'Public', - ], - 'timePattern' => [ - 'title' => '提取时间正则', - 'type' => 'string', - 'description' => 'The regular expression to extract the time.', - 'example' => '[0-9]{0,2}\\/[0-9a-zA-Z]+\\/[0-9:,]+', - 'visibility' => 'Public', - ], - 'timeZone' => [ - 'title' => '时间字段分区', - 'type' => 'string', - 'description' => 'The time zone of the time field.', - 'example' => 'GMT+08:00', - 'visibility' => 'Public', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'type' => 'string', - 'description' => 'The ID of the write processor.', - 'example' => 'ingest-processor-1756802123-953901', - 'visibility' => 'Public', - ], - 'endpoint' => [ - 'title' => 's3 endpoint', - 'type' => 'string', - 'description' => 'The S3 endpoint.', - 'example' => 's3.us-east-1.amazonaws.com', - 'visibility' => 'Public', + 'advancedParameters' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'example' => '', - 'alibabaCloud' => 'alibabaCloud:1.0.0', - 'info' => [ - 'runtimeType' => 'none', - 'namespace' => 'Sls::2020-12-30', - 'apiStyle' => 'restful', - ], - 'components' => [ - 'schemas' => [ - 'S3IngestionConfigurationSource' => [ - 'title' => 'A short description of struct', - 'description' => 'S3导入配置', - 'type' => 'object', - 'properties' => [ - 'awsRegion' => [ - 'title' => 's3 region', - 'type' => 'string', - 'required' => true, - 'example' => 'ap-northeast-1', - ], - 'awsAccessKey' => [ - 'title' => 'aws access key', - 'type' => 'string', - 'required' => true, - 'example' => 'AKIxxxxxxxxxxYJE', - ], - 'awsAccessKeySecret' => [ - 'title' => 'aws access key secret', - 'type' => 'string', - 'required' => true, - 'example' => '123xxxxxxxxxxfjf', - ], - 'bucket' => [ - 'title' => 's3 bucket', - 'type' => 'string', - 'required' => true, - 'example' => 's3bucket', - ], - 'compressionCodec' => [ - 'title' => '压缩类型：none,snappy,gzip', - 'type' => 'string', - 'required' => true, - 'example' => 'none', - ], - 'encoding' => [ - 'title' => '编码类型', - 'type' => 'string', - 'required' => true, - 'example' => 'UTF-8', - ], - 'format' => [ - 'title' => '格式', - 'type' => 'object', - 'required' => true, - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '{"type": "line"}', - ], - ], - 'interval' => [ - 'title' => '检查新文件周期', - 'type' => 'string', - 'required' => true, - 'example' => '30m', - ], - 'pattern' => [ - 'title' => '文件路径正则过滤', - 'type' => 'string', - 'example' => '.*', - ], - 'prefix' => [ - 'title' => '文件路径前缀过滤', - 'type' => 'string', - 'example' => 'prefix', - ], - 'awsUseSQS' => [ - 'title' => '使用sqs', - 'type' => 'boolean', - 'example' => 'false', - ], - 'awsSQSQueueUrl' => [ - 'title' => 'sqs queue url', - 'type' => 'string', - 'example' => 'https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan', - ], - 'useAwsSQSOnly' => [ - 'title' => '仅使用sqs获取新文件', - 'type' => 'boolean', - 'example' => 'false', - ], - 'tagPackId' => [ - 'title' => '支持上下文浏览', - 'type' => 'boolean', - 'example' => 'false', - ], - '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', - ], - 'processorId' => [ - 'title' => '写入处理器ID', - 'type' => 'string', - 'example' => 'ingest-processor-1756802123-953901', - ], - 'endpoint' => [ - 'title' => 's3 endpoint', - 'type' => 'string', - 'example' => 's3.us-east-1.amazonaws.com', - ], - ], - ], - ], - ], - 'visibility' => 'Public', ], 'SavedSearch' => [ 'title' => 'A short description of struct', @@ -5552,101 +2136,32 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'savedsearchName' => [ - 'sdkPropertyName' => 'savedsearchName', - 'title' => 'savedsearchName', - 'description' => 'The name of the saved search.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'savedsearch-name', - ], - 'searchQuery' => [ - 'title' => 'searchQuery', - 'description' => 'The search statement or analytic statement.', - 'visibility' => 'Public', + 'savedsearchName' => ['sdkPropertyName' => 'savedsearchName', 'title' => 'savedsearchName', 'description' => 'The name of the saved search.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name'], + 'searchQuery' => ['title' => 'searchQuery', 'description' => 'The search statement or analytic statement.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5'], + 'logstore' => ['title' => 'logstore', 'description' => 'The name of the logstore.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore'], + 'topic' => ['title' => 'topic', 'description' => 'The topic of the log. The default value is an empty string ("").', 'visibility' => 'Public', 'type' => 'string', 'example' => 'topic-test'], + 'displayName' => ['title' => 'displayName', 'description' => 'The display name of the saved search.', 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'Method'], + ], + 'example' => '', + ], + 'Schedule' => [ + 'title' => 'job schedule', + 'description' => 'The schedule structure.', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '定时类型：FixedRate/Cron', + 'description' => 'schedule type', 'type' => 'string', 'required' => true, - 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', - ], - 'logstore' => [ - 'title' => 'logstore', - 'description' => 'The name of the logstore.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - ], - 'topic' => [ - 'title' => 'topic', - 'description' => 'The topic of the log. The default value is an empty string ("").', - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'topic-test', - ], - 'displayName' => [ - 'title' => 'displayName', - 'description' => 'The display name of the saved search.', - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'Method', - ], - ], - 'example' => '', - ], - 'Schedule' => [ - 'title' => 'job schedule', - 'description' => 'The schedule structure.', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'title' => '定时类型：FixedRate/Cron', - 'description' => 'schedule type', - 'type' => 'string', - 'required' => true, - 'example' => 'FixedRate', - 'enum' => [ - 'FixedRate', - 'Cron', - ], - ], - 'cronExpression' => [ - 'title' => 'Cron情况下：cron表达式', - 'description' => 'The cron expression.', - 'type' => 'string', - 'required' => false, - 'example' => '0/5 * * * *', - ], - 'runImmediately' => [ - 'title' => '定时任务是否立即执行', - 'description' => 'Specifies whether to execute the scheduled task immediately.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'timeZone' => [ - 'title' => 'Cron表达式所在时区，默认为空，表示东八区', - 'description' => 'The time zone of the cron expression. If this parameter is left empty, the default time zone UTC+8 is used.', - 'type' => 'string', - 'required' => false, - 'example' => '+0800', - ], - 'delay' => [ - 'title' => '定时类任务延迟执行（单位是秒：s）', - 'description' => 'The delay before a scheduled task is executed, in seconds (s).', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - 'interval' => [ - 'title' => 'FixedRate情况下：固定间隔', - 'description' => 'The fixed interval.', - 'type' => 'string', - 'required' => false, - 'example' => '60s', + 'example' => 'FixedRate', + 'enum' => ['FixedRate', 'Cron'], ], + 'cronExpression' => ['title' => 'Cron情况下：cron表达式', 'description' => 'The cron expression.', 'type' => 'string', 'required' => false, 'example' => '0/5 * * * *'], + 'runImmediately' => ['title' => '定时任务是否立即执行', 'description' => 'Specifies whether to execute the scheduled task immediately.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'timeZone' => ['title' => 'Cron表达式所在时区，默认为空，表示东八区', 'description' => 'The time zone of the cron expression. If this parameter is left empty, the default time zone UTC+8 is used.', 'type' => 'string', 'required' => false, 'example' => '+0800'], + 'delay' => ['title' => '定时类任务延迟执行（单位是秒：s）', 'description' => 'The delay before a scheduled task is executed, in seconds (s).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + 'interval' => ['title' => 'FixedRate情况下：固定间隔', 'description' => 'The fixed interval.', 'type' => 'string', 'required' => false, 'example' => '60s'], ], 'required' => false, 'example' => '', @@ -5657,74 +2172,15 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '定时sql任务描述', - 'description' => 'The description of the scheduled SQL job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a scheduled sql job', - ], - 'displayName' => [ - 'title' => '定时sql显示名称', - 'description' => 'The display name of the scheduled SQL job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'This is a scheduled sql job', - ], - 'name' => [ - 'title' => '定时sql任务名称', - 'description' => 'The name of the scheduled SQL job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'test-scheduled-sql', - ], - 'schedule' => [ - 'title' => '调度配置', - 'description' => 'The scheduling settings of the Scheduled SQL job.'."\n", - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - ], - 'configuration' => [ - 'title' => '定时sql配置', - 'description' => 'The configuration of the Scheduled SQL job.'."\n", - 'visibility' => 'Public', - 'required' => true, - '$ref' => '#/components/schemas/ScheduledSQLConfiguration', - ], - 'createTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the Scheduled SQL job was created.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714123644', - ], - 'lastModifiedTime' => [ - 'title' => '最近修改时间', - 'description' => 'The time when the Scheduled SQL job was last modified.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1714123644', - ], - 'scheduleId' => [ - 'title' => '调度ID', - 'description' => 'The ID of the scheduler.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'e73f43732852064ad5d091914e39342f', - ], - 'status' => [ - 'title' => '定时SQL状态', - 'description' => 'The status of the Scheduled SQL job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ENABLED', - ], + 'description' => ['title' => '定时sql任务描述', 'description' => 'The description of the scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => false, 'example' => 'This is a scheduled sql job'], + 'displayName' => ['title' => '定时sql显示名称', 'description' => 'The display name of the scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'This is a scheduled sql job'], + 'name' => ['title' => '定时sql任务名称', 'description' => 'The name of the scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test-scheduled-sql'], + 'schedule' => ['title' => '调度配置', 'description' => 'The scheduling settings of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/Schedule'], + 'configuration' => ['title' => '定时sql配置', 'description' => 'The configuration of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration'], + 'createTime' => ['title' => '创建时间', 'description' => 'The time when the Scheduled SQL job was created.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1714123644'], + 'lastModifiedTime' => ['title' => '最近修改时间', 'description' => 'The time when the Scheduled SQL job was last modified.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1714123644'], + 'scheduleId' => ['title' => '调度ID', 'description' => 'The ID of the scheduler.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'e73f43732852064ad5d091914e39342f'], + 'status' => ['title' => '定时SQL状态', 'description' => 'The status of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ENABLED'], ], 'required' => false, ], @@ -5734,153 +2190,30 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'script' => [ - 'title' => 'SQL代码', - 'description' => 'The query statement of the Scheduled SQL job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '* | select *', - ], - 'sqlType' => [ - 'title' => 'SQL类型', - 'description' => 'The type of the query statement.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'searchQuery', - ], - 'destEndpoint' => [ - 'title' => '目标Region', - 'description' => 'The endpoint.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com', - ], - 'destProject' => [ - 'title' => '目标Project', - 'description' => 'The destination project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'project-demo', - ], - 'sourceLogstore' => [ - 'title' => '源库', - 'description' => 'The source Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'source-logstore-demo', - ], - 'destLogstore' => [ - 'title' => '目标库', - 'description' => 'The destination Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'dest-logstore-demo', - ], - 'roleArn' => [ - 'title' => '角色ARN', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that is assigned to the Scheduled SQL job.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::123456789:role/aliyunlogetlrole', - ], - 'destRoleArn' => [ - 'title' => '写角色ARN', - 'description' => 'The ARN of the RAM role that is assumed to write data to the destination Logstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'acs:ram::123456789:role/aliyunlogetlrole', - ], - 'fromTimeExpr' => [ - 'title' => 'SQL时间窗口开始', - 'description' => 'The start time of the SQL time window.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '@m-1m', - ], - 'toTimeExpr' => [ - 'title' => 'SQL时间窗口结束', - 'description' => 'The end time of the SQL time window.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => '@m', - ], - 'maxRunTimeInSeconds' => [ - 'title' => 'SQL超时最长时间', - 'description' => 'The maximum timeout period of SQL analysis. Unit: seconds. Valid values: 60 to 1800.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '600', - ], - 'resourcePool' => [ - 'title' => 'resourcePool', - 'description' => 'The type of the resource pool. The value enhanced specifies an enhanced resource pool.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'enhanced', - ], - 'maxRetries' => [ - 'title' => 'SQL超时最大次数', - 'description' => 'The maximum number of SQL timeouts allowed. Valid values: 1 to 100.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], - 'fromTime' => [ - 'title' => '调度时间范围开始', - 'description' => 'The start time. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1712592000', - ], - 'toTime' => [ - 'title' => '调度时间范围结束', - 'description' => 'The end time. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - 'dataFormat' => [ - 'title' => '定时sql写入模式', - 'description' => 'The data format. Valid values: log2log, log2metric, and metric2metric.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'log2log', - ], - 'parameters' => [ - 'title' => 'parameters', - 'description' => 'The SQL configurations. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => true, - 'example' => '{'."\n" - .' addLabels: "{}",'."\n" - .' hashLabels: "[]",'."\n" - .' labelKeys: "[\\"your label1\\",\\"your label2\\"]",'."\n" - .' metricKeys: "[\\"your Indicator1\\",\\"your Indicator2\\"]",'."\n" - .' metricName: "",'."\n" - .' timeKey: ""'."\n" - .'}', - ], + 'script' => ['title' => 'SQL代码', 'description' => 'The query statement of the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '* | select *'], + 'sqlType' => ['title' => 'SQL类型', 'description' => 'The type of the query statement.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'searchQuery'], + 'destEndpoint' => ['title' => '目标Region', 'description' => 'The endpoint.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-intranet.log.aliyuncs.com'], + 'destProject' => ['title' => '目标Project', 'description' => 'The destination project.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'project-demo'], + 'sourceLogstore' => ['title' => '源库', 'description' => 'The source Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'source-logstore-demo'], + 'destLogstore' => ['title' => '目标库', 'description' => 'The destination Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'dest-logstore-demo'], + 'roleArn' => ['title' => '角色ARN', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role that is assigned to the Scheduled SQL job.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], + 'destRoleArn' => ['title' => '写角色ARN', 'description' => 'The ARN of the RAM role that is assumed to write data to the destination Logstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], + 'fromTimeExpr' => ['title' => 'SQL时间窗口开始', 'description' => 'The start time of the SQL time window.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '@m-1m'], + 'toTimeExpr' => ['title' => 'SQL时间窗口结束', 'description' => 'The end time of the SQL time window.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => '@m'], + 'maxRunTimeInSeconds' => ['title' => 'SQL超时最长时间', 'description' => 'The maximum timeout period of SQL analysis. Unit: seconds. Valid values: 60 to 1800.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '600'], + 'resourcePool' => ['title' => 'resourcePool', 'description' => 'The type of the resource pool. The value enhanced specifies an enhanced resource pool.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'enhanced'], + 'maxRetries' => ['title' => 'SQL超时最大次数', 'description' => 'The maximum number of SQL timeouts allowed. Valid values: 1 to 100.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], + 'fromTime' => ['title' => '调度时间范围开始', 'description' => 'The start time. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1712592000'], + 'toTime' => ['title' => '调度时间范围结束', 'description' => 'The end time. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0'], + 'dataFormat' => ['title' => '定时sql写入模式', 'description' => 'The data format. Valid values: log2log, log2metric, and metric2metric.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'log2log'], + 'parameters' => ['title' => 'parameters', 'description' => 'The SQL configurations. For more information, see [Process and store data from a Logstore to a Metricstore](~~286459~~).'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => true, 'example' => '{'."\n" + .' addLabels: "{}",'."\n" + .' hashLabels: "[]",'."\n" + .' labelKeys: "[\\"your label1\\",\\"your label2\\"]",'."\n" + .' metricKeys: "[\\"your Indicator1\\",\\"your Indicator2\\"]",'."\n" + .' metricName: "",'."\n" + .' timeKey: ""'."\n" + .'}'], ], 'required' => false, ], @@ -5899,21 +2232,10 @@ .'* Closed: The service has overdue payments and is disabled.'."\n", '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' => 'Indicates whether the service is activated.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - ], + 'enabled' => ['title' => '是否开通', 'description' => 'Indicates whether the service is activated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'false'], ], ], 'SeverityConfiguration' => [ @@ -5922,20 +2244,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'severity' => [ - 'title' => '告警严重度数值', - 'description' => 'The value of the alert severity.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'evalCondition' => [ - 'title' => '触发条件配置', - 'description' => 'The trigger condition configurations.'."\n", - 'visibility' => 'Public', - '$ref' => '#/components/schemas/ConditionConfiguration', - ], + 'severity' => ['title' => '告警严重度数值', 'description' => 'The value of the alert severity.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'evalCondition' => ['title' => '触发条件配置', 'description' => 'The trigger condition configurations.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/ConditionConfiguration'], ], ], 'shard' => [ @@ -5944,117 +2254,58 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'shardID' => [ - 'title' => 'shard id', - 'description' => 'shard id'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'status' => [ - 'title' => 'shard 的读写状态，readwrite 或者 readonly。', - 'description' => 'The status of the shard. After you create a shard, the shard enters the readwrite state. If you split a shard or merge shards, the shard status changes to readonly. The newly generated shards are in the readwrite state. The status of a shard does not affect the performance of read operations that are performed on the shard. Data can be written to the shards that are in the readwrite state, but data cannot be written to the shards that are in the readonly state. Valid values:'."\n" - ."\n" - .'* readwrite'."\n" - .'* readonly'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'readwrite', - ], - 'inclusiveBeginKey' => [ - 'title' => '指定Shard范围的起始值，Shard范围中包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', - 'description' => 'The start of the MD5 hash range. The value is included in the MD5 hash range of the shard.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '00000000000000000000000000000000', - ], - 'exclusiveEndKey' => [ - 'title' => '指定Shard范围的结束值，Shard范围中不包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', - 'description' => 'The end of the MD5 hash range.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '8000000000000000000000000000000', - ], - 'serverIp' => [ - 'title' => '所在的服务器 ip。', - 'description' => '服务IP地址。', - 'visibility' => 'Private', - 'type' => 'string', - 'example' => '203.0.113.10', - ], - 'createTime' => [ - 'title' => 'Shard的创建时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', - 'description' => 'The time at which the shard was created. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1524222931', - ], + 'shardID' => ['title' => 'shard id', 'description' => 'shard id'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'status' => ['title' => 'shard 的读写状态，readwrite 或者 readonly。', 'description' => 'The status of the shard. After you create a shard, the shard enters the readwrite state. If you split a shard or merge shards, the shard status changes to readonly. The newly generated shards are in the readwrite state. The status of a shard does not affect the performance of read operations that are performed on the shard. Data can be written to the shards that are in the readwrite state, but data cannot be written to the shards that are in the readonly state. Valid values:'."\n" + ."\n" + .'* readwrite'."\n" + .'* readonly'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'readwrite'], + 'inclusiveBeginKey' => ['title' => '指定Shard范围的起始值，Shard范围中包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', 'description' => 'The start of the MD5 hash range. The value is included in the MD5 hash range of the shard.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '00000000000000000000000000000000'], + 'exclusiveEndKey' => ['title' => '指定Shard范围的结束值，Shard范围中不包含该值。即 shard 包含MD5值在 [inclusiveBeginKey, exclusiveEndKey) 之间的日志。', 'description' => 'The end of the MD5 hash range.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '8000000000000000000000000000000'], + 'serverIp' => ['title' => '所在的服务器 ip。', 'description' => '服务IP地址。', 'visibility' => 'Private', 'type' => 'string', 'example' => '203.0.113.10'], + 'createTime' => ['title' => 'Shard的创建时间。Unix时间戳格式，表示从1970-1-1 00:00:00 UTC计算起的秒数。', 'description' => 'The time at which the shard was created. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1524222931'], ], ], 'ShardingPolicy' => [ - 'title' => '哈希写入配置', + 'title' => '', 'description' => 'Hashing configuration for writes.', 'type' => 'object', 'properties' => [ 'shardGroup' => [ - 'title' => 'ShardGroup 配置，整个 LogStore 的哈希区间将被均为切分成多个大小相同的 ShardGroup。写入的数据计算一级哈希后选择相应的 ShardGroup 写入。', + 'title' => '', 'type' => 'object', 'properties' => [ 'keys' => [ - 'title' => '用于计算哈希的键，大小写敏感，顺序敏感，键不能重复。', + 'title' => '', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => 'userId', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'userId'], 'required' => true, 'description' => '', 'example' => '', ], - 'groupCount' => [ - 'title' => 'ShardGroup 分组个数，必须为 2 的幂次，小于 shard 个数，通常为 4-32 个。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'description' => '', - 'example' => '8', - ], + 'groupCount' => ['title' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'description' => '', 'example' => '8'], ], 'description' => '', 'example' => '', ], 'shardHash' => [ - 'title' => 'ShardHash 配置，二级哈希。此配置用于在 ShardGroup 内部选择 shard 进行写入', + 'title' => '', 'type' => 'object', 'properties' => [ 'keys' => [ - 'title' => '用于计算哈希的键，大小写敏感，顺序敏感，键不能重复。', + 'title' => '', 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => 'instanceId', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => 'instanceId'], 'required' => true, 'description' => '', 'example' => '', ], 'maxHashCount' => [ - 'title' => '表示哈希重试个数，当写入失败时，会切换哈希值进行写入重试。可选值为 1、2、4。1 表示不带重试，2 表示最多一次重试，4 表示最多 3次重试。', + 'title' => '', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'default' => '2', - 'enum' => [ - '1', - '2', - '4', - ], + 'enum' => ['1', '2', '4'], 'description' => '', 'example' => '2', ], @@ -6063,13 +2314,7 @@ 'description' => '', 'example' => '', ], - 'queryActiveTime' => [ - 'title' => '查询生效时间，Unix Timestamp', - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'example' => '1764659409', - ], + 'queryActiveTime' => ['title' => '', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => '1764659409'], ], 'example' => '', ], @@ -6079,13 +2324,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'title' => '是否开启', - 'description' => 'Specifies whether to send alerts.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], + 'enabled' => ['title' => '是否开启', 'description' => 'Specifies whether to send alerts.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], ], 'required' => false, ], @@ -6095,13 +2334,7 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'title' => '是否开启', - 'description' => 'Specifies whether to send alerts.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], + 'enabled' => ['title' => '是否开启', 'description' => 'Specifies whether to send alerts.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], ], ], 'SinkEventStoreConfiguration' => [ @@ -6110,41 +2343,11 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'enabled' => [ - 'title' => '是否开启', - 'description' => 'Specifies whether to send alerts.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - ], - 'endpoint' => [ - 'title' => 'endpoint', - 'description' => 'endpoint'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn-shanghai-intranet.log.aliyuncs.com', - ], - 'project' => [ - 'title' => '项目名称', - 'description' => 'The name of the project.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'exampleProject', - ], - 'eventStore' => [ - 'title' => '事件库名称', - 'description' => 'The name of the Eventstore.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'exampleStore', - ], - 'roleArn' => [ - 'title' => '角色', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'acs:ram::123456789:role/aliyunlogetlrole', - ], + 'enabled' => ['title' => '是否开启', 'description' => 'Specifies whether to send alerts.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'], + 'endpoint' => ['title' => 'endpoint', 'description' => 'endpoint'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn-shanghai-intranet.log.aliyuncs.com'], + 'project' => ['title' => '项目名称', 'description' => 'The name of the project.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'exampleProject'], + 'eventStore' => ['title' => '事件库名称', 'description' => 'The name of the Eventstore.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'exampleStore'], + 'roleArn' => ['title' => '角色', 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'acs:ram::123456789:role/aliyunlogetlrole'], ], ], 'StoreViewStore' => [ @@ -6152,26 +2355,9 @@ 'description' => 'StoreView store', 'type' => 'object', 'properties' => [ - 'project' => [ - 'title' => 'Project 名称', - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - 'storeName' => [ - 'title' => 'LogStore 或 MetricStore 名称', - 'description' => 'The name of the LogStore or MetricStore.', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - 'query' => [ - 'title' => '查询过滤语句', - 'description' => 'The query filter statement.', - 'type' => 'string', - 'example' => 'job: IT | select name, age, gender from log', - ], + 'project' => ['title' => 'Project 名称', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + 'storeName' => ['title' => 'LogStore 或 MetricStore 名称', 'description' => 'The name of the LogStore or MetricStore.', 'type' => 'string', 'required' => true, 'example' => 'my-logstore'], + 'query' => ['title' => '查询过滤语句', 'description' => 'The query filter statement.', 'type' => 'string', 'example' => 'job: IT | select name, age, gender from log'], ], 'example' => '', ], @@ -6180,53 +2366,16 @@ 'description' => 'Parameters to submit an asynchronous SQL query.', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => 'logstore的名称', - 'description' => 'The name of the logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'query' => [ - 'title' => '待执行的SQL内容', - 'description' => 'The SQL statement to execute.', - 'type' => 'string', - 'required' => true, - 'example' => 'job: IT | select name, age, gender from log', - ], - 'from' => [ - 'title' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', - 'description' => 'The start of the query time range. This time is the log time specified when the log was written. The time range defined by the from and to parameters is left-inclusive and right-exclusive. This means the time range includes the start time but excludes the end time. If the from and to values are the same, the time range is invalid and the function returns an error. The value is a UNIX timestamp in seconds since 00:00:00 UTC on January 1, 1970.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268100', - ], - 'to' => [ - 'title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', - 'description' => 'The end of the query time range. This time is the log time specified when the log was written. The time range defined by the from and to parameters is left-inclusive and right-exclusive. This means the time range includes the start time but excludes the end time. If the from and to values are the same, the time range is invalid and the function returns an error. The value is a UNIX timestamp in seconds since 00:00:00 UTC on January 1, 1970.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268200', - ], + 'logstore' => ['title' => 'logstore的名称', 'description' => 'The name of the logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], + 'query' => ['title' => '待执行的SQL内容', 'description' => 'The SQL statement to execute.', 'type' => 'string', 'required' => true, 'example' => 'job: IT | select name, age, gender from log'], + 'from' => ['title' => '查询开始时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', 'description' => 'The start of the query time range. This time is the log time specified when the log was written. The time range defined by the from and to parameters is left-inclusive and right-exclusive. This means the time range includes the start time but excludes the end time. If the from and to values are the same, the time range is invalid and the function returns an error. The value is a UNIX timestamp in seconds since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268100'], + 'to' => ['title' => '查询结束时间点。该时间是指写入日志数据时指定的日志时间。 请求参数 from 和 to 定义的时间区间遵循左闭右开原则，即该时间区间包括区间开始时间点，但不包括区间结束时间点。如果 from 和 to 的值相同，则为无效区间，函数直接返回错误。 Unix 时间戳格式，表示从 1970-1-1 00:00:00 UTC 计算起的秒数。', 'description' => 'The end of the query time range. This time is the log time specified when the log was written. The time range defined by the from and to parameters is left-inclusive and right-exclusive. This means the time range includes the start time but excludes the end time. If the from and to values are the same, the time range is invalid and the function returns an error. The value is a UNIX timestamp in seconds since 00:00:00 UTC on January 1, 1970.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200'], 'extensions' => [ 'title' => '扩展项', 'type' => 'object', 'properties' => [ - 'maxRunTime' => [ - 'title' => '允许请求执行的最大时间（单位毫秒），当前设置的允许最大执行时间不得超过600000（即10分钟），默认值为600000', - 'description' => 'The maximum running time for the request in milliseconds. Maximum value: 600,000 (10 minutes). Default value: 600,000.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000', - ], - 'powerSql' => [ - 'title' => '是否开启增强SQL，默认为false', - 'description' => 'Specifies whether to enable enhanced SQL. The default value is false.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'maxRunTime' => ['title' => '允许请求执行的最大时间（单位毫秒），当前设置的允许最大执行时间不得超过600000（即10分钟），默认值为600000', 'description' => 'The maximum running time for the request in milliseconds. Maximum value: 600,000 (10 minutes). Default value: 600,000.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000'], + 'powerSql' => ['title' => '是否开启增强SQL，默认为false', 'description' => 'Specifies whether to enable enhanced SQL. The default value is false.', 'type' => 'boolean', 'example' => 'true'], ], 'description' => 'Extensions.', 'example' => '', @@ -6240,49 +2389,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'id' => [ - 'title' => '模板ID', - 'description' => 'The ID of the template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'sls.app.ack.ip.not_enough', - ], - 'type' => [ - 'title' => '模板类型', - 'description' => 'The type of the template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'sys', - ], - 'version' => [ - 'title' => '模板版本', - 'description' => 'The version of the template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '1', - ], - 'lang' => [ - 'title' => '模板语言', - 'description' => 'The language of the template.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'cn', - ], - 'tokens' => [ - 'title' => '模板携带的token', - 'description' => 'The tokens that are carried by the template.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - 'required' => false, - ], - 'aonotations' => [ - 'title' => '模板标注', - 'description' => 'The annotations of the template.'."\n", - 'visibility' => 'Public', - 'type' => 'object', - ], + 'id' => ['title' => '模板ID', 'description' => 'The ID of the template.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'sls.app.ack.ip.not_enough'], + 'type' => ['title' => '模板类型', 'description' => 'The type of the template.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'sys'], + 'version' => ['title' => '模板版本', 'description' => 'The version of the template.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '1'], + 'lang' => ['title' => '模板语言', 'description' => 'The language of the template.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'cn'], + 'tokens' => ['title' => '模板携带的token', 'description' => 'The tokens that are carried by the template.'."\n", 'visibility' => 'Public', 'type' => 'object', 'required' => false], + 'aonotations' => ['title' => '模板标注', 'description' => 'The annotations of the template.'."\n", 'visibility' => 'Public', 'type' => 'object'], ], ], 'Ticket' => [ @@ -6290,405 +2402,86 @@ 'description' => 'The ticket information.', 'type' => 'object', 'properties' => [ - 'ticketId' => [ - 'title' => 'ticket对应唯一Id', - 'type' => 'string', - 'example' => 'xxxxx', - 'description' => '', - ], - 'ticket' => [ - 'title' => 'ticket', - 'type' => 'string', - 'example' => 'xxxxx', - 'description' => '', - ], - 'number' => [ - 'title' => 'ticket最大使用次数', - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '1', - 'description' => '', - ], - 'expirationTime' => [ - 'title' => 'ticket过期时间，秒为单位', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'description' => '', - ], - 'extra' => [ - 'title' => '扩展字段', - 'type' => 'string', - 'example' => '{"xx":"yy"}', - 'description' => '', - ], - 'callerUid' => [ - 'title' => 'ticket创建时的Uid', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000000000', - 'description' => '', - ], - 'name' => [ - 'title' => '名称', - 'type' => 'string', - 'example' => '测试', - 'description' => '', - ], - 'usedNumber' => [ - 'title' => 'ticket已使用次数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'description' => '', - ], - 'createDate' => [ - 'title' => 'ticket创建时间', - 'type' => 'string', - 'example' => '2023-09-06 14:57:07', - 'description' => '', - ], - 'expireDate' => [ - 'title' => 'ticket过期时间', - 'type' => 'string', - 'example' => '2023-09-06 14:58:07', - 'description' => '', - ], - 'valid' => [ - 'title' => '是否禁止', - 'type' => 'boolean', - 'example' => 'false', - 'description' => '', - ], - 'sharingTo' => [ - 'title' => '分享对象', - 'type' => 'string', - 'example' => '{"type":"aliyun","ids":[1,2]}', - 'description' => '', - ], + 'ticketId' => ['title' => 'ticket对应唯一Id', 'type' => 'string', 'description' => '', 'example' => 'xxxxx'], + 'ticket' => ['title' => 'ticket', 'type' => 'string', 'description' => '', 'example' => 'xxxxx'], + 'number' => ['title' => 'ticket最大使用次数', 'type' => 'integer', 'description' => '', 'example' => '1', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '0'], + 'expirationTime' => ['title' => 'ticket过期时间，秒为单位', 'type' => 'integer', 'description' => '', 'example' => '100', 'format' => 'int64'], + 'extra' => ['title' => '扩展字段', 'type' => 'string', 'description' => '', 'example' => '{"xx":"yy"}'], + 'callerUid' => ['title' => 'ticket创建时的Uid', 'type' => 'integer', 'description' => '', 'example' => '1000000000', 'format' => 'int64'], + 'name' => ['title' => '名称', 'type' => 'string', 'description' => '', 'example' => '测试'], + 'usedNumber' => ['title' => 'ticket已使用次数', 'type' => 'integer', 'description' => '', 'example' => '1', 'format' => 'int32'], + 'createDate' => ['title' => 'ticket创建时间', 'type' => 'string', 'description' => '', 'example' => '2023-09-06 14:57:07'], + 'expireDate' => ['title' => 'ticket过期时间', 'type' => 'string', 'description' => '', 'example' => '2023-09-06 14:58:07'], + 'valid' => ['title' => '是否禁止', 'type' => 'boolean', 'description' => '', 'example' => 'false'], + 'sharingTo' => ['title' => '分享对象', 'type' => 'string', 'description' => '', 'example' => '{"type":"aliyun","ids":[1,2]}'], ], 'example' => '', ], ], ], 'apis' => [ - 'AddMemories' => [ - 'path' => '/memorystores/{memoryStore}/memories', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - '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', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'messages' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'role' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'properties' => [], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'user_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'agent_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'app_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'run_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'infer' => [ - 'type' => 'boolean', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'custom_instructions' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'results' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'message' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'status' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'eventId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'title' => '', - 'description' => '', - 'example' => '', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => 'Adds memories.', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"results\\": [\\n {\\n \\"message\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"eventId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'AddMemories', - ], 'ApplyConfigToMachineGroup' => [ 'summary' => 'Applies a Logtail configuration to a machine group.', 'path' => '/machinegroups/{machineGroup}/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, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the machine group.', - 'type' => 'string', - 'required' => true, - 'example' => 'sample-group', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'sample-group', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logtail configuration.', - 'type' => 'string', - 'required' => true, - 'example' => 'logtail-config-sample', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'ApplyConfigToMachineGroup', 'description' => '- The Host consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.'."\n" ."\n" - .'- Create an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).
'."\n" - .' An AccessKey pair for an Alibaba Cloud account provides full access to all API operations. This poses a security risk. For security reasons, we recommend that you create and use a RAM user for API access or routine O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).
'."\n" + .'- Create an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).
An AccessKey pair for an Alibaba Cloud account provides full access to all API operations. This poses a security risk. For security reasons, we recommend that you create and use a RAM user for API access or routine O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).
'."\n" ."\n" .'- Identify the name and region of the project. For more information, see [Manage projects](~~48984~~).'."\n" ."\n" @@ -6714,56 +2507,33 @@ '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}'], ], ], ], ], ], 'CallAiTools' => [ - 'summary' => 'Calls observable AI tools. The capabilities of these tools are continuously updated. You can call the tool list API to retrieve the currently supported capabilities.', + 'summary' => 'Invokes an observability AI tool. Tool capabilities are continuously updated. You can call the tool list operation to retrieve the currently supported capabilities.', 'path' => '/ml/tool/call', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => [ [ @@ -6773,37 +2543,20 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'toolName' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'toolName' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], 'params' => [ + 'description' => 'The tool parameters.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => 'Tool parameters.', - 'title' => '', 'required' => false, - 'example' => '', - ], - 'regionId' => [ - 'type' => 'string', - 'description' => 'The target region.', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'title' => '', - 'required' => false, 'example' => '', ], + 'regionId' => ['description' => 'The target region.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, 'description' => '', 'title' => '', - 'required' => false, 'example' => '', ], ], @@ -6812,60 +2565,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' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'CallAiTools', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Invoke an observability AI tool capability', + 'description' => 'This operation is available only at the endpoints in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -6873,76 +2596,107 @@ 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"\\"\\"","type":"json"}]', ], + 'CancelDownloadJob' => [ + 'summary' => 'Cancel Download', + 'path' => '/downloadjobs/{downloadJobName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '217895', + 'abilityTreeNodes' => ['FEATUREsls1J4K38'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'Project name', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'downloadJobName', + 'in' => 'path', + 'schema' => ['description' => 'Log download job name', 'type' => 'string', 'required' => true, 'example' => 'download-123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Cancel Log Download Job', + 'description' => 'Currently supported region: Heyuan', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], 'ChangeResourceGroup' => [ 'summary' => 'Changes the resource group to which a resource belongs.', 'path' => '/resourcegroup', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => '', - 'description' => 'The project to which the resource belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project to which the resource belongs.', 'type' => 'string', 'example' => 'ali-test-project', 'title' => '', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request struct.'."\n", + 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'description' => 'The type of the resource. Only PROJECT is supported. Set the value to PROJECT.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PROJECT', - 'default' => 'PROJECT', - 'title' => '', - ], - 'resourceId' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rg-ae******ey', - 'title' => '', - ], + 'resourceType' => ['description' => 'The type of the resource. Only PROJECT is supported. Set the value to PROJECT.', 'type' => 'string', 'required' => false, 'example' => 'PROJECT', 'default' => 'PROJECT', 'title' => ''], + 'resourceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-ae******ey', 'title' => ''], ], 'required' => false, 'example' => 'ali-test-project', @@ -6954,40 +2708,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'], ], ], ], @@ -7005,17 +2741,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}'], ], ], ], @@ -7024,73 +2753,38 @@ 'ConsumerGroupHeartBeat' => [ 'summary' => 'A consumer sends a heartbeat to the server to maintain its active status.', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}?type=heartbeat', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - 'http', - ], + '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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the consumer group. The name must be unique within a project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'consumer_group_test', - ], + 'schema' => ['description' => 'The name of the consumer group. The name must be unique within a project.', 'type' => 'string', 'required' => true, 'example' => 'consumer_group_test', 'title' => ''], ], [ 'name' => 'consumer', 'in' => 'query', - 'schema' => [ - 'description' => 'The consumer.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'consumer_1', - ], + 'schema' => ['description' => 'The consumer.', 'type' => 'string', 'required' => true, 'example' => 'consumer_1', 'title' => ''], ], [ 'name' => 'body', @@ -7099,14 +2793,7 @@ 'schema' => [ 'description' => 'The list of shard IDs that are being consumed.', 'type' => 'array', - 'items' => [ - 'description' => 'The list of shard IDs that are being consumed.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '[0]', - ], + 'items' => ['description' => 'The list of shard IDs that are being consumed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[0]', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', @@ -7117,46 +2804,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' => 'The list of all shard IDs that are consumed by the consumer.', 'type' => 'array', - 'items' => [ - 'description' => 'The list of all shard IDs that are consumed by the consumer.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '[0]', - ], + 'items' => ['description' => 'The list of all shard IDs that are consumed by the consumer.', 'type' => 'integer', 'format' => 'int32', 'example' => '[0]', 'title' => ''], 'title' => '', 'example' => '', ], @@ -7205,18 +2871,10 @@ 'action' => 'log:ConsumerGroupHeartBeat', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -7225,20 +2883,14 @@ 'ConsumerGroupUpdateCheckPoint' => [ 'summary' => 'Updates the checkpoint of a shard for a consumer group.', '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, @@ -7247,92 +2899,48 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '155573', - 'abilityTreeNodes' => [ - 'FEATUREslsD1VSU4', - ], + 'abilityTreeNodes' => ['FEATUREslsD1VSU4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the consumer group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'consumer_group_test', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'consumer_group_test', 'title' => ''], ], [ 'name' => 'consumer', 'in' => 'query', - 'schema' => [ - 'description' => 'The consumer.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'consumer_1', - 'title' => '', - ], + 'schema' => ['description' => 'The consumer.', 'type' => 'string', 'required' => true, 'example' => 'consumer_1', 'title' => ''], ], [ 'name' => 'forceSuccess', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable forceful updates. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable forceful updates. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the shards.'."\n", + 'description' => 'The IDs of the shards.', 'type' => 'object', 'properties' => [ - 'shard' => [ - 'description' => 'The ID of the shard.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - 'title' => '', - ], - 'checkpoint' => [ - 'description' => 'The value of the checkpoint.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng==', - 'title' => '', - ], + 'shard' => ['description' => 'The ID of the shard.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + 'checkpoint' => ['description' => 'The value of the checkpoint.', 'type' => 'string', 'required' => true, 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng==', 'title' => ''], ], 'required' => false, 'title' => '', @@ -7344,56 +2952,38 @@ 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' => 'ConsumerGroupUpdateCheckPoint', - 'description' => '* If you do not specify a consumer, you must set **forceSuccess** to **true**. Otherwise, the checkpoint cannot be updated.'."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + 'description' => '- If you do not specify a consumer, you must set **forceSuccess** to **true**. Otherwise, the checkpoint cannot be updated.'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).', + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | InvalidShardCheckPoint| shard checkpoint not encoded by base64. |checkpoint不是Base64编码，格式错误。 |'."\n" @@ -7416,18 +3006,10 @@ 'action' => 'log:ConsumerGroupUpdateCheckPoint', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -7435,20 +3017,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, @@ -7457,9 +3033,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '233752', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -7473,20 +3047,8 @@ 'configType' => [ 'description' => 'The type of the process-level configuration.', 'enumValueTitles' => [ - 'apm_biz_trace' => 'apm\\_biz\\_trace', - 'apm_self_protect' => 'apm\\_self\\_protect', - 'apm_convergence' => 'apm\\_convergence', - 'apm_custom_extract' => 'apm\\_custom\\_extract', - 'apm_pilot' => 'apm\\_pilot', - 'apm_trace' => 'apm\\_trace', - 'rum_app_config' => 'rum\\_app\\_config', - 'security_rasp' => 'security\\_rasp', - 'rum_web_config' => 'rum\\_web\\_config', - 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', - 'apm_intacheap' => 'apm\\_intacheap', - 'apm_user_method' => 'apm\\_user\\_method', - 'apm_global' => 'apm\\_global', - 'apm_forward_process' => 'apm\\_forward\\_process', + 'apm_biz_trace' => 'apm\\_biz\\_trace', 'apm_self_protect' => 'apm\\_self\\_protect', 'apm_convergence' => 'apm\\_convergence', 'apm_custom_extract' => 'apm\\_custom\\_extract', 'apm_pilot' => 'apm\\_pilot', 'apm_trace' => 'apm\\_trace', 'rum_app_config' => 'rum\\_app\\_config', 'security_rasp' => 'security\\_rasp', 'rum_web_config' => 'rum\\_web\\_config', 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', + 'apm_intacheap' => 'apm\\_intacheap', 'apm_user_method' => 'apm\\_user\\_method', 'apm_global' => 'apm\\_global', 'apm_forward_process' => 'apm\\_forward\\_process', ], 'type' => 'string', 'required' => true, @@ -7495,34 +3057,17 @@ ], 'attributes' => [ 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The process to which the configuration applies.', - 'type' => 'string', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The process to which the configuration applies.', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"', 'title' => ''], 'description' => 'The process that the configuration applies to.', 'required' => false, 'title' => '', 'example' => '', ], - 'config' => [ - 'description' => 'The default configurations.', - 'type' => 'string', - 'required' => true, - 'example' => '{}', - 'title' => '', - ], + 'config' => ['description' => 'The default configurations.', 'type' => 'string', 'required' => true, 'example' => '{}', 'title' => ''], 'grayConfigs' => [ 'type' => 'array', - 'items' => [ - 'description' => 'The canary release environment.', - '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The canary release environment.', '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', 'required' => false, 'title' => '', 'example' => ''], 'description' => 'The canary release environment.', 'required' => false, 'title' => '', @@ -7540,47 +3085,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' => 'CreateAgentInstanceConfig', 'summary' => 'Creates a process-level configuration.', 'changeSet' => [], @@ -7593,86 +3118,41 @@ 'CreateAlert' => [ 'summary' => 'Creates an alert rule in a 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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations of the alert rule.'."\n", + 'description' => 'The configurations of the alert rule.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the alert rule. Make sure that the name is unique in a project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'alert-123456', - 'title' => '', - ], - 'displayName' => [ - 'description' => 'The display name of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-alert', - 'title' => '', - ], - 'description' => [ - 'description' => 'The description of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '一条告警规则', - 'title' => '', - ], - 'configuration' => [ - 'description' => 'The detailed configurations of the alert rule.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/AlertConfiguration', - 'title' => '', - 'example' => '', - ], - 'schedule' => [ - 'description' => 'The scheduling configurations of the alert rule.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - 'title' => '', - 'example' => '', - ], + 'name' => ['description' => 'The name of the alert rule. Make sure that the name is unique in a project.', 'type' => 'string', 'required' => true, 'example' => 'alert-123456', 'title' => ''], + 'displayName' => ['description' => 'The display name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'test-alert', 'title' => ''], + 'description' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'An alert rule', 'required' => false, 'title' => ''], + 'configuration' => ['description' => 'The detailed configurations of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration', 'title' => '', 'example' => ''], + 'schedule' => ['description' => 'The scheduling configurations of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -7683,54 +3163,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' => 'CreateAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" @@ -7751,116 +3205,67 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'translator' => 'manual', ], 'CreateAnnotationDataSet' => [ 'summary' => 'Creates a dataset.', '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' => 'The data structure of the request.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/MLDataSetParam', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The request struct for the dataset.', '$ref' => '#/components/schemas/MLDataSetParam', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'datasetId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the dataset.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - 'title' => '', - ], + 'schema' => ['description' => 'The unique identifier of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'CreateAnnotationDataSet', + 'title' => 'Create a dataset', + 'description' => 'This operation is available only at the China (Shanghai) and Singapore endpoints.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -7870,89 +3275,49 @@ 'CreateAnnotationLabel' => [ 'summary' => 'Creates an annotation label table.', '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' => 'The struct of the annotation label table.', - 'required' => false, - '$ref' => '#/components/schemas/MLLabelParam', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The struct of the annotation label table.', '$ref' => '#/components/schemas/MLLabelParam', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'CreateAnnotationLabel', 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', @@ -7961,47 +3326,31 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'CreateAzureBlobIngestion' => [ 'summary' => 'Creates an Azure BLOB ingestion task.', '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' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'body', @@ -8010,39 +3359,11 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'displayName' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'schedule' => [ - '$ref' => '#/components/schemas/Schedule', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'configuration' => [ - 'required' => true, - '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'name' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'displayName' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + 'schedule' => ['$ref' => '#/components/schemas/Schedule', 'description' => '', 'title' => '', 'example' => ''], + 'configuration' => ['required' => true, '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', 'description' => '', 'title' => '', 'example' => ''], + 'name' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'description' => '', @@ -8055,76 +3376,48 @@ 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' => 'CreateAzureBlobIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'CreateAzureBlobIngestion', ], 'CreateConfig' => [ 'summary' => 'Creates a Logtail configuration.', '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, @@ -8133,78 +3426,40 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8979', - 'abilityTreeNodes' => [ - 'FEATUREslsYP6SBU', - ], + 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => 'The body of the request.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/LogtailConfig', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The body of the request.', '$ref' => '#/components/schemas/LogtailConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -8217,14 +3472,17 @@ 'title' => 'CreateConfig', 'description' => '### [](#)Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~).'."\n" - .'* You can create up to 100 Logtail configurations in a project.'."\n" - .'* The Logtail configuration is planned out. For more information, see [Logtail configurations](~~29058~~).'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~).'."\n" + ."\n" + .'- You can create up to 100 Logtail configurations in a project.'."\n" + ."\n" + .'- The Logtail configuration is planned out. For more information, see [Logtail configurations](~~29058~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -8244,18 +3502,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}'], ], ], ], @@ -8264,88 +3514,50 @@ 'CreateConsumerGroup' => [ 'summary' => 'Creates a consumer group for a 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' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore', 'title' => ''], ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The information about the consumer group.'."\n", + 'description' => 'The information about the consumer group.', 'type' => 'object', 'properties' => [ - 'consumerGroup' => [ - 'description' => 'The name of the consumer group. The name must be unique in a project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'consumerGroupX', - 'title' => '', - ], - 'timeout' => [ - 'description' => 'The timeout period. If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '300', - 'title' => '', - ], - 'order' => [ - 'description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' * In a shard, data is consumed in ascending order based on the value of the \\*\\*\\__tag\\_\\_:\\__receive_time\\_\\_\\*\\* field.'."\n" - .' * If a shard is split, data in the original shard is consumed first. Then, data in the new shards is consumed at the same time.'."\n" - .' * If shards are merged, data in the original shards is consumed first. Then, data in the new shard is consumed.'."\n" - ."\n" - .'* false Data in all shards is consumed at the same time. If a new shard is generated after a shard is split or after shards are merged, data in the new shard is immediately consumed.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'title' => '', - ], + 'consumerGroup' => ['description' => 'The name of the consumer group. The name must be unique in a project.', 'type' => 'string', 'required' => true, 'example' => 'consumerGroupX', 'title' => ''], + 'timeout' => ['description' => 'The timeout period. If the server does not receive heartbeats from a consumer within the timeout period, the server deletes the consumer. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '300', 'title' => ''], + 'order' => ['description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .' - In a shard, data is consumed in ascending order based on the value of the \\*\\*\\_\\_tag\\_\\_:\\_\\_receive\\_time\\_\\_\\*\\* field.'."\n" + ."\n" + .' - If a shard is split, data in the original shard is consumed first. Then, data in the new shards is consumed at the same time.'."\n" + ."\n" + .' - If shards are merged, data in the original shards is consumed first. Then, data in the new shard is consumed.'."\n" + ."\n" + .'- false Data in all shards is consumed at the same time. If a new shard is generated after a shard is split or after shards are merged, data in the new shard is immediately consumed.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], 'required' => true, 'title' => '', @@ -8357,46 +3569,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'], ], ], ], @@ -8405,22 +3593,25 @@ 'title' => 'CreateConsumerGroup', 'description' => '### Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* You can create up to 30 consumer groups for a Logstore. The name of a consumer group must be unique in a project.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- You can create up to 30 consumer groups for a Logstore. The name of a consumer group must be unique in a project.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - .'* Simple Log Service provides examples of both regular log consumption and consumer group-based log consumption by using Simple Log Service SDK for Java. For more information, see [Consume log data](~~120035~~) and [Use consumer groups to consume data](~~28998~~).'."\n" + .'- Simple Log Service provides examples of both regular log consumption and consumer group-based log consumption by using Simple Log Service SDK for Java. For more information, see [Consume log data](~~120035~~) and [Use consumer groups to consume data](~~28998~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:CreateConsumerGroup`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}`|', + .'| Action | Resource |'."\n" + .'| :------------------------ | :---------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `log:CreateConsumerGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -8441,18 +3632,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}'], ], ], ], @@ -8461,100 +3644,55 @@ 'CreateDashboard' => [ 'summary' => 'Creates a dashboard.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', - 'schema' => [ - 'description' => 'The data structure of the dashboard.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/dashboard', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The data structure of the dashboard.', 'required' => true, '$ref' => '#/components/schemas/dashboard', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -8567,12 +3705,13 @@ 'title' => 'CreateDashboard', 'description' => '### [](#)Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -8584,166 +3723,45 @@ 'action' => 'log:CreateDashboard', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], - ], - 'CreateDataset' => [ - 'summary' => 'Creates a dataset.', - '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' => [ - 'description' => 'A short description of struct', - 'type' => 'string', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'schema' => [ - 'type' => 'object', - 'additionalProperties' => [ - '$ref' => '#/components/schemas/IndexKey', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', - 'title' => '', - 'example' => '', ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'CreateDataset', ], 'CreateDomain' => [ 'summary' => 'Binds a new custom domain name to a 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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The information about the domain name.'."\n", + 'description' => 'The information about the domain name.', 'type' => 'object', 'properties' => [ - 'domainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - 'title' => '', - ], + 'domainName' => ['description' => 'The domain name.', 'type' => 'string', 'required' => true, 'example' => 'example.com', 'title' => ''], ], 'required' => true, 'title' => '', @@ -8755,53 +3773,29 @@ 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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateDomain', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 403 | ExceedQuota| domain quota exceed. | 域名创建达到上限，目前最多只支持绑定一个域名。 |'."\n" @@ -8819,18 +3813,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}'], ], ], ], @@ -8839,42 +3825,27 @@ 'CreateDownloadJob' => [ 'summary' => 'Creates a log download task in a specified 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' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'body', @@ -8885,84 +3856,40 @@ 'description' => 'The configuration of the log download task.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => 'The name of the job. The name must meet the following requirements:'."\n" - ."\n" - .'The job name must be unique within a project.'."\n" - ."\n" - .'- It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'- It must start and end with a lowercase letter or a digit.'."\n" - ."\n" - .'- The name must be 2 to 64 characters in length.', - 'type' => 'string', - 'required' => true, - 'example' => 'download-123', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the log download task.', - 'type' => 'string', - 'required' => false, - 'example' => 'Log download task', - ], + 'name' => ['description' => 'The name of the job. The name must meet the following requirements:'."\n" + ."\n" + .'The job name must be unique within a project.'."\n" + ."\n" + .'- It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- It must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'download-123'], + 'description' => ['description' => 'The description of the log download task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Log download task'], 'configuration' => [ 'title' => '', 'description' => 'The download configuration.', 'type' => 'object', 'properties' => [ - 'logstore' => [ - 'title' => '', - 'description' => 'The source Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - 'fromTime' => [ - 'title' => '', - 'description' => 'The start time. This is a UNIX timestamp that is accurate to the second.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1722406260', - ], - 'toTime' => [ - 'title' => '', - 'description' => 'The end time. This is a UNIX timestamp that is accurate to the second.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1722409860', - ], - 'query' => [ - 'title' => '', - 'description' => 'The search statement.', - 'type' => 'string', - 'required' => true, - 'example' => '* | select *', - ], + 'logstore' => ['description' => 'The source Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-logstore'], + 'fromTime' => ['description' => 'The start time. This is a UNIX timestamp that is accurate to the second.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1722406260'], + 'toTime' => ['description' => 'The end time. This is a UNIX timestamp that is accurate to the second.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1722409860'], + 'query' => ['description' => 'The search statement.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '* | select *'], 'powerSql' => [ - 'title' => '', 'description' => 'Specifies whether to enable PowerSQL. Valid values: \\`true\\` and \\`false\\`.', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'Yes', - 'false' => 'No', - ], + 'title' => '', 'example' => 'true', ], 'allowInComplete' => [ 'description' => 'Specifies whether to allow the download of incomplete results. Valid values: \\`true\\` and \\`false\\`.', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], 'type' => 'boolean', 'required' => true, - 'enumValueTitles' => [ - 'true' => 'Yes', - 'false' => 'No', - ], - 'title' => '', 'example' => 'false', + 'title' => '', ], 'sink' => [ 'title' => '', @@ -8971,59 +3898,31 @@ 'properties' => [ 'type' => [ 'description' => 'The type of the destination. Set the value to \\`AliyunOSS\\`.', + 'enumValueTitles' => ['AliyunOSS' => 'AliyunOSS'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'AliyunOSS' => 'AliyunOSS', - ], - 'title' => '', 'example' => 'AliyunOSS', + 'title' => '', ], 'contentType' => [ - 'title' => '', 'description' => 'The format of the downloaded file. Valid values: \\`csv\\` and \\`json\\`.', + 'enumValueTitles' => ['csv' => 'The file is in CSV format.', 'json' => 'The file is in JSON format.'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'csv' => 'The file is in CSV format.', - 'json' => 'The file is in JSON format.', - ], + 'title' => '', 'example' => 'csv', ], 'compressionType' => [ - 'title' => '', 'description' => 'The compression format of the file. Valid values: \\`zstd\\`, \\`lz4\\`, \\`gzip\\`, and \\`none\\`.', + 'enumValueTitles' => ['zstd' => 'The file is compressed using zstd.', 'lz4' => 'The file is compressed using lz4.', 'gzip' => 'The file is compressed using gzip.', 'none' => 'The file is not compressed.'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'zstd' => 'The file is compressed using zstd.', - 'lz4' => 'The file is compressed using lz4.', - 'gzip' => 'The file is compressed using gzip.', - 'none' => 'The file is not compressed.', - ], - 'example' => 'none', - ], - 'roleArn' => [ - 'title' => '', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role to use for the download.', - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole', - ], - 'bucket' => [ - 'title' => '', - 'description' => 'The destination Object Storage Service (OSS) bucket.', - 'type' => 'string', - 'required' => false, - 'example' => 'oss-test-bucket', - ], - 'prefix' => [ - 'description' => 'The prefix of the path in the destination OSS bucket.', - 'type' => 'string', - 'required' => false, 'title' => '', - 'example' => 'download/', + 'example' => 'none', ], + 'roleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role to use for the download.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole'], + 'bucket' => ['description' => 'The destination Object Storage Service (OSS) bucket.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'oss-test-bucket'], + 'prefix' => ['description' => 'The prefix of the path in the destination OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'download/', 'title' => ''], ], 'required' => true, 'example' => '', @@ -9032,13 +3931,7 @@ 'required' => true, 'example' => '', ], - 'displayName' => [ - 'title' => '', - 'description' => 'The display name.', - 'type' => 'string', - 'required' => true, - 'example' => 'download-123456789', - ], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'download-123456789'], ], 'required' => true, 'example' => '', @@ -9049,52 +3942,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' => 'CreateDownloadJob', + 'extraInfo' => '下载数据量限制'."\n" + ."\n" + .'- 仅查询：华东1（杭州）、华东2（上海）、华北2（北京）、华南1（深圳）和新加坡地域最多支持下载2000万行数据，其他地域最多支持下载100万行数据。数据量不超过20 GB。'."\n" + ."\n" + .'- SQL分析：最多支持下载100万行数据。数据量不超过2GB。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -9104,42 +3981,27 @@ 'CreateETL' => [ 'summary' => 'Creates a data transformation job in a specified 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' => 'The project name.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', @@ -9149,42 +4011,18 @@ 'description' => 'The configuration of the data transformation job.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The job name. The naming convention is as follows:'."\n" - ."\n" - .'The job name must be unique within the project.'."\n" - ."\n" - .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'- The name must start and end with a lowercase letter or a digit.'."\n" - ."\n" - .'- The length must be 2 to 64 characters.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'etl-123456', - ], - 'displayName' => [ - 'description' => 'The display name of the data transformation job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'sls-test-etl', - ], - 'description' => [ - 'description' => 'The description of the data transformation job.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'this is ETL', - ], - 'configuration' => [ - 'description' => 'The detailed configuration of the data transformation job.', - 'required' => true, - '$ref' => '#/components/schemas/ETLConfiguration', - 'title' => '', - 'example' => '', - ], + 'name' => ['description' => 'The job name. The naming convention is as follows:'."\n" + ."\n" + .'The job name must be unique within the project.'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- The name must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- The length must be 2 to 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'etl-123456', 'title' => ''], + 'displayName' => ['description' => 'The display name of the data transformation job.', 'type' => 'string', 'required' => true, 'example' => 'sls-test-etl', 'title' => ''], + 'description' => ['description' => 'The description of the data transformation job.', 'type' => 'string', 'required' => false, 'example' => 'this is ETL', 'title' => ''], + 'configuration' => ['description' => 'The detailed configuration of the data transformation job.', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -9196,45 +4034,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"}]', @@ -9320,56 +4139,209 @@ ], 'ramActions' => [], ], - 'CreateIndex' => [ - 'path' => '/logstores/{logstore}/index', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateElasticsearchIngestion' => [ + 'path' => '/elasticsearchingestions', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'chargeType' => 'paid', - 'abilityTreeCode' => '8963', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeCode' => '273937', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ - 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-logstore-test', + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'description' => 'The description of the job.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'es ingestion', + 'title' => '', + ], + 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'es ingestion'."\n", 'title' => ''], + 'schedule' => ['description' => 'The schedule structure.', '$ref' => '#/components/schemas/Schedule', 'required' => false, 'title' => '', 'example' => ''], + 'configuration' => ['description' => 'The configuration for the ES or OpenSearch import job.', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The unique identifier of the ES or OpenSearch import job.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch- 123456-123', 'title' => ''], + ], + 'description' => 'The request body.', 'title' => '', + 'example' => '', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], + ], ], ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateElasticsearchIngestion', + 'summary' => 'Creates an ES or OpenSearch import job.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'CreateGCSIngestion' => [ + 'path' => '/gcsingestions', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], + ], + 'parameters' => [ [ 'name' => 'project', 'in' => 'host', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'."\n"], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-project-test', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The task description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + 'configuration' => ['description' => 'The ingestion configuration.', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The job name. Must be unique within the same project. Naming rules:'."\n" + ."\n" + .'- Can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- Must start and end with a lowercase letter or digit.'."\n" + ."\n" + .'- Must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + ], + 'description' => 'The request body.', + 'required' => false, 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], + ], ], + 'schema' => ['description' => 'The response body.', 'type' => 'any', 'example' => '{}', 'title' => ''], + ], + ], + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateGCSIngestion', + 'summary' => 'Creates a GCS file import task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', + ], + 'CreateIndex' => [ + 'path' => '/logstores/{logstore}/index', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'chargeType' => 'paid', + 'abilityTreeCode' => '8963', + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], + ], + 'parameters' => [ + [ + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-logstore-test', 'title' => ''], + ], + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test', 'title' => ''], ], [ 'name' => 'body', @@ -9386,44 +4358,26 @@ 'additionalProperties' => [ 'type' => 'object', 'properties' => [ - 'caseSensitive' => [ - 'description' => 'Specifies whether to enable case sensitivity. This parameter is required only when **type** is set to **text**. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false (default)', - 'type' => 'boolean', - ], - 'chn' => [ - 'description' => 'Specifies whether to include Chinese characters. This parameter is required only when **type** is set to **text**. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false (default)', - 'type' => 'boolean', - ], - 'type' => [ - 'description' => 'The data type of the field value. Valid values: text, json, double, and long.', - 'type' => 'string', - ], - 'alias' => [ - 'description' => 'The alias of the field.', - 'type' => 'string', - ], + 'caseSensitive' => ['description' => 'Specifies whether to enable case sensitivity. This parameter is required only when **type** is set to **text**. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean'], + 'chn' => ['description' => 'Specifies whether to include Chinese characters. This parameter is required only when **type** is set to **text**. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean'], + 'type' => ['description' => 'The data type of the field value. Valid values: text, json, double, and long.', 'type' => 'string'], + 'alias' => ['description' => 'The alias of the field.', 'type' => 'string'], 'token' => [ 'title' => '', 'description' => 'The delimiters that are used to split text.', 'type' => 'array', - 'items' => [ - 'description' => 'The delimiter.', - 'type' => 'string', - ], + 'items' => ['description' => 'The delimiter.', 'type' => 'string'], 'required' => false, ], - 'doc_value' => [ - 'description' => 'Specifies whether to turn on Enable Analytics for the field.', - 'type' => 'boolean', - ], + 'doc_value' => ['description' => 'Specifies whether to turn on Enable Analytics for the field.', 'type' => 'boolean'], ], 'description' => 'The index configuration of the field.', ], @@ -9433,85 +4387,55 @@ 'description' => 'The configuration of full-text indexes. You must specify this parameter, the keys parameter, or both parameters. For more information, see Example.', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'description' => 'Specifies whether to include Chinese characters. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false (default)', - 'type' => 'boolean', - ], - 'caseSensitive' => [ - 'description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false (default)', - 'type' => 'boolean', - ], + 'chn' => ['description' => 'Specifies whether to include Chinese characters. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean'], + 'caseSensitive' => ['description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default)', 'type' => 'boolean'], 'token' => [ 'title' => '', 'description' => 'The delimiters. You can specify a delimiter to delimit the content of a field value. For more information about delimiters, see Example.', 'type' => 'array', - 'items' => [ - 'description' => 'The delimiter. You can specify a delimiter to delimit the content of a field value. For more information about delimiters, see Example.', - 'type' => 'string', - ], + 'items' => ['description' => 'The delimiter. You can specify a delimiter to delimit the content of a field value. For more information about delimiters, see Example.', 'type' => 'string'], 'required' => true, ], 'include_keys' => [ 'title' => '', 'description' => 'The included fields. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'array', - 'items' => [ - 'description' => 'The included field. You cannot specify both include\\_keys and exclude\\_keys.', - 'type' => 'string', - ], + 'items' => ['description' => 'The included field. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'string'], 'required' => false, ], 'exclude_keys' => [ 'title' => '', 'description' => 'The excluded fields. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'array', - 'items' => [ - 'description' => 'The excluded field. You cannot specify both include\\_keys and exclude\\_keys.', - 'type' => 'string', - ], + 'items' => ['description' => 'The excluded field. You cannot specify both include\\_keys and exclude\\_keys.', 'type' => 'string'], 'required' => false, ], ], 'required' => false, ], - 'ttl' => [ - 'description' => 'The retention period of logs. Unit: days. Valid values: 7, 30, and 90.', - 'type' => 'integer', - ], - 'max_text_len' => [ - 'description' => 'The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of max\\_text\\_len. Valid values: 64 to 16384.', - 'type' => 'integer', - ], - 'log_reduce' => [ - 'description' => 'Specifies whether to turn on LogReduce. After you turn on LogReduce, either the whitelist or blacklist takes effect.', - 'type' => 'boolean', - ], + 'ttl' => ['description' => 'The retention period of logs. Unit: days. Valid values: 7, 30, and 90.', 'type' => 'integer'], + 'max_text_len' => ['description' => 'The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of max\\_text\\_len. Valid values: 64 to 16384.', 'type' => 'integer'], + 'log_reduce' => ['description' => 'Specifies whether to turn on LogReduce. After you turn on LogReduce, either the whitelist or blacklist takes effect.', 'type' => 'boolean'], 'log_reduce_white_list' => [ 'title' => '', 'description' => 'The fields in the whitelist that you want to use to cluster logs.', 'type' => 'array', - 'items' => [ - 'description' => 'The field in the whitelist that you want to use to cluster logs.', - 'type' => 'string', - ], + 'items' => ['description' => 'The field in the whitelist that you want to use to cluster logs.', 'type' => 'string'], 'required' => false, ], 'log_reduce_black_list' => [ 'title' => '', 'description' => 'The fields in the blacklist that you want to use to cluster logs.', 'type' => 'array', - 'items' => [ - 'description' => 'The field in the blacklist that you want to use to cluster logs.', - 'type' => 'string', - ], + 'items' => ['description' => 'The field in the blacklist that you want to use to cluster logs.', 'type' => 'string'], 'required' => false, ], ], @@ -9526,46 +4450,22 @@ 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'], ], ], ], @@ -9586,27 +4486,34 @@ 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateIndex', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], + ], + ], + ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], 'CreateLogStore' => [ 'summary' => 'Creates a Logstore.', 'path' => '/logstores', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -9615,175 +4522,104 @@ 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '115729', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request parameters.', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'logstoreName' => [ - 'description' => 'The name of the Logstore. The name must meet the following requirements:'."\n" - ."\n" - .'- The name must be unique within a project.'."\n" - ."\n" - .'- It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'- It must start and end with a lowercase letter or a digit.'."\n" - ."\n" - .'- It must be 2 to 63 characters in length.', - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - 'title' => '', - ], - 'shardCount' => [ - 'description' => 'The number of shards.'."\n" - ."\n" - .'> You cannot change the number of shards with this operation. To change the number of shards, call the \\`SplitShard\\` or \\`MergeShards\\` operation.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - 'title' => '', - ], - 'ttl' => [ - 'description' => 'The data retention period, in days. Valid values: 1 to 3650. If you set the value to 3650, data is stored permanently.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - 'title' => '', - ], - 'encrypt_conf' => [ - 'description' => 'The data structure of the encryption configuration. The parameters include `enable`, `encrypt_type`, and `user_cmk_info`. For more information, see [EncryptConf](~~409461~~).', - 'required' => false, - '$ref' => '#/components/schemas/EncryptConf', - 'title' => '', - 'example' => '', - ], - 'autoSplit' => [ - 'description' => 'Specifies whether to automatically split shards.'."\n" - ."\n" - .'- true: automatically splits shards.'."\n" - ."\n" - .'- false: does not automatically split shards.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], - 'enable_tracking' => [ - 'description' => 'Specifies whether to enable web tracking. Default value: false.'."\n" - ."\n" - .'- true: enables web tracking.'."\n" - ."\n" - .'- false: disables web tracking.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], - 'maxSplitShard' => [ - 'description' => 'The maximum number of shards that can be created by an automatic split. The value must be between 1 and 256.'."\n" - ."\n" - .'> This parameter is required if you set the autoSplit parameter to true.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - 'title' => '', - ], - 'appendMeta' => [ - 'description' => 'Specifies whether to record the client\'s **public IP address** and the **log reception time**. The default value is false.'."\n" - ."\n" - .'- true: records the public IP address of the client and the time when logs are received. If this feature is enabled, Simple Log Service automatically adds the public IP address of the log source and the server time of log reception to the tag field of the logs.'."\n" - ."\n" - .'- false: does not record the public IP address of the client or the time when logs are received.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], - 'telemetryType' => [ - 'description' => 'The type of observable data. Valid values:'."\n" - ."\n" - .'- **None**: log data. This is the default value.'."\n" - ."\n" - .'- **Metrics**: metrics.', - 'type' => 'string', - 'required' => false, - 'example' => 'None', - 'title' => '', - ], - 'hot_ttl' => [ - 'description' => 'The retention period of data in the hot storage tier of the Logstore, in days. The minimum value is 7. The value cannot be greater than the value of \\`ttl\\`. If you set this parameter to -1, data is permanently stored in the hot tier.'."\n" - ."\n" - .'After the hot tier retention period expires, data is moved to the Infrequent Access (IA) storage class. For more information, see [Automatic Storage Tiering](~~308645~~).', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'example' => '60', - ], - 'mode' => [ - 'description' => 'The Logstore mode. Simple Log Service provides two modes: Standard and Query.'."\n" - ."\n" - .'- **standard**: Supports comprehensive data analytics. This mode is suitable for use cases such as real-time monitoring, interactive analysis, and building a complete observability system.'."\n" - ."\n" - .'- **query**: Supports high-performance queries. The index traffic cost for this mode is about half that of the Standard mode. This mode does not support SQL analysis. It is suitable for use cases that involve large amounts of data, long retention periods, and no log analysis requirements.', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - 'title' => '', - ], - 'infrequentAccessTTL' => [ - 'description' => 'The retention period of data in the Infrequent Access (IA) storage class, in days. The value must be 30 or greater.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'example' => '30', - ], - 'processorId' => [ - 'title' => 'IngestProcessor ID', - 'description' => 'The ID of the ingest processor.', - 'type' => 'string', - 'required' => false, - 'example' => 'processor-nginx-parser-001', - ], - 'shardingPolicy' => [ - 'description' => 'The configuration for hash-based writes.', - '$ref' => '#/components/schemas/ShardingPolicy', - 'title' => '', - 'required' => false, - 'example' => '', - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the resource group.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => '', - ], + 'logstoreName' => ['description' => 'The name of the Logstore. The name must meet the following requirements:'."\n" + ."\n" + .'- The name must be unique within a project.'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- The name must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- The name must be 2 to 63 characters long.', 'type' => 'string', 'required' => true, 'example' => 'my-logstore', 'title' => ''], + 'shardCount' => ['description' => 'The number of shards.'."\n" + ."\n" + .'> You cannot update the shard count with this operation. To do so, call the SplitShard or MergeShards operation.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], + 'ttl' => ['description' => 'The data retention period in days. Valid values: 1 to 3,650. If you set this parameter to 3,650, data is stored permanently.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + 'encrypt_conf' => ['description' => 'The encryption configuration. This data structure includes the `enable`, `encrypt_type`, and `user_cmk_info` parameters. For more information, see [EncryptConf](~~409461~~).'."\n" + ."\n" + .'Example 1 (Enable default encryption):'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "enable": true,'."\n" + .' "encrypt_conf": "default"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'Example 2 (Enable BYOK encryption):'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "enable": true,'."\n" + .' "encrypt_conf": "default",'."\n" + .' "user_cmk_info": {'."\n" + .' "cmk_key_id": "xxxxx",'."\n" + .' "arn": "acs:ram::112340000000:role/rolename",'."\n" + .' "region": "cn-hangzhou"'."\n" + .' }'."\n" + .'}'."\n" + .'```', 'required' => false, '$ref' => '#/components/schemas/EncryptConf', 'title' => '', 'example' => ''], + 'autoSplit' => ['description' => 'Specifies whether to enable automatic shard splitting. If you set this parameter to true, Log Service automatically splits a shard to increase write throughput when the write traffic to the shard continuously exceeds the service limit. If you enable automatic shard splitting, you must also specify `maxSplitShard`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'enable_tracking' => ['description' => 'Specifies whether to enable WebTracking. The default value is false. This feature lets you collect and analyze user behavior data from browsers or mini programs, such as page views, purchase history, and dwell time.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'maxSplitShard' => ['description' => 'The maximum number of shards after an automatic split. The value must be an integer from 1 to 256.'."\n" + ."\n" + .'> This parameter is required if you set `autoSplit` to true.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64', 'title' => ''], + 'appendMeta' => ['description' => 'Specifies whether to record the source **public IP address** and the **server reception time**. Default value: false.'."\n" + ."\n" + .'- true: Log Service automatically appends the public IP address of the source device and the server reception time to the Tag field of logs.'."\n" + ."\n" + .'- false: Log Service does not append the source public IP address or the server reception time.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'telemetryType' => ['description' => 'The type of observable data. Default value: log data. Valid values:'."\n" + ."\n" + .'- **None**: log data. This is the default value.'."\n" + ."\n" + .'- **Metrics**: Metrics data.', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''], + 'hot_ttl' => ['description' => 'The retention period of data in the hot storage tier of the Logstore, in days. The value must be an integer from 7 to the value of `ttl`. If you do not specify this parameter, data is stored in the hot storage tier for the entire data retention period specified by `ttl`.'."\n" + ."\n" + .'After the hot storage retention period expires, data is moved to the Infrequent Access (IA) storage tier. To enable IA storage, you must set the hot storage retention period to at least 7 days. For more information, see [Smart Tiered Storage](~~308645~~).'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'- Scenario 1 (Store data in the hot storage tier for 30 days): `{"ttl": 30}` or `{"ttl": 30, "hot_ttl": 30}`'."\n" + ."\n" + .'- Scenario 2 (Store data in the hot storage tier for 7 days and in the IA storage tier for 23 days): `{"ttl": 30, "hot_ttl": 7}`', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '60'], + 'mode' => ['description' => 'Log Service provides two types of Logstores: standard and query.'."\n" + ."\n" + .'- **standard**: Supports end-to-end data analytics. This mode is suitable for scenarios such as real-time monitoring, interactive analysis, and building a complete observability system.'."\n" + ."\n" + .'- **query**: Supports high-performance queries. The index traffic cost is approximately half that of the standard mode, but SQL analysis is not supported. This mode is suitable for scenarios that involve large volumes of data, long retention periods such as weeks or months, and do not require SQL-based analysis.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], + 'infrequentAccessTTL' => ['description' => 'The retention period for Infrequent Access (IA) storage, in days. While this parameter has no minimum value, data must remain in the IA storage tier for at least 30 days before it can be moved to archive storage.'."\n" + ."\n" + .'If the total retention period (`ttl`) is longer than the sum of the hot storage period (`hot_ttl`) and the IA storage period (`infrequentAccessTTL`), the remaining time is the archive storage period.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'- Scenario 1 (Store data in the hot storage tier for 7 days and in the IA storage tier for 23 days): `{"ttl": 30, "hot_ttl": 7}`'."\n" + ."\n" + .'- Scenario 2 (Store data in the hot storage tier for 7 days, in the IA storage tier for 30 days, and in the archive storage tier for 60 days): `{"ttl": 97, "hot_ttl": 7, "infrequentAccessTTL": 30}`'."\n" + ."\n" + .'- Scenario 3 (Store data in the hot storage tier for 60 days and in the archive storage tier for 60 days, with the IA storage period being 0 days): `{"ttl": 120, "hot_ttl": 60, "infrequentAccessTTL": 0}`', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], + 'processorId' => ['description' => 'The ID of the IngestProcessor.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'processor-nginx-parser-001'], + 'shardingPolicy' => ['description' => 'The configuration for hash-based writes. When you write data, logs are stored in a shard that is selected based on the configured hash-based sharding policy. Before you configure this parameter, make sure that the hash ranges of the shards are evenly distributed. Improper configuration may affect write performance. Configure this parameter with caution.', '$ref' => '#/components/schemas/ShardingPolicy', 'title' => '', 'required' => false, 'example' => ''], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the Logstore belongs.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-xxxxxxxx'], + 'enableModify' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], 'required' => true, 'title' => '', @@ -9795,74 +4631,49 @@ 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' => 'CreateLogStore', 'description' => '### Usage notes'."\n" ."\n" - .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. Specify the project in the Host.'."\n" + .'- The Host header of the request consists of a project name and a Log Service endpoint. You must specify the project in this header.'."\n" ."\n" - .'- Create an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- You must create and obtain an AccessKey. For more information, see [AccessKey](~~29009~~).'."\n" ."\n" - .'An AccessKey pair for an Alibaba Cloud account has full access to all API operations, which poses a high security risk. We recommend that you create and use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" + .'An Alibaba Cloud account\'s AccessKey pair has full permissions for all API operations, which poses a security risk. For enhanced security, we strongly recommend using a RAM user to call API operations or perform routine O\\&M. You must grant the RAM user permissions to manage Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" - .'- Obtain the project name and the region where the project is located. For more information, see [Manage projects](~~48984~~).'."\n" + .'- Ensure you have the name and region of the project where you want to create the Logstore. For more information, see [Manage projects](~~48984~~).'."\n" ."\n" - .'- Each project can contain a maximum of 200 Logstores.'."\n" + .'- You can create a maximum of 200 Logstores in a project.'."\n" ."\n" - .'- Logs are deleted after the specified data retention period expires.'."\n" + .'- Log Service automatically deletes logs after the specified data retention period expires.'."\n" ."\n" .'### Authorization'."\n" ."\n" - .'The following table describes the permissions required for this operation. To grant a RAM user or RAM role the permissions to call this operation, add this information to the Action element of a RAM policy.'."\n" + .'The following table lists the permission required to call this API. To grant this permission to a RAM user or RAM role, add the corresponding Action to a RAM policy statement.'."\n" ."\n" - .'| Action | Resource description in an authorization policy |'."\n" - .'| :------------------- | :--------------------------------------------------------------------------------- |'."\n" - .'| `log:CreateLogStore` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', + .'| Action | Resource |'."\n" + .'| :------------------- | :----------------------------------------------------------------------------- |'."\n" + .'| `log:CreateLogStore` | `acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}` |', 'extraInfo' => "\n" .'| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" @@ -9874,22 +4685,10 @@ ."\n" .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:09.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-12-02T11:55:04.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI offline', - ], + ['createdAt' => '2025-12-03T01:37:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-12-02T11:55:04.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], @@ -9901,61 +4700,37 @@ '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' => 'Enables the service log feature for a 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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', @@ -9963,19 +4738,13 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'loggingProject' => [ - 'title' => '', - 'description' => 'The name of the project to which service logs are stored.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'loggingProject' => ['description' => 'The name of the project to which service logs are stored.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], 'loggingDetails' => [ 'title' => '', - 'description' => 'The configurations of service logs.'."\n", + 'description' => 'The configurations of service logs.', 'type' => 'array', 'items' => [ 'title' => '', @@ -9983,38 +4752,30 @@ 'type' => 'object', 'properties' => [ 'type' => [ - 'title' => '', 'description' => 'The type of service logs. Valid values:'."\n" ."\n" - .'* consumergroup_log: the consumption delay logs of consumer groups.'."\n" - .'* logtail_alarm: the alert logs of Logtail.'."\n" - .'* operation_log: the operation logs.'."\n" - .'* logtail_profile: the collection logs of Logtail.'."\n" - .'* metering: the metering logs.'."\n" - .'* logtail_status: the status logs of Logtail.'."\n" - .'* scheduledsqlalert: the run logs of Scheduled SQL jobs.'."\n" - .'* etl_alert: the run logs of data transformation jobs.'."\n", + .'- consumergroup\\_log: the consumption delay logs of consumer groups.'."\n" + ."\n" + .'- logtail\\_alarm: the alert logs of Logtail.'."\n" + ."\n" + .'- operation\\_log: the operation logs.'."\n" + ."\n" + .'- logtail\\_profile: the collection logs of Logtail.'."\n" + ."\n" + .'- metering: the metering logs.'."\n" + ."\n" + .'- logtail\\_status: the status logs of Logtail.'."\n" + ."\n" + .'- scheduledsqlalert: the run logs of Scheduled SQL jobs.'."\n" + ."\n" + .'- etl\\_alert: the run logs of data transformation jobs.', 'type' => 'string', 'required' => true, 'example' => 'consumergroup_log', - 'enum' => [ - 'consumergroup_log', - 'logtail_alarm', - 'operation_log', - 'logtail_profile', - 'metering', - 'logtail_status', - 'scheduled_sql_alert', - 'etl_alert', - ], - ], - 'logstore' => [ + 'enum' => ['consumergroup_log', 'logtail_alarm', 'operation_log', 'logtail_profile', 'metering', 'logtail_status', 'scheduled_sql_alert', 'etl_alert'], 'title' => '', - 'description' => 'The name of the Logstore to which service logs of the type are stored.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', ], + 'logstore' => ['description' => 'The name of the Logstore to which service logs of the type are stored.', 'type' => 'string', 'required' => true, 'example' => 'my-logstore', 'title' => ''], ], 'required' => false, 'example' => '', @@ -10032,53 +4793,29 @@ 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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateLogging', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -10090,18 +4827,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'], ], ], ], @@ -10110,20 +4839,14 @@ 'CreateLogtailPipelineConfig' => [ 'summary' => 'Creates a Logtail pipeline configuration.', 'path' => '/pipelineconfigs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -10132,21 +4855,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191781', - 'abilityTreeNodes' => [ - 'FEATUREsls9GTH7Z', - ], + 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'body', @@ -10157,53 +4872,27 @@ 'description' => 'The content of the Logtail pipeline configuration.', 'type' => 'object', 'properties' => [ - 'configName' => [ - 'description' => 'The name of the configuration.'."\n" - ."\n" - .'> The configuration name must be unique within the project and cannot be modified after the configuration is created. The name must follow these rules:'."\n" - .'>'."\n" - .'> - It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - .'>'."\n" - .'> - It must start and end with a lowercase letter or a digit.'."\n" - .'>'."\n" - .'> - It must be 2 to 128 characters in length.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', - 'title' => '', - ], - 'logSample' => [ - 'description' => 'A sample log. Multiple log entries are supported.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world', - ], - 'global' => [ - 'description' => 'The global configuration.', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '', - ], + 'configName' => ['description' => 'The name of the configuration.'."\n" + ."\n" + .'> The configuration name must be unique within the project and cannot be modified after the configuration is created. The name must follow these rules:'."\n" + .'>'."\n" + .'> - It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + .'>'."\n" + .'> - It must start and end with a lowercase letter or a digit.'."\n" + .'>'."\n" + .'> - It must be 2 to 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], + 'logSample' => ['description' => 'A sample log. Multiple log entries are supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], + 'global' => ['description' => 'The global configuration.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => ''], 'inputs' => [ 'title' => '', - 'description' => 'The list of input plugins.'."\n" - .'>Currently, you can configure only one input plugin.>', + 'description' => 'The list of input plugins. >Currently, you can configure only one input plugin.>', 'type' => 'array', - 'items' => [ - 'description' => 'The input plugin.'."\n" - ."\n" - .'> For information about the parameters of the file input plugin, see [File plugin](~~65064~~). For information about the parameters of other input plugins, see [Processing plugins](~~64957~~).', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "input_file",'."\n" - .' "FilePaths": ["/var/log/*.log"]'."\n" - .'}', - ], + 'items' => ['description' => 'The input plugin.'."\n" + ."\n" + .'> For information about the parameters of the file input plugin, see [File plugin](~~65064~~). For information about the parameters of other input plugins, see [Processing plugins](~~64957~~).', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "Type": "input_file",'."\n" + .' "FilePaths": ["/var/log/*.log"]'."\n" + .'}'], 'required' => true, 'minItems' => 1, 'example' => '', @@ -10228,64 +4917,38 @@ ."\n" .'>', 'type' => 'array', - 'items' => [ - 'description' => 'The processing plugin.'."\n" - ."\n" - .'> For more information about native and extension processing plugins, see [Processing plugins](~~64957~~).', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "processor_parse_json_native",'."\n" - .' "SourceKey": "content"'."\n" - .'}', - ], + 'items' => ['description' => 'The processing plugin.'."\n" + ."\n" + .'> For more information about native and extension processing plugins, see [Processing plugins](~~64957~~).', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "Type": "processor_parse_json_native",'."\n" + .' "SourceKey": "content"'."\n" + .'}'], 'required' => false, 'minItems' => 1, 'example' => '', ], 'aggregators' => [ 'title' => '', - 'description' => 'The list of aggregation plugins.'."\n" - .'>This parameter is valid only when you use extension processing plugins. You can use a maximum of one aggregation plugin.>', + 'description' => 'The list of aggregation plugins. >This parameter is valid only when you use extension processing plugins. You can use a maximum of one aggregation plugin.>', 'type' => 'array', - 'items' => [ - 'description' => 'The aggregation plugin.', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '', - ], + 'items' => ['description' => 'The aggregation plugin.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => ''], 'required' => false, 'minItems' => 1, 'example' => '', ], 'flushers' => [ 'title' => '', - 'description' => 'The list of output plugins.'."\n" - .'>Currently, you can add only one flusher\\_sls plugin.>', + 'description' => 'The list of output plugins. >Currently, you can add only one flusher\\_sls plugin.>', 'type' => 'array', - 'items' => [ - 'description' => 'The output plugin.', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "flusher_sls",'."\n" - .' "Logstore": "test"'."\n" - .'}', - ], + 'items' => ['description' => 'The output plugin.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "Type": "flusher_sls",'."\n" + .' "Logstore": "test"'."\n" + .'}'], 'required' => true, 'minItems' => 1, 'example' => '', ], - 'task' => [ - 'description' => 'The task configuration.', - 'type' => 'object', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'task' => ['description' => 'The task configuration.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'example' => '', @@ -10296,53 +4959,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' => 'CreateLogtailPipelineConfig', 'requestParamsDescription' => '## Global configuration'."\n" @@ -10974,17 +5611,10 @@ 'action' => 'log:CreateLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], + ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -10993,38 +5623,23 @@ 'CreateMachineGroup' => [ 'summary' => 'Creates a machine group.', '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', @@ -11032,78 +5647,46 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The information about the machine group.'."\n", + 'description' => 'The information about the machine group.', 'type' => 'object', 'properties' => [ - 'groupName' => [ + 'groupName' => ['description' => 'The name of the machine group. The name must meet the following requirements:'."\n" + ."\n" + .'- The name of each machine group in a project must be unique.'."\n" + ."\n" + .'- It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- It must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- It must be 3 to 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group', 'title' => ''], + 'machineIdentifyType' => ['description' => 'The type of the machine group identifier. Valid values:'."\n" + ."\n" + .'- ip: The machine group uses IP addresses as identifiers.'."\n" + ."\n" + .'- userdefined: The machine group uses custom identifiers.', 'type' => 'string', 'required' => true, 'example' => 'ip', 'default' => 'ip', 'title' => ''], + 'groupType' => ['description' => 'The type of the machine group. The parameter can be left empty.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '""'], + 'groupAttribute' => [ 'title' => '', - 'description' => 'The name of the machine group. The name must meet the following requirements:'."\n" - ."\n" - .'* The name of each machine group in a project must be unique.'."\n" - .'* It can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - .'* It must start and end with a lowercase letter or a digit.'."\n" - .'* It must be 3 to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group', + 'description' => 'The attributes of the machine group.', + 'type' => 'object', + 'properties' => [ + 'groupTopic' => ['description' => 'The log topic of the machine group.', 'type' => 'string', 'required' => false, 'example' => 'testtopic', 'title' => ''], + 'externalName' => ['description' => 'The identifier of the external management system on which the machine group depends.', 'type' => 'string', 'required' => false, 'example' => 'testgroup', 'title' => ''], + ], + 'required' => false, + 'example' => '', ], - 'machineIdentifyType' => [ + 'machineList' => [ 'title' => '', - 'description' => 'The type of the machine group identifier. Valid values:'."\n" + 'description' => 'The identifiers of machine group.'."\n" ."\n" - .'* ip: The machine group uses IP addresses as identifiers.'."\n" - .'* userdefined: The machine group uses custom identifiers.'."\n", - 'type' => 'string', + .'- If you set machineIdentifyType to ip, enter the IP address of the machine.'."\n" + ."\n" + .'- If you set machineIdentifyType to userdefined, enter a custom identifier.', + 'type' => 'array', + 'items' => ['description' => 'The machine identifier. Enter an IP address or a custom identifier based on the type of the machine group.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => '', 'required' => false], 'required' => true, - 'example' => 'ip', - 'default' => 'ip', - ], - 'groupType' => [ - 'title' => '', - 'description' => 'The type of the machine group. The parameter can be left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], - 'groupAttribute' => [ - 'title' => '', - 'description' => 'The attributes of the machine group.'."\n", - 'type' => 'object', - 'properties' => [ - 'groupTopic' => [ - 'title' => '', - 'description' => 'The log topic of the machine group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testtopic', - ], - 'externalName' => [ - 'title' => '', - 'description' => 'The identifier of the external management system on which the machine group depends.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup', - ], - ], - 'required' => false, - 'example' => '', - ], - 'machineList' => [ - 'title' => '', - 'description' => 'The identifiers of machine group.'."\n" - ."\n" - .'* If you set machineIdentifyType to ip, enter the IP address of the machine.'."\n" - .'* If you set machineIdentifyType to userdefined, enter a custom identifier.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The machine identifier. Enter an IP address or a custom identifier based on the type of the machine group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], - 'required' => true, - 'example' => '', + 'example' => '', ], ], 'required' => true, @@ -11115,46 +5698,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'], ], ], ], @@ -11163,7 +5722,7 @@ 'title' => 'CreateMachineGroup', 'description' => '### Usage notes'."\n" ."\n" - .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | MachineGroupAlreadyExist| groupName already exists. | 机器组已存在。 |'."\n" @@ -11183,101 +5742,57 @@ '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}'], ], ], ], ], ], - 'CreateMaxComputeExport' => [ - 'summary' => 'Creates a MaxCompute data shipping job.', - 'path' => '/maxcomputeexports', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateMaterializedView' => [ + 'summary' => 'Creates a materialized view.', + 'path' => '/materializedviews', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '203409', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'riskType' => 'none', + 'abilityTreeCode' => '294418', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project. This parameter is specified in the request path.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The body parameters.'."\n", 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The unique identifier of the MaxCompute data shipping job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456'."\n", - 'title' => '', - ], - 'displayName' => [ - 'description' => 'The display name of the MaxCompute data shipping job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-mc-job', - 'title' => '', - ], - 'description' => [ - 'description' => 'The description of the MaxCompute data shipping job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '创建一个MaxCompute投递任务'."\n", - 'title' => '', - ], - 'configuration' => [ - 'description' => 'The setting of the MaxCompute data shipping job.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/MaxComputeExportConfiguration', - 'title' => '', - 'example' => '', - ], + 'name' => ['description' => 'The name of the materialized view. The name must be unique within the project, 2 to 63 characters long, and contain only lowercase letters, digits, hyphens (-), and underscores (_). It must also start and end with a lowercase letter or a digit.', 'type' => 'string', 'title' => '', 'example' => ''], + 'logstore' => ['description' => 'The destination Logstore for the aggregated data from the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], + 'originalSql' => ['description' => 'The query statement that defines the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], + 'aggIntervalMins' => ['description' => 'The aggregation interval in minutes. The system creates aggregation tasks based on this interval.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'startTime' => ['description' => 'The time when the materialized view starts to aggregate data. Specify the time as a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'ttl' => ['description' => 'The time-to-live (TTL) of the data in the materialized view, in days. After this period, the data expires and is automatically deleted.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], - 'required' => false, + 'description' => 'The configuration of the materialized view.', 'title' => '', 'example' => '', ], @@ -11286,182 +5801,133 @@ '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'], ], ], ], ], - 'errorCodes' => [ - 401 => [ - [ - 'errorCode' => 'AuthorizationRequired', - 'errorMessage' => 'Authorization Required', - 'description' => '', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'CreateMaxComputeExport', - 'description' => '* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n", + 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'CreateMaterializedView', ], - 'CreateMemoryStore' => [ - 'summary' => 'Create a memory store.', - 'path' => '/memorystores', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateMaxComputeExport' => [ + 'summary' => 'Creates a MaxCompute data shipping job.', + 'path' => '/maxcomputeexports', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, + 'abilityTreeCode' => '203409', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => 'The body parameters.', 'type' => 'object', 'properties' => [ - 'customInstructions' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'enableGraph' => [ - 'type' => 'boolean', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'strategy' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'shortTermTtl' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'name' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'name' => ['description' => 'The unique identifier of the MaxCompute data shipping job.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456'."\n", 'title' => ''], + 'displayName' => ['description' => 'The display name of the MaxCompute data shipping job.', 'type' => 'string', 'required' => true, 'example' => 'my-mc-job', 'title' => ''], + 'description' => ['description' => 'The description of the MaxCompute data shipping job.', 'type' => 'string', 'example' => 'Create a MaxCompute delivery task', 'required' => false, 'title' => ''], + 'configuration' => ['description' => 'The setting of the MaxCompute data shipping job.', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration', 'title' => '', 'example' => ''], ], - 'description' => '', + 'required' => false, 'title' => '', 'example' => '', ], ], - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'CreateMaxComputeExport', + 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'CreateMemoryStore', + 'translator' => 'manual', ], 'CreateMetricStore' => [ 'summary' => 'Creates a Metricstore to store metrics.', 'path' => '/metricstores', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -11470,21 +5936,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225682', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'body', @@ -11495,98 +5953,23 @@ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the Metricstore to create.', - 'type' => 'string', - 'required' => true, - 'example' => 'my_metric_store', - 'title' => '', - ], - 'ttl' => [ - 'description' => 'The data retention period of the Metricstore. Unit: days.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '7', - 'title' => '', - ], - 'shardCount' => [ - 'description' => 'The number of [shards](~~28976~~) for the Metricstore.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - 'title' => '', - ], - 'autoSplit' => [ - 'description' => 'Specifies whether to enable automatic shard splitting.', - 'type' => 'boolean', - 'default' => 'false', - 'title' => '', - 'required' => false, - 'example' => 'true', - ], - 'maxSplitShard' => [ - 'description' => 'The maximum number of shards into which a shard can be split. This parameter is valid only if autoSplit is set to true.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - 'title' => '', - 'required' => false, - ], - 'mode' => [ - 'description' => 'The type of the Metricstore. Only standard is supported. The default value is standard.', - 'type' => 'string', - 'default' => 'standard', - 'title' => '', - 'required' => false, - 'example' => 'standard', - ], - 'metricType' => [ - 'description' => 'The type of the Metricstore. Only prometheus is supported. The default value is prometheus.', - 'type' => 'string', - 'default' => 'prometheus', - 'title' => '', - 'required' => false, - 'example' => 'prometheus', - ], - 'hot_ttl' => [ - 'description' => 'The period for which data is stored in the hot tier. Unit: days. The value must be at least 7 and cannot be greater than the value of ttl. If you set this parameter to -1, all data is stored in the hot tier for the duration specified by ttl.'."\n" - ."\n" - .'When the hot storage period ends, the data is moved to the IA storage class. For more information, see [Tiered Storage of Hot and Cold Data](~~308645~~).', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'example' => '60', - ], - 'infrequentAccessTTL' => [ - 'description' => 'The retention period of data in the IA storage class. Unit: days. The minimum value is 30. After this period, data is moved to Archive Storage.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'example' => '30', - ], - 'appendMeta' => [ - 'description' => 'Specifies whether to record the public IP address of the client. The default value is false.'."\n" - ."\n" - .'- true: Records the public IP address.'."\n" - ."\n" - .'- false: Does not record the public IP address.', - 'type' => 'boolean', - 'default' => 'false', - 'title' => '', - 'required' => false, - 'example' => 'false', - ], - 'shardingPolicy' => [ - 'description' => 'The write hashing configuration.', - '$ref' => '#/components/schemas/ShardingPolicy', - 'title' => '', - 'required' => false, - 'example' => '', - ], + 'name' => ['description' => 'The name of the Metricstore to create.', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store', 'title' => ''], + 'ttl' => ['description' => 'The data retention period of the Metricstore. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', 'title' => ''], + 'shardCount' => ['description' => 'The number of [shards](~~28976~~) for the Metricstore.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], + 'autoSplit' => ['description' => 'Specifies whether to enable automatic shard splitting.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'true'], + 'maxSplitShard' => ['description' => 'The maximum number of shards into which a shard can be split. This parameter is valid only if autoSplit is set to true.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => '', 'required' => false], + 'mode' => ['description' => 'The type of the Metricstore. Only standard is supported. The default value is standard.', 'type' => 'string', 'default' => 'standard', 'title' => '', 'required' => false, 'example' => 'standard'], + 'metricType' => ['description' => 'The type of the Metricstore. Only prometheus is supported. The default value is prometheus.', 'type' => 'string', 'default' => 'prometheus', 'title' => '', 'required' => false, 'example' => 'prometheus'], + 'hot_ttl' => ['description' => 'The period for which data is stored in the hot tier. Unit: days. The value must be at least 7 and cannot be greater than the value of ttl. If you set this parameter to -1, all data is stored in the hot tier for the duration specified by ttl.'."\n" + ."\n" + .'When the hot storage period ends, the data is moved to the IA storage class. For more information, see [Tiered Storage of Hot and Cold Data](~~308645~~).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '60'], + 'infrequentAccessTTL' => ['description' => 'The retention period of data in the IA storage class. Unit: days. The minimum value is 30. After this period, data is moved to Archive Storage.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], + 'appendMeta' => ['description' => 'Specifies whether to record the public IP address of the client. The default value is false.'."\n" + ."\n" + .'- true: Records the public IP address.'."\n" + ."\n" + .'- false: Does not record the public IP address.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], + 'shardingPolicy' => ['description' => 'The write hashing configuration.', '$ref' => '#/components/schemas/ShardingPolicy', 'title' => '', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', @@ -11597,62 +5980,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' => 'The specified metricstore xxx already exists.', - ], + ['errorCode' => 'MetricStoreAlreadyExist', 'errorMessage' => 'The specified metricstore xxx already exists.', 'description' => 'The specified metricstore xxx already exists.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateMetricStore', 'description' => 'A [Metricstore](~~171723~~) is used to store [metrics](~~174965~~).'."\n" @@ -11671,26 +6024,11 @@ ."\n" .'- A Logstore and a Metricstore in the same project cannot have the same name.', 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:07.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-12-02T11:55:01.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-11-24T09:35:52.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-12-03T01:37:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-12-02T11:55:01.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-11-24T09:35:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], @@ -11703,12 +6041,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}'], ], ], ], @@ -11717,42 +6050,27 @@ 'CreateOSSExport' => [ 'summary' => 'Exports logs from a Logstore to an 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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'my-project'."\n", - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], ], [ 'name' => 'body', @@ -11762,42 +6080,18 @@ 'description' => 'The configuration of the OSS data shipping job.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the job. The name must meet the following requirements:'."\n" - ."\n" - .'The job name must be unique within the project.'."\n" - ."\n" - .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'- The name must start and end with a lowercase letter or a digit.'."\n" - ."\n" - .'- The name must be 2 to 64 characters in length.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'export-oss-1234567890-123456', - ], - 'displayName' => [ - 'description' => 'The display name of the job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'my-oss-job', - ], - 'description' => [ - 'description' => 'The description of the job.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '创建一个OSS投递任务', - ], - 'configuration' => [ - 'description' => 'The configuration of the job.', - 'required' => true, - '$ref' => '#/components/schemas/OSSExportConfiguration', - 'title' => '', - 'example' => '', - ], + 'name' => ['description' => 'The name of the job. The name must meet the following requirements:'."\n" + ."\n" + .'The job name must be unique within the project.'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- The name must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456', 'title' => ''], + 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'my-oss-job', 'title' => ''], + 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Create a Unit OSS delivery task', 'required' => false, 'title' => ''], + 'configuration' => ['description' => 'The configuration of the job.', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -11808,51 +6102,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' => 'CreateOSSExport', 'changeSet' => [], @@ -11860,46 +6133,32 @@ 'flowControlList' => [], ], 'ramActions' => [], + 'translator' => 'manual', ], 'CreateOSSHDFSExport' => [ 'summary' => 'Creates an export job from OSS to HDFS in a specified project.', 'path' => '/osshdfsexports', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'my-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'body', @@ -11909,42 +6168,18 @@ 'description' => 'The configuration of the OSS to Hadoop Distributed File System (HDFS) export job.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the job. The name must be unique within the project and follow these conventions:'."\n" - ."\n" - .'The job name must be unique within the project.'."\n" - ."\n" - .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'- The name must start and end with a lowercase letter or a digit.'."\n" - ."\n" - .'- The name must be 2 to 64 characters in length.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'export-osshdfs-1234567890-123456', - ], - 'displayName' => [ - 'description' => 'The display name of the job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'my-oss-hdfs-job'."\n", - ], - 'description' => [ - 'description' => 'The description of the job.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '创建一个OSS-HDFS投递任务'."\n", - ], - 'configuration' => [ - 'description' => 'The configuration of the job.', - 'required' => true, - '$ref' => '#/components/schemas/OSSExportConfiguration', - 'title' => '', - 'example' => '', - ], + 'name' => ['description' => 'The name of the job. The name must be unique within the project and follow these conventions:'."\n" + ."\n" + .'The job name must be unique within the project.'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- The name must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456', 'title' => ''], + 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'my-oss-hdfs-job'."\n", 'title' => ''], + 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Create a Unit OSS-HDFS delivery task', 'required' => false, 'title' => ''], + 'configuration' => ['description' => 'The configuration of the job.', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -11955,46 +6190,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"}]', @@ -12004,46 +6220,32 @@ 'flowControlList' => [], ], 'ramActions' => [], + 'translator' => 'manual', ], 'CreateOSSIngestion' => [ 'summary' => 'Creates an OSS import task in a specified project.', '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' => 'The project name.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'body', @@ -12053,49 +6255,19 @@ 'description' => 'The configuration of the OSS import job.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'The job description.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '任务描述'."\n", - ], - 'displayName' => [ - 'description' => 'The display name.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'OSS导入', - ], - 'schedule' => [ - 'description' => 'The scheduling configuration. This parameter is optional. To meet specific timing requirements, such as importing data at 8:00 AM every Monday, use a cron expression.', - 'required' => false, - '$ref' => '#/components/schemas/Schedule', - 'title' => '', - 'example' => '', - ], - 'configuration' => [ - 'description' => 'The OSS import configuration.', - 'required' => true, - '$ref' => '#/components/schemas/OSSIngestionConfiguration', - 'title' => '', - 'example' => '', - ], - 'name' => [ - 'description' => 'The job name. The naming conventions are as follows:'."\n" - ."\n" - .'The job name must be unique within the project.'."\n" - ."\n" - .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'- The name must start and end with a lowercase letter or a digit.'."\n" - ."\n" - .'- The name must be 2 to 64 characters in length.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ingest-oss-123456', - ], + 'description' => ['description' => 'The job description.', 'type' => 'string', 'example' => 'Task description', 'required' => false, 'title' => ''], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'OSS import', 'required' => true, 'title' => ''], + 'schedule' => ['description' => 'The scheduling configuration. This parameter is optional. To meet specific timing requirements, such as importing data at 8:00 AM every Monday, use a cron expression.', '$ref' => '#/components/schemas/Schedule', 'required' => false, 'title' => '', 'example' => ''], + 'configuration' => ['description' => 'The OSS import configuration.', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration', 'title' => '', 'example' => ''], + 'name' => ['description' => 'The job name. The naming conventions are as follows:'."\n" + ."\n" + .'The job name must be unique within the project.'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- The name must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], ], 'required' => false, 'title' => '', @@ -12106,51 +6278,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' => 'CreateOSSIngestion', 'changeSet' => [], @@ -12158,25 +6309,19 @@ 'flowControlList' => [], ], 'ramActions' => [], + 'translator' => 'manual', ], 'CreateProject' => [ 'summary' => 'Creates a 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, @@ -12185,9 +6330,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '8733', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -12197,62 +6340,43 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => '', - 'description' => 'The description of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'this is test', - ], - 'projectName' => [ - 'title' => '', - 'description' => 'The project name must be unique in a region. You cannot change the name after you create the project. The name must meet the following requirements:'."\n" - ."\n" - .'* The name must be globally unique.'."\n" - .'* The name can contain only lowercase letters, digits, and hyphens (-).'."\n" - .'* The name must start and end with a lowercase letter or a digit.'."\n" - .'* The name must be 3 to 63 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], - 'resourceGroupId' => [ - 'title' => '', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzf******sxby', - ], + 'description' => ['description' => 'The description of the project.', 'type' => 'string', 'required' => true, 'example' => 'this is test', 'title' => ''], + 'projectName' => ['description' => 'The project name must be unique in a region. You cannot change the name after you create the project. The name must meet the following requirements:'."\n" + ."\n" + .'- The name must be globally unique.'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, and hyphens (-).'."\n" + ."\n" + .'- The name must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- The name must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test-project'], + 'resourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'rg-aekzf******sxby'], 'dataRedundancyType' => [ - 'title' => '', 'description' => 'The disaster recovery type. Valid values:'."\n" ."\n" - .'* LRS: locally redundant storage'."\n" - .'* ZRS: zone-redundant storage'."\n", + .'- LRS: locally redundant storage'."\n" + ."\n" + .'- ZRS: zone-redundant storage', 'type' => 'string', - 'required' => false, 'example' => 'LRS', - 'enum' => [ - 'LRS', - 'ZRS', - ], + 'enum' => ['LRS', 'ZRS'], + 'title' => '', + 'required' => false, ], 'recycleBinEnabled' => [ 'description' => 'Specifies whether to enable the recycle bin feature.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", + .'- true'."\n" + ."\n" + .'- false', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], 'example' => 'true', 'title' => '', ], @@ -12267,147 +6391,108 @@ 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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'CreateProject', - 'description' => '### 接口说明'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" - ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- Project名称在阿里云地域内全局唯一，创建后不可修改。'."\n" - .'- 每个阿里云账号支持添加的project数量请参见[基础资源](~~86660~~)。'."\n" - .'### 鉴权资源'."\n" - .'下表列出了API对应的授权信息。您可以在RAM权限策略语句的Action元素中添加该信息，用于为RAM用户或RAM角色授予调用此API的权限。'."\n" - .'|动作（Action） | 授权策略中的资源描述方式（Resource） |'."\n" - .'| :------------ | :------------ |'."\n" - .'| `log:CreateProject` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', - 'requestParamsDescription' => '**Sample request**'."\n" + 'description' => '### Usage notes'."\n" ."\n" - .' POST / HTTP/1.1'."\n" - .' Host:test-project.cn-hangzhou.log.aliyuncs.com'."\n" - .' Content-Type:application/json'."\n" + .'- An AccessKey pair is required. For more information, see[AccessKey pair](~~29009~~).'."\n" ."\n" - .' {'."\n" - .' "description" : "this is test",'."\n" - .' "projectName" : "test-project",'."\n" - .' "resourceGroupId" : "rg-aekzf******sxby"'."\n" - .' }'."\n", - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 400 | ProjectAlreadyExist | Project already exist. | Project已存在。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations, which is high risk. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have permissions to manage Simple Log Service resources. For more information, see[Create a RAM user and authorize the RAM user](~~47664~~).'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [ + .'- A project name must be globally unique in an Alibaba Cloud region and cannot be changed after the project is created.'."\n" + ."\n" + .'- For limits on the number of projects per Alibaba Cloud account, see[Basic resources](~~86660~~).'."\n" + ."\n" + .'### Authorization information'."\n" + ."\n" + .'The following table describes the authorization information for this API operation. You can add this information to the Action element of a RAM policy statement to grant RAM users or RAM roles permissions to call this operation.'."\n" + ."\n" + .'| Action | Resource in policy |'."\n" + .'| :------------------ | :-------------------------------------------------------- |'."\n" + .'| `log:CreateProject` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', + 'requestParamsDescription' => '**Sample request**'."\n" + ."\n" + .'```'."\n" + .'POST / HTTP/1.1'."\n" + .'Host:test-project.cn-hangzhou.log.aliyuncs.com'."\n" + .'Content-Type:application/json'."\n" + ."\n" + .'{'."\n" + .' "description" : "this is test",'."\n" + .' "projectName" : "test-project",'."\n" + .' "resourceGroupId" : "rg-aekzf******sxby"'."\n" + .'}'."\n" + .'```', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 400 | ProjectAlreadyExist | Project already exist. | Project已存在。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'log:CreateProject', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['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}'], ], ], ], ], ], 'CreateS3Ingestion' => [ - 'summary' => 'Creates a job to import files from S3.', + 'summary' => 'Creates an S3 file import job.', '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' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The project name.', - 'title' => '', - 'example' => 'testproject', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'testproject', 'title' => ''], ], [ 'name' => 'body', @@ -12416,49 +6501,19 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'description' => [ - 'type' => 'string', - 'description' => 'The description of the job.', - 'required' => false, - 'title' => '', - 'example' => 'test', - ], - 'displayName' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The display name.', - 'title' => '', - 'example' => 'test', - ], - 'schedule' => [ - '$ref' => '#/components/schemas/Schedule', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'configuration' => [ - '$ref' => '#/components/schemas/S3IngestionConfiguration', - 'description' => 'The configuration.', - 'required' => false, - 'title' => '', - 'example' => '', - ], - 'name' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The job name. The naming conventions are as follows:'."\n" - ."\n" - .'The job name must be unique within the same project.'."\n" - ."\n" - .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'- The name must start and end with a lowercase letter or a digit.'."\n" - ."\n" - .'- The name must be 2 to 64 characters in length.', - 'title' => '', - 'example' => 'test', - ], + 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], + 'schedule' => ['$ref' => '#/components/schemas/Schedule', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'configuration' => ['description' => 'The configuration.', '$ref' => '#/components/schemas/S3IngestionConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'name' => ['description' => 'The name of the job. Follow these naming rules:'."\n" + ."\n" + .'Each job in the same project must have a unique name.'."\n" + ."\n" + .'- Use only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- Start and end with a lowercase letter or digit.'."\n" + ."\n" + .'- Be 2 to 64 characters long.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], 'required' => false, 'description' => '', @@ -12470,46 +6525,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' => 'CreateS3Ingestion', @@ -12523,30 +6559,21 @@ 'CreateSavedSearch' => [ 'summary' => 'Creates a saved search.', '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' => [ [ @@ -12555,44 +6582,14 @@ 'style' => 'json', 'schema' => [ 'title' => 'A short description of struct', - 'description' => 'The request body parameters.'."\n", + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'savedsearchName' => [ - 'description' => 'The name of the saved search. The name must be 3 to 63 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'pv in minutes', - 'title' => '', - ], - 'searchQuery' => [ - 'description' => 'The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the `Search statement|Analytic statement` format. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time', - 'title' => '', - ], - 'logstore' => [ - 'description' => 'The name of the Logstore to which the saved search belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - 'title' => '', - ], - 'topic' => [ - 'description' => 'The topic of the logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'theme', - 'title' => '', - ], - 'displayName' => [ - 'description' => 'The display name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'displayname', - 'title' => '', - ], + 'savedsearchName' => ['description' => 'The name of the saved search. The name must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'pv in minutes', 'title' => ''], + 'searchQuery' => ['description' => 'The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the `Search statement|Analytic statement` format. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).', 'type' => 'string', 'required' => true, 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time', 'title' => ''], + 'logstore' => ['description' => 'The name of the Logstore to which the saved search belongs.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore', 'title' => ''], + 'topic' => ['description' => 'The topic of the logs.', 'type' => 'string', 'required' => true, 'example' => 'theme', 'title' => ''], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'displayname', 'title' => ''], ], 'required' => true, 'example' => '', @@ -12601,59 +6598,29 @@ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -12666,21 +6633,23 @@ 'title' => 'CreateSavedSearch', 'description' => '### Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - .'* Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" + .'- Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:CreateSavedSearch`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}`|', + .'| Action | Resource |'."\n" + .'| :---------------------- | :--------------------------------------------------------------------------------------- |'."\n" + .'| `log:CreateSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -12692,18 +6661,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}'], ], ], ], @@ -12712,21 +6673,14 @@ 'CreateScheduledSQL' => [ 'summary' => 'Creates a scheduled SQL job in a specified project.', '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, @@ -12735,21 +6689,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209629', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The name of the project.', - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'body', @@ -12759,49 +6705,19 @@ 'description' => 'The configurations of the scheduled SQL job.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The job name. The name must be unique within a project.'."\n" - ."\n" - .'The naming convention is as follows:'."\n" - ."\n" - .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - ."\n" - .'- The name must start and end with a lowercase letter or a digit.'."\n" - ."\n" - .'- The name must be 2 to 64 characters in length.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'sql-123456789-123456', - ], - 'displayName' => [ - 'description' => 'The display name of the job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-scheduled-sql', - ], - 'description' => [ - 'description' => 'The description of the job.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '创建一个定时SQL任务', - ], - 'schedule' => [ - 'description' => 'The scheduling configuration for the job.', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - 'title' => '', - 'example' => '', - ], - 'configuration' => [ - 'description' => 'The configuration of the job.', - 'required' => true, - '$ref' => '#/components/schemas/ScheduledSQLConfiguration', - 'title' => '', - 'example' => '', - ], + 'name' => ['description' => 'The job name. The name must be unique within a project.'."\n" + ."\n" + .'The naming convention is as follows:'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- The name must start and end with a lowercase letter or a digit.'."\n" + ."\n" + .'- The name must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456', 'title' => ''], + 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-scheduled-sql', 'title' => ''], + 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Create a scheduled SQL task', 'required' => false, 'title' => ''], + 'schedule' => ['description' => 'The scheduling configuration for the job.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], + 'configuration' => ['description' => 'The configuration of the job.', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -12813,45 +6729,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"}]', @@ -12868,53 +6765,33 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'translator' => 'manual', ], 'CreateSqlInstance' => [ 'summary' => 'If you use Standard SQL to analyze a large volume of data, a single query may not be able to scan all logs within a specified time range, which can result in incomplete data. Adding shards improves read and write performance, but this change applies only to new data. To analyze a larger volume of data in a single query, you can enable Dedicated SQL and increase its compute resources.', 'path' => '/sqlinstance', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => 'The name of the project for which you want to enable Dedicated SQL.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project for which you want to enable Dedicated SQL.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'body', @@ -12924,21 +6801,8 @@ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'cu' => [ - 'description' => 'The number of compute units (CUs). CUs are the compute cores that can be used in parallel when Dedicated SQL is running.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'title' => '', - 'example' => '2', - ], - 'useAsDefault' => [ - 'description' => 'Specifies whether to enable Dedicated SQL by default for the project. If you set this parameter to \\`true\\`, all query and analysis operations in the project, such as alerting and dashboards, use Dedicated SQL.', - 'type' => 'boolean', - 'required' => true, - 'title' => '', - 'example' => '', - ], + 'cu' => ['description' => 'The number of compute units (CUs). CUs are the compute cores that can be used in parallel when Dedicated SQL is running.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '2'], + 'useAsDefault' => ['description' => 'Specifies whether to enable Dedicated SQL by default for the project. If you set this parameter to \\`true\\`, all query and analysis operations in the project, such as alerting and dashboards, use Dedicated SQL.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -12950,53 +6814,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' => 'CreateSqlInstance', 'description' => '**Ensure that you understand the billing methods and [pricing](~~223777~~) of Dedicated SQL before you use this operation.**', @@ -13012,12 +6850,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}'], ], ], ], @@ -13026,20 +6859,14 @@ 'CreateStoreView' => [ 'summary' => 'Creates a dataset.', 'path' => '/storeviews', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -13048,21 +6875,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '208488', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'example-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], ], [ 'name' => 'body', @@ -13072,40 +6891,25 @@ 'description' => 'The dataset configuration.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => 'The name of the dataset.'."\n" - ."\n" - .'- The name can contain only lowercase letters, digits, and underscores (\\_).'."\n" - ."\n" - .'- The name must start with a lowercase letter.'."\n" - ."\n" - .'- The name must be 3 to 62 characters in length.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'my_storeview', - ], + 'name' => ['description' => 'The name of the dataset.'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, and underscores (\\_).'."\n" + ."\n" + .'- The name must start with a lowercase letter.'."\n" + ."\n" + .'- The name must be 3 to 62 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], 'storeType' => [ 'description' => 'The type of the dataset. Set this parameter to metricstore to create a Metricstore dataset. Set this parameter to logstore to create a Logstore dataset.', + 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'metricstore' => 'metricstore', - 'logstore' => 'logstore', - ], - 'title' => '', 'example' => 'logstore', + 'title' => '', ], 'stores' => [ 'description' => 'A list of Logstores or Metricstores.', 'type' => 'array', - 'items' => [ - 'description' => 'A Logstore or Metricstore.', - 'required' => true, - '$ref' => '#/components/schemas/StoreViewStore', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'A Logstore or Metricstore.', 'required' => true, '$ref' => '#/components/schemas/StoreViewStore', 'title' => '', 'example' => ''], 'required' => true, 'title' => '', 'example' => '', @@ -13121,53 +6925,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' => 'CreateStoreView', 'changeSet' => [], @@ -13182,12 +6960,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -13196,118 +6969,70 @@ 'CreateTicket' => [ 'summary' => 'Obtains a ticket. Simple Log Service allows you to share the query and analysis pages and dashboard pages with other users and embed the console pages into third-party systems. This way, other users can view your logs in password-free mode. The URLs of the shared pages are referred to as password-free URLs. You can call the CreateTicket operation to obtain a ticket and generate a password-free URL based on the ticket and the URL of the console page that you want to share.', 'path' => '/tickets', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => '* You must use the Simple Log Service endpoint for the China (Shanghai) or Singapore region to call the CreateTicket operation. After you obtain the ticket, you can use the ticket regardless of the region.'."\n" - .'* The validity period for the URL of the console page that you want to embed. Unit: seconds. Default value: 86400 (one day). Valid values: 0 to 2592000 (30 days).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '86400', - 'title' => '', - ], + 'schema' => ['description' => '- You must use the Simple Log Service endpoint for the China (Shanghai) or Singapore region to call the CreateTicket operation. After you obtain the ticket, you can use the ticket regardless of the region.'."\n" + ."\n" + .'- The validity period for the URL of the console page that you want to embed. Unit: seconds. Default value: 86400 (one day). Valid values: 0 to 2592000 (30 days).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '86400', 'title' => ''], ], [ 'name' => 'accessTokenExpirationTime', 'in' => 'query', - 'schema' => [ - 'description' => '* The validity period of the access token. Unit: seconds. Default value: 86400, which specifies one day. Valid values: 0 to 86400.'."\n" - .'* The validity period of the access token is the smaller value between accessTokenExpirationTime and expirationTime.'."\n" - .'* If you use a Security Token Service (STS) token to call this operation, the validity period of the access token is the smallest value among accessTokenExpirationTime, expirationTime, and the validity period of the STS token.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '600', - 'title' => '', - ], + 'schema' => ['description' => '- The validity period of the access token. Unit: seconds. Default value: 86400, which specifies one day. Valid values: 0 to 86400.'."\n" + ."\n" + .'- The validity period of the access token is the smaller value between accessTokenExpirationTime and expirationTime.'."\n" + ."\n" + .'- If you use a Security Token Service (STS) token to call this operation, the validity period of the access token is the smallest value among accessTokenExpirationTime, expirationTime, and the validity period of the STS token.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + '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' => 'The returned struct.'."\n", + 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ - 'ticket' => [ - 'description' => 'The ticket that is used for logon-free access.'."\n", - 'type' => 'string', - 'example' => 'eyJ***************.eyJ******************.KUT****************', - 'title' => '', - ], + 'ticket' => ['description' => 'The ticket that is used for logon-free access.', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ticket\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', 'title' => 'CreateTicket', 'changeSet' => [], @@ -13319,20 +7044,14 @@ 'DeleteAgentInstanceConfig' => [ 'summary' => 'Deletes a process configuration.', 'path' => '/agentinstanceconfigs/{configType}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -13341,9 +7060,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227415', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -13353,20 +7070,8 @@ 'schema' => [ 'description' => 'The type of the process-level configuration.', 'enumValueTitles' => [ - 'apm_biz_trace' => 'apm\\_biz\\_trace', - 'apm_self_protect' => 'apm\\_self\\_protect', - 'apm_convergence' => 'apm\\_convergence', - 'apm_custom_extract' => 'apm\\_custom\\_extract', - 'apm_pilot' => 'apm\\_pilot', - 'apm_trace' => 'apm\\_trace', - 'rum_app_config' => 'rum\\_app\\_config', - 'security_rasp' => 'security\\_rasp', - 'rum_web_config' => 'rum\\_web\\_config', - 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', - 'apm_intacheap' => 'apm\\_intacheap', - 'apm_user_method' => 'apm\\_user\\_method', - 'apm_global' => 'apm\\_global', - 'apm_forward_process' => 'apm\\_forward\\_process', + 'apm_biz_trace' => 'apm\\_biz\\_trace', 'apm_self_protect' => 'apm\\_self\\_protect', 'apm_convergence' => 'apm\\_convergence', 'apm_custom_extract' => 'apm\\_custom\\_extract', 'apm_pilot' => 'apm\\_pilot', 'apm_trace' => 'apm\\_trace', 'rum_app_config' => 'rum\\_app\\_config', 'security_rasp' => 'security\\_rasp', 'rum_web_config' => 'rum\\_web\\_config', 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', + 'apm_intacheap' => 'apm\\_intacheap', 'apm_user_method' => 'apm\\_user\\_method', 'apm_global' => 'apm\\_global', 'apm_forward_process' => 'apm\\_forward\\_process', ], 'type' => 'string', 'required' => true, @@ -13380,13 +7085,8 @@ 'style' => 'json', 'schema' => [ 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The process to which the process-level configuration belongs.', - 'type' => 'string', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The process to which the process-level configuration belongs.', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"', 'title' => ''], 'description' => 'The process to which the configuration applies.', 'required' => false, 'title' => '', @@ -13398,47 +7098,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' => 'DeleteAgentInstanceConfig', 'changeSet' => [], 'flowControl' => [ @@ -13450,106 +7130,59 @@ 'DeleteAlert' => [ 'summary' => 'Deletes an alert rule.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'DeleteAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" @@ -13570,12 +7203,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -13584,100 +7212,54 @@ 'DeleteAnnotationData' => [ 'summary' => 'Deletes data from a dataset.', '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' => 'The unique ID of the dataset.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], [ 'name' => 'annotationdataId', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique ID of the data.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '2156d560fc7c01420542df92cd6365ds', - ], + 'schema' => ['description' => 'The unique ID of the data.', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'DeleteAnnotationData', 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', @@ -13686,94 +7268,53 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'DeleteAnnotationDataSet' => [ 'summary' => 'Deletes a dataset. You can delete a dataset only if it contains no data structures.', 'path' => '/ml/annotationdataset/{datasetId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + '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' => 'The unique ID of the dataset.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'DeleteAnnotationDataSet', 'description' => 'The endpoint for this API is available only in the China (Shanghai) and Singapore regions.', @@ -13782,94 +7323,53 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'DeleteAnnotationLabel' => [ 'summary' => 'Deletes a custom annotation label.', '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' => 'The label ID.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799', - ], + 'schema' => ['description' => 'The label ID.', 'type' => 'string', 'required' => false, 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799', 'title' => ''], ], ], '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' => 'DeleteAnnotationLabel', 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', @@ -13878,130 +7378,82 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'DeleteAzureBlobIngestion' => [ 'summary' => 'Create a file import task from Azure Blob', '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, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], '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' => 'DeleteAzureBlobIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteAzureBlobIngestion', ], 'DeleteCollectionPolicy' => [ 'summary' => 'Deletes a log collection rule for an Alibaba Cloud product.', 'path' => '/collectionpolicy/{policyName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, @@ -14010,92 +7462,50 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '194655', - 'abilityTreeNodes' => [ - 'FEATUREsls9NGCVR', - ], + 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ 'name' => 'policyName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the rule.', - 'type' => 'string', - 'required' => true, - 'maxLength' => 63, - 'minLength' => 3, - 'title' => '', - 'example' => 'your_log_policy', - ], + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'maxLength' => 63, 'minLength' => 3, 'example' => 'your_log_policy', 'title' => ''], ], [ 'name' => 'productCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the product.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'oss', - ], + 'schema' => ['description' => 'The code of the product.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''], ], [ 'name' => 'dataCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the log type.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'access_log', - ], + 'schema' => ['description' => 'The code of the log type.', 'type' => 'string', 'required' => false, 'example' => 'access_log', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + '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' => 'DeleteCollectionPolicy', 'description' => 'This API can be called only from endpoints in the China (Shanghai), Singapore, and China (Heyuan) Automotive Compliance Cloud (cn-heyuan-acdr-1) regions.', @@ -14105,104 +7515,58 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'DeleteConfig' => [ 'summary' => 'Deletes a Logtail configuration.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logtail configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'logtail-config-sample', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -14215,14 +7579,17 @@ 'title' => 'DeleteConfig', 'description' => '### [](#)Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* If a Logtail configuration is applied to a machine group, you cannot collect data from the machine group after you delete the Logtail configuration.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- If a Logtail configuration is applied to a machine group, you cannot collect data from the machine group after you delete the Logtail configuration.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" - .'* The name of the required Logtail configuration is obtained. For more information, see [ListConfig](~~29043~~).'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" + ."\n" + .'- The name of the required Logtail configuration is obtained. For more information, see [ListConfig](~~29043~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -14241,18 +7608,10 @@ 'action' => 'log:DeleteConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -14261,99 +7620,59 @@ 'DeleteConsumeProcessor' => [ 'summary' => 'Deletes a consume processor.', '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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'processorName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the consume processor.', - 'type' => 'string', - 'required' => true, - 'example' => 'consume-processor-1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the consume processor.', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'DeleteConsumeProcessor', 'changeSet' => [], @@ -14365,100 +7684,55 @@ 'DeleteConsumerGroup' => [ 'summary' => 'Deletes a consumer group.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project name', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => 'Logstore name', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['title' => 'Logstore name', 'description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'title' => 'Consumer group', - 'description' => 'The name of the consumer group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'consumer-group-1', - ], + 'schema' => ['title' => 'Consumer group', 'description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -14467,21 +7741,23 @@ 'title' => 'DeleteConsumerGroup', 'description' => '### Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - .'* The name of the consumer group is obtained. For more information, see [ListConsumerGroup](~~74964~~).'."\n" + .'- The name of the consumer group is obtained. For more information, see [ListConsumerGroup](~~74964~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:DeleteConsumerGroup`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}`|', + .'| Action | Resource |'."\n" + .'| :------------------------ | :---------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `log:DeleteConsumerGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -14500,18 +7776,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}'], ], ], ], @@ -14520,99 +7788,54 @@ 'DeleteDashboard' => [ 'summary' => 'Deletes a dashboard.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'Project name', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'dashboardName', 'in' => 'path', - 'schema' => [ - 'title' => 'Dashboard name', - 'description' => 'The name of the dashboard.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], + 'schema' => ['title' => 'Dashboard name', 'description' => 'The name of the dashboard.', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -14625,12 +7848,13 @@ 'title' => 'DeleteDashboard', 'description' => '### [](#)Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -14642,186 +7866,69 @@ 'action' => 'log:DeleteDashboard', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', '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' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => 'Deletes a dataset.', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteDataset', - ], 'DeleteDomain' => [ 'summary' => 'Deletes a custom domain name that is bound to a 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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'domainName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The domain name to be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'The domain name to be deleted.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'example.com'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'DeleteDomain', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | ParameterInvalid| specified domain does not exist. | 要删除的域名不存在。 |'."\n" @@ -14839,18 +7946,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}'], ], ], ], @@ -14859,110 +7958,71 @@ 'DeleteDownloadJob' => [ 'summary' => 'Deletes a download job.', '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' => [ [ 'name' => 'downloadJobName', 'in' => 'path', 'schema' => [ - 'title' => '', 'description' => 'The name of the log download job.', - 'type' => 'string', 'properties' => [], + 'type' => 'string', 'required' => true, + 'title' => '', 'example' => 'download-123', ], ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], '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' => 'DeleteDownloadJob', 'changeSet' => [], @@ -14970,105 +8030,63 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'DeleteETL' => [ 'summary' => 'Deletes a data transformation job.', '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' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'etlName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the data transformation job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'etl-123456', - ], + 'schema' => ['description' => 'The name of the data transformation job.', 'type' => 'string', 'required' => true, 'example' => 'etl-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'DeleteETL', 'changeSet' => [], @@ -15077,98 +8095,117 @@ ], 'ramActions' => [], ], - 'DeleteIndex' => [ - 'summary' => 'Deletes an index of a Logstore.', - 'path' => '/logstores/{logstore}/index', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteElasticsearchIngestion' => [ + 'summary' => 'Deletes an ES/OpenSearch ingestion task.', + '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', + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'esIngestionName', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', + 'schema' => ['description' => 'The name of the ES/OpenSearch ingestion task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'."\n", 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteElasticsearchIngestion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'DeleteIndex' => [ + 'summary' => 'Deletes an index of a Logstore.', + 'path' => '/logstores/{logstore}/index', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], + ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -15177,7 +8214,7 @@ 'title' => 'DeleteIndex', 'description' => '### Usage notes'."\n" ."\n" - .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | ParameterInvalid | Log store index not created. | 没有创建日志索引。 |'."\n" @@ -15197,18 +8234,10 @@ '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}'], ], ], ], @@ -15217,99 +8246,59 @@ 'DeleteIngestProcessor' => [ 'summary' => 'Deletes an ingest processor.', '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'processorName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The identifier of the ingest processor.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'parse-nginx-log', - ], + 'schema' => ['description' => 'The identifier of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'parse-nginx-log'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'DeleteIngestProcessor', 'changeSet' => [], @@ -15321,95 +8310,50 @@ 'DeleteLogStore' => [ 'summary' => 'Deletes a Logstore, including all shards and indexes in the Logstore.', '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aliyun-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -15418,7 +8362,7 @@ 'title' => 'DeleteLogStore', 'description' => '### Usage notes'."\n" ."\n" - .'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.'."\n", + .'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -15438,18 +8382,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}'], ], ], ], @@ -15458,83 +8394,45 @@ 'DeleteLogging' => [ 'summary' => 'Deletes the service log for a specified 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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['title' => 'Project 名称。', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -15548,208 +8446,217 @@ ], 'ramActions' => [], ], - 'DeleteLogtailPipelineConfig' => [ - 'summary' => 'Deletes a Logtail pipeline configuration.', - 'path' => '/pipelineconfigs/{configName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteLogs' => [ + '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' => [ + 'description' => 'Request parameters.', + 'type' => 'object', + 'properties' => [ + 'from' => ['description' => 'The start time of the query. This time refers to the log time specified when the log data was written.'."\n" + ."\n" + .'The time interval defined by the request parameters from and to follows the left-closed, right-open principle. That is, the interval includes the start time but does not include the end time. If the values of from and to are the same, the interval is invalid, and the function returns an error directly.'."\n" + .'Unix timestamp format, indicating the number of seconds elapsed since 1970-01-01 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268100', 'title' => ''], + 'to' => ['description' => 'The end time of the query. This time refers to the log time specified when the log data was written.'."\n" + ."\n" + .'The time interval defined by the request parameters from and to follows the left-closed, right-open principle. That is, the interval includes the start time but does not include the end time. If the values of from and to are the same, the interval is invalid, and the function returns an error directly.'."\n" + .'Unix timestamp format, indicating the number of seconds elapsed since 1970-01-01 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200', 'title' => ''], + 'query' => ['description' => 'Optional: The query statement used to filter the logs to be updated. For more information, see [Query overview](~~43772~~).'."\n" + ."\n" + .'Note: This parameter supports only query statements. Analysis statements such as SPL and SQL are not supported.', 'type' => 'string', 'required' => false, 'example' => 'status:400', 'title' => ''], + 'rowId' => ['description' => 'Optional: The value of the built-in field __rowid__ that is automatically returned in the query results.'."\n" + ."\n" + .'One of rowId and query must be specified. If both are specified, rowId takes precedence.', 'type' => 'string', 'required' => false, 'example' => ' 0|1000001|638732499', 'title' => ''], + ], + 'required' => false, 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', + 'example' => '', ], ], [ - 'name' => 'configName', + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-project-test', 'title' => ''], + ], + [ + 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logtail pipeline configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', - ], + 'schema' => ['description' => 'Queries data in the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'affectedRows' => ['description' => 'The number of log rows that were deleted.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteLogtailPipelineConfig', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete logs', + 'summary' => 'Deletes log data from a Logstore under a specified project', + 'description' => 'The Host is composed of the project name and the Log Service endpoint. You need to specify the project in the Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'description' => 'The UK (London) region is supported. Supported regions are constantly updated.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"affectedRows\\": 10\\n}","type":"json"}]', ], - 'DeleteMachineGroup' => [ - 'summary' => 'Deletes a machine group. If the Logtail configurations for log collection are applied to a machine group, the configurations are disassociated from the machine group after the machine group is deleted.', - 'path' => '/machinegroups/{machineGroup}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteLogtailPipelineConfig' => [ + 'summary' => 'Deletes a Logtail pipeline configuration.', + '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'machineGroup', + 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group-4', - ], + 'schema' => ['description' => 'The name of the Logtail pipeline configuration.', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'DeleteLogtailPipelineConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'description' => 'The UK (London) region is supported. Supported regions are constantly updated.', + ], + 'DeleteMachineGroup' => [ + 'summary' => 'Deletes a machine group. If the Logtail configurations for log collection are applied to a machine group, the configurations are disassociated from the machine group after the machine group is deleted.', + 'path' => '/machinegroups/{machineGroup}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'machineGroup', + 'in' => 'path', + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group-4', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], ], ], @@ -15758,7 +8665,7 @@ 'title' => 'DeleteMachineGroup', 'description' => '### Usage notes'."\n" ."\n" - .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | MachineGroupNotExist| MachineGroup groupName does not exist.| 机器组不存在。 |'."\n" @@ -15777,251 +8684,161 @@ 'action' => 'log:DeleteMachineGroup', '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}'], ], ], ], ], ], - 'DeleteMaxComputeExport' => [ - 'summary' => 'Deletes a MaxCompute data shipping job.', - 'path' => '/maxcomputeexports/{mcExportName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteMaterializedView' => [ + 'summary' => 'Deletes a materialized view.', + 'path' => '/materializedviews/{name}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '203413', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'riskType' => 'none', + 'abilityTreeCode' => '294477', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'mcExportName', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the MaxCompute data shipping job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'DeleteMaxComputeExport', - 'description' => '* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n", + 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteMaterializedView', ], - 'DeleteMemories' => [ - 'path' => '/memorystores/{memoryStore}/memories', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteMaxComputeExport' => [ + 'summary' => 'Deletes a MaxCompute data shipping job.', + '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' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'memoryStore', + 'name' => 'mcExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'agent_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'user_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'run_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The unique name of the MaxCompute data shipping job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456', 'title' => ''], ], - [ - 'name' => 'app_id', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => 'Deletes memories in batches.', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteMaxComputeExport', + 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteMemories', ], - 'DeleteMemory' => [ - 'path' => '/memorystores/{memoryStore}/memories/{memoryId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteMetricStore' => [ + 'summary' => 'Deletes an existing Metricstore. When you delete a Metricstore, the metric data stored in the Metricstore and associated resources such as associated collection settings and transformation settings are also deleted.', + 'path' => '/metricstores/{name}', + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => [], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -16029,352 +8846,134 @@ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '225684', + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'memoryStore', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store', 'title' => ''], ], - [ - 'name' => 'memoryId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => 'The specified metricstore xxx does not exist.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'summary' => 'Deletes a memory.', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteMetricStore', + 'description' => 'Metricstores are used to store metric data. For more information, see [Metric data](~~174965~~).'."\n" + ."\n" + .'- You must specify an existing Metricstore.'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query metric data is obtained. The information includes the name of the project to which the metric data belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" + ."\n" + .'- You can create up to 200 Logstores or Metricstores in a project.'."\n" + ."\n" + .'- Metric data is automatically deleted when the retention period of the metric data ends.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteMemory', ], - 'DeleteMemoryStore' => [ - 'path' => '/memorystores/{memoryStore}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'DeleteOSSExport' => [ + 'summary' => 'Deletes a specified OSS data shipping job.', + 'path' => '/ossexports/{ossExportName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => 'Deletes a memory store.', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteMemoryStore', - ], - 'DeleteMetricStore' => [ - 'summary' => 'Deletes an existing Metricstore. When you delete a Metricstore, the metric data stored in the Metricstore and associated resources such as associated collection settings and transformation settings are also deleted.', - 'path' => '/metricstores/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '225684', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], - ], - [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Metricstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_metric_store', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'MetricStoreNotExist', - 'errorMessage' => 'The specified metricstore xxx does not exist.', - 'description' => 'The specified metricstore xxx does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteMetricStore', - 'description' => 'Metricstores are used to store metric data. For more information, see [Metric data](~~174965~~).'."\n" - ."\n" - .'* You must specify an existing Metricstore.'."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query metric data is obtained. The information includes the name of the project to which the metric data belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" - .'* You can create up to 200 Logstores or Metricstores in a project.'."\n" - .'* Metric data is automatically deleted when the retention period of the metric data ends.', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - 'DeleteOSSExport' => [ - 'summary' => 'Deletes a specified OSS data shipping job.', - 'path' => '/ossexports/{ossExportName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], + '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 name', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['description' => 'Project name', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the OSS data shipping job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'export-oss-1234567890-123456'."\n", - ], + 'schema' => ['description' => 'The name of the OSS data shipping job.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'DeleteOSSExport', 'changeSet' => [], @@ -16382,98 +8981,60 @@ 'flowControlList' => [], ], 'ramActions' => [], + 'translator' => 'machine', ], 'DeleteOSSHDFSExport' => [ 'summary' => 'Deletes an OSS-HDFS data shipping job.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-osshdfs-1234567890-123456'."\n" - ."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The unique name of the job.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n" + ."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], ], @@ -16489,100 +9050,59 @@ 'DeleteOSSIngestion' => [ 'summary' => 'Deletes an OSS import task.', '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' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The project name.', - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'ossIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the OSS import task.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ingest-oss-123456', - ], + 'schema' => ['description' => 'The name of the OSS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'DeleteOSSIngestion', 'changeSet' => [], @@ -16594,30 +9114,21 @@ 'DeleteProject' => [ 'summary' => 'Deletes a specified 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', ], @@ -16625,70 +9136,34 @@ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-project-test', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test', 'title' => ''], ], [ 'name' => 'forceDelete', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], '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'], ], ], ], @@ -16714,9 +9189,7 @@ .'| `log:DeleteProject` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', 'requestParamsDescription' => 'Request example:'."\n" ."\n" - .'DELETE / HTTP/1.1'."\n" - .'Host:ali-project-test.cn-hangzhou.log.aliyuncs.com'."\n" - .'Content-Type:application/json'."\n" + .'DELETE / HTTP/1.1 Host:ali-project-test.cn-hangzhou.log.aliyuncs.com Content-Type:application/json'."\n" ."\n" .'Common request parameters', 'responseParamsDescription' => 'Response example:'."\n" @@ -16739,18 +9212,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}'], ], ], ], @@ -16759,80 +9224,48 @@ 'DeleteProjectPolicy' => [ 'summary' => 'Deletes a 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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], ], @@ -16841,12 +9274,13 @@ 'title' => 'DeleteProjectPolicy', 'description' => '### [](#)Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -16858,218 +9292,125 @@ 'action' => 'log:DeleteProjectPolicy', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DeleteS3Ingestion' => [ - 'summary' => 'Deletes an S3 import task.', '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, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ 'name' => 's3IngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the S3 ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'DeleteS3Ingestion', + 'summary' => 'Deletes an S3 ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'DeleteS3Ingestion', - 'translator' => 'machine', ], 'DeleteSavedSearch' => [ 'summary' => 'Deletes a saved search.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'savedsearchName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the saved search to be deleted.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-savedsearch-name', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the saved search to be deleted.', 'type' => 'string', 'required' => true, 'example' => 'test-savedsearch-name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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'], ], ], ], @@ -17078,21 +9419,23 @@ 'title' => 'DeleteSavedSearch', 'description' => '### Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - .'* After you delete a saved search, it cannot be restored. Proceed with caution.'."\n" + .'- After you delete a saved search, it cannot be restored. Proceed with caution.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:DeleteSavedSearch`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}`|', + .'| Action | Resource |'."\n" + .'| :---------------------- | :--------------------------------------------------------------------------------------- |'."\n" + .'| `log:DeleteSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -17104,18 +9447,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}'], ], ], ], @@ -17124,92 +9459,54 @@ 'DeleteScheduledSQL' => [ 'summary' => 'Deletes a Scheduled SQL job.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], ], @@ -17228,12 +9525,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -17242,20 +9534,14 @@ 'DeleteStoreView' => [ 'summary' => 'Deletes a dataset by using the name of the dataset.', 'path' => '/storeviews/{name}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -17264,85 +9550,45 @@ 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '208667', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'DeleteStoreView', 'changeSet' => [], @@ -17357,37 +9603,23 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeRegions' => [ - 'summary' => 'Returns a list of active regions.', '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' => [ @@ -17395,9 +9627,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '226892', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ @@ -17405,12 +9635,8 @@ 'in' => 'query', 'schema' => [ 'title' => 'A short description of struct', - 'description' => 'The language of the returned \\`localName\\` parameter.', - 'enumValueTitles' => [ - 'ja' => 'ja', - 'en' => 'en', - 'zh' => 'zh', - ], + 'description' => 'The language of the returned `localName` value.', + 'enumValueTitles' => ['ja' => 'ja', 'en' => 'en', 'zh' => 'zh'], 'type' => 'string', 'required' => false, 'example' => 'zh', @@ -17420,40 +9646,25 @@ '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' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'regions' => [ @@ -17461,39 +9672,15 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'region' => [ - 'description' => 'The SLS region.', - 'type' => 'string', - 'title' => '', - 'example' => '', - ], - 'localName' => [ - 'description' => 'The name of the SLS region.', - 'type' => 'string', - 'title' => '', - 'example' => '', - ], - 'intranetEndpoint' => [ - 'description' => 'The internal endpoint of SLS.', - 'type' => 'string', - 'title' => '', - 'example' => '', - ], - 'internetEndpoint' => [ - 'description' => 'The public endpoint of SLS.', - 'type' => 'string', - 'title' => '', - 'example' => '', - ], + 'region' => ['description' => 'The ID of the region.', 'type' => 'string', 'title' => '', 'example' => ''], + 'localName' => ['description' => 'The display name of the region.', 'type' => 'string', 'title' => '', 'example' => ''], + 'intranetEndpoint' => ['description' => 'The intranet endpoint of the region.', 'type' => 'string', 'title' => '', 'example' => ''], + 'internetEndpoint' => ['description' => 'The public endpoint of the region.', 'type' => 'string', 'title' => '', 'example' => ''], + 'internalEndpoint' => ['description' => 'The accelerated endpoint of the region.', 'type' => 'string', 'title' => '', 'example' => ''], 'dataRedundancyType' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The supported data redundancy types.', 'title' => '', 'example' => '', ], @@ -17502,7 +9689,7 @@ 'title' => '', 'example' => '', ], - 'description' => '', + 'description' => 'A list of available regions and their details.', 'title' => '', 'example' => '', ], @@ -17513,126 +9700,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' => 'DescribeRegions', + 'summary' => 'Queries the available regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"regions\\": [\\n {\\n \\"region\\": \\"\\",\\n \\"localName\\": \\"\\",\\n \\"intranetEndpoint\\": \\"\\",\\n \\"internetEndpoint\\": \\"\\",\\n \\"internalEndpoint\\": \\"\\",\\n \\"dataRedundancyType\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'DisableAlert' => [ 'summary' => 'Disables an alert rule.', 'path' => '/alerts/{alertName}?action=disable', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'DisableAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" @@ -17653,12 +9789,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -17667,92 +9798,54 @@ 'DisableScheduledSQL' => [ 'summary' => 'Disables the Scheduled SQL feature.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456', - 'title' => '', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], ], @@ -17771,12 +9864,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -17785,105 +9873,59 @@ 'EnableAlert' => [ 'summary' => 'Enables an alert rule.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'EnableAlert', 'changeSet' => [], @@ -17898,12 +9940,7 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -17912,92 +9949,54 @@ 'EnableScheduledSQL' => [ 'summary' => 'Enables the Scheduled SQL feature.', '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'."\n", - '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' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456', - 'title' => '', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], + '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'], ], ], ], @@ -18016,208 +10015,23 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], - ], - 'ExecuteQuery' => [ - 'summary' => 'Executes query interfaces such as SQL and SPL.', - 'path' => '/execute-query', - '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', - ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'Log project', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'Type, such as SQL', - 'type' => 'string', - 'required' => true, - 'example' => 'SQL', - 'default' => 'SQL', - 'title' => '', - ], - 'query' => [ - 'description' => 'Query statement', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'Accept-Encoding', - 'in' => 'header', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => 'lz4', - 'description' => '', - 'title' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], - ], - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], - ], - ], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'meta' => [ - 'type' => 'object', - 'properties' => [ - 'affectedRows' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'elapsedMillisecond' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'title' => '', - 'description' => 'Schema of Response', - 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meta\\": {\\n \\"affectedRows\\": 0,\\n \\"elapsedMillisecond\\": 0\\n }\\n}","type":"json"}]', - 'title' => 'ExecuteQuery', ], 'GetAgentInstanceConfig' => [ 'path' => '/agentinstanceconfigs/{configType}', - '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' => [ @@ -18225,9 +10039,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227420', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ @@ -18237,20 +10049,8 @@ 'schema' => [ 'description' => 'The type of the process-level configuration.', 'enumValueTitles' => [ - 'apm_biz_trace' => 'apm\\_biz\\_trace', - 'apm_self_protect' => 'apm\\_self\\_protect', - 'apm_convergence' => 'APM Convergence', - 'apm_custom_extract' => 'apm\\_custom\\_extract', - 'apm_pilot' => 'apm\\_pilot', - 'apm_trace' => 'apm\\_trace', - 'rum_app_config' => 'rum\\_app\\_config', - 'security_rasp' => 'security\\_rasp', - 'rum_web_config' => 'rum\\_web\\_config', - 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', - 'apm_intacheap' => 'apm\\_intacheap', - 'apm_user_method' => 'apm\\_user\\_method', - 'apm_global' => 'apm\\_global', - 'apm_forward_process' => 'apm\\_forward\\_process', + 'apm_biz_trace' => 'apm\\_biz\\_trace', 'apm_self_protect' => 'apm\\_self\\_protect', 'apm_convergence' => 'APM Convergence', 'apm_custom_extract' => 'apm\\_custom\\_extract', 'apm_pilot' => 'apm\\_pilot', 'apm_trace' => 'apm\\_trace', 'rum_app_config' => 'rum\\_app\\_config', 'security_rasp' => 'security\\_rasp', 'rum_web_config' => 'rum\\_web\\_config', 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', + 'apm_intacheap' => 'apm\\_intacheap', 'apm_user_method' => 'apm\\_user\\_method', 'apm_global' => 'apm\\_global', 'apm_forward_process' => 'apm\\_forward\\_process', ], 'type' => 'string', 'required' => true, @@ -18264,13 +10064,8 @@ 'style' => 'json', 'schema' => [ 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'Process configuration owner', - 'type' => 'string', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'Process configuration owner', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"', 'title' => ''], 'description' => 'The owner of the process-level configuration.', 'required' => false, 'title' => '', @@ -18282,96 +10077,46 @@ 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'], ], ], 'schema' => [ 'type' => 'object', 'properties' => [ - 'configType' => [ - 'description' => 'The type of the process-level configuration.', - 'type' => 'string', - 'title' => '', - 'example' => 'apm_biz_trace', - ], + 'configType' => ['description' => 'The type of the process-level configuration.', 'type' => 'string', 'title' => '', 'example' => 'apm_biz_trace'], 'attributes' => [ 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The source of the process configuration.', - 'type' => 'string', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The source of the process configuration.', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"', 'title' => ''], 'description' => 'The owner of the configuration for the process.', 'title' => '', 'example' => '', ], - 'config' => [ - 'description' => 'The default configuration.', - 'type' => 'string', - 'title' => '', - 'example' => '{}', - ], + 'config' => ['description' => 'The default configuration.', 'type' => 'string', 'title' => '', 'example' => '{}'], 'grayConfigs' => [ 'type' => 'array', - 'items' => [ - 'description' => 'A canary release configuration.', - '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'A canary release configuration.', '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', 'title' => '', 'example' => ''], 'title' => '', 'description' => 'The canary release configurations.', 'example' => '', ], - 'createTime' => [ - 'description' => 'The time when the configuration was created.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '1749543828', - ], - 'lastModifyTime' => [ - 'description' => 'The time when the configuration was last modified.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '1749543828', - ], + 'createTime' => ['description' => 'The time when the configuration was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1749543828'], + 'lastModifyTime' => ['description' => 'The time when the configuration was last modified.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1749543828'], ], 'description' => '', 'title' => '', @@ -18379,9 +10124,7 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAgentInstanceConfig', 'summary' => 'Retrieves a process-level configuration.', 'changeSet' => [], @@ -18394,115 +10137,60 @@ 'GetAlert' => [ 'summary' => 'Queries the information about an alert rule.', 'path' => '/alerts/{alertName}', - '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' => '200220', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'alertName', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456', - 'title' => '', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => [ - 'description' => 'The configurations of the alert rule.'."\n", - '$ref' => '#/components/schemas/Alert', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The configurations of the alert rule.', '$ref' => '#/components/schemas/Alert', 'title' => '', 'example' => ''], ], ], - '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/1h\\"\\n },\\n \\"createTime\\": 0,\\n \\"lastModifiedTime\\": 0,\\n \\"status\\": \\"ENABLED/DISABLED\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAlert', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" @@ -18522,122 +10210,65 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"alert-123456\\",\\n \\"displayName\\": \\"alertNameExample\\",\\n \\"description\\": \\"Alert Desc\\",\\n \\"configuration\\": {\\n \\"muteUntil\\": 1698907508,\\n \\"version\\": \\"2.0\\",\\n \\"type\\": \\"default\\",\\n \\"templateConfiguration\\": {\\n \\"id\\": \\"sls.app.ack.ip.not_enough\\",\\n \\"type\\": \\"sys\\",\\n \\"version\\": \\"1\\",\\n \\"lang\\": \\"cn\\",\\n \\"tokens\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"aonotations\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"dashboard\\": \\"DasnboardExample\\",\\n \\"threshold\\": 1,\\n \\"noDataFire\\": false,\\n \\"noDataSeverity\\": 6,\\n \\"sendResolved\\": false,\\n \\"queryList\\": [\\n {\\n \\"chartTitle\\": \\"chartExmaple\\",\\n \\"query\\": \\"* | select *\\",\\n \\"timeSpanType\\": \\"Relative\\",\\n \\"start\\": \\"-5m\\",\\n \\"end\\": \\"now\\",\\n \\"storeType\\": \\"log\\",\\n \\"project\\": \\"projectExample\\",\\n \\"store\\": \\"store Example\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"roleArn\\": \\"\\",\\n \\"dashboardId\\": \\"dashboardExample\\",\\n \\"powerSqlMode\\": \\"auto\\",\\n \\"ui\\": \\"\\"\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"key\\": \\"title\\",\\n \\"value\\": \\"example value\\"\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"key\\": \\"title\\",\\n \\"value\\": \\"example value\\"\\n }\\n ],\\n \\"conditionConfiguration\\": {\\n \\"condition\\": \\"cnt > 100\\",\\n \\"countCondition\\": \\"__count__ > 5\\"\\n },\\n \\"severityConfigurations\\": [\\n {\\n \\"severity\\": 8,\\n \\"evalCondition\\": {\\n \\"condition\\": \\"cnt > 100\\",\\n \\"countCondition\\": \\"__count__ > 5\\"\\n }\\n }\\n ],\\n \\"joinConfigurations\\": [\\n {\\n \\"type\\": \\"left_join\\",\\n \\"condition\\": \\"$0.id == $1.id\\"\\n }\\n ],\\n \\"groupConfiguration\\": {\\n \\"type\\": \\"custom\\",\\n \\"fields\\": [\\n \\"id\\"\\n ]\\n },\\n \\"policyConfiguration\\": {\\n \\"alertPolicyId\\": \\"sls.builtin.dynamic\\",\\n \\"actionPolicyId\\": \\"example_action_policy\\",\\n \\"repeatInterval\\": \\"10m\\"\\n },\\n \\"autoAnnotation\\": false,\\n \\"sinkEventStore\\": {\\n \\"enabled\\": true,\\n \\"endpoint\\": \\"cn-shanghai-intranet.log.aliyuncs.com\\",\\n \\"project\\": \\"exampleProject\\",\\n \\"eventStore\\": \\"exampleStore\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\"\\n },\\n \\"sinkCms\\": {\\n \\"enabled\\": true\\n },\\n \\"sinkAlerthub\\": {\\n \\"enabled\\": true\\n },\\n \\"tags\\": [\\n \\"host\\"\\n ]\\n },\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"createTime\\": 1695090077,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"ENABLED/DISABLED\\"\\n}","type":"json"}]', ], 'GetAnnotationData' => [ 'summary' => 'Retrieves a data struct from a dataset by its unique identity.', 'path' => '/ml/annotationdataset/{datasetId}/annotationdata/{annotationdataId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + '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' => 'The unique identity of the dataset.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => 'The unique identity of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], [ 'name' => 'annotationdataId', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique identity of the data.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '2156d560fc7c01420542df92cd6365ds', - ], + 'schema' => ['description' => 'The unique identity of the data.', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The data struct.', - '$ref' => '#/components/schemas/MLDataParam', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The data struct.', '$ref' => '#/components/schemas/MLDataParam', 'title' => '', 'example' => ''], ], ], - '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' => 'GetAnnotationData', 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', @@ -18646,102 +10277,54 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'GetAnnotationDataSet' => [ 'summary' => 'Retrieves information about a dataset.', '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' => 'The unique ID of the dataset.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The dataset struct.', - '$ref' => '#/components/schemas/MLDataSetParam', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The dataset struct.', '$ref' => '#/components/schemas/MLDataSetParam', 'title' => '', 'example' => ''], ], ], - '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' => 'GetAnnotationDataSet', 'description' => 'The endpoint for this API is available only in the China (Shanghai) and Singapore regions.', @@ -18750,102 +10333,54 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'GetAnnotationLabel' => [ 'summary' => 'Retrieves a label table by its ID.', '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' => 'The ID of the label.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799', - ], + 'schema' => ['description' => 'The ID of the label.', 'type' => 'string', 'required' => false, 'example' => 'sls_builtin_4e0aba6d9664073513e9954fb57bd799', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The label table struct.', - '$ref' => '#/components/schemas/MLLabelParam', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The label table struct.', '$ref' => '#/components/schemas/MLLabelParam', 'title' => '', 'example' => ''], ], ], - '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' => 'GetAnnotationLabel', 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', @@ -18854,126 +10389,67 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'GetAppliedConfigs' => [ 'summary' => 'Queries the Logtail configurations that are applied to a machine group.', '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group', - ], + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The information about the Logtail configurations.'."\n", + 'description' => 'The information about the Logtail configurations.', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '', - 'description' => 'The number of Logtail configurations.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'count' => ['description' => 'The number of Logtail configurations.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'configs' => [ 'title' => '', - 'description' => 'The names of the Logtail configurations.'."\n", + 'description' => 'The names of the Logtail configurations.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The information about the Logtail configuration.'."\n", - 'type' => 'string', - 'example' => '[ "two", "three", "test_logstore" ]', - ], + 'items' => ['description' => 'The information about the Logtail configuration.', 'type' => 'string', 'example' => '[ "two", "three", "test_logstore" ]', 'title' => ''], 'example' => '', ], ], @@ -18981,9 +10457,9 @@ ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"count\\": 2,\\n \\"configs\\": [\\n \\"[ \\\\\\"two\\\\\\", \\\\\\"three\\\\\\", \\\\\\"test_logstore\\\\\\" ]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 2,\\n \\"configs\\": [\\n \\"[ \\\\\\"two\\\\\\", \\\\\\"three\\\\\\", \\\\\\"test_logstore\\\\\\" ]\\"\\n ]\\n}","type":"json"}]', 'title' => 'GetAppliedConfigs', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -19002,18 +10478,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}'], ], ], ], @@ -19022,121 +10490,63 @@ 'GetAppliedMachineGroups' => [ 'summary' => 'Queries the machine groups to which a Logtail configuration is bound.', '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logtail configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'logtail-config-sample', - ], + 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The information about the machine groups.'."\n", + 'description' => 'The information about the machine groups.', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '', - 'description' => 'The number of returned machine groups.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], + 'count' => ['description' => 'The number of returned machine groups.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], 'machinegroups' => [ 'title' => '', - 'description' => 'The names of the returned machine groups.'."\n", + 'description' => 'The names of the returned machine groups.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'example' => 'sample-group1', - ], + 'items' => ['description' => 'The name of the machine group.', 'type' => 'string', 'title' => '', 'example' => 'sample-group1'], 'example' => '[ "sample-group1","sample-group2" ]', ], ], @@ -19144,9 +10554,9 @@ ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"count\\": 2,\\n \\"machinegroups\\": [\\n \\"sample-group1\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 2,\\n \\"machinegroups\\": [\\n \\"sample-group1\\"\\n ]\\n}","type":"json"}]', 'title' => 'GetAppliedMachineGroups', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -19165,18 +10575,10 @@ '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}'], ], ], ], @@ -19185,12 +10587,8 @@ 'GetAsyncSql' => [ 'summary' => 'Retrieves the status and results of an asynchronous SQL query.', 'path' => '/asyncsql/{queryId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -19205,104 +10603,54 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '292959', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', 'allowEmptyValue' => true, - 'schema' => [ - 'type' => 'string', - 'description' => 'The name of the project.', - 'title' => '', - 'required' => false, - 'example' => 'sls-demo-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'sls-demo-project', 'title' => ''], ], [ 'name' => 'queryId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => 'The ID of the asynchronous SQL query. This ID is fixed throughout the SQL lifecycle.', - 'title' => '', - 'required' => false, - 'example' => '690C4F2A16FBD65C40000484_14', - ], + 'schema' => ['description' => 'The ID of the asynchronous SQL query. This ID is fixed throughout the SQL lifecycle.', 'type' => 'string', 'required' => false, 'example' => '690C4F2A16FBD65C40000484_14', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'The offset for paginated results.', - 'title' => '', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The offset for paginated results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'line', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'The number of results to return per page. The maximum value is 1000.', - 'title' => '', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The number of results to return per page. The maximum value is 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Content-Type' => [ - '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'], ], ], - 'schema' => [ - '$ref' => '#/components/schemas/AsyncSqlResponseData', - 'description' => 'The data format of the response body. This corresponds to the protobuf format.', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The data format of the response body. This corresponds to the protobuf format.', '$ref' => '#/components/schemas/AsyncSqlResponseData', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAsyncSql', 'description' => 'After you submit an SQL request using the SubmitAsyncSql operation, you can use this operation to poll the execution status of the request. You can set the polling interval to 1 second or longer. When the query is complete, use the GetAsyncSql operation to retrieve the results in pages.', 'responseParamsDescription' => 'The error\\_code and error\\_message parameters are valid only when the state parameter is FAILED.', @@ -19314,236 +10662,126 @@ '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' => 'Retrieves information about an Azure BLOB import task.', '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' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'azureBlobIngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - '$ref' => '#/components/schemas/AzureBlobIngestion', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['$ref' => '#/components/schemas/AzureBlobIngestion', 'description' => '', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAzureBlobIngestion', + 'summary' => 'Gets the details of an Azure Blob ingestion.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'title' => 'GetAzureBlobIngestion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-azure-blob-123456\\",\\n \\"description\\": \\"azure blob ingestion\\",\\n \\"displayName\\": \\"azure blob ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"30m\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"tagPackId\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accountName\\": \\"test001\\",\\n \\"accountKey\\": \\"dGVzdGtleQ==\\",\\n \\"containerName\\": \\"test-container\\",\\n \\"endpoint\\": \\"https://your-storage.blob.core.windows.net\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\"\\n}","type":"json"}]', ], 'GetCheckPoint' => [ 'summary' => 'Queries the checkpoints of a shard from which data is consumed by a consumer group.', 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'consumerGroup', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the consumer group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'consumer-group-1', - ], + 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1', 'title' => ''], ], [ 'name' => 'shard', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The shard ID.'."\n" - ."\n" - .'* If the specified shard does not exist, an empty list is returned.'."\n" - .'* If no shard ID is specified, the checkpoints of all shards are returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The shard ID.'."\n" + ."\n" + .'- If the specified shard does not exist, an empty list is returned.'."\n" + ."\n" + .'- If no shard ID is specified, the checkpoints of all shards are returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The checkpoints of the shard from which data is consumed by a consumer group.'."\n", + 'description' => 'The checkpoints of the shard from which data is consumed by a consumer group.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ - 'shard' => [ - 'title' => 'shard id。', - 'description' => 'The shard ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'checkpoint' => [ - 'title' => '', - 'description' => 'The value of the checkpoint.'."\n", - 'type' => 'string', - 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng==', - ], - 'updateTime' => [ - 'title' => '', - 'description' => 'The time when the checkpoint was last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1524224984800922', - ], - 'consumer' => [ - 'title' => '', - 'description' => 'The consumer at the checkpoint.'."\n", - 'type' => 'string', - 'example' => 'consumer_1', - ], + 'shard' => ['title' => 'shard id。', 'description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'checkpoint' => ['description' => 'The value of the checkpoint.', 'type' => 'string', 'example' => 'MTUyNDE1NTM3OTM3MzkwODQ5Ng==', 'title' => ''], + 'updateTime' => ['description' => 'The time when the checkpoint was last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1524224984800922', 'title' => ''], + 'consumer' => ['description' => 'The consumer at the checkpoint.', 'type' => 'string', 'example' => 'consumer_1', 'title' => ''], ], 'example' => '', ], @@ -19551,9 +10789,9 @@ ], ], ], - 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"shard\\": 0,\\n \\"checkpoint\\": \\"MTUyNDE1NTM3OTM3MzkwODQ5Ng==\\",\\n \\"updateTime\\": 1524224984800922,\\n \\"consumer\\": \\"consumer_1\\"\\n }\\n]","errorExample":""},{"type":"xml","example":"\\n 1\\n MTUyNDE1NTM3OTM3MzkwODQ5Ng==\\n 1524224984800922\\n consumer_1\\n","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shard\\": 0,\\n \\"checkpoint\\": \\"MTUyNDE1NTM3OTM3MzkwODQ5Ng==\\",\\n \\"updateTime\\": 1524224984800922,\\n \\"consumer\\": \\"consumer_1\\"\\n }\\n]","type":"json"}]', 'title' => 'GetCheckPoint', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -19571,107 +10809,59 @@ 'GetCollectionPolicy' => [ 'summary' => 'You can call the GetCollectionPolicy operation to retrieve the details of a specific rule.', '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' => 'The name of the rule.', - 'type' => 'string', - 'required' => true, - 'maxLength' => 63, - 'minLength' => 3, - 'title' => '', - 'example' => 'your_log_policy'."\n", - ], + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'maxLength' => 63, 'minLength' => 3, 'example' => 'your_log_policy'."\n", 'title' => ''], ], [ 'name' => 'productCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the product.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'oss', - ], + 'schema' => ['description' => 'The code of the product.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''], ], [ 'name' => 'dataCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The code for the log type.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'access_log', - ], + 'schema' => ['description' => 'The code for the log type.', 'type' => 'string', 'required' => false, 'example' => 'access_log', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + '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' => [ @@ -19683,109 +10873,43 @@ 'description' => 'The details of the rule.', 'type' => 'object', 'properties' => [ - 'policyName' => [ - 'description' => 'The name of the rule.', - 'type' => 'string', - 'title' => '', - 'example' => 'your_log_policy', - ], - 'enabled' => [ - 'description' => 'Indicates whether the rule is enabled.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'true'."\n", - ], - 'productCode' => [ - 'description' => 'The code of the product.', - 'type' => 'string', - 'title' => '', - 'example' => 'oss', - ], - 'dataCode' => [ - 'description' => 'The code for the log type.', - 'type' => 'string', - 'title' => '', - 'example' => 'access_log', - ], + 'policyName' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'your_log_policy', 'title' => ''], + 'enabled' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'productCode' => ['description' => 'The code of the product.', 'type' => 'string', 'example' => 'oss', 'title' => ''], + 'dataCode' => ['description' => 'The code for the log type.', 'type' => 'string', 'example' => 'access_log', 'title' => ''], 'policyConfig' => [ 'description' => 'The configuration of the collection rule.', 'type' => 'object', 'properties' => [ - 'resourceMode' => [ - 'description' => 'The collection pattern for resources.', - 'type' => 'string', - 'title' => '', - 'example' => 'all', - ], + 'resourceMode' => ['description' => 'The collection pattern for resources.', 'type' => 'string', 'example' => 'all', 'title' => ''], 'regions' => [ 'description' => 'The regions where the instances reside. Wildcard characters are supported.', 'type' => 'array', - 'items' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'title' => '', - 'example' => 'cn-hangzhou', - ], + 'items' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'title' => '', 'example' => '', ], 'instanceIds' => [ 'description' => 'The instance IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'title' => '', - 'example' => 'your-test-bucket1'."\n", - ], + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'your-test-bucket1'."\n", 'title' => ''], 'title' => '', 'example' => '', ], - 'resourceTags' => [ - 'description' => 'The resource tags.', - 'type' => 'object', - 'title' => '', - 'example' => '{"tag1":"value1","tag2":"value2"}', - ], + 'resourceTags' => ['description' => 'The resource tags.', 'type' => 'object', 'example' => '{"tag1":"value1","tag2":"value2"}', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'centralizeEnabled' => [ - 'description' => 'Indicates whether centralized storage is enabled.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'false', - ], + 'centralizeEnabled' => ['description' => 'Indicates whether centralized storage is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'centralizeConfig' => [ 'description' => 'The configuration for centralized shipping.', 'type' => 'object', 'properties' => [ - 'destRegion' => [ - 'description' => 'The destination region for centralized shipping.', - 'type' => 'string', - 'title' => '', - 'example' => 'cn-beijing'."\n", - ], - 'destProject' => [ - 'description' => 'The destination project for centralized shipping.', - 'type' => 'string', - 'title' => '', - 'example' => 'your-sls-project-in-beijing'."\n", - ], - 'destLogstore' => [ - 'description' => 'The destination Logstore for centralized shipping.', - 'type' => 'string', - 'title' => '', - 'example' => 'your-sls-logstore-in-beijing'."\n", - ], - 'destTTL' => [ - 'description' => 'The retention period of the destination Logstore. Unit: days.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '0', - ], + 'destRegion' => ['description' => 'The destination region for centralized shipping.', 'type' => 'string', 'example' => 'cn-beijing'."\n", 'title' => ''], + 'destProject' => ['description' => 'The destination project for centralized shipping.', 'type' => 'string', 'example' => 'your-sls-project-in-beijing'."\n", 'title' => ''], + 'destLogstore' => ['description' => 'The destination Logstore for centralized shipping.', 'type' => 'string', 'example' => 'your-sls-logstore-in-beijing'."\n", 'title' => ''], + 'destTTL' => ['description' => 'The retention period of the destination Logstore. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', @@ -19794,21 +10918,11 @@ 'description' => 'The configuration of the resource directory. This parameter is empty if no configuration is specified.', 'type' => 'object', 'properties' => [ - 'accountGroupType' => [ - 'description' => 'The mode for selecting accounts in the resource directory. Valid values: \\`all\\` and \\`custom\\`.', - 'type' => 'string', - 'title' => '', - 'example' => 'all,custom', - ], + 'accountGroupType' => ['description' => 'The mode for selecting accounts in the resource directory. Valid values: \\`all\\` and \\`custom\\`.', 'type' => 'string', 'example' => 'all,custom', 'title' => ''], 'members' => [ 'description' => 'The member accounts. This parameter is returned only when \\`accountGroupType\\` is set to \\`custom\\`.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the Alibaba Cloud account.', - 'type' => 'string', - 'title' => '', - 'example' => '165***********50', - ], + 'items' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '165***********50', 'title' => ''], 'title' => '', 'example' => '', ], @@ -19820,34 +10934,14 @@ 'description' => 'The configuration that is supported only for global log types, such as when \\`productCode\\` is \\`sls\\`. Otherwise, this parameter is empty.', 'type' => 'object', 'properties' => [ - 'dataRegion' => [ - 'description' => 'This parameter is supported only for global log types, such as when \\`productCode\\` is \\`sls\\`. This parameter specifies the region to which global logs are collected during the initial configuration.', - 'type' => 'string', - 'title' => '', - 'example' => 'cn-beijing', - ], - 'dataProject' => [ - 'description' => 'This parameter is valid only for global log types, such as when \\`productCode\\` is \\`sls\\`. If this parameter is left empty, logs are collected to the default project of the account in the specified \\`dataRegion\\`.', - 'type' => 'string', - 'title' => '', - 'example' => '""', - ], + 'dataRegion' => ['description' => 'This parameter is supported only for global log types, such as when \\`productCode\\` is \\`sls\\`. This parameter specifies the region to which global logs are collected during the initial configuration.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'dataProject' => ['description' => 'This parameter is valid only for global log types, such as when \\`productCode\\` is \\`sls\\`. If this parameter is left empty, logs are collected to the default project of the account in the specified \\`dataRegion\\`.', 'type' => 'string', 'example' => '""', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'internalPolicy' => [ - 'description' => 'Indicates whether the rule is a built-in rule. Built-in rules cannot be modified or deleted.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'false', - ], - 'policyUid' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the rule belongs. If the rule is created by a resource directory administrator or a delegated administrator, this parameter specifies the ID of the administrator\'s Alibaba Cloud account.', - 'type' => 'string', - 'title' => '', - 'example' => '148***********50'."\n", - ], + 'internalPolicy' => ['description' => 'Indicates whether the rule is a built-in rule. Built-in rules cannot be modified or deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'policyUid' => ['description' => 'The ID of the Alibaba Cloud account to which the rule belongs. If the rule is created by a resource directory administrator or a delegated administrator, this parameter specifies the ID of the administrator\'s Alibaba Cloud account.', 'type' => 'string', 'example' => '148***********50'."\n", 'title' => ''], ], 'title' => '', 'example' => '', @@ -19857,9 +10951,7 @@ ], ], ], - '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' => 'GetCollectionPolicy', 'description' => 'The endpoint for this operation is available only in the China (Shanghai), Singapore, and China (Heyuan) Automotive Compliance Cloud (cn-heyuan-acdr-1) regions.', @@ -19868,125 +10960,80 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'GetConfig' => [ - 'summary' => 'Queries the details of a Logtail configuration.', + 'summary' => 'Gets the details of a Logtail configuration.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logtail configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'logtail-config-sample', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'logtail-config-sample', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The data structure of the Logtail configuration.'."\n", - '$ref' => '#/components/schemas/LogtailConfig', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The data structure of the Logtail configuration.', '$ref' => '#/components/schemas/LogtailConfig', 'title' => '', 'example' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"configName\\": \\"test-config\\",\\n \\"logSample\\": \\"2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world\\",\\n \\"inputType\\": \\"file\\",\\n \\"inputDetail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"outputType\\": \\"LogService\\",\\n \\"outputDetail\\": {\\n \\"endpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"logstoreName\\": \\"test-logstore\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"telemetryType\\": \\"logs\\"\\n },\\n \\"createTime\\": 1655176807,\\n \\"lastModifyTime\\": 1655176807\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"configName\\": \\"test-config\\",\\n \\"logSample\\": \\"2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world\\",\\n \\"inputType\\": \\"file\\",\\n \\"inputDetail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"outputType\\": \\"LogService\\",\\n \\"outputDetail\\": {\\n \\"endpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"logstoreName\\": \\"test-logstore\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"telemetryType\\": \\"logs\\"\\n },\\n \\"createTime\\": 1655176807,\\n \\"lastModifyTime\\": 1655176807\\n}","type":"json"}]', 'title' => 'GetConfig', 'description' => '### [](#)Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" - .'* The name of the required Logtail configuration is obtained. For more information, see [ListConfig](~~29043~~).'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" + ."\n" + .'- The name of the required Logtail configuration is obtained. For more information, see [ListConfig](~~29043~~).', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -20005,18 +11052,10 @@ '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}'], ], ], ], @@ -20025,107 +11064,60 @@ 'GetConsumeProcessor' => [ 'summary' => 'Retrieves the details of a consume processor.', '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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'processorName', 'in' => 'path', - 'schema' => [ - 'description' => 'The identifier of the consume processor.', - 'type' => 'string', - 'required' => true, - 'example' => 'consume-processor-1', - 'title' => '', - ], + 'schema' => ['description' => 'The identifier of the consume processor.', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], - 'schema' => [ - 'description' => 'The details of the consume processor.', - '$ref' => '#/components/schemas/ConsumeProcessor', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The details of the consume processor.', '$ref' => '#/components/schemas/ConsumeProcessor', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"processorName\\": \\"consume-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n}","type":"json"}]', 'title' => 'GetConsumeProcessor', 'changeSet' => [], @@ -20137,147 +11129,71 @@ 'GetContextLogs' => [ 'summary' => 'Queries the contextual logs of a specified log.', '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'pack_id', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The unique identifier of the log group to which the start log belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '85C897C740352DC6-808', - ], + 'schema' => ['description' => 'The unique identifier of the log group to which the start log belongs.', 'type' => 'string', 'required' => true, 'example' => '85C897C740352DC6-808', 'title' => ''], ], [ 'name' => 'pack_meta', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The unique context identifier of the start log in the log group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0', - ], + 'schema' => ['description' => 'The unique context identifier of the start log in the log group.', 'type' => 'string', 'required' => true, 'example' => '2|MTY1NTcwNTUzODY5MTY0MDk1Mg==|3|0', 'title' => ''], ], [ 'name' => 'back_lines', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of logs that you want to obtain and are generated before the generation time of the start log. Valid values: `(0,100]`.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of logs that you want to obtain and are generated before the generation time of the start log. Valid values: `(0,100]`.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'forward_lines', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of logs that you want to obtain and are generated after the generation time of the start log. Valid values: `(0,100]`.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of logs that you want to obtain and are generated after the generation time of the start log. Valid values: `(0,100]`.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total_lines' => [ - 'title' => '', - 'description' => 'The total number of logs that are returned. The logs include the start log that is specified in the request.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201', - ], - 'back_lines' => [ - 'title' => '', - 'description' => 'The number of logs that are generated before the generation time of the start log.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'forward_lines' => [ + 'total_lines' => ['description' => 'The total number of logs that are returned. The logs include the start log that is specified in the request.', 'type' => 'integer', 'format' => 'int64', 'example' => '201', 'title' => ''], + 'back_lines' => ['description' => 'The number of logs that are generated before the generation time of the start log.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'forward_lines' => ['description' => 'The number of logs that are generated after the generation time of the start log.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'progress' => ['description' => 'Indicates whether the query and analysis results are complete. Valid values:'."\n" + ."\n" + .'- Complete: The query is successful, and the complete query and analysis results are returned.'."\n" + ."\n" + .'- Incomplete: The query is successful, but the query and analysis results are incomplete. To obtain the complete results, you must repeat the request.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], + 'logs' => [ 'title' => '', - 'description' => 'The number of logs that are generated after the generation time of the start log.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'progress' => [ - 'title' => '', - 'description' => 'Indicates whether the query and analysis results are complete. Valid values:'."\n" - ."\n" - .'* Complete: The query is successful, and the complete query and analysis results are returned.'."\n" - .'* Incomplete: The query is successful, but the query and analysis results are incomplete. To obtain the complete results, you must repeat the request.'."\n", - 'type' => 'string', - 'example' => 'Complete', - ], - 'logs' => [ - 'title' => '', - 'description' => 'The logs that are returned.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The logs that are returned. The logs are arranged in contextual order. If no contextual logs are found based on the specified start log, this parameter is empty.'."\n", - 'type' => 'object', - 'example' => '{ "__index_number__": "-100", "__tag__:__pack_id__": "895CEA449A52FE-8c8", "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"}', - ], - 'example' => '', + 'description' => 'The logs that are returned.', + 'type' => 'array', + 'items' => ['description' => 'The logs that are returned. The logs are arranged in contextual order. If no contextual logs are found based on the specified start log, this parameter is empty.', 'type' => 'object', 'title' => '', 'example' => '{ "__index_number__": "-100", "__tag__:__pack_id__": "895CEA449A52FE-8c8", "__pack_meta__": "0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1"}'], + 'example' => '', ], ], 'example' => '', @@ -20288,34 +11204,38 @@ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"total_lines\\": 201,\\n \\"back_lines\\": 100,\\n \\"forward_lines\\": 100,\\n \\"progress\\": \\"Complete\\",\\n \\"logs\\": [\\n {\\n \\"__index_number__\\": \\"-100\\",\\n \\"__tag__:__pack_id__\\": \\"895CEA449A52FE-8c8\\",\\n \\"__pack_meta__\\": \\"0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total_lines\\": 201,\\n \\"back_lines\\": 100,\\n \\"forward_lines\\": 100,\\n \\"progress\\": \\"Complete\\",\\n \\"logs\\": [\\n {\\n \\"__index_number__\\": \\"-100\\",\\n \\"__tag__:__pack_id__\\": \\"895CEA449A52FE-8c8\\",\\n \\"__pack_meta__\\": \\"0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetContextLogs', 'description' => '### Usage notes'."\n" ."\n" - .'* You can specify a log as the start log. The time range of a contextual query is one day before and one day after the generation time of the start log.'."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- You can specify a log as the start log. The time range of a contextual query is one day before and one day after the generation time of the start log.'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + .'- Indexes are configured before you query logs. For more information, see [Create indexes](~~90732~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - .'* Indexes are configured before you query logs. For more information, see [Create indexes](~~90732~~).'."\n" - .'* The values of the pack\\_id and pack\\_meta fields are obtained before you query logs. The fields are internal fields, and you can obtain the values by using the debugging feature of your browser in the Simple Log Service console.'."\n" + .'- The values of the pack\\_id and pack\\_meta fields are obtained before you query logs. The fields are internal fields, and you can obtain the values by using the debugging feature of your browser in the Simple Log Service console.'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:GetLogStoreContextLogs`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}`|', + .'| Action | Resource |'."\n" + .'| :--------------------------- | :--------------------------------------------------------------------------------- |'."\n" + .'| `log:GetLogStoreContextLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', 'responseParamsDescription' => 'The logs parameter contains log content and the following fields that are formatted in key-value pairs.'."\n" ."\n" - .'|Field|Type|Example|Description|'."\n" - .'|:---|:---|:---|:---|'."\n" - .'|`__index_number__`|String|\\-100|The position of the log in the context. A negative value indicates that the log is generated before the generation time of the start log. The value 0 indicates that the log is the start log. A positive value indicates that the log is generated after the generation time of the start log. For example, the value -100 indicates that the log is the 100th log before the generation time of the start log.|'."\n" - .'|`__tag__:__pack_id__`|String|895CEA449A52FE-8c8|The unique identifier of the log group to which the log belongs. The identifier can be used as the value of the pack\\_id parameter in the request.|'."\n" - .'|`__pack_meta__`|String|`0|MTU1OTI4NTExMjg3NTQ2NDU1OA==|4|1`|The unique context identifier of the log in the log group. The identifier can be used as the value of the pack\\_meta parameter in the request.|', + .'| Field | Type | Example | Description |'."\n" + .'| :-------------------- | :----- | :----------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `__index_number__` | String | -100 | The position of the log in the context. A negative value indicates that the log is generated before the generation time of the start log. The value 0 indicates that the log is the start log. A positive value indicates that the log is generated after the generation time of the start log. For example, the value -100 indicates that the log is the 100th log before the generation time of the start log. |'."\n" + .'| `__tag__:__pack_id__` | String | 895CEA449A52FE-8c8 | The unique identifier of the log group to which the log belongs. The identifier can be used as the value of the pack_id parameter in the request. |'."\n" + .'| `__pack_meta__` | String | \\`0 | MTU1OTI4NTExMjg3NTQ2NDU1OA== |', 'extraInfo' => '| HTTP 状态码 | 错误码| 错误信息 | 描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'|404|ProjectNotExist|Project ProjectName does not exist.|Project 不存在。|'."\n" @@ -20471,132 +11391,67 @@ 'GetCursor' => [ 'summary' => 'Retrieves a cursor based on a specified time.', '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' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The project name.', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The logstore name.', - 'type' => 'string', - 'required' => true, - 'example' => 'sls-test-logstore', - ], + 'schema' => ['description' => 'The logstore name.', 'type' => 'string', 'required' => true, 'example' => 'sls-test-logstore', 'title' => ''], ], [ 'name' => 'shardId', 'in' => 'path', - 'schema' => [ - 'title' => 'shard id。', - 'description' => 'The shard ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => 'shard id。', 'description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'A point in time. This can be a UNIX timestamp or the string `begin` or `end`.', - 'type' => 'string', - 'required' => true, - 'example' => 'begin', - ], + 'schema' => ['description' => 'A point in time. This can be a UNIX timestamp or the string `begin` or `end`.', 'type' => 'string', 'required' => true, 'example' => 'begin', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The cursor value.', 'type' => 'object', 'properties' => [ - 'cursor' => [ - 'title' => '', - 'description' => 'The cursor value.', - 'type' => 'string', - 'example' => 'MTQ0NzI5OTYwNjg5NjYzMjM1Ng==', - ], + 'cursor' => ['description' => 'The cursor value.', 'type' => 'string', 'example' => 'MTQ0NzI5OTYwNjg5NjYzMjM1Ng==', 'title' => ''], ], 'title' => '', 'example' => '', @@ -20646,18 +11501,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}'], ], ], ], @@ -20666,133 +11513,68 @@ 'GetCursorTime' => [ 'summary' => 'Retrieves the server time that corresponds to a 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' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The project name.', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The logstore name.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'The logstore name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ 'name' => 'shardId', 'in' => 'path', - 'schema' => [ - 'title' => 'shard id。', - 'description' => 'The shard ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['title' => 'shard id。', 'description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ 'name' => 'cursor', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The cursor for which you want to obtain the timestamp. Call the [GetCursor](~~2771314~~) operation to obtain a cursor.'."\n" - ."\n" - .'> If the value of the cursor is less than the begin cursor or greater than the end cursor, InvalidCursor is returned. If the shard contains no data, the current time is returned.', - 'type' => 'string', - 'required' => true, - 'example' => 'MTU0NzQ3MDY4MjM3NjUxMzQ0Ng==', - ], + 'schema' => ['description' => 'The cursor for which you want to obtain the timestamp. Call the [GetCursor](~~2771314~~) operation to obtain a cursor.'."\n" + ."\n" + .'> If the value of the cursor is less than the begin cursor or greater than the end cursor, InvalidCursor is returned. If the shard contains no data, the current time is returned.', 'type' => 'string', 'required' => true, 'example' => 'MTU0NzQ3MDY4MjM3NjUxMzQ0Ng==', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => '', - 'description' => 'The server time that corresponds to the cursor. The value is a UNIX timestamp. A UNIX timestamp represents the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.', - 'type' => 'string', - 'example' => '1554260243', - ], + 'cursor_time' => ['description' => 'The server time that corresponds to the cursor. The value is a UNIX timestamp. A UNIX timestamp represents the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.', 'type' => 'string', 'example' => '1554260243', 'title' => ''], ], 'description' => '', 'title' => '', @@ -20839,18 +11621,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}'], ], ], ], @@ -20859,113 +11633,71 @@ 'GetDashboard' => [ 'summary' => 'Queries a dashboard.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'dashboardName', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The name of the dashboard.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the dashboard.', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The data structure of the dashboard.'."\n", - '$ref' => '#/components/schemas/dashboard', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The data structure of the dashboard.', '$ref' => '#/components/schemas/dashboard', 'title' => '', 'example' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"dashboardName\\": \\"dashboard-1609294922657-434834\\",\\n \\"displayName\\": \\"test-alert\\",\\n \\"description\\": \\"this is a dashboard\\",\\n \\"attribute\\": {\\n \\"key\\": \\"yyy\\"\\n },\\n \\"charts\\": [\\n {\\n \\"title\\": \\"my-chart\\",\\n \\"type\\": \\"linepro\\",\\n \\"search\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"display\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"action\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"dashboardName\\": \\"dashboard-1609294922657-434834\\",\\n \\"displayName\\": \\"test-alert\\",\\n \\"description\\": \\"this is a dashboard\\",\\n \\"attribute\\": {\\n \\"key\\": \\"yyy\\"\\n },\\n \\"charts\\": [\\n {\\n \\"title\\": \\"my-chart\\",\\n \\"type\\": \\"linepro\\",\\n \\"search\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"display\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"action\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetDashboard', 'description' => '### [](#)Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -20977,633 +11709,350 @@ '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}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], ], ], ], ], ], - 'GetDataset' => [ - 'summary' => 'Retrieves dataset information.', - 'path' => '/datasets/{name}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetDownloadJob' => [ + 'summary' => 'Retrieves information about a download task.', + 'path' => '/downloadjobs/{downloadJobName}', + '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' => '296325', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '216704', + 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', + 'name' => 'downloadJobName', + 'in' => 'path', 'schema' => [ - 'description' => 'A short description of struct', + 'description' => 'The name of the log download task.', + 'properties' => [], 'type' => 'string', + 'required' => true, 'title' => '', - 'example' => '', + 'example' => 'download-123', ], ], [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information about the download job.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'createTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', + 'status' => ['description' => 'The status of the download task.', 'type' => 'string', 'title' => '', 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR'], + 'name' => ['description' => 'The name of the download task.', 'type' => 'string', 'title' => '', 'example' => 'download-123'], + 'description' => ['description' => 'The description of the task.', 'type' => 'string', 'title' => '', 'example' => 'a download job'], + 'configuration' => [ 'title' => '', + 'description' => 'The download configuration.', + 'type' => 'object', + 'properties' => [ + 'logstore' => ['description' => 'The source Logstore.', 'type' => 'string', 'title' => '', 'example' => 'ali-test-logstore'], + 'fromTime' => ['description' => 'The start time of the download task. The value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722409860'], + 'toTime' => ['description' => 'The end time of the download task. The value is a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722411060'], + 'query' => ['description' => 'The search statement.', 'type' => 'string', 'title' => '', 'example' => '* | select *'], + 'powerSql' => ['description' => 'Specifies whether to enable PowerSQL.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'allowInComplete' => [ + 'description' => 'Specifies whether to allow downloading incomplete data.', + 'enumValueTitles' => ['true' => 'yes', 'false' => 'no'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'sink' => [ + 'title' => '', + 'description' => 'The export configuration.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The value is fixed to AliyunOSS.', 'type' => 'string', 'example' => 'AliyunOSS', 'title' => ''], + 'contentType' => ['description' => 'The file format.', 'type' => 'string', 'title' => '', 'example' => 'csv'], + 'compressionType' => ['description' => 'The compression format.', 'type' => 'string', 'title' => '', 'example' => 'none'], + 'roleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role that is used for the download.', 'type' => 'string', 'title' => '', 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole'], + 'bucket' => ['description' => 'The Object Storage Service (OSS) bucket.', 'type' => 'string', 'title' => '', 'example' => 'ali-test-oss-bucket'], + 'prefix' => ['description' => 'The prefix of the file that is saved to the bucket.', 'type' => 'string', 'example' => 'download/', 'title' => ''], + ], + 'example' => '', + ], + ], 'example' => '', ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', + 'createTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'title' => '', 'example' => '1722411060'], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'title' => '', 'example' => 'download-123456'], + 'executionDetails' => [ 'title' => '', - 'example' => '', - ], - 'schema' => [ + 'description' => 'The execution details.', 'type' => 'object', - 'additionalProperties' => [ - '$ref' => '#/components/schemas/IndexKey', - 'description' => '', - 'title' => '', - 'example' => '', + 'properties' => [ + 'progress' => ['description' => 'The download progress.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'filePath' => ['description' => 'The URL of the download result.', 'type' => 'string', 'title' => '', 'example' => 'https://xxx.csv.zst?xxx'], + 'fileSize' => ['description' => 'The size of the downloaded file in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123456'], + 'executeTime' => ['description' => 'The duration of the download task in seconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], + 'logCount' => ['description' => 'The number of downloaded log entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], + 'errorMessage' => ['description' => 'The error message if the download fails.', 'type' => 'string', 'title' => '', 'example' => 'timeout'], + 'checkSum' => ['description' => 'The ETag of the file.', 'type' => 'string', 'example' => 'EXSFGSDASDASDG123ASD', 'title' => ''], + 'notice' => ['type' => 'string', 'description' => 'Notification text. ', 'example' => 'test', 'title' => ''], ], - 'description' => '', - 'title' => '', 'example' => '', ], ], - 'description' => '', - 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"STARTING、RUNNING、SUCCEEDED、ERROR\\",\\n \\"name\\": \\"download-123\\",\\n \\"description\\": \\"a download job\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"ali-test-logstore\\",\\n \\"fromTime\\": 1722409860,\\n \\"toTime\\": 1722411060,\\n \\"query\\": \\"* | select *\\",\\n \\"powerSql\\": false,\\n \\"allowInComplete\\": true,\\n \\"sink\\": {\\n \\"type\\": \\"AliyunOSS\\",\\n \\"contentType\\": \\"csv\\",\\n \\"compressionType\\": \\"none\\",\\n \\"roleArn\\": \\"acs:ram::0123456789:role/aliyunlogdefaultrole\\",\\n \\"bucket\\": \\"ali-test-oss-bucket\\",\\n \\"prefix\\": \\"download/\\"\\n }\\n },\\n \\"createTime\\": \\"1722411060\\",\\n \\"displayName\\": \\"download-123456\\",\\n \\"executionDetails\\": {\\n \\"progress\\": 100,\\n \\"filePath\\": \\"https://xxx.csv.zst?xxx\\",\\n \\"fileSize\\": 123456,\\n \\"executeTime\\": 123,\\n \\"logCount\\": 123,\\n \\"errorMessage\\": \\"timeout\\",\\n \\"checkSum\\": \\"EXSFGSDASDASDG123ASD\\",\\n \\"notice\\": \\"test\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetDownloadJob', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - '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"}]', - 'title' => 'GetDataset', + 'translator' => 'machine', ], - 'GetDownloadJob' => [ - 'summary' => 'Retrieves information about a download task.', - 'path' => '/downloadjobs/{downloadJobName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetETL' => [ + 'summary' => 'Retrieves the configuration of a specified extract, transform, and load (ETL) job.', + 'path' => '/etls/{etlName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '216704', - 'abilityTreeNodes' => [ - 'FEATUREsls1J4K38', - ], + 'abilityTreeCode' => '203168', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ - [ - 'name' => 'downloadJobName', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the log download task.', - 'type' => 'string', - 'properties' => [], - 'required' => true, - 'example' => 'download-123', - ], - ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'etlName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the ETL job.', 'type' => 'string', 'required' => false, 'example' => 'etl-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The information about the download job.', - 'type' => 'object', - 'properties' => [ - 'status' => [ - 'title' => '', - 'description' => 'The status of the download task.', - 'type' => 'string', - 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR', - ], - 'name' => [ - 'title' => '', - 'description' => 'The name of the download task.', - 'type' => 'string', - 'example' => 'download-123', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the task.', - 'type' => 'string', - 'example' => 'a download job', - ], - 'configuration' => [ - 'title' => '', - 'description' => 'The download configuration.', - 'type' => 'object', - 'properties' => [ - 'logstore' => [ - 'title' => '', - 'description' => 'The source Logstore.', - 'type' => 'string', - 'example' => 'ali-test-logstore', - ], - 'fromTime' => [ - 'title' => '', - 'description' => 'The start time of the download task. The value is a UNIX timestamp in seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1722409860', - ], - 'toTime' => [ - 'title' => '', - 'description' => 'The end time of the download task. The value is a UNIX timestamp in seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1722411060', - ], - 'query' => [ - 'title' => '', - 'description' => 'The search statement.', - 'type' => 'string', - 'example' => '* | select *', - ], - 'powerSql' => [ - 'title' => '', - 'description' => 'Specifies whether to enable PowerSQL.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'allowInComplete' => [ - 'description' => 'Specifies whether to allow downloading incomplete data.', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'yes', - 'false' => 'no', - ], - 'title' => '', - 'example' => 'true', - ], - 'sink' => [ - 'title' => '', - 'description' => 'The export configuration.', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => 'The value is fixed to AliyunOSS.', - 'type' => 'string', - 'title' => '', - 'example' => 'AliyunOSS', - ], - 'contentType' => [ - 'title' => '', - 'description' => 'The file format.', - 'type' => 'string', - 'example' => 'csv', - ], - 'compressionType' => [ - 'title' => '', - 'description' => 'The compression format.', - 'type' => 'string', - 'example' => 'none', - ], - 'roleArn' => [ - 'title' => '', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role that is used for the download.', - 'type' => 'string', - 'example' => 'acs:ram::0123456789:role/aliyunlogdefaultrole', - ], - 'bucket' => [ - 'title' => '', - 'description' => 'The Object Storage Service (OSS) bucket.', - 'type' => 'string', - 'example' => 'ali-test-oss-bucket', - ], - 'prefix' => [ - 'description' => 'The prefix of the file that is saved to the bucket.', - 'type' => 'string', - 'title' => '', - 'example' => 'download/', - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'createTime' => [ - 'title' => '', - 'description' => 'The time when the task was created.', - 'type' => 'string', - 'example' => '1722411060', - ], - 'displayName' => [ - 'title' => '', - 'description' => 'The display name.', - 'type' => 'string', - 'example' => 'download-123456', - ], - 'executionDetails' => [ - 'title' => '', - 'description' => 'The execution details.', - 'type' => 'object', - 'properties' => [ - 'progress' => [ - 'title' => '', - 'description' => 'The download progress.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'filePath' => [ - 'title' => '', - 'description' => 'The URL of the download result.', - 'type' => 'string', - 'example' => 'https://xxx.csv.zst?xxx', - ], - 'fileSize' => [ - 'title' => '', - 'description' => 'The size of the downloaded file in bytes.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'executeTime' => [ - 'title' => '', - 'description' => 'The duration of the download task in seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'logCount' => [ - 'title' => '', - 'description' => 'The number of downloaded log entries.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'errorMessage' => [ - 'title' => '', - 'description' => 'The error message if the download fails.', - 'type' => 'string', - 'example' => 'timeout', - ], - 'checkSum' => [ - 'description' => 'The ETag of the file.', - 'type' => 'string', - 'title' => '', - 'example' => 'EXSFGSDASDASDG123ASD', - ], - 'notice' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'example' => '', - ], + 'schema' => ['description' => 'The configuration of the ETL job.', '$ref' => '#/components/schemas/ETL', 'title' => '', 'example' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ETL\\",\\n \\"description\\": \\"ETL\\",\\n \\"displayName\\": \\"ETL\\",\\n \\"configuration\\": {\\n \\"script\\": \\"e_set(\\\\\\"key\\\\\\",\\\\\\"value\\\\\\")\\",\\n \\"lang\\": \\"SPL\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"fromTime\\": 0,\\n \\"toTime\\": 0,\\n \\"sinks\\": [\\n {\\n \\"name\\": \\"test-etljob\\",\\n \\"endpoint\\": \\"\\",\\n \\"project\\": \\"test-project\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"datasets\\": [\\n \\"__UNNAMED__\\"\\n ],\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\"\\n }\\n ],\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714274900,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"f0eb655e501a8780808d1970ef6d04c4\\"\\n}","type":"json"}]', + 'title' => 'GetETL', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetETL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + ], + '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'], ], - '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"}]', - 'title' => 'GetDownloadJob', + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'esIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the ES/OpenSearch job.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The configuration of the ES/OpenSearch import job.', '$ref' => '#/components/schemas/ESIngestion', 'title' => '', 'example' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetElasticsearchIngestion', + 'summary' => 'Retrieves information about an ES/OpenSearch import job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-es-123456\\",\\n \\"description\\": \\"es ingestion\\",\\n \\"displayName\\": \\"es ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"test-logstore\\",\\n \\"source\\": {\\n \\"BootstrapServers\\": \\"\\",\\n \\"Index\\": \\"\\",\\n \\"Username\\": \\"\\",\\n \\"Password\\": \\"\\",\\n \\"TimeFieldName\\": \\"\\",\\n \\"TimeFormat\\": \\"\\",\\n \\"TimeZone\\": \\"\\",\\n \\"Query\\": \\"\\",\\n \\"ConnectorMode\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"MaxDataDelaySec\\": 0,\\n \\"MinFragRangeSec\\": 0,\\n \\"VpcId\\": \\"\\"\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', ], - 'GetETL' => [ - 'summary' => 'Retrieves the configuration of a specified extract, transform, and load (ETL) job.', - 'path' => '/etls/{etlName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetGCSIngestion' => [ + 'path' => '/gcsingestions/{gcsIngestionName}', + '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', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => 'The name of the project.', - 'required' => false, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], ], [ - 'name' => 'etlName', + 'name' => 'gcsIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the ETL job.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'etl-123456', - ], + 'schema' => ['description' => 'The name of the GCS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-12345', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'The configuration of the ETL job.', - '$ref' => '#/components/schemas/ETL', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The GCS import task.', '$ref' => '#/components/schemas/GCSIngestion', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ETL\\",\\n \\"description\\": \\"ETL\\",\\n \\"displayName\\": \\"ETL\\",\\n \\"configuration\\": {\\n \\"script\\": \\"e_set(\\\\\\"key\\\\\\",\\\\\\"value\\\\\\")\\",\\n \\"lang\\": \\"SPL\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"fromTime\\": 0,\\n \\"toTime\\": 0,\\n \\"sinks\\": [\\n {\\n \\"name\\": \\"test-etljob\\",\\n \\"endpoint\\": \\"\\",\\n \\"project\\": \\"test-project\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"datasets\\": [\\n \\"__UNNAMED__\\"\\n ],\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\"\\n }\\n ],\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714274900,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"f0eb655e501a8780808d1970ef6d04c4\\"\\n}","type":"json"}]', - 'title' => 'GetETL', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetGCSIngestion', + 'summary' => 'Retrieves a Google Cloud Storage (GCS) file import task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'log:GetETL', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-gcs-123456\\",\\n \\"description\\": \\"gcs ingestion\\",\\n \\"displayName\\": \\"gcs ingestion\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"gcsbucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"never\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"restoreObjectEnabled\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"tagPackId\\": false,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"format\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"lastModifiedTime\\": 1714360581\\n}","type":"json"}]', ], 'GetHistograms' => [ - 'summary' => 'You can call the GetHistograms operation to query the distribution of logs that meet the search criteria in a specified Logstore.', + 'summary' => 'Queries the distribution of logs that meet the specified query conditions in a Logstore by calling the GetHistograms operation.', 'path' => '/logstores/{logstore}/index?type=histogram', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The Logstore name.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range for the subinterval. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1409529600', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the subinterval. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1409529600'], ], [ 'name' => 'to', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range for the subinterval. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1409569200', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The end time of the subinterval. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1409569200'], ], [ 'name' => 'topic', 'in' => 'query', - 'schema' => [ - 'description' => 'The topic of the log.', - 'type' => 'string', - 'required' => false, - 'example' => 'topic', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The topic of the logs.', 'type' => 'string', 'required' => false, 'example' => 'topic'], ], [ 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'description' => 'The search statement. Only search statements are supported. Analytic statements are not supported. For more information about the syntax of search statements, see [Search syntax](~~43772~~).', - 'type' => 'string', - 'required' => false, - 'example' => 'with_pack_meta', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The query statement. Only query statements are supported. Analytic statements are not supported. For more information about the query syntax, see [Query syntax](~~43772~~).', 'type' => 'string', 'required' => false, 'example' => 'with_pack_meta'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => [ @@ -21611,41 +12060,18 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'from' => [ - 'description' => 'The beginning of the time range for the subinterval. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.'."\n" - ."\n" - .'The time range is a left-closed, right-open interval. This means that the subinterval includes the start time but not the end time. If the values of from and to are the same, the interval is invalid and an error is returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1409529600', - 'title' => '', - ], - 'to' => [ - 'description' => 'The end of the time range for the subinterval. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 1970-01-01 00:00:00 UTC.'."\n" - ."\n" - .'The time range is a left-closed, right-open interval. This means that the subinterval includes the start time but not the end time. If the values of from and to are the same, the interval is invalid and an error is returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1409569200', - 'title' => '', - ], - 'count' => [ - 'description' => 'The number of logs that are found in the subinterval.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'title' => '', - ], - 'progress' => [ - 'description' => 'Indicates whether the query result in the subinterval is complete.'."\n" - ."\n" - .'Complete: The query is complete and the result is complete.'."\n" - ."\n" - .'Incomplete: The query is complete but the result is incomplete. Send the request again to obtain the complete result.', - 'type' => 'string', - 'example' => 'Complete', - 'title' => '', - ], + 'from' => ['title' => '', 'description' => 'The start time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'The time interval follows the left-closed, right-open principle. The interval includes the start time but excludes the end time. If the values of from and to are the same, the interval is invalid and the function returns an error.', 'type' => 'integer', 'format' => 'int64', 'example' => '1409529600'], + 'to' => ['title' => '', 'description' => 'The end time of the subinterval. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'The time interval follows the left-closed, right-open principle. The interval includes the start time but excludes the end time. If the values of from and to are the same, the interval is invalid and the function returns an error.', 'type' => 'integer', 'format' => 'int64', 'example' => '1409569200'], + 'count' => ['title' => '', 'description' => 'The number of logs queried in the subinterval.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'progress' => ['title' => '', 'description' => 'Indicates whether the query results in the subinterval are complete.'."\n" + ."\n" + .'Complete: The query is complete and the returned results are complete.'."\n" + ."\n" + .'Incomplete: The query is complete but the returned results are incomplete. Repeat the request to obtain complete results.', 'type' => 'string', 'example' => 'Complete'], ], 'description' => '', 'title' => '', @@ -21658,33 +12084,29 @@ ], ], 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"from\\": 1409529600,\\n \\"to\\": 1409569200,\\n \\"count\\": 2,\\n \\"progress\\": \\"Complete\\"\\n }\\n]","type":"json"}]', - 'title' => 'GetHistograms', - 'description' => '### Interface description'."\n" - ."\n" - .'- The Host in the request syntax consists of the project name and the Simple Log Service Endpoint. You must specify the project in the Host.'."\n" + 'title' => 'Query log distribution', + 'description' => '### Operation description'."\n" ."\n" - .'- The subintervals in the response are divided consistently. If the requested time range is the same, the subinterval division in the response is also the same.'."\n" - ."\n" - .'- If the number of logs in a query varies greatly, the Simple Log Service application programming interface (API) cannot predict how many calls are needed to retrieve the full result. You must check the status of the progress member in each response. This status indicates whether to call the operation again to retrieve the final result. Each repeated call consumes the same number of query CUs.'."\n" - ."\n" - .'- The delay between when a log is written to a Logstore and when it can be queried using the GetHistograms and GetLogs operations varies by log type. Simple Log Service classifies logs into two types based on their timestamps:'."\n" - ."\n" - .' - Real-time data: The log timestamp is within the range of (-180 seconds, +900 seconds] relative to the server\'s current time. For example, if a log\'s timestamp is UTC 2014-09-25 12:03:00 and the server receives it at UTC 2014-09-25 12:05:00, the log is processed as real-time data. The maximum latency for real-time data to become searchable is 3 seconds. In 99.9% of cases, the data is searchable within 1 second.'."\n" - ."\n" - .' - Historical data: The log timestamp is within the range of \\[-7 × 86400 seconds, -180 seconds) relative to the server\'s current time. For example, if a log\'s timestamp is UTC 2014-09-25 12:00:00 and the server receives it at UTC 2014-09-25 12:05:00, the log is processed as historical data. This typically happens during data backfill.'."\n" + .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. Specify the project in the Host.'."\n" + .'- The subinterval division in the response is always stable. If the time range in your query request remains unchanged, the subinterval division in the response also remains unchanged.'."\n" + .'- When the number of logs involved in a query changes significantly, the Simple Log Service API cannot predict how many times this operation needs to be invoked to obtain complete results. Check the progress status value in the response of each request to determine whether to invoke this operation again to obtain the final complete results. Each repeated invocation consumes the same number of query CUs.'."\n" + .'- The latency between writing a log to a Logstore and querying the log by using LogSearch operations (GetHistograms and GetLogs) varies depending on the log type. Simple Log Service classifies logs into the following two types based on log UNIX timestamps:'."\n" + .' - Real-time data: The time point in the log is within the range of (-180 seconds, 900 seconds] relative to the current server time. For example, if the log time is UTC 2014-09-25 12:03:00 and the server receives the log at UTC 2014-09-25 12:05:00, the log is processed as real-time data. The latency from writing real-time data to querying the data in the LogSearch interface is 3 seconds.'."\n" + .' - Historical data: The time point in the log is within the range of [-7x86400 seconds, -180 seconds) relative to the current server time. For example, if the log time is UTC 2014-09-25 12:00:00 and the server receives the log at UTC 2014-09-25 12:05:00, the log is processed as historical data. This typically occurs in data backfill scenarios.'."\n" + .' The maximum latency from writing real-time data to querying the data is 3 seconds. In 99.9% of cases, the query is completed within 1 second.'."\n" ."\n" - .'> Simple Log Service calculates the difference between the log time (the \\_\\_time\\_\\_ field) and the time the server received the log (the \\_\\_tag\\_\\_:\\_\\_receive\\_time\\_\\_ field). If the difference is in the range of (-180 seconds, 900 seconds], the data is real-time data. If the difference is in the range of \\[-7 × 86400 seconds, -180 seconds), the data is historical data.'."\n" + .'> Simple Log Service calculates the difference between the log time (field name: \\_\\_time\\_\\_) and the server receive time (field name: \\_\\_tag\\_\\_:\\_\\_receive\\_time\\__). If the difference is within the range of \\(-180 seconds, 900 seconds], the log is real-time data. If the difference is within the range of \\[-7x86400 seconds, -180 seconds), the log is historical data.'."\n" ."\n" - .'- Simple Log Service provides a Java software development kit (SDK) example for using the GetHistograms query. For more information, see [Use GetHistograms to query log distribution](~~462234~~).', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'- Simple Log Service provides a usage example of GetHistograms queries in the Java SDK. For more information, see [Use GetHistograms to query log distribution](~~462234~~).', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | Error code description |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ProjectNotExist| Project does not exist. | Project不存在。 |'."\n" - .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" - .'| 400 | InvalidTimeRange| request time range is invalid. | 请求的时间区间无效。 |'."\n" - .'| 400 | InvalidQueryString| query string is invalid. | 请求的查询语句无效。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + .'| 404 | ProjectNotExist| Project does not exist. | The specified project does not exist. |'."\n" + .'| 404 | LogStoreNotExist | Logstore does not exist. | The specified Logstore does not exist. |'."\n" + .'| 400 | InvalidTimeRange| request time range is invalid. | The specified time range is invalid. |'."\n" + .'| 400 | InvalidQueryString| query string is invalid. | The specified query statement is invalid. |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | An internal service invoke error occurred. |'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", + .'For more information, see [Common error codes](~~29013~~).'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -21693,144 +12115,74 @@ ], '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' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + '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' => 'The information about the index.', 'type' => 'object', 'properties' => [ - 'ttl' => [ - 'description' => 'The lifecycle of the index file. Valid values: 7, 30, and 90. Unit: day.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '30', - 'title' => '', - ], - 'max_text_len' => [ - 'description' => 'The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of the max\\_text\\_len parameter. Valid values: 64 to 16384. Unit: bytes.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', - 'title' => '', - ], + 'ttl' => ['description' => 'The lifecycle of the index file. Valid values: 7, 30, and 90. Unit: day.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', 'title' => ''], + 'max_text_len' => ['description' => 'The maximum length of a field value that can be retained. Default value: 2048. Unit: bytes. The default value is equal to 2 KB. You can change the value of the max\\_text\\_len parameter. Valid values: 64 to 16384. Unit: bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''], 'log_reduce_white_list' => [ 'title' => '', 'description' => 'The fields in the whitelist that are used to cluster logs. This parameter is valid only if the log clustering feature is enabled.', 'type' => 'array', - 'items' => [ - 'description' => 'The field in the whitelist.', - 'type' => 'string', - 'example' => 'a', - 'title' => '', - ], + 'items' => ['description' => 'The field in the whitelist.', 'type' => 'string', 'example' => 'a', 'title' => ''], 'example' => '', ], 'log_reduce_black_list' => [ 'title' => '', 'description' => 'The fields in the blacklist that are used to cluster logs. This parameter is valid only if the log clustering feature is enabled.', 'type' => 'array', - 'items' => [ - 'description' => 'The field in the blacklist.', - 'type' => 'string', - 'example' => 'b', - 'title' => '', - ], + 'items' => ['description' => 'The field in the blacklist.', 'type' => 'string', 'example' => 'b', 'title' => ''], 'example' => '', ], 'line' => [ @@ -21838,37 +12190,22 @@ 'description' => 'The configurations of full-text indexes.', 'type' => 'object', 'properties' => [ - 'chn' => [ - 'description' => 'Indicates whether Chinese characters are included. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'caseSensitive' => [ - 'description' => 'Indicates whether case sensitivity is enabled. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], + 'chn' => ['description' => 'Indicates whether Chinese characters are included. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'caseSensitive' => ['description' => 'Indicates whether case sensitivity is enabled. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'token' => [ 'title' => '', 'description' => 'The delimiters.', 'type' => 'array', - 'items' => [ - 'description' => 'The delimiter. Examples: ",", ".", "'."\r".'", and "'."\n" - .'".', - 'type' => 'string', - 'example' => ',', - 'title' => '', - ], + 'items' => ['description' => 'The delimiter. Examples: ",", ".", "'."\r".'", and "'."\n" + .'".', 'type' => 'string', 'example' => ',', 'title' => ''], 'required' => true, 'example' => '', ], @@ -21876,24 +12213,14 @@ 'title' => '', 'description' => 'The included fields.', 'type' => 'array', - 'items' => [ - 'description' => 'The included field.', - 'type' => 'string', - 'example' => 'includeField', - 'title' => '', - ], + 'items' => ['description' => 'The included field.', 'type' => 'string', 'example' => 'includeField', 'title' => ''], 'example' => '', ], 'exclude_keys' => [ 'title' => '', 'description' => 'The excluded fields.', 'type' => 'array', - 'items' => [ - 'description' => 'The excluded field.', - 'type' => 'string', - 'example' => 'excludeField', - 'title' => '', - ], + 'items' => ['description' => 'The excluded field.', 'type' => 'string', 'example' => 'excludeField', 'title' => ''], 'example' => '', ], ], @@ -21908,78 +12235,39 @@ 'description' => 'The configurations of the field index.', 'type' => 'object', 'properties' => [ - 'caseSensitive' => [ - 'description' => 'Indicates whether case sensitivity is enabled. This parameter is required only when **type** is set to **text**. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - ], - 'chn' => [ - 'description' => 'Indicates whether Chinese characters are included. This parameter is required only when **type** is set to **text**. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - ], + 'caseSensitive' => ['description' => 'Indicates whether case sensitivity is enabled. This parameter is required only when **type** is set to **text**. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean'], + 'chn' => ['description' => 'Indicates whether Chinese characters are included. This parameter is required only when **type** is set to **text**. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean'], 'token' => [ 'title' => '', 'description' => 'The delimiters.', 'type' => 'array', - 'items' => [ - 'description' => 'The delimiter. This parameter is required only when **type** is set to **text**.', - 'type' => 'string', - ], - ], - 'type' => [ - 'description' => 'The data type of the field value. Valid values: text, json, double, and long.', - 'type' => 'string', - ], - 'doc_value' => [ - 'description' => 'Indicates whether the analytics feature is enabled for the field. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - ], - 'alias' => [ - 'description' => 'The alias of the field.', - 'type' => 'string', + 'items' => ['description' => 'The delimiter. This parameter is required only when **type** is set to **text**.', 'type' => 'string'], ], + 'type' => ['description' => 'The data type of the field value. Valid values: text, json, double, and long.', 'type' => 'string'], + 'doc_value' => ['description' => 'Indicates whether the analytics feature is enabled for the field. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean'], + 'alias' => ['description' => 'The alias of the field.', 'type' => 'string'], ], '$ref' => '#/components/schemas/IndexKey', 'example' => '', ], 'example' => '', ], - 'log_reduce' => [ - 'description' => 'Indicates whether the log clustering feature is enabled.', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'lastModifyTime' => [ - 'description' => 'The time when the index configurations were last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1524155379', - 'title' => '', - ], - 'index_mode' => [ - 'description' => 'The type of the index.', - 'type' => 'string', - 'title' => '', - 'example' => 'v2', - ], - 'storage' => [ - 'description' => 'The storage type. The value is fixed as pg.', - 'type' => 'string', - 'title' => '', - 'example' => 'pg', - ], + 'log_reduce' => ['description' => 'Indicates whether the log clustering feature is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'lastModifyTime' => ['description' => 'The time when the index configurations were last updated. The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1524155379', 'title' => ''], + 'index_mode' => ['description' => 'The type of the index.', 'type' => 'string', 'title' => '', 'example' => 'v2'], + 'storage' => ['description' => 'The storage type. The value is fixed as pg.', 'type' => 'string', 'title' => '', 'example' => 'pg'], ], 'title' => '', 'example' => '', @@ -22003,108 +12291,77 @@ 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetIndex', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], + ], + ], + ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ttl\\": 30,\\n \\"max_text_len\\": 2048,\\n \\"log_reduce_white_list\\": [\\n \\"a\\"\\n ],\\n \\"log_reduce_black_list\\": [\\n \\"b\\"\\n ],\\n \\"line\\": {\\n \\"chn\\": false,\\n \\"caseSensitive\\": false,\\n \\"token\\": [\\n \\",\\"\\n ],\\n \\"include_keys\\": [\\n \\"includeField\\"\\n ],\\n \\"exclude_keys\\": [\\n \\"excludeField\\"\\n ]\\n },\\n \\"keys\\": {\\n \\"key\\": {\\n \\"caseSensitive\\": true,\\n \\"chn\\": true,\\n \\"token\\": [\\n \\"\\"\\n ],\\n \\"type\\": \\"\\",\\n \\"doc_value\\": true,\\n \\"alias\\": \\"\\"\\n }\\n },\\n \\"log_reduce\\": false,\\n \\"lastModifyTime\\": 1524155379,\\n \\"index_mode\\": \\"v2\\",\\n \\"storage\\": \\"pg\\"\\n}","type":"json"}]', ], 'GetIngestProcessor' => [ 'summary' => 'Retrieves information about an ingest processor.', 'path' => '/ingestprocessors/{processorName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + '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' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The name of the project.', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'processorName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The identity of the ingest processor.', - 'type' => 'string', - 'required' => true, - 'example' => 'parse-nginx-log', - ], + 'schema' => ['description' => 'The identity of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'parse-nginx-log'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], - 'schema' => [ - 'description' => 'The information about the ingest processor.', - '$ref' => '#/components/schemas/IngestProcessor', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The information about the ingest processor.', '$ref' => '#/components/schemas/IngestProcessor', 'title' => '', 'example' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', @@ -22114,79 +12371,48 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'GetLogStore' => [ - 'summary' => 'Retrieves the details of a 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' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The Logstore struct.', - '$ref' => '#/components/schemas/logstore', - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'The Logstore object.', '$ref' => '#/components/schemas/logstore', 'title' => '', 'example' => 'ali-test-logstore'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetLogStore', + 'summary' => 'Retrieves the details of a Logstore.', 'description' => '### Description'."\n" ."\n" - .'The Host consists of the project name and the Simple Log Service Endpoint. You must specify the project in the Host.', + .'The host consists of the project name and the Log Service endpoint.', 'extraInfo' => '### 错误码'."\n" .'| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" @@ -22206,137 +12432,79 @@ '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' => '[{"errorExample":"","example":"{\\n \\"logstoreName\\": \\"my-logstore\\",\\n \\"ttl\\": 1,\\n \\"shardCount\\": 2,\\n \\"enable_tracking\\": false,\\n \\"autoSplit\\": true,\\n \\"maxSplitShard\\": 6,\\n \\"appendMeta\\": false,\\n \\"telemetryType\\": \\"Metrics\\",\\n \\"createTime\\": 1453949705,\\n \\"lastModifyTime\\": 1524155379,\\n \\"encrypt_conf\\": {\\n \\"enable\\": true,\\n \\"encrypt_type\\": \\"default\\",\\n \\"user_cmk_info\\": {\\n \\"cmk_key_id\\": \\"f5136b95-2420-ab31-xxxxxxxxx\\",\\n \\"arn\\": \\"acs:ram::13234:role/logsource\\",\\n \\"region_id\\": \\"cn-hangzhou\\"\\n }\\n },\\n \\"hot_ttl\\": 60,\\n \\"infrequentAccessTTL\\": 30,\\n \\"mode\\": \\"standard\\",\\n \\"productType\\": \\"aliyun\\",\\n \\"processorId\\": \\"\\",\\n \\"shardingPolicy\\": {\\n \\"shardGroup\\": {\\n \\"keys\\": [\\n \\"userId\\"\\n ],\\n \\"groupCount\\": 8\\n },\\n \\"shardHash\\": {\\n \\"keys\\": [\\n \\"instanceId\\"\\n ],\\n \\"maxHashCount\\": 2\\n },\\n \\"queryActiveTime\\": 1764659409\\n },\\n \\"resourceGroupId\\": \\"\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"logstoreName\\": \\"my-logstore\\",\\n \\"ttl\\": 1,\\n \\"shardCount\\": 2,\\n \\"enable_tracking\\": false,\\n \\"autoSplit\\": true,\\n \\"maxSplitShard\\": 6,\\n \\"appendMeta\\": false,\\n \\"telemetryType\\": \\"Metrics\\",\\n \\"createTime\\": 1453949705,\\n \\"lastModifyTime\\": 1524155379,\\n \\"encrypt_conf\\": {\\n \\"enable\\": true,\\n \\"encrypt_type\\": \\"default\\",\\n \\"user_cmk_info\\": {\\n \\"cmk_key_id\\": \\"f5136b95-2420-ab31-xxxxxxxxx\\",\\n \\"arn\\": \\"acs:ram::13234:role/logsource\\",\\n \\"region_id\\": \\"cn-hangzhou\\"\\n }\\n },\\n \\"hot_ttl\\": 60,\\n \\"infrequentAccessTTL\\": 30,\\n \\"mode\\": \\"standard\\",\\n \\"productType\\": \\"aliyun\\",\\n \\"processorId\\": \\"\\",\\n \\"shardingPolicy\\": {\\n \\"shardGroup\\": {\\n \\"keys\\": [\\n \\"userId\\"\\n ],\\n \\"groupCount\\": 8\\n },\\n \\"shardHash\\": {\\n \\"keys\\": [\\n \\"instanceId\\"\\n ],\\n \\"maxHashCount\\": 2\\n },\\n \\"queryActiveTime\\": 1764659409\\n },\\n \\"resourceGroupId\\": \\"\\",\\n \\"enableModify\\": false\\n}","type":"json"}]', ], - 'GetLogStoreMeteringMode' => [ - 'summary' => 'Queries the billing mode of a Logstore.', - 'path' => '/logstores/{logstore}/meteringmode', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetLogStoreConfig' => [ + 'summary' => 'Retrieves the configuration of a Logstore.', + 'path' => '/logstores/{logstore}/config', + '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', - 'abilityTreeCode' => '195981', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'projectName', - ], + 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'logstoreName', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => [ 'type' => 'object', 'properties' => [ - 'meteringMode' => [ + 'clientIpHeaders' => [ + 'type' => 'array', + 'items' => ['description' => 'A case-insensitive header key, such as `X-Forwarded-For`.', 'type' => 'string', 'example' => 'X-Forwarded-For', 'title' => ''], 'title' => '', - 'description' => 'The billing mode. Default value: ChargeByFunction. Valid values: ChargeByFunction and ChargeByDataIngest.'."\n", - 'type' => 'string', - 'example' => 'ChargeByFunction', - 'enum' => [ - 'ChargeByFunction', - 'ChargeByDataIngest', - ], + 'description' => 'An array of header keys used to extract the client IP address when data is written to the Logstore. The keys are case-insensitive, but their order in the array is significant. For this feature to work, enable the `appendMeta` option on the Logstore. Log Service searches the request headers for these keys in the specified order and adds the first valid IP address it finds as a log tag.', + 'example' => '', ], ], 'description' => '', @@ -22345,9 +12513,103 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetLogStoreConfig', + 'description' => '- The `Host` in the request syntax consists of the Project name and the Log Service endpoint.'."\n" + ."\n" + .'- An AccessKey pair is available. For more information, see [AccessKey](~~29009~~).'."\n" + ."\n" + .'The AccessKey of an Alibaba Cloud account has full permissions on all APIs and poses a high security risk. Use a RAM user to make API calls or perform routine operations. Grant the RAM user the required permissions to access Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" + ."\n" + .'- The Project name, region, and Logstore name are obtained. For more information, see [Manage Project](~~48984~~) and [Manage Logstore](~~48990~~).'."\n" + ."\n" + .'### Authorization'."\n" + ."\n" + .'To grant a RAM user or RAM role the permission to call this operation, add the following Action to a RAM permission policy.'."\n" + ."\n" + .'| Action | Resource |'."\n" + .'| :---------------------- | :--------------------------------------------------------------------------------- |'."\n" + .'| `log:GetLogStoreConfig` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clientIpHeaders\\": [\\n \\"X-Forwarded-For\\"\\n ]\\n}","type":"json"}]', + ], + 'GetLogStoreMeteringMode' => [ + 'summary' => 'Queries the billing mode of a Logstore.', + 'path' => '/logstores/{logstore}/meteringmode', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195981', + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'projectName', 'title' => ''], + ], + [ + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'logstoreName', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'meteringMode' => [ + 'description' => 'The billing mode. Default value: ChargeByFunction. Valid values: ChargeByFunction and ChargeByDataIngest.', + 'type' => 'string', + 'example' => 'ChargeByFunction', + 'enum' => ['ChargeByFunction', 'ChargeByDataIngest'], + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meteringMode\\": \\"ChargeByFunction\\"\\n}","type":"json"}]', 'title' => 'GetLogStoreMeteringMode', 'changeSet' => [], @@ -22362,12 +12624,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -22376,98 +12633,53 @@ 'GetLogging' => [ 'summary' => 'Queries the service log configuration of a 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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The service log information.'."\n", - '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', - 'title' => '', - ], + 'schema' => ['description' => 'The service log information.', '$ref' => '#/components/schemas/logging', 'example' => '{"loggingDetails":[{"logstore":"internal-diagnostic_log","type":"consumergroup_log"},{"logstore":"internal-diagnostic_log","type":"logtail_alarm"},{"logstore":"internal-diagnostic_log","type":"logtail_profile"},{"logstore":"internal-diagnostic_log","type":"metering"},{"logstore":"internal-diagnostic_log","type":"scheduled_sql_alert"},{"logstore":"internal-diagnostic_log","type":"logtail_status"},{"logstore":"internal-diagnostic_log","type":"etl_alert"}],"loggingProject":"java-sdk-test-project-name"}'."\n", 'title' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"loggingProject\\": \\"my-project\\",\\n \\"loggingDetails\\": [\\n {\\n \\"type\\": \\"consumergroup_log\\",\\n \\"logstore\\": \\"my-logstore\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'GetLogging', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -22479,306 +12691,168 @@ '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' => 'This operation queries log data in a Logstore of a specified project.', + 'summary' => 'Queries log data from a Logstore in the specified project.', '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' => '', - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The Logstore from which to query data.', - 'type' => 'string', - 'required' => true, - 'example' => 'example-logstore', - ], + 'schema' => ['description' => 'The Logstore to query.', 'type' => 'string', 'required' => true, 'example' => 'example-logstore', 'title' => ''], ], [ 'name' => 'from', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The start of the time range to query. This time is the log time that is specified when the log data is written.'."\n" - ."\n" - .'- The time range that is specified by the **from** and **to** parameters is a left-closed, right-open interval. The interval includes the start time but not the end time. If the values of **from** and **to** are the same, the interval is invalid. The system returns an error.'."\n" - ."\n" - .'- The value is a UNIX timestamp. It represents the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> To make sure that no data is missed, snap the query time to the minute. If you specify a time range in an analytic statement, the time range in the analytic statement is used for the query and analysis.'."\n" - ."\n" - .'To specify a time in seconds, use the [from\\_unixtime function](~~63451~~) or the [to\\_unixtime function](~~63451~~) to convert the time format in the analytic statement. Examples:'."\n" - ."\n" - .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\n" - ."\n" - .'- `* | SELECT * FROM log WHERE __time__ > to_unixtime(date_parse(\'2022-10-19 15:46:05\', \'%Y-%m-%d %H:%i:%s\')) AND __time__ < to_unixtime(now())`', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268185', - ], + 'schema' => ['description' => 'The start of the query time range, based on the log time specified when the log data was written.'."\n" + ."\n" + .'- The **from** and **to** parameters define a left-closed, right-open interval \\[from, to). If **from** equals **to**, the interval is invalid and the system returns an error.'."\n" + ."\n" + .'- Value: a UNIX timestamp representing the number of seconds elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> To avoid missing data, align the query time to the minute level. If a time range is specified in the analytic statement, that time range takes precedence.'."\n" + ."\n" + .'To specify a time in seconds within an analytic statement, use the [from\\_unixtime function](~~63451~~) or the [to\\_unixtime function](~~63451~~) to convert the time format. Examples:'."\n" + ."\n" + .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\n" + ."\n" + .'- `* | SELECT * FROM log WHERE __time__ > to_unixtime(date_parse(\'2022-10-19 15:46:05\', \'%Y-%m-%d %H:%i:%s\')) AND __time__ < to_unixtime(now())`', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185', 'title' => ''], ], [ 'name' => 'to', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The end of the time range to query. This time is the log time that is specified when the log data is written.'."\n" - ."\n" - .'- The time range that is specified by the **from** and **to** parameters is a left-closed, right-open interval. The interval includes the start time but not the end time. If the values of **from** and **to** are the same, the interval is invalid. The system returns an error.'."\n" - ."\n" - .'- The value is a UNIX timestamp. It represents the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'> To make sure that no data is missed, snap the query time to the minute. If you specify a time range in an analytic statement, the time range in the analytic statement is used for the query and analysis.'."\n" - ."\n" - .'To specify a time in seconds, use the [from\\_unixtime function](~~63451~~) or the [to\\_unixtime function](~~63451~~) to convert the time format in the analytic statement. Examples:'."\n" - ."\n" - .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\n" - ."\n" - .'- `* | SELECT * FROM log WHERE __time__ > to_unixtime(date_parse(\'2022-10-19 15:46:05\', \'%Y-%m-%d %H:%i:%s\')) AND __time__ < to_unixtime(now())`', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627269085', - ], + 'schema' => ['description' => 'The end of the query time range, based on the log time specified when the log data was written.'."\n" + ."\n" + .'- The **from** and **to** parameters define a left-closed, right-open interval \\[from, to). If **from** equals **to**, the interval is invalid and the system returns an error.'."\n" + ."\n" + .'- Value: a UNIX timestamp representing the number of seconds elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'> To avoid missing data, align the query time to the minute level. If a time range is specified in the analytic statement, that time range takes precedence.'."\n" + ."\n" + .'To specify a time in seconds within an analytic statement, use the [from\\_unixtime function](~~63451~~) or the [to\\_unixtime function](~~63451~~) to convert the time format. Examples:'."\n" + ."\n" + .'- `* | SELECT * FROM log WHERE from_unixtime(__time__) > from_unixtime(1664186624) AND from_unixtime(__time__) < now()`'."\n" + ."\n" + .'- `* | SELECT * FROM log WHERE __time__ > to_unixtime(date_parse(\'2022-10-19 15:46:05\', \'%Y-%m-%d %H:%i:%s\')) AND __time__ < to_unixtime(now())`', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627269085', 'title' => ''], ], [ 'name' => 'query', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The search statement or analytic statement. For more information, see [Query overview](~~43772~~) and [Analysis overview](~~53608~~).'."\n" - .'To use the Exclusive SQL feature, add `set session parallel_sql=true;` to the analytic statement in the query parameter. Example: `* | set session parallel_sql=true; select count(*) as pv`. For information about common query and analysis issues, see [Common errors that occur when you query and analyze logs](~~61628~~).'."\n" - ."\n" - .'> If the query parameter contains an analytic statement (SQL statement), the line and offset parameters are invalid. We recommend that you set these parameters to 0. You must use the LIMIT clause in the SQL statement to turn pages. For more information, see [Page through query and analysis results](~~89994~~).', - 'type' => 'string', - 'required' => false, - 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', - ], + 'schema' => ['description' => 'The search statement or analytic statement. See [Query overview](~~43772~~) and [Analysis overview](~~53608~~). To enable the Exclusive SQL feature, add `set session parallel_sql=true;` to the analytic statement. Example: `* | set session parallel_sql=true; select count(*) as pv`. For common query and analysis issues, see [Common errors that occur when you query and analyze logs](~~61628~~).'."\n" + ."\n" + .'> When the query parameter contains an analytic statement (SQL statement), the `line` and `offset` parameters are ignored. Set both to 0 and use the LIMIT clause in the SQL statement for pagination. See [Page through query and analysis results](~~89994~~).', 'type' => 'string', 'required' => false, 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', 'title' => ''], ], [ 'name' => 'topic', 'in' => 'query', - 'schema' => [ - 'title' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', - 'description' => 'The topic of the logs. The default value is an empty string. For more information, see [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' => 'The log topic. Default value: an empty string. See [Topic](~~48881~~).', 'type' => 'string', 'required' => false, 'example' => 'topic'], ], [ 'name' => 'line', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'This parameter is valid only when the query parameter is a search statement. It specifies the maximum number of logs to return for the request. The value ranges from 0 to 100. The default value is 100. For more information about paged queries, see [Page through query and analysis results](~~89994~~).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'default' => '100', - 'example' => '100', - ], + 'schema' => ['description' => 'Valid only when the query parameter is a search statement. Maximum number of logs to return. Valid values: 0 to 100. Default value: 100. See [Page through query and analysis results](~~89994~~).', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '0', 'example' => '100', 'default' => '100', 'title' => '', 'required' => false], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'This parameter is valid only when the query parameter is a search statement. It specifies the start line of the query. The default value is 0. For more information about paged queries, see [Page through query and analysis results](~~89994~~).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'default' => '0', - 'example' => '0', - ], + 'schema' => ['description' => 'Valid only when the query parameter is a search statement. The starting row for the query. Default value: 0. See [Page through query and analysis results](~~89994~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'default' => '0', 'title' => '', 'required' => false], ], [ 'name' => 'reverse', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'Specifies whether to return logs in descending order of their timestamps. The precision is at the minute level.'."\n" - ."\n" - .'- true: Returns logs in descending order of their timestamps.'."\n" - ."\n" - .'- false (default): Returns logs in ascending order of their timestamps.'."\n" - ."\n" - .'>'."\n" - ."\n" - .'- If the query parameter is a search statement, the reverse parameter is valid and specifies the sorting order of the returned logs.'."\n" - ."\n" - .'- If the query parameter is a search and analytic statement, the reverse parameter is invalid. The sorting order is specified by the ORDER BY clause in the SQL analytic statement. If the ORDER BY clause specifies asc (default), the logs are sorted in ascending order. If the ORDER BY clause specifies desc, the logs are sorted in descending order.'."\n" - ."\n" - .'>', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - 'example' => 'false', - ], + 'schema' => ['description' => 'Whether to return logs in descending order of timestamp, with minute-level precision.'."\n" + ."\n" + .'- true: Descending order (newest first).'."\n" + ."\n" + .'- false (default): Ascending order (oldest first).'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- When the query parameter is a search statement, the reverse parameter controls the sort order.'."\n" + ."\n" + .'- When the query parameter includes an analytic statement, the reverse parameter is ignored. Use the ORDER BY clause in the SQL statement instead. ORDER BY defaults to ascending (asc). Specify desc for descending order.'."\n" + ."\n" + .'>', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], [ 'name' => 'powerSql', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'Specifies whether to use the Exclusive SQL feature. For more information, see [Enable the Exclusive SQL feature](~~223777~~).'."\n" - ."\n" - .'- true: Use the Exclusive SQL feature.'."\n" - ."\n" - .'- false (default): Use the standard SQL feature.'."\n" - ."\n" - .'In addition to using the powerSql parameter, you can also use the **query** parameter to enable the Exclusive SQL feature.', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - 'example' => 'false', - ], + 'schema' => ['description' => 'Whether to enable the Exclusive SQL feature. See [Enable the Exclusive SQL feature](~~223777~~).'."\n" + ."\n" + .'- true: Enable Exclusive SQL.'."\n" + ."\n" + .'- false (default): Use standard SQL.'."\n" + ."\n" + .'Alternatively, add `set session parallel_sql=true;` to the analytic statement in the **query** parameter to enable Exclusive SQL.', 'type' => 'boolean', 'example' => 'false', 'default' => 'false', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-progress' => [ - 'schema' => [ - 'title' => '查询结果的状态，包括： Complete：查询已经完成，返回结果为完整结果。 Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'type' => 'string', - 'example' => 'Complete', - ], + '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' => 'The array of logs. Each element is a log.', + 'description' => 'The log array. Each element is a log entry.', 'type' => 'array', - 'items' => [ - 'description' => 'The array of logs. Each element is a log.', - 'type' => 'object', - 'title' => '', - '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' => 'The log array. Each element is a log entry.', 'type' => 'object', 'example' => '[{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}, {\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}, {\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}, {\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}, {\'remote_addr\': \'198.51.100.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}]', 'title' => ''], 'title' => '', 'example' => '', ], @@ -22788,35 +12862,35 @@ 'title' => 'GetLogs', 'description' => '###'."\n" ."\n" - .'> Simple Log Service supports scheduled SQL jobs. For more information, see [Create a scheduled SQL job](~~286457~~).'."\n" + .'> Simple Log Service supports scheduled SQL jobs. For details, see [Create a scheduled SQL job](~~286457~~).'."\n" ."\n" - .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project name in the Host.'."\n" + .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. Specify the project name in the Host.'."\n" ."\n" - .'- Create and obtain an AccessKey pair. For more information, see [AccessKey pair](~~2766629~~).'."\n" + .'- Create and obtain an AccessKey pair. For details, see [AccessKey pair](~~2766629~~).'."\n" ."\n" - .'An AccessKey pair that belongs to an Alibaba Cloud account has permissions to access all APIs. This poses a high security risk. We strongly recommend that you create and use a RAM user to make API calls or perform routine operations and maintenance (O\\&M). The RAM user must have the required permissions to access Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" + .'Create and use a RAM user to make API calls or perform routine O\\&M. Using an Alibaba Cloud account AccessKey pair grants access to all APIs and poses a high security risk. Ensure the RAM user has the required permissions for Simple Log Service resources. For details, see [Create and authorize a RAM user](~~47664~~).'."\n" ."\n" - .'- Obtain the name and region of the project, and the name of the Logstore that contains the logs you want to query. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" + .'- Obtain the project name, region, and Logstore name for the logs to query. See [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" - .'- Simple Log Service imposes limits on log queries. Therefore, you must design appropriate query and analytic statements and set a reasonable query time range. For more information, see [Log query limits](~~43772~~) and [Log analysis limits](~~53608~~).'."\n" + .'- Simple Log Service imposes limits on log queries. Design appropriate query and analytic statements and set a reasonable time range. See [Log query limits](~~43772~~) and [Log analysis limits](~~53608~~).'."\n" ."\n" - .'- You must configure indexes before you query logs. For more information, see [Create indexes](~~90732~~).'."\n" + .'- Configure indexes before querying logs. See [Create indexes](~~90732~~).'."\n" ."\n" - .'- If the number of logs that match a query varies greatly, the Simple Log Service API cannot predict the number of times you must call this operation to obtain the complete result. Check the value of the x-log-progress header in each response to determine whether to call the operation again. Each repeated call consumes the same number of query capacity units (CUs).'."\n" + .'- When the number of matching logs varies significantly, the API cannot predict how many calls are needed to retrieve the complete result. Check the `x-log-progress` header in each response to determine whether to repeat the call. Each repeated call consumes the same number of query capacity units (CUs).'."\n" ."\n" - .'- When a log is written to a Logstore, the latency before the log is queryable using the GetHistograms and GetLogs operations varies based on the log type. Simple Log Service classifies logs into the following two types based on their timestamps:'."\n" + .'- After a log is written to a Logstore, the latency before it becomes queryable through the GetHistograms and GetLogs operations depends on the log type. Simple Log Service classifies logs into two types based on their timestamps:'."\n" ."\n" - .' - Real-time data: The timestamp of the log is within the time range of (-180 seconds, 900 seconds] relative to the current server time. For example, if a log is generated at UTC 2014-09-25 12:03:00 and is received by the server at UTC 2014-09-25 12:05:00, the log is processed as real-time data. This typically occurs in normal scenarios. The latency for real-time data to become queryable is about 3 seconds.'."\n" + .' - Real-time data: The log timestamp falls within (-180 seconds, 900 seconds] relative to the current server time. For example, if a log is generated at UTC 2014-09-25 12:03:00 and is received by the server at UTC 2014-09-25 12:05:00, the log is classified as real-time data. This is typical in normal scenarios. Real-time data becomes queryable in about 3 seconds.'."\n" ."\n" - .' - Historical data: The timestamp of the log is within the time range of \\[-7 × 86,400 seconds, -180 seconds) relative to the current server time. For example, if a log is generated at UTC 2014-09-25 12:00:00 and is received by the server at UTC 2014-09-25 12:05:00, the log is processed as historical data. This typically occurs in data backfill scenarios.'."\n" + .' - Historical data: The log timestamp falls within \\[-7 x 86,400 seconds, -180 seconds) relative to the current server time. For example, if a log is generated at UTC 2014-09-25 12:00:00 and is received by the server at UTC 2014-09-25 12:05:00, the log is classified as historical data. This is typical in data backfill scenarios.'."\n" ."\n" - .'> Simple Log Service calculates the difference between the log time (the \\_\\_time\\_\\_ field) and the server receipt time (the \\_\\_tag\\_\\_: **receive\\_time** field). If the difference is in the range of (-180 seconds, 900 seconds], the log is real-time data. If the difference is in the range of \\[-7 × 86,400 seconds, -180 seconds), the log is historical data.'."\n" + .'> Simple Log Service calculates the difference between the log time (the \\_\\_time\\_\\_ field) and the server receipt time (the \\_\\_tag\\_\\_: **receive\\_time** field). If the difference falls within (-180 seconds, 900 seconds], the log is real-time data. If the difference falls within \\[-7 x 86,400 seconds, -180 seconds), the log is historical data.'."\n" ."\n" - .'- Simple Log Service provides examples of how to use the GetLogs operation in Java and Python software development kits (SDKs). For more information, see [GetLogs examples for Java](~~407683~~) and [GetLogs examples for Python](~~407684~~).'."\n" + .'- Simple Log Service provides Java and Python SDK examples for the GetLogs operation. See [GetLogs examples for Java](~~407683~~) and [GetLogs examples for Python](~~407684~~).'."\n" ."\n" .'### Authorization'."\n" ."\n" - .'The following table describes the authorization information that is required for this operation. You can add this information to the Action element of a RAM access policy statement to grant RAM users or RAM roles the permission to call this operation.'."\n" + .'The following table describes the authorization information required for this operation. Add this information to the Action element of a RAM access policy statement to grant RAM users or RAM roles the permission to call this operation.'."\n" ."\n" .'| Action | Resource |'."\n" .'| :-------------------- | :--------------------------------------------------------------------------------- |'."\n" @@ -22840,28 +12914,19 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'GetLogsV2' => [ - 'summary' => 'Queries raw logs from a specified Logstore in a project. The response contains raw logs within a specified time range and is compressed for transmission.', + 'summary' => 'Queries raw log data from a specified Logstore in a project and returns raw logs within a specified time range. The results are compressed before transmission.', 'path' => '/logstores/{logstore}/logs', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ @@ -22869,51 +12934,34 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179698', - 'abilityTreeNodes' => [ - 'FEATUREslsCAO32E', - ], + 'abilityTreeNodes' => ['FEATUREslsCAO32E'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The Logstore name.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore'], ], [ 'name' => 'Accept-Encoding', 'in' => 'header', 'schema' => [ - 'description' => 'The compression method.'."\n" + 'title' => '', + 'description' => 'The compression method for the response content. SDK users do not need to specify this parameter because the SDK automatically handles compression and decompression.'."\n" ."\n" - .'- Java, Python, and Go support lz4 and gzip decompression.'."\n" + .'- Java, Python, and Go currently support lz4 and gzip decompression.'."\n" ."\n" - .'- PHP, JavaScript, and C# support gzip decompression only.', - 'enumValueTitles' => [ - 'lz4' => 'lz4', - 'gzip' => 'gzip', - ], + .'- php, JavaScript, and C# currently support only gzip decompression.', + 'enumValueTitles' => ['lz4' => 'lz4', 'gzip' => 'gzip'], 'type' => 'string', - 'required' => true, + 'required' => false, 'example' => 'lz4', 'default' => 'lz4', - 'title' => '', ], ], [ @@ -22924,116 +12972,33 @@ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'from' => [ - 'description' => 'The start of the time range to query. The value is the log time that was specified when the log was written.'."\n" - ."\n" - .'The time range is a left-closed right-open interval. This means the range includes the start time but not the end time. If the from and to values are the same, the interval is invalid and an error is returned. The value is a UNIX timestamp that represents the number of seconds since 00:00:00 UTC on January 1, 1970.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268185', - 'title' => '', - ], - 'to' => [ - 'description' => 'The end of the time range to query. The value is the log time that was specified when the log was written.'."\n" - ."\n" - .'The time range is a left-closed right-open interval. This means the range includes the start time but not the end time. If the from and to values are the same, the interval is invalid and an error is returned. The value is a UNIX timestamp that represents the number of seconds since 00:00:00 UTC on January 1, 1970.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1627268185', - 'title' => '', - ], - 'line' => [ - 'description' => 'The maximum number of logs to return. This parameter is valid only if the query parameter contains a query statement. The value must be an integer from 0 to 100. The default value is 100.', - 'type' => 'integer', - 'format' => 'int64', - 'maximum' => '100', - 'minimum' => '0', - 'example' => '100', - 'default' => '100', - 'title' => '', - 'required' => false, - ], - 'offset' => [ - 'description' => 'The line number from which to start the query. This parameter is valid only if the query parameter contains a query statement. The default value is 0.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'default' => '0', - 'title' => '', - 'required' => false, - ], - 'reverse' => [ - 'description' => 'Specifies whether to return logs in descending order of their timestamps. The precision is at the minute level.'."\n" - ."\n" - .'true: Returns logs in descending order of their timestamps.'."\n" - .'false (default): Returns logs in ascending order of their timestamps.'."\n" - .'Note:'."\n" - .'If the query parameter contains a query statement, the reverse parameter is valid and specifies the sorting order.'."\n" - .'If the query parameter contains a query and analysis statement, the reverse parameter is invalid. The sorting order is specified by the ORDER BY clause in the analytic statement. If ORDER BY is asc (default), logs are sorted in ascending order. If ORDER BY is desc, logs are sorted in descending order.', - 'type' => 'boolean', - 'default' => 'false', - 'title' => '', - 'required' => false, - 'example' => 'false', - ], - 'powerSql' => [ - 'description' => 'Specifies whether to enable enhanced SQL. The default value is false.', - 'type' => 'boolean', - 'default' => 'false', - 'title' => '', - 'required' => false, - 'example' => 'false', - ], - 'session' => [ - 'description' => 'The query parameter.', - 'type' => 'string', - 'required' => false, - 'example' => 'mode=scan', - 'title' => '', - ], - 'topic' => [ - 'description' => 'The log topic. The default value is double quotation marks ("").', - 'type' => 'string', - 'example' => '""', - 'required' => false, - 'title' => '', - ], - 'query' => [ - 'description' => 'The query statement or analytic statement. For more information, see [Query overview](~~43772~~) and [Analysis overview](~~53608~~).'."\n" - ."\n" - .'To use the Exclusive SQL feature, add set session parallel\\_sql=true; to the analytic statement in the query parameter. Example: \\* | set session parallel\\_sql=true; select count(\\*) as pv.'."\n" - ."\n" - .'Note: If the query parameter contains an analytic statement (SQL statement), the line and offset parameters are invalid. Set them to 0. Use the LIMIT clause in the SQL statement for paging. For more information, see Paginate query and analysis results.', - 'type' => 'string', - 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', - 'title' => '', - 'required' => false, - ], - 'forward' => [ - 'description' => 'For a scan or phrase query, specifies whether to page forward or backward.', - 'type' => 'boolean', - 'default' => 'false', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], - 'highlight' => [ - 'description' => 'Specifies whether to highlight the results.', - 'type' => 'boolean', - 'default' => 'false', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], - 'isAccurate' => [ - 'description' => 'Specifies whether to enable nanosecond-level sorting.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'title' => '', - ], + 'from' => ['title' => '', 'description' => 'The start time of the query. This time refers to the log time specified when log data is written.'."\n" + ."\n" + .'The time range defined by the from and to request parameters follows the left-closed, right-open principle. The time range includes the start time but excludes the end time. If the values of from and to are the same, the time range is invalid and the function returns an error.'."\n" + .'The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185'], + 'to' => ['title' => '', 'description' => 'The end time of the query. This time refers to the log time specified when log data is written.'."\n" + ."\n" + .'The time range defined by the from and to request parameters follows the left-closed, right-open principle. The time range includes the start time but excludes the end time. If the values of from and to are the same, the time range is invalid and the function returns an error.'."\n" + .'The value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185'], + 'line' => ['title' => '', 'description' => 'The maximum number of logs to return. This parameter is valid only when the query parameter is a query statement (not an analytic statement). Minimum value: 0. Maximum value: 100. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '0', 'example' => '100', 'default' => '100', 'required' => false], + 'offset' => ['title' => '', 'description' => 'The row from which the query starts. This parameter is valid only when the query parameter is a query statement (not an analytic statement). The value starts from 0. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'default' => '0', 'required' => false], + 'reverse' => ['title' => '', 'description' => 'Specifies whether to return logs in reverse chronological order of log timestamps, accurate to the minute level. This parameter is valid only when the query parameter is a query statement (not an analytic statement).'."\n" + ."\n" + .'- true: Returns logs in descending order of log timestamps.'."\n" + .'- false (default): Returns logs in ascending order of log timestamps.'."\n" + ."\n" + .'To sort results in an analytic statement, use the ORDER BY syntax. If ORDER BY is set to asc (default), logs are returned in ascending order. If ORDER BY is set to desc, logs are returned in descending order.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], + 'powerSql' => ['title' => '', 'description' => 'Specifies whether to enable Dedicated SQL. Disabled by default.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], + 'session' => ['description' => 'The query parameter.', 'type' => 'string', 'required' => false, 'example' => 'mode=scan', 'title' => ''], + 'topic' => ['description' => 'The topic. Default value: empty string.', 'type' => 'string', 'example' => '""', 'required' => false, 'title' => ''], + 'query' => ['title' => '', 'description' => 'The query statement or analytic statement. For more information, see [query overview](~~43772~~) and [analysis overview](~~53608~~).'."\n" + ."\n" + .'Add set session parallel_sql=true; to the analytic statement in the query parameter to use Dedicated SQL. Example: * | set session parallel_sql=true; select count(*) as pv.'."\n" + ."\n" + .'Note: When the query parameter contains an analytic statement (SQL statement), the line and offset parameters of this API are invalid. Set them to 0. Use the LIMIT syntax in the SQL statement for pagination. For more information, see Display query and analysis results by page.', 'type' => 'string', 'example' => 'status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5', 'required' => false], + 'forward' => ['description' => 'Specifies whether to page forward or backward for scan or phrase queries.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + 'highlight' => ['description' => 'Specifies whether to enable highlighting.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + 'isAccurate' => ['description' => 'Specifies whether to enable nanosecond-precision ordering.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', @@ -23045,274 +13010,117 @@ 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' => [ - 'description' => 'The data returned.', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'meta' => [ - 'description' => 'The metadata of the returned data.', + 'description' => 'The metadata of the response.', 'type' => 'object', 'properties' => [ - 'progress' => [ - 'description' => 'The progress of the query. Valid values:'."\n" - ."\n" - .'- Complete: The query is complete, and the returned result is complete.'."\n" - ."\n" - .'- Incomplete: The query is complete, but the returned result is incomplete. You must send the request again to obtain the complete result.', - 'type' => 'string', - 'example' => 'Complete', - 'title' => '', - ], - 'aggQuery' => [ - 'description' => 'The SQL part of the query statement that follows the pipe character (|).', - 'type' => 'string', - 'example' => 'select *', - 'title' => '', - ], - 'whereQuery' => [ - 'description' => 'The part of the query statement that precedes the pipe character (|).', - 'type' => 'string', - 'example' => '*', - 'title' => '', - ], - 'hasSQL' => [ - 'description' => 'Indicates whether the query is an SQL query.', - 'type' => 'boolean', - 'example' => 'false', - 'title' => '', - ], - 'processedRows' => [ - 'description' => 'The number of rows processed in the query.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - 'title' => '', - ], - 'elapsedMillisecond' => [ - 'description' => 'The time consumed by the query, in milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - 'title' => '', - ], - 'cpuSec' => [ - 'description' => 'The core-hours for the Exclusive SQL.', - 'type' => 'number', - 'format' => 'double', - 'example' => '0.002', - 'title' => '', - ], - 'cpuCores' => [ - 'description' => 'The number of CPU cores used.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], + 'progress' => ['description' => 'Indicates whether the query results are complete. Valid values:'."\n" + ."\n" + .'- Complete: The query is complete and the results are complete.'."\n" + .'- Incomplete: The query is complete but the results are incomplete. Repeat the request to obtain complete results.', 'type' => 'string', 'example' => 'Complete', 'title' => ''], + 'aggQuery' => ['description' => 'The SQL part after the pipe (|) in the query statement.', 'type' => 'string', 'example' => 'select *', 'title' => ''], + 'whereQuery' => ['description' => 'The part before the pipe (|) in the query statement.', 'type' => 'string', 'example' => '*', 'title' => ''], + 'hasSQL' => ['description' => 'Indicates whether the query is an SQL query.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'processedRows' => ['description' => 'The number of rows processed in this query.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'elapsedMillisecond' => ['description' => 'The time consumed by this query, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'cpuSec' => ['description' => 'The core-hour consumed by Dedicated SQL.', 'type' => 'number', 'format' => 'double', 'example' => '0.002', 'title' => ''], + 'cpuCores' => ['description' => 'The number of CPU cores used.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'keys' => [ - 'description' => 'All keys in the query result.', + 'description' => 'All keys in the query results.', 'type' => 'array', - 'items' => [ - 'description' => 'The key.', - 'type' => 'string', - 'example' => 'key', - 'title' => '', - ], + 'items' => ['description' => 'key', 'type' => 'string', 'example' => 'key', 'title' => ''], 'title' => '', 'example' => '', ], 'terms' => [ 'description' => 'All terms in the query statement.', 'type' => 'array', - 'items' => [ - 'description' => 'The term.', - 'type' => 'object', - 'example' => '{term=*, key=}', - 'title' => '', - ], + 'items' => ['description' => 'The term.', 'type' => 'object', 'example' => '{term=*, key=}', 'title' => ''], 'title' => '', 'example' => '', ], - 'limited' => [ - 'description' => 'The number of entries returned. This parameter is returned if the SQL statement does not contain a LIMIT clause.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], - 'mode' => [ - 'description' => 'The query mode. Valid values:'."\n" - .'0: Normal query, which includes SQL queries.'."\n" - .'1: Phrase query.'."\n" - .'2: SCAN query.'."\n" - .'3: SCAN SQL query.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'title' => '', - ], + 'limited' => ['description' => 'The limit on the number of rows. Returned when the SQL statement does not contain a LIMIT clause.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'mode' => ['description' => 'The query mode. Valid values:'."\n" + .'- 0: standard query (including SQL)'."\n" + .'- 1: phrase query'."\n" + .'- 2: SCAN'."\n" + .'- 3: SCAN SQL', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'phraseQueryInfo' => [ - 'description' => 'The information about the phrase query.', + 'description' => 'The phrase query information.', 'type' => 'object', 'properties' => [ - 'scanAll' => [ - 'description' => 'Indicates whether all logs are scanned.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], - 'beginOffset' => [ - 'description' => 'The starting offset of the scan result after index filtering.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'title' => '', - ], - 'endOffset' => [ - 'description' => 'The end offset of the scan result after index filtering.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'title' => '', - ], - 'endTime' => [ - 'description' => 'The end time of the scan result after index filtering.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], + 'scanAll' => ['description' => 'Indicates whether all logs have been scanned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'beginOffset' => ['description' => 'The start offset of the scan results after index filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'endOffset' => ['description' => 'The end offset of the scan results after index filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'endTime' => ['description' => 'The end time of the scan results after index filtering.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], - 'scanBytes' => [ - 'description' => 'The volume of data scanned in the scan query, in bytes.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - 'title' => '', - ], + 'scanBytes' => ['description' => 'The amount of data scanned during the scan, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], 'highlights' => [ 'description' => 'The highlighted content.', 'type' => 'array', 'items' => [ 'description' => 'The highlighted content.', - 'type' => 'array', - 'items' => [ - 'description' => 'The highlighted log content.', - '$ref' => '#/components/schemas/LogContent', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => '高亮日志内容', 'extendType' => 'true', '$ref' => '#/components/schemas/LogContent'], + 'type' => 'object', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], - 'count' => [ - 'description' => 'The number of log entries returned in this query.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'title' => '', - ], - 'processedBytes' => [ - 'description' => 'The volume of logs processed in the query, in bytes.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - 'title' => '', - ], - 'isAccurate' => [ - 'description' => 'Indicates whether nanosecond-level sorting is enabled.', - 'type' => 'boolean', - 'example' => 'true', - 'title' => '', - ], + 'count' => ['description' => 'The number of log entries returned in this query request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'processedBytes' => ['description' => 'The volume of logs processed by the query, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'isAccurate' => ['description' => 'Specifies whether to enable nanosecond-precision ordering.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'columnTypes' => [ 'description' => 'The column types.', 'type' => 'array', - 'items' => [ - 'description' => 'The type.', - 'type' => 'string', - 'example' => 'long', - 'title' => '', - ], + 'items' => ['description' => 'The type.', 'type' => 'string', 'example' => 'long', 'title' => ''], 'title' => '', 'example' => '', ], - 'telementryType' => [ - 'description' => 'The type of observable data.', - 'type' => 'string', - 'example' => 'None', - 'title' => '', - ], + 'telementryType' => ['description' => 'The observable data type.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], 'title' => '', 'example' => '', ], 'data' => [ - 'description' => 'The query results.', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The returned data.', - 'type' => 'string', - 'example' => '{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}', - 'title' => '', - ], + 'additionalProperties' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}', 'title' => ''], 'title' => '', 'example' => '', ], @@ -23325,139 +13133,78 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meta\\": {\\n \\"progress\\": \\"Complete\\",\\n \\"aggQuery\\": \\"select *\\",\\n \\"whereQuery\\": \\"*\\",\\n \\"hasSQL\\": false,\\n \\"processedRows\\": 10000,\\n \\"elapsedMillisecond\\": 5,\\n \\"cpuSec\\": 0.002,\\n \\"cpuCores\\": 3,\\n \\"keys\\": [\\n \\"key\\"\\n ],\\n \\"terms\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"limited\\": 100,\\n \\"mode\\": 0,\\n \\"phraseQueryInfo\\": {\\n \\"scanAll\\": true,\\n \\"beginOffset\\": 0,\\n \\"endOffset\\": 0,\\n \\"endTime\\": 1\\n },\\n \\"scanBytes\\": 1024,\\n \\"highlights\\": [\\n [\\n {\\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}","type":"json"}]', - 'title' => 'GetLogsV2', - 'description' => '- The Simple Log Service software development kit (SDK) is available for Go, Java, and Python. You can also call all OpenAPI operations directly.'."\n" - ."\n" - .'- Specify a compression method when you call this operation. Available compression algorithms depend on your programming language. For more information, see the Accept-Encoding request parameter.'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query log data in a logstore', + 'description' => '- Specify the compression method during use. Different programming languages implement different compression algorithms. For details, see the Accept-Encoding request parameter.'."\n" ."\n" .'- For more information, see [GetLogs](~~2771313~~).'."\n" + .'### Authentication'."\n" + .'The following table describes the authorization information required by this API. You can add this information to the Action element in a RAM access policy statement to grant a Resource Access Management (RAM) user or RAM role the permission to invoke this API.'."\n" + .'| Action | Resource |'."\n" + .'| :------------ | :------------ |'."\n" + .'| `log:GetLogStoreLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |'."\n" ."\n" - .'### Permissions'."\n" - ."\n" - .'The following table lists the permissions required to call this API operation. Add the action to a RAM policy statement to grant a RAM user or RAM role permission to call this operation.'."\n" - ."\n" - .'| Action | Resource in an authorization policy |'."\n" - .'| :-------------------- | :-------------------------------------------------------- |'."\n" - .'| `log:GetLogStoreLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', + .'The following procedure describes how to use this API:', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meta\\": {\\n \\"progress\\": \\"Complete\\",\\n \\"aggQuery\\": \\"select *\\",\\n \\"whereQuery\\": \\"*\\",\\n \\"hasSQL\\": false,\\n \\"processedRows\\": 10000,\\n \\"elapsedMillisecond\\": 5,\\n \\"cpuSec\\": 0.002,\\n \\"cpuCores\\": 3,\\n \\"keys\\": [\\n \\"key\\"\\n ],\\n \\"terms\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"limited\\": 100,\\n \\"mode\\": 0,\\n \\"phraseQueryInfo\\": {\\n \\"scanAll\\": true,\\n \\"beginOffset\\": 0,\\n \\"endOffset\\": 0,\\n \\"endTime\\": 1\\n },\\n \\"scanBytes\\": 1024,\\n \\"highlights\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"count\\": 1,\\n \\"processedBytes\\": 10000,\\n \\"isAccurate\\": true,\\n \\"columnTypes\\": [\\n \\"long\\"\\n ],\\n \\"telementryType\\": \\"None\\"\\n },\\n \\"data\\": [\\n {\\n \\"key\\": \\"{\'remote_addr\': \'198.51.XXX.XXX\', \'pv\': \'1\', \'__source__\': \'\', \'__time__\': \'1649902984\'}\\"\\n }\\n ]\\n}","type":"json"}]', ], 'GetLogtailPipelineConfig' => [ 'summary' => 'Queries the information about a Logtail pipeline configuration.', 'path' => '/pipelineconfigs/{configName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logtail pipeline configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', - ], + 'schema' => ['description' => 'The name of the Logtail pipeline configuration.', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The Logtail pipeline configuration.'."\n", - '$ref' => '#/components/schemas/LogtailPipelineConfig', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The Logtail pipeline configuration.', '$ref' => '#/components/schemas/LogtailPipelineConfig', 'title' => '', 'example' => ''], ], ], - '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 \\"TopicType\\": \\"custom\\",\\n \\"TopicFormat\\": \\"aaa\\",\\n \\"EnableAlwaysOnline\\": true,\\n \\"EnableTimestampNanosecond\\": true,\\n \\"UsingOldContentTag\\": true\\n },\\n \\"inputs\\": [\\n {\\n \\"Type\\": \\"input_file\\",\\n \\"FilePaths\\": [\\n \\"/home/**/*.log\\"\\n ],\\n \\"MaxDirSearchDepth\\": 10,\\n \\"Multiline\\": {\\n \\"StartPattern\\": \\"\\\\\\\\d+\\"\\n },\\n \\"TailSizeKB\\": 1024\\n }\\n ],\\n \\"processors\\": [\\n {\\n \\"Type\\": \\"processor_regex\\",\\n \\"SourceKey\\": \\"content\\",\\n \\"Regex\\": \\"(\\\\\\\\d+).*([^;])\\",\\n \\"Keys\\": [\\n \\"k1\\",\\n \\"k2\\"\\n ]\\n }\\n ],\\n \\"aggregators\\": [\\n {\\n \\"Type\\": \\"aggregator_shardhash\\",\\n \\"SourceKeys\\": [\\n \\"__source__\\"\\n ]\\n }\\n ],\\n \\"flushers\\": [\\n {\\n \\"Type\\": \\"flusher_sls\\",\\n \\"Logstore\\": \\"test_logstore\\",\\n \\"Endpoint\\": \\"cn-hangzhou-intranet.aliyuncs.com\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"FlowControlExpireTime\\": 2,\\n \\"MaxSendRate\\": 3,\\n \\"EnableShardHash\\": true,\\n \\"TelemetryType\\": \\"log\\"\\n }\\n ],\\n \\"createTime\\": 1655176807,\\n \\"lastModifyTime\\": 1655176807,\\n \\"task\\": {\\n \\"Type\\": \\"task_example\\"\\n }\\n}","type":"json"}]', 'title' => 'GetLogtailPipelineConfig', 'changeSet' => [], @@ -23471,50 +13218,33 @@ 'action' => 'log:GetLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], + ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'description' => 'The UK (London) region is supported. Supported regions are constantly updated.'."\n", + 'description' => 'The UK (London) region is supported. Supported regions are constantly updated.', ], 'GetMLServiceResults' => [ 'summary' => 'Alibaba Cloud Simple Log Service (SLS) provides intelligent analysis for data such as logs, metrics, and traces. You can call models to obtain analysis results directly. Its main features include Named Entity Recognition (NER) for log data, anomaly detection for time series data, and root cause analysis for high-latency trace spans.', 'path' => '/ml/service/{serviceName}/analysis', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + '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' => [ [ @@ -23522,15 +13252,11 @@ 'in' => 'path', 'schema' => [ 'description' => 'The service name.', + 'enumValueTitles' => ['sls_builtin_service_trace_rca' => 'The service for analyzing high-latency trace requests.', 'sls_builtin_service_log_struct' => 'The service for LogNER.', 'sls_builtin_service_metric_anomaly' => 'The service for single-dimension time series anomaly detection.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'sls_builtin_service_trace_rca' => 'The service for analyzing high-latency trace requests.', - 'sls_builtin_service_log_struct' => 'The service for LogNER.', - 'sls_builtin_service_metric_anomaly' => 'The service for single-dimension time series anomaly detection.', - ], - 'title' => '', 'example' => 'sls_builtin_service_log_struct', + 'title' => '', ], ], [ @@ -23540,38 +13266,27 @@ 'description' => '- true: The request can use a built-in system service.'."\n" ."\n" .'- false: The request cannot use a built-in system service.', + 'enumValueTitles' => ['true' => 'The request can use a built-in system service.', 'false' => 'The request cannot use a built-in system service.'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'The request can use a built-in system service.', - 'false' => 'The request cannot use a built-in system service.', - ], - 'title' => '', 'example' => 'true', + 'title' => '', ], ], [ 'name' => 'version', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The version number of the algorithm. Different versions correspond to different algorithms.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'v1', - ], + 'schema' => ['description' => 'The version number of the algorithm. Different versions correspond to different algorithms.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => 'The request struct.', - 'required' => false, - 'enumValueTitles' => [ - 'others' => 'The content varies based on the value of serviceName.', - ], + 'enumValueTitles' => ['others' => 'The content varies based on the value of serviceName.'], '$ref' => '#/components/schemas/MLServiceAnalysisParam', + 'required' => false, 'title' => '', 'example' => '', ], @@ -23581,46 +13296,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' => [ @@ -23631,17 +13322,13 @@ 'description' => 'The status of the task.', 'type' => 'object', 'additionalProperties' => [ - 'type' => 'string', 'description' => 'By default, this parameter is empty, and tasks in all statuses are returned. Supported statuses are success, fail, and running.', - 'enumValueTitles' => [ - '无' => 'None', - ], - 'title' => '', + 'enumValueTitles' => ['无' => 'None', 'None' => 'None'], + 'type' => 'string', 'example' => '200', + 'title' => '', ], - 'enumValueTitles' => [ - '无' => 'None', - ], + 'enumValueTitles' => ['无' => 'None', 'None' => 'None'], 'title' => '', 'example' => '', ], @@ -23651,12 +13338,7 @@ 'items' => [ 'description' => 'The dataset struct.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The returned result.', - 'title' => '', - 'example' => '{\'marker\': \'\'}', - ], + 'additionalProperties' => ['description' => 'The returned result.', 'type' => 'string', 'example' => '{\'marker\': \'\'}', 'title' => ''], 'title' => '', 'example' => '', ], @@ -23664,21 +13346,16 @@ 'example' => '', ], ], - 'enumValueTitles' => [ - '无' => 'None', - ], + 'enumValueTitles' => ['无' => 'None', 'None' => 'None'], 'title' => '', 'example' => '', ], ], ], - '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' => 'GetMLServiceResults', - 'description' => 'This API endpoint is available only in the China (Shanghai) and Singapore regions.'."\n" - .'The following basic permissions are required:'."\n" + 'description' => 'This API endpoint is available only in the China (Shanghai) and Singapore regions. The following basic permissions are required:'."\n" ."\n" .'```'."\n" .'{'."\n" @@ -23913,115 +13590,62 @@ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], 'GetMachineGroup' => [ - 'summary' => 'Queries the details of a machine group.', + 'summary' => 'Gets the details of a machine group.', '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group', - ], + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The response body.'."\n", - '$ref' => '#/components/schemas/machineGroup', - 'example' => '', - ], + 'schema' => ['description' => 'The response body.', '$ref' => '#/components/schemas/machineGroup', 'title' => '', 'example' => ''], ], ], - '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":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"groupName\\": \\"machineGroup-test\\",\\n \\"groupType\\": \\"“”\\",\\n \\"machineIdentifyType\\": \\"ip\\",\\n \\"groupAttribute\\": {\\n \\"groupTopic\\": \\"testtopic\\",\\n \\"externalName\\": \\"testgroup\\"\\n },\\n \\"machineList\\": [\\n \\"47.100.XX.XX\\"\\n ]\\n}","type":"json"}]', 'title' => 'GetMachineGroup', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" @@ -24040,1938 +13664,1269 @@ '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}'], ], ], ], ], ], - 'GetMaxComputeExport' => [ - 'summary' => 'Queries a MaxCompute data shipping job.', - 'path' => '/maxcomputeexports/{mcExportName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMaterializedView' => [ + 'path' => '/materializedviews/{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' => '203462', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '294427', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'mcExportName', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-123456789-123456', - 'title' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Content-Type', + 'in' => 'header', + 'schema' => ['type' => 'string', 'default' => 'application/json', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'returnStatus', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + ], 'schema' => [ - 'description' => 'The detailed setting of the MaxCompute data shipping job.'."\n", - '$ref' => '#/components/schemas/MaxComputeExport', 'title' => '', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'logstore' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'originalSql' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'aggIntervalMins' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'startTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ttl' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'enabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'status' => [ + 'type' => 'object', + 'properties' => [ + 'lastRunTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'maxCursorTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'lastRunError' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => 'Retrieves a materialized view.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"\\",\\n \\"logstore\\": \\"\\",\\n \\"originalSql\\": \\"\\",\\n \\"aggIntervalMins\\": 0,\\n \\"startTime\\": 0,\\n \\"ttl\\": 0,\\n \\"enabled\\": false,\\n \\"status\\": {\\n \\"lastRunTime\\": 0,\\n \\"maxCursorTime\\": 0,\\n \\"lastRunError\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetMaterializedView', + ], + 'GetMaxComputeExport' => [ + 'summary' => 'Queries a MaxCompute data shipping job.', + 'path' => '/maxcomputeexports/{mcExportName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '203462', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], + ], + [ + 'name' => 'mcExportName', + 'in' => 'path', + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-123456789-123456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The detailed setting of the MaxCompute data shipping job.', '$ref' => '#/components/schemas/MaxComputeExport', 'title' => '', 'example' => ''], + ], + ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"MaxComputeExport\\",\\n \\"description\\": \\"MaxComputeExport\\",\\n \\"displayName\\": \\"MaxComputeExport\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\\\n\\",\\n \\"sink\\": {\\n \\"odpsEndpoint\\": \\"https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api\\",\\n \\"odpsTunnelEndpoint\\": \\"https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com\\",\\n \\"odpsProject\\": \\"demo_project\\",\\n \\"odpsTable\\": \\"demo_table\\",\\n \\"odpsRolearn\\": \\"acs:ram::xxxxxxx\\",\\n \\"odpsAccessKeyId\\": \\"axxxxxxxxxxxb\\",\\n \\"odpsAccessSecret\\": \\"aaxxxxxxxxxxxxxxxxxxxxxbb\\",\\n \\"partitionTimeFormat\\": \\"%Y_%m_%d\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"fields\\": [\\n \\"\'f1\'\\"\\n ],\\n \\"partitionColumn\\": [\\n \\"\'p1\'\\"\\n ],\\n \\"filterInvalid\\": true,\\n \\"timeFormatType\\": \\"StrfTimeFormat\\",\\n \\"bufferInterval\\": \\"1800\\"\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718390800\\n },\\n \\"createTime\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', 'title' => 'GetMaxComputeExport', - 'description' => '* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'GetMemories' => [ - 'path' => '/memorystores/{memoryStore}/all-memories', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetMetricStore' => [ + 'summary' => 'Queries a Metricstore.', + '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', + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + ], 'schema' => [ + 'title' => '', + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'limit' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'user_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'agent_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'app_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'run_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'page' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'page_size' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'name' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'example' => 'my_metric_store', 'title' => ''], + 'ttl' => ['description' => 'The retention period of data. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'shardCount' => ['description' => 'The number of shards.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'autoSplit' => ['description' => 'Indicates whether automatic sharding is enabled.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'maxSplitShard' => ['description' => 'The maximum number of shards that can be generated by automatic sharding.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => ''], + 'mode' => ['description' => 'The type of the Metricstore. Example: standard.', 'type' => 'string', 'example' => 'standard', 'title' => ''], + 'metricType' => ['description' => 'The type of metrics in the Metricstore. Example: prometheus.', 'type' => 'string', 'example' => 'prometheus', 'title' => ''], + 'createTime' => ['description' => 'The time when the Metricstore was created. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1698933894', 'title' => ''], + 'lastModifyTime' => ['description' => 'The time when the Metricstore was last modified. The value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1712023974', 'title' => ''], + 'hot_ttl' => ['description' => 'The retention period of data in the hot storage layer. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'infrequentAccessTTL' => ['description' => 'The retention period for the Infrequent Access (IA) storage class. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], + 'appendMeta' => ['type' => 'boolean', 'description' => 'Indicates whether to record the public IP address and log reception time. ', 'default' => 'false', 'title' => '', 'example' => 'false'], + 'shardingPolicy' => ['description' => 'Hash write configuration ', '$ref' => '#/components/schemas/ShardingPolicy', 'title' => '', 'example' => ''], + 'processorId' => ['description' => 'The ID of the write processor associated with the Metricstore ', 'title' => 'The ID of the write processor associated with the Metricstore ', 'type' => 'string', 'example' => ''], ], - 'description' => '', - 'title' => '', 'example' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => 'The specified metricstore xxx does not exist.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"my_metric_store\\",\\n \\"ttl\\": 7,\\n \\"shardCount\\": 2,\\n \\"autoSplit\\": true,\\n \\"maxSplitShard\\": 64,\\n \\"mode\\": \\"standard\\",\\n \\"metricType\\": \\"prometheus\\",\\n \\"createTime\\": 1698933894,\\n \\"lastModifyTime\\": 1712023974,\\n \\"hot_ttl\\": 60,\\n \\"infrequentAccessTTL\\": 30,\\n \\"appendMeta\\": false,\\n \\"shardingPolicy\\": {\\n \\"shardGroup\\": {\\n \\"keys\\": [\\n \\"userId\\"\\n ],\\n \\"groupCount\\": 8\\n },\\n \\"shardHash\\": {\\n \\"keys\\": [\\n \\"instanceId\\"\\n ],\\n \\"maxHashCount\\": 2\\n },\\n \\"queryActiveTime\\": 1764659409\\n },\\n \\"processorId\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'GetMetricStore', + 'description' => 'A [Metricstore](~~171723~~) is used to store [metrics](~~174965~~). This operation queries only the configuration of a Metricstore. To query the metric data, see [Query and analyze data](~~174968~~) and [GetLogsV2](~~2771318~~).'."\n" + ."\n" + .'- You must specify an existing Metricstore.'."\n" + ."\n" + .'- The Host in the request syntax consists of a project name and a Simple Log Service endpoint. You must specify the project in the Host.'."\n" + ."\n" + .'- You must have an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'An AccessKey pair for an Alibaba Cloud account has full access permissions to all API operations. This poses a high security threat. For security, we recommend that you use a RAM user for API access or routine O\\&M. Grant the RAM user the required permissions to operate Simple Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" + ."\n" + .'- Obtain the name and region of the project that contains the Metricstore. For more information, see [Manage projects](~~48984~~).'."\n" + ."\n" + .'- You can create a maximum of 200 Logstores or Metricstores in a project.'."\n" + ."\n" + .'- Metrics are deleted after their retention period expires.', + 'changeSet' => [ + ['createdAt' => '2025-12-03T01:37:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-12-02T11:55:01.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-11-24T09:35:51.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'GetMetricStoreMeteringMode' => [ + 'summary' => 'Queries the billing mode of a Metricstore.', + 'path' => '/metricstores/{metricStore}/meteringmode', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213243', + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], + ], + 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'projectName', 'title' => ''], ], [ - 'name' => 'memoryStore', + 'name' => 'metricStore', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['title' => 'metricStore', 'description' => 'metricStore', 'type' => 'string', 'required' => true, 'example' => 'metricStoreName'], ], ], 'responses' => [ 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], 'schema' => [ + 'title' => '', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'results' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'actorId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'agentId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'createdAt' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'hash' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'memory' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'role' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'runId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'score' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'updatedAt' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'userId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'relations' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'destination' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'relationship' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'source' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', + 'meteringMode' => [ + 'description' => 'The billing mode. Default value: ChargeByFunction. Valid values: ChargeByFunction and ChargeByDataIngest.', + 'type' => 'string', + 'example' => 'ChargeByFunction', + 'enum' => ['ChargeByFunction', 'ChargeByDataIngest'], 'title' => '', - 'example' => '', - ], - ], - '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', - ], ], ], - 'description' => '', - 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'summary' => '', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meteringMode\\": \\"ChargeByFunction\\"\\n}","type":"json"}]', + 'title' => 'GetMetricStoreMeteringMode', + 'description' => 'MetricStore supports two billing modes: [pay-by-feature](~~48220~~) and [pay-by-write-traffic](~~2365756~~).'."\n" + ."\n" + .'- You must specify an existing MetricStore when you call this operation.'."\n" + ."\n" + .'- In the request syntax, Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is required. For more information, see[AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations, which is high risk. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have permissions to manage Simple Log Service resources. For more information, see[Create a RAM user and authorize the RAM user](~~47664~~).'."\n" + ."\n" + .'- Before you call this operation, make sure that you have obtained the project name and region of the logs. For more information, see[Manage a project](~~48984~~).'."\n" + ."\n" + .'- You can create up to 200 Logstores or MetricStores in a project.'."\n" + ."\n" + .'- When metric data reaches the retention period that you configured, the data is deleted.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - '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"}]', - 'title' => '', ], - 'GetMemory' => [ - 'path' => '/memorystores/{memoryStore}/memories/{memoryId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetOSSExport' => [ + 'summary' => 'Retrieves the specified OSS data shipping job.', + 'path' => '/ossexports/{ossExportName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'memoryId', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The unique name of the existing job.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'immutable' => [ - 'type' => 'boolean', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'owner' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'updatedAt' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'organization' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'memory' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'properties' => [], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'expirationDate' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'createdAt' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The details of the job configuration.', '$ref' => '#/components/schemas/OSSExport', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => 'Retrieves memory information.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"https://oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"bucket\\": \\"my-bucket\\",\\n \\"prefix\\": \\"prefix-demo/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"pathFormat\\": \\"%Y/%m/%d/%H/%M\\",\\n \\"pathFormatType\\": \\"time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"csv\\",\\n \\"contentDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"your log key1\\\\\\",\\\\n \\\\\\"your log key2\\\\\\",\\\\n \\\\\\"your log key3\\\\\\",\\\\n ],\\\\n \\\\\\"delimiter\\\\\\": \\\\\\" \\\\\\",\\\\n \\\\\\"header\\\\\\": true,\\\\n \\\\\\"lineFeed\\\\\\": \\\\\\"\\\\\\\\n\\\\\\",\\\\n \\\\\\"null\\\\\\": \\\\\\"-\\\\\\",\\\\n \\\\\\"quote\\\\\\": \\\\\\"\\\\\\\\\\\\\\"\\\\\\"\\\\n},\\"\\n },\\n \\"compressionType\\": \\"snappy\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718380800,\\n \\"sourceSecureTransport\\": false\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', + 'title' => 'GetOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"immutable\\": false,\\n \\"owner\\": \\"\\",\\n \\"updatedAt\\": \\"\\",\\n \\"organization\\": \\"\\",\\n \\"memory\\": \\"\\",\\n \\"metadata\\": {},\\n \\"id\\": \\"\\",\\n \\"expirationDate\\": \\"\\",\\n \\"createdAt\\": \\"\\"\\n}","type":"json"}]', - 'title' => 'GetMemory', ], - 'GetMemoryHistory' => [ - 'path' => '/memorystores/{memoryStore}/memories/{memoryId}/history', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetOSSHDFSExport' => [ + 'summary' => 'Retrieves the details of a specified OSS-HDFS delivery job.', + 'path' => '/osshdfsexports/{ossExportName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'memoryId', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The unique name of the job.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'memoryId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'input' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'role' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'content' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'newMemory' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'userId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'event' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'createdAt' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'updatedAt' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'oldMemory' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'properties' => [], - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The detailed configuration of the job.', '$ref' => '#/components/schemas/OSSExport', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => 'Retrieve memory history.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"https://oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"bucket\\": \\"my-bucket\\",\\n \\"prefix\\": \\"prefix-demo/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"pathFormat\\": \\"%Y/%m/%d/%H/%M\\",\\n \\"pathFormatType\\": \\"time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"csv\\",\\n \\"contentDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"your log key1\\\\\\",\\\\n \\\\\\"your log key2\\\\\\",\\\\n \\\\\\"your log key3\\\\\\",\\\\n ],\\\\n \\\\\\"delimiter\\\\\\": \\\\\\" \\\\\\",\\\\n \\\\\\"header\\\\\\": true,\\\\n \\\\\\"lineFeed\\\\\\": \\\\\\"\\\\\\\\n\\\\\\",\\\\n \\\\\\"null\\\\\\": \\\\\\"-\\\\\\",\\\\n \\\\\\"quote\\\\\\": \\\\\\"\\\\\\\\\\\\\\"\\\\\\"\\\\n},\\"\\n },\\n \\"compressionType\\": \\"snappy\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718380800\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', + 'title' => 'GetOSSHDFSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - '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 }\\n]","type":"json"}]', - 'title' => 'GetMemoryHistory', ], - 'GetMemoryStore' => [ - 'path' => '/memorystores/{memoryStore}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetOSSIngestion' => [ + 'summary' => 'Retrieves a specified OSS import job.', + 'path' => '/ossingestions/{ossIngestionName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '203101', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'ossIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the OSS import job.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => ['description' => 'The configuration of the OSS import job.', '$ref' => '#/components/schemas/OSSIngestion', 'title' => '', 'example' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetOSSIngestion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'produces' => [ - 'application/json', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-oss-123456\\",\\n \\"description\\": \\"oss ingestion\\",\\n \\"displayName\\": \\"oss ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"ossbucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"never\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"restoreObjectEnabled\\": true,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"useMetaIndex\\": false,\\n \\"roleARN\\": \\"acs:ram::12345:role/aliyunlogdefaultrole\\",\\n \\"tagPackId\\": true,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"Line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', + ], + 'GetProject' => [ + 'path' => '/', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '8911', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-project-test', 'title' => ''], ], [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'name' => 'crossRegion', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'type' => 'string', - 'title' => '', - 'description' => '', - 'example' => '', - ], - 'customInstructions' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'createTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'enableGraph' => [ - 'type' => 'boolean', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'strategy' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'shortTermTtl' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'name' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + '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'], ], - 'description' => '', - 'title' => '', - 'example' => '', ], + 'schema' => ['description' => 'The project details.', '$ref' => '#/components/schemas/project', 'example' => '{ "createTime": "2020-11-18 16:55:57", "description": "test", "lastModifyTime": "2020-11-18 17:07:26", "owner": "174****745", "projectName": "ali-project-test", "region": "cn-hangzhou", "status": "Normal" }', 'title' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '', + 'title' => 'Get a specified project', + 'summary' => 'Queries the details of a specified project.', + 'description' => '### Operation description'."\n" + .'The Host in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | Description |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist| The Project does not exist : projectName | The project does not exist. |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | An internal service invocation error occurred. |'."\n" + ."\n" + .'For more information, see [Common error codes](~~29013~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"\\",\\n \\"customInstructions\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"createTime\\": 0,\\n \\"enableGraph\\": false,\\n \\"updateTime\\": 0,\\n \\"strategy\\": \\"\\",\\n \\"shortTermTtl\\": 0,\\n \\"name\\": \\"\\"\\n}","type":"json"}]', - 'title' => '', - ], - 'GetMetricStore' => [ - 'path' => '/metricstores/{name}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - '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' => '[{"errorExample":"","example":"{\\n \\"createTime\\": \\"2021-07-07 14:08:09\\",\\n \\"lastModifyTime\\": \\"2022-04-18 13:30:19\\",\\n \\"description\\": \\"Description of my-project\\",\\n \\"owner\\": \\"\\\\\\"\\\\\\"\\",\\n \\"projectName\\": \\"ali-test-project\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"Normal\\",\\n \\"resourceGroupId\\": \\"rg-acf******sq\\",\\n \\"dataRedundancyType\\": \\"LRS\\",\\n \\"recycleBinEnabled\\": false,\\n \\"internetEndpoint\\": \\"\\",\\n \\"internalEndpoint\\": \\"\\",\\n \\"quota\\": {\\n \\"key\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetProjectLogs' => [ + 'summary' => 'Queries logs in a project. You can use this operation to query logs at the project level.', + 'path' => '/logs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], - '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' => '8913', + 'abilityTreeNodes' => ['FEATUREslsCAO32E'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The name of the project.', - 'example' => 'my-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Metricstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'my_metric_store', - ], + 'name' => 'query', + 'in' => 'query', + 'schema' => ['description' => 'The standard SQL statement. In this example, the SQL statement queries the number of page views (PVs) from 2022-03-01 10:41:40 to 2022-03-01 10:56:40 in a Logstore whose name is nginx-moni.', 'type' => 'string', 'required' => true, 'example' => 'SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400', 'title' => ''], + ], + [ + 'name' => 'powerSql', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the Dedicated SQL feature. For more information, see [Enable Dedicated SQL](~~223777~~). Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false (default): enables the Standard SQL feature.'."\n" + ."\n" + .'You can use the powerSql or **query** parameter to configure Dedicated SQL.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-progress' => [ + 'schema' => ['title' => '查询结果的状态，包括： Complete：查询已经完成，返回结果为完整结果。 Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', 'type' => 'string', 'example' => 'Complete'], + ], + 'x-log-count' => [ + 'schema' => ['title' => '当前查询结果的日志总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + ], + 'x-log-processed-rows' => [ + 'schema' => ['title' => '本次查询处理的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'], + ], + 'x-log-elapsed-millisecond' => [ + 'schema' => ['title' => '本次查询消耗的毫秒时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The response struct.', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'title' => '', - 'description' => 'The name of the Metricstore.', - 'type' => 'string', - 'example' => 'my_metric_store', - ], - 'ttl' => [ - 'title' => '', - 'description' => 'The retention period of data. Unit: days.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'shardCount' => [ - 'title' => '', - 'description' => 'The number of shards.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'autoSplit' => [ - 'title' => '', - 'description' => 'Indicates whether automatic sharding is enabled.', - 'type' => 'boolean', - 'default' => 'true', - 'example' => 'true', - ], - 'maxSplitShard' => [ - 'title' => '', - 'description' => 'The maximum number of shards that can be generated by automatic sharding.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'mode' => [ - 'title' => '', - 'description' => 'The type of the Metricstore. Example: standard.', - 'type' => 'string', - 'example' => 'standard', - ], - 'metricType' => [ - 'title' => '', - 'description' => 'The type of metrics in the Metricstore. Example: prometheus.', - 'type' => 'string', - 'example' => 'prometheus', - ], - 'createTime' => [ - 'title' => '', - 'description' => 'The time when the Metricstore was created. The value is a UNIX timestamp.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1698933894', - ], - 'lastModifyTime' => [ - 'title' => '', - 'description' => 'The time when the Metricstore was last modified. The value is a UNIX timestamp.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1712023974', - ], - 'hot_ttl' => [ - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'description' => 'The retention period of data in the hot storage layer. Unit: days.', - 'example' => '', - ], - 'infrequentAccessTTL' => [ - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'description' => 'The retention period for the Infrequent Access (IA) storage class. Unit: days.', - 'example' => '', - ], - 'appendMeta' => [ - 'type' => 'boolean', - 'default' => 'false', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'shardingPolicy' => [ - '$ref' => '#/components/schemas/ShardingPolicy', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'description' => 'The logs that are returned.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The log that is returned.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The log that is returned.', 'type' => 'string', 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', 'title' => ''], + 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', ], 'example' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'MetricStoreNotExist', - 'errorMessage' => 'The specified metricstore xxx does not exist.', - 'description' => 'The specified metricstore xxx does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'GetMetricStore', - 'summary' => 'Queries a Metricstore.', - 'description' => 'A [Metricstore](~~171723~~) is used to store [metrics](~~174965~~). This operation queries only the configuration of a Metricstore. To query the metric data, see [Query and analyze data](~~174968~~) and [GetLogsV2](~~2771318~~).'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"key\\": \\"[ { \\\\\\"__time__\\\\\\" : 1409529660, \\\\\\"__source__\\\\\\" : \\\\\\"192.168.1.100\\\\\\", \\\\\\"Key1\\\\\\" : \\\\\\"error\\\\\\", \\\\\\"Key2\\\\\\" : \\\\\\"Value2\\\\\\" }, { \\\\\\"__time__\\\\\\" : 1409529680, \\\\\\"__source__\\\\\\" : \\\\\\"192.168.1.100\\\\\\", \\\\\\"Key3\\\\\\" : \\\\\\"error\\\\\\", \\\\\\"Key4\\\\\\" : \\\\\\"Value4\\\\\\" } ]\\"\\n }\\n]","type":"json"}]', + 'title' => 'GetProjectLogs', + 'description' => '### Usage notes'."\n" ."\n" - .'- You must specify an existing Metricstore.'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" - .'- The Host in the request syntax consists of a project name and a Simple Log Service endpoint. You must specify the project in the Host.'."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" - .'- You must have an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'An AccessKey pair for an Alibaba Cloud account has full access permissions to all API operations. This poses a high security threat. For security, we recommend that you use a RAM user for API access or routine O\\&M. Grant the RAM user the required permissions to operate Simple Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" - .'- Obtain the name and region of the project that contains the Metricstore. For more information, see [Manage projects](~~48984~~).'."\n" + .'- Indexes are configured before you query logs. For more information, see [Create indexes](~~90732~~).'."\n" ."\n" - .'- You can create a maximum of 200 Logstores or Metricstores in a project.'."\n" + .'- Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" ."\n" - .'- Metrics are deleted after their retention period expires.', - 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:06.000Z', - 'description' => 'Response parameters changed', - ], - [ - 'createdAt' => '2025-12-02T11:55:01.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-11-24T09:35:51.000Z', - 'description' => 'Response parameters changed', - ], - ], + .'- You must set query to a standard SQL statement.'."\n" + ."\n" + .'- You must specify a Logstore in the FROM clause of an SQL statement. A Logstore can be used as an SQL table.'."\n" + ."\n" + .'- You must specify a time range in an SQL statement by using the \\_\\_date\\_\\_ or \\_\\_time\\_\\_ parameter. The value of the \\_\\_date\\_\\_ parameter is a timestamp. The value of the \\_\\_time\\_\\_ parameter is an integer, and the unit of the value is seconds.'."\n" + ."\n" + .'### Authentication resources'."\n" + ."\n" + .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + ."\n" + .'| Action | Resource |'."\n" + .'| :------------------- | :-------------------------------------------------------- |'."\n" + .'| `log:GetProjectLogs` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', + 'requestParamsDescription' => 'Sample requests'."\n" + ."\n" + .'GET /logs?query=SELECT COUNT(\\*) as pv FROM nginx-moni where **time** > 1646102500 and **time** < 1646103400\\&powerSql=false HTTP/1.1 Host:ali-test-project.ch-hangzhou.log.aliyuncs.com Content-Type:application/json', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 400 | ParameterInvalid| Parameter is invalid. | 请求的参数错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', + 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - '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\\": 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}","type":"json"}]', ], - 'GetMetricStoreMeteringMode' => [ - 'summary' => 'Queries the billing mode of a Metricstore.', - 'path' => '/metricstores/{metricStore}/meteringmode', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetProjectPolicy' => [ + 'summary' => 'Queries a 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', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '213243', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeCode' => '157642', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'projectName', - ], - ], - [ - 'name' => 'metricStore', - 'in' => 'path', - 'schema' => [ - 'title' => 'metricStore', - 'description' => 'metricStore'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'metricStoreName', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project'], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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' => '', - 'description' => 'The response body.'."\n", - 'type' => 'object', - 'properties' => [ - 'meteringMode' => [ - 'title' => '', - 'description' => 'The billing mode. Default value: ChargeByFunction. Valid values: ChargeByFunction and ChargeByDataIngest.'."\n", - 'type' => 'string', - 'example' => 'ChargeByFunction', - 'enum' => [ - 'ChargeByFunction', - 'ChargeByDataIngest', - ], - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'example' => '', ], + 'schema' => ['description' => 'The policy.', 'type' => 'string', 'example' => '{ "Version": "1", "Statement": [{ "Action": ["log:PostLogStoreLogs"], "Resource": "acs:log:*:*:project/exampleproject/*", "Effect": "Deny", "Condition": { "StringNotLike": { "acs:SourceVpc": ["vpc-*"] } } }] }', 'title' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"meteringMode\\": \\"ChargeByFunction\\"\\n}","type":"json"}]', - 'title' => 'GetMetricStoreMeteringMode', - 'description' => '时序库支持两种计费模式，[按使用功能计费](~~48220~~) 与 [按写入数据量计费](~~2365756~~)。'."\n" - .'- 此接口需要指定一个已存在的时序库。'."\n" - .'- 请求语法中的Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。'."\n" - .'- 已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + 'responseDemo' => '[{"errorExample":"","example":"\\"{ \\\\t\\\\\\"Version\\\\\\": \\\\\\"1\\\\\\", \\\\t\\\\\\"Statement\\\\\\": [{ \\\\t\\\\t\\\\\\"Action\\\\\\": [\\\\\\"log:PostLogStoreLogs\\\\\\"], \\\\t\\\\t\\\\\\"Resource\\\\\\": \\\\\\"acs:log:*:*:project/exampleproject/*\\\\\\", \\\\t\\\\t\\\\\\"Effect\\\\\\": \\\\\\"Deny\\\\\\", \\\\t\\\\t\\\\\\"Condition\\\\\\": { \\\\t\\\\t\\\\t\\\\\\"StringNotLike\\\\\\": { \\\\t\\\\t\\\\t\\\\t\\\\\\"acs:SourceVpc\\\\\\": [\\\\\\"vpc-*\\\\\\"] \\\\t\\\\t\\\\t} \\\\t\\\\t} \\\\t}] }\\"","type":"json"}]', + 'title' => 'GetProjectPolicy', + 'description' => '### [](#)Usage notes'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。'."\n" - .'- 已明确您查询日志所属的Project名称、所属地域等信息。如何查询，请参见[管理Project](~~48984~~)。'."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'- 一个Project中，最多创建 200 个 Logstore 或 MetricStore。'."\n" - .'- 当时序数据保存时间达到您所设置的数据保存时间后，数据将被删除。', + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'GetOSSExport' => [ - 'summary' => 'Retrieves the specified OSS data shipping job.', - 'path' => '/ossexports/{ossExportName}', - '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' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetS3Ingestion' => [ + 'summary' => 'Retrieves information about an S3 import task.', + 'path' => '/s3ingestions/{s3IngestionName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '203470', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeCode' => '263582', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'my-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'ossExportName', + 'name' => 's3IngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the existing job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'export-oss-123456789-123456'."\n", - ], + 'schema' => ['description' => 'The name of the S3 import task.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'The details of the job configuration.', - '$ref' => '#/components/schemas/OSSExport', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The S3 import task.', '$ref' => '#/components/schemas/S3Ingestion', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"http://xxxxxxxx\\",\\n \\"bucket\\": \\"test-bucket\\",\\n \\"prefix\\": \\"prefixxxx/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::xxxxxxx\\",\\n \\"pathFormat\\": \\"%Y_%m_%d/good/bad\\",\\n \\"pathFormatType\\": \\"only support time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"json/parquet/csv/orc\\",\\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/gizp/zstd/none\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 123456789,\\n \\"toTime\\": 123456789\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', - 'title' => 'GetOSSExport', + 'title' => 'GetS3Ingestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"ingest-s3-123456\\",\\n \\"description\\": \\"s3 ingestion\\",\\n \\"displayName\\": \\"s3 ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"awsRegion\\": \\"ap-northeast-1\\",\\n \\"awsAccessKey\\": \\"AKIxxxxxxxxxxYJE\\",\\n \\"awsAccessKeySecret\\": \\"123xxxxxxxxxxfjf\\",\\n \\"bucket\\": \\"s3bucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"30m\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"awsUseSQS\\": false,\\n \\"awsSQSQueueUrl\\": \\"https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan\\",\\n \\"useAwsSQSOnly\\": false,\\n \\"tagPackId\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"endpoint\\": \\"s3.us-east-1.amazonaws.com\\",\\n \\"cloudFrontEndpoint\\": \\"dtfsb7voqy76q.cloudfront.net \\",\\n \\"cloudFrontToken\\": \\"@test-s3-access/ABS\\",\\n \\"useCloudFront\\": false,\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n}","type":"json"}]', ], - 'GetOSSHDFSExport' => [ - 'summary' => 'Retrieves the details of a specified OSS-HDFS delivery job.', - 'path' => '/osshdfsexports/{ossExportName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSavedSearch' => [ + 'summary' => 'Queries a saved search.', + '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' => '203478', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'my-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project'], ], [ - 'name' => 'ossExportName', + 'name' => 'savedsearchName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'export-osshdfs-1234567890-123456'."\n", - ], + 'schema' => ['description' => 'The name of the saved search.', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'The detailed configuration of the job.', - '$ref' => '#/components/schemas/OSSExport', - 'title' => '', - 'example' => '', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"http://xxxxxxxx\\",\\n \\"bucket\\": \\"test-bucket\\",\\n \\"prefix\\": \\"prefixxxx/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::xxxxxxx\\",\\n \\"pathFormat\\": \\"%Y_%m_%d/good/bad\\",\\n \\"pathFormatType\\": \\"only support time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"json/parquet/csv/orc\\",\\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/gizp/zstd/none\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 123456789,\\n \\"toTime\\": 123456789\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n}","type":"json"}]', - 'title' => 'GetOSSHDFSExport', + 'headers' => [ + 'Server' => [ + 'schema' => ['type' => 'string', 'example' => 'nginx'], + ], + 'Content-Length' => [ + 'schema' => ['type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], + 'schema' => ['description' => 'The response body.', '$ref' => '#/components/schemas/SavedSearch', 'example' => 'saved-search', 'title' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"savedsearchName\\": \\"savedsearch-name\\",\\n \\"searchQuery\\": \\"status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5\\",\\n \\"logstore\\": \\"aliyun-test-logstore\\",\\n \\"topic\\": \\"topic-test\\",\\n \\"displayName\\": \\"Method\\"\\n}","type":"json"}]', + 'title' => 'GetSavedSearch', + 'description' => '### Usage notes'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" + ."\n" + .'- You can call the ListSavedSearch operation to query the name of a saved search.'."\n" + ."\n" + .'### Authentication resources'."\n" + ."\n" + .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + ."\n" + .'| Action | Resource |'."\n" + .'| :------------------- | :--------------------------------------------------------------------------------------- |'."\n" + .'| `log:GetSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'GetOSSIngestion' => [ - 'summary' => 'Retrieves a specified OSS import job.', - 'path' => '/ossingestions/{ossIngestionName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetSavedSearch', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], + ], + ], + ], ], + ], + 'GetScheduledSQL' => [ + 'summary' => 'Retrieves the specified Scheduled SQL job.', + 'path' => '/scheduledsqls/{scheduledSQLName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '203101', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '209801', + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'."\n"], ], [ - 'name' => 'ossIngestionName', + 'name' => 'scheduledSQLName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the OSS import job.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ingest-oss-123456', - ], + 'schema' => ['description' => 'The unique name of the existing job.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'description' => 'The configuration of the OSS import job.', - '$ref' => '#/components/schemas/OSSIngestion', - 'title' => '', - 'example' => '', + 'headers' => [ + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], ], + 'schema' => ['description' => 'The configuration of the Scheduled SQL job.', '$ref' => '#/components/schemas/ScheduledSQL', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 401 => [ + ['errorCode' => 'AuthorizationRequired', 'errorMessage' => 'Authorization Required', 'description' => ''], + ], ], - '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/1h\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"ossbucket\\",\\n \\"compressionCodec\\": \\"none,snappy,gzip\\",\\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' => 'GetOSSIngestion', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"description\\": \\"This is a scheduled sql job\\",\\n \\"displayName\\": \\"This is a scheduled sql job\\",\\n \\"name\\": \\"test-scheduled-sql\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"script\\": \\"* | select *\\",\\n \\"sqlType\\": \\"searchQuery\\",\\n \\"destEndpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"destProject\\": \\"project-demo\\",\\n \\"sourceLogstore\\": \\"source-logstore-demo\\",\\n \\"destLogstore\\": \\"dest-logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"destRoleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"fromTimeExpr\\": \\"@m-1m\\",\\n \\"toTimeExpr\\": \\"@m\\",\\n \\"maxRunTimeInSeconds\\": 600,\\n \\"resourcePool\\": \\"enhanced\\",\\n \\"maxRetries\\": 20,\\n \\"fromTime\\": 1712592000,\\n \\"toTime\\": 0,\\n \\"dataFormat\\": \\"log2log\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714123644,\\n \\"lastModifiedTime\\": 1714123644,\\n \\"scheduleId\\": \\"e73f43732852064ad5d091914e39342f\\",\\n \\"status\\": \\"ENABLED\\"\\n}","type":"json"}]', + 'title' => 'GetScheduledSQL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'GetProject' => [ - 'summary' => 'Queries the details of a project.', - 'path' => '/', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetSlsService' => [ + 'summary' => 'Call the GetSlsService operation to retrieve the activation status of Simple Log Service. The endpoint must be China (Shanghai) or Singapore.', + 'path' => '/slsservice', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '8911', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-project-test', - 'title' => '', - ], - ], + 'abilityTreeCode' => '194671', + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], + 'parameters' => [], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], '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'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], ], - 'schema' => [ - 'description' => 'The details of the project.'."\n", - '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', - 'title' => '', - ], + 'schema' => ['description' => 'The response body.', '$ref' => '#/components/schemas/serviceStatus', 'title' => '', 'example' => ''], ], ], - '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' => 'GetProject', - 'description' => '### Usage notes'."\n" - ."\n" - .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ProjectNotExist| The Project does not exist : projectName | Project不存在。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"NotExist\\",\\n \\"enabled\\": false\\n}","type":"json"}]', + 'title' => 'GetSlsService', + 'description' => 'This operation requires an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + .'An AccessKey pair for an Alibaba Cloud account grants full access to all APIs. This poses a high security threat. Create and use a RAM user for API access or routine operations and maintenance (O\\&M). The RAM user must have permissions to operate Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - '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}', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'GetProjectLogs' => [ - 'summary' => 'Queries logs in a project. You can use this operation to query logs at the project level.', - 'path' => '/logs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSqlInstance' => [ + 'summary' => 'Gets information about the Dedicated SQL instance of a project, such as the number of compute units (CUs) and whether the Dedicated SQL instance is enabled by default. Before you call this operation, you must create a Dedicated SQL instance by calling the CreateSqlInstance or UpdateSqlInstance operation.', + 'path' => '/sqlinstance', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '8913', - 'abilityTreeNodes' => [ - 'FEATUREslsCAO32E', - ], + 'abilityTreeCode' => '215092', + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The standard SQL statement. In this example, the SQL statement queries the number of page views (PVs) from 2022-03-01 10:41:40 to 2022-03-01 10:56:40 in a Logstore whose name is nginx-moni.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SELECT COUNT(*) as pv FROM nginx-moni where __time__ > 1646102500 and __time__ < 1646103400', - ], - ], - [ - 'name' => 'powerSql', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'Specifies whether to enable the Dedicated SQL feature. For more information, see [Enable Dedicated SQL](~~223777~~). Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false (default): enables the Standard SQL feature.'."\n" - ."\n" - .'You can use the powerSql or **query** parameter to configure Dedicated SQL.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'Project Name', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'x-log-progress' => [ - 'schema' => [ - 'title' => '查询结果的状态，包括： Complete：查询已经完成，返回结果为完整结果。 Incomplete：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', - 'type' => 'string', - 'example' => 'Complete', - ], - ], - 'x-log-count' => [ - 'schema' => [ - 'title' => '当前查询结果的日志总数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - ], - 'x-log-processed-rows' => [ - 'schema' => [ - 'title' => '本次查询处理的行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - ], - 'x-log-elapsed-millisecond' => [ - 'schema' => [ - 'title' => '本次查询消耗的毫秒时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The logs that are returned.'."\n", + 'description' => 'Dedicated SQL instance', 'type' => 'array', 'items' => [ - 'title' => '', - 'description' => 'The log that is returned.'."\n", + 'description' => 'Dedicated SQL instance', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The log that is returned.'."\n", - 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', - 'title' => '', + 'properties' => [ + 'name' => ['description' => 'The value is group1. This is an internal parameter that you can ignore.', 'type' => 'string', 'title' => '', 'example' => 'group1'], + 'cu' => ['description' => 'The maximum number of CUs that the Dedicated SQL version can use. A CU is a compute core that can be used for parallel processing when the Dedicated SQL version is running.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'createTime' => ['description' => 'The time when the configuration for the Dedicated SQL version was created. This is a UNIX timestamp.', 'type' => 'integer', 'example' => '1710230272', 'format' => 'int32', 'title' => ''], + 'updateTime' => ['description' => 'The time when the configuration for the Dedicated SQL version was updated. This is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1710230272'], + 'useAsDefault' => ['description' => 'Indicates whether the Dedicated SQL version is enabled by default for the project. If this parameter is set to true, all query and analysis operations in the project, such as alerts and dashboards, use the Dedicated SQL version.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], - 'example' => '[ { "__time__" : 1409529660, "__source__" : "192.168.1.100", "Key1" : "error", "Key2" : "Value2" }, { "__time__" : 1409529680, "__source__" : "192.168.1.100", "Key3" : "error", "Key4" : "Value4" } ]', + 'title' => '', + 'example' => '', ], + 'title' => '', 'example' => '', ], ], ], - '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' => 'GetProjectLogs', - 'description' => '### Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" - .'* Indexes are configured before you query logs. For more information, see [Create indexes](~~90732~~).'."\n" - .'* Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" - .'* You must set query to a standard SQL statement.'."\n" - .'* You must specify a Logstore in the FROM clause of an SQL statement. A Logstore can be used as an SQL table.'."\n" - .'* You must specify a time range in an SQL statement by using the \\_\\_date\\_\\_ or \\_\\_time\\_\\_ parameter. The value of the \\_\\_date\\_\\_ parameter is a timestamp. The value of the \\_\\_time\\_\\_ parameter is an integer, and the unit of the value is seconds.'."\n" - ."\n" - .'### Authentication resources'."\n" - ."\n" - .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" - ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:GetProjectLogs`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`|', - 'requestParamsDescription' => 'Sample requests'."\n" - ."\n" - .'GET /logs?query=SELECT COUNT(\\*) as pv FROM nginx-moni where **time** > 1646102500 and **time** < 1646103400\\&powerSql=false HTTP/1.1 Host:ali-test-project.ch-hangzhou.log.aliyuncs.com Content-Type:application/json'."\n", - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 400 | ParameterInvalid| Parameter is invalid. | 请求的参数错误。 |'."\n" - ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"name\\": \\"group1\\",\\n \\"cu\\": 2,\\n \\"createTime\\": 1710230272,\\n \\"updateTime\\": 1710230272,\\n \\"useAsDefault\\": true\\n }\\n]","type":"json"}]', + 'title' => 'GetSqlInstance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'GetProjectPolicy' => [ - 'summary' => 'Queries a project policy.', - 'path' => '/policy', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:GetSqlInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'GetStoreView' => [ + 'summary' => 'Queries the configurations of a dataset by using the name of the dataset.', + 'path' => '/storeviews/{name}', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '157642', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208676', + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], - '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' => '返回响应的时间。', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The configurations of the dataset.', + 'type' => 'object', + 'properties' => [ + 'storeType' => [ + 'title' => 'Id of the request', + 'description' => 'The type of the dataset.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- metricstore'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- logstore'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'type' => 'string', + 'example' => 'logstore', ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', + 'stores' => [ + 'description' => 'The Logstores or Metricstores.', + 'type' => 'array', + 'items' => ['description' => 'The Logstore or Metricstore.', '$ref' => '#/components/schemas/StoreViewStore', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], - ], - 'schema' => [ - 'description' => 'The policy.'."\n", - 'type' => 'string', - 'example' => '{ "Version": "1", "Statement": [{ "Action": ["log:PostLogStoreLogs"], "Resource": "acs:log:*:*:project/exampleproject/*", "Effect": "Deny", "Condition": { "StringNotLike": { "acs:SourceVpc": ["vpc-*"] } } }] }', - 'title' => '', + 'example' => '', ], ], ], - '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' => 'GetProjectPolicy', - 'description' => '### [](#)Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n", + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"storeType\\": \\"logstore\\",\\n \\"stores\\": [\\n {\\n \\"project\\": \\"ali-test-project\\",\\n \\"storeName\\": \\"my-logstore\\",\\n \\"query\\": \\"job: IT | select name, age, gender from log\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetStoreView', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -25980,144 +14935,144 @@ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:GetProjectPolicy', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], + 'action' => 'log:GetStoreView', + 'authLevel' => 'operate', + 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], - 'GetS3Ingestion' => [ - 'summary' => 'Retrieves information about an S3 import task.', - 'path' => '/s3ingestions/{s3IngestionName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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', - 'abilityTreeCode' => '263582', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212612', + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'test', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project'], ], [ - 'name' => 's3IngestionName', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the S3 import task.', - 'title' => '', - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - '$ref' => '#/components/schemas/S3Ingestion', - 'description' => 'The S3 import task.', - 'title' => '', + 'title' => 'Schema of Response', + 'description' => 'The index configurations of all Logstores in the dataset.', + 'type' => 'object', + 'properties' => [ + 'indexes' => [ + 'description' => 'The index configurations.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'project' => ['description' => 'The name of the project to which the Logstore belongs.', 'type' => 'string', 'example' => 'example-project', 'title' => ''], + 'logstore' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'example' => 'my-logstore', 'title' => ''], + 'index' => ['description' => 'The index configurations of the Logstore.', '$ref' => '#/components/schemas/index', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], 'example' => '', ], ], ], - 'title' => 'GetS3Ingestion', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetStoreViewIndex', + 'summary' => 'Queries the indexes of a dataset by using the name of the dataset. Only datasets of the logstore type are supported.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - '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/1h\\"\\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' => 'Queries a saved search.', - 'path' => '/savedsearches/{savedsearchName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetStoreViewIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"indexes\\": [\\n {\\n \\"project\\": \\"example-project\\",\\n \\"logstore\\": \\"my-logstore\\",\\n \\"index\\": {\\n \\"max_text_len\\": 2048,\\n \\"log_reduce_white_list\\": [\\n \\"name\\"\\n ],\\n \\"log_reduce_black_list\\": [\\n \\"time\\"\\n ],\\n \\"line\\": {\\n \\"chn\\": false,\\n \\"caseSensitive\\": true,\\n \\"token\\": [\\n \\",\\"\\n ],\\n \\"include_keys\\": [\\n \\"includeField\\"\\n ],\\n \\"exclude_keys\\": [\\n \\"excludeField\\"\\n ]\\n },\\n \\"keys\\": {\\n \\"key\\": {\\n \\"chn\\": true,\\n \\"caseSensitive\\": true,\\n \\"alias\\": \\"myAlias\\",\\n \\"type\\": \\"text\\",\\n \\"doc_value\\": true,\\n \\"index_all\\": true,\\n \\"max_depth\\": 0,\\n \\"embedding\\": \\"\\",\\n \\"vector_index\\": \\"\\",\\n \\"token\\": [\\n \\"|\\"\\n ],\\n \\"json_keys\\": {\\n \\"key\\": {\\n \\"chn\\": true,\\n \\"caseSensitive\\": true,\\n \\"token\\": [\\n \\"|\\"\\n ],\\n \\"alias\\": \\"myAlias\\",\\n \\"type\\": \\"text\\",\\n \\"doc_value\\": true\\n }\\n }\\n }\\n },\\n \\"log_reduce\\": true,\\n \\"scan_index\\": false\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListAgentInstanceConfigs' => [ + 'summary' => 'This operation lists process-level configurations.', + 'path' => '/agentinstanceconfigs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227400', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-project', - ], + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to skip. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'savedsearchName', - 'in' => 'path', + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return. The default value is 500.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'configType', + 'in' => 'query', 'schema' => [ - 'description' => 'The name of the saved search.'."\n", + 'description' => 'The type of the process-level configuration.', + 'enumValueTitles' => [ + 'apm_biz_trace' => 'apm_biz_trace', 'apm_self_protect' => 'apm_self_protect', 'apm_convergence' => 'apm_convergence', 'apm_custom_extract' => 'apm\\\\_custom\\\\_extract', 'apm_pilot' => 'APM Pilot', 'apm_trace' => 'apm_trace', 'rum_app_config' => 'rum_app_config', 'security_rasp' => 'security\\\\_rasp', 'rum_web_config' => 'RUM Web Configuration', 'apm_biz_trace_global' => 'apm\\\\_biz\\\\_trace\\\\_global', + 'apm_intacheap' => 'apm_intacheap', 'apm_user_method' => 'apm\\\\_user\\\\_method', 'apm_global' => 'apm_global', 'apm_forward_process' => 'APM Forwarding Process', + ], 'type' => 'string', - 'required' => true, - 'example' => 'savedsearch-name', + 'required' => false, + 'example' => 'apm_trace', 'title' => '', ], ], @@ -26125,1051 +15080,848 @@ 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'nginx', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'Content-Length' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '0', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], 'Connection' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'close', - ], + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], 'Date' => [ - 'schema' => [ - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'description' => 'The response body.'."\n", - 'example' => 'saved-search', - '$ref' => '#/components/schemas/SavedSearch', + 'type' => 'object', + 'properties' => [ + 'size' => ['description' => 'The number of data entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'total' => ['description' => 'The total number of data entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'configs' => ['description' => 'The process-level configurations.', '$ref' => '#/components/schemas/ListAgentInstanceConfigs', 'title' => '', 'example' => ''], + ], + 'description' => '', 'title' => '', + 'example' => '', ], ], ], - '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' => 'GetSavedSearch', - 'description' => '### Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - .'* You can call the ListSavedSearch operation to query the name of a saved search.'."\n" - ."\n" - .'### Authentication resources'."\n" - ."\n" - .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" - ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:GetSavedSearch`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}`|', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAgentInstanceConfigs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ + 'ramActions' => [], + 'description' => 'Retrieves a list of process-level configurations.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"size\\": 10,\\n \\"total\\": 10,\\n \\"configs\\": [\\n {\\n \\"configType\\": \\"apm_biz_trace\\",\\n \\"attributes\\": {\\n \\"key\\": \\"\\\\\\"workspace\\\\\\": \\\\\\"test-workspace\\\\\\"\\\\n\\\\\\"service\\\\\\": \\\\\\"test-service\\\\\\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListAiTools' => [ + 'summary' => 'Lists the AI tools provided by the observability service, including Copilot capabilities for various services.', + 'path' => '/ml/tool/list', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'log:GetSavedSearch', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + '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'], ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}', + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fields' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the field.', 'type' => 'string', 'title' => '', 'example' => ''], + 'option' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'The valid values for the field.', + 'title' => '', + 'example' => '', + ], + 'required' => ['description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'type' => ['description' => 'The type of the field.', 'type' => 'string', 'title' => '', 'example' => ''], + 'example' => ['description' => 'An example of the field.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => ['description' => 'The description of the field.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The fields of the tool.', + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The name of the tool.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => ['description' => 'The description of the tool.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - ], - 'GetScheduledSQL' => [ - 'summary' => 'Retrieves the specified Scheduled SQL job.', - 'path' => '/scheduledsqls/{scheduledSQLName}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAiTools', + 'description' => 'The endpoint for this API is available only in the China (Shanghai) and Singapore regions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"option\\": [\\n \\"\\"\\n ],\\n \\"required\\": false,\\n \\"type\\": \\"\\",\\n \\"example\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n ],\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n]","type":"json"}]', + ], + 'ListAlerts' => [ + 'summary' => 'Lists the alert rules in a specified project.', + 'path' => '/alerts', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '209801', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '199870', + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The project name.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'scheduledSQLName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the existing job.', - 'type' => 'string', - 'required' => true, - 'example' => 'sql-123456789-123456'."\n", - 'title' => '', - ], + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => 'The line from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of rows to return on each page for a paged query. The maximum value is 200. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'logstore', + 'in' => 'query', + 'schema' => ['description' => 'The Logstore from which to obtain alert rules. The default value is empty.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度', - 'type' => 'string', - ], + 'Server' => [ + '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'], ], - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], 'schema' => [ - 'description' => 'The configuration of the Scheduled SQL job.', - '$ref' => '#/components/schemas/ScheduledSQL', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'The total number of alerts in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'count' => ['description' => 'The number of alerts returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'results' => [ + 'description' => 'The list of alert configurations.', + 'type' => 'array', + 'items' => ['description' => 'The alert configuration.', '$ref' => '#/components/schemas/Alert', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', 'title' => '', 'example' => '', ], ], ], - '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/1h\\"\\n },\\n \\"configuration\\": {\\n \\"script\\": \\"* | select *\\",\\n \\"sqlType\\": \\"searchQuery\\",\\n \\"destEndpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"destProject\\": \\"project-demo\\",\\n \\"sourceLogstore\\": \\"source-logstore-demo\\",\\n \\"destLogstore\\": \\"dest-logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"destRoleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"fromTimeExpr\\": \\"@m-1m\\",\\n \\"toTimeExpr\\": \\"@m\\",\\n \\"maxRunTimeInSeconds\\": 600,\\n \\"resourcePool\\": \\"enhanced\\",\\n \\"maxRetries\\": 20,\\n \\"fromTime\\": 1712592000,\\n \\"toTime\\": 0,\\n \\"dataFormat\\": \\"log2log\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714123644,\\n \\"lastModifiedTime\\": 1714123644,\\n \\"scheduleId\\": \\"e73f43732852064ad5d091914e39342f\\",\\n \\"status\\": \\"ENABLED\\"\\n}","type":"json"}]', - 'title' => 'GetScheduledSQL', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAlerts', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:GetScheduledSQL', + 'action' => 'log:ListAlerts', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"alert-123456\\",\\n \\"displayName\\": \\"alertNameExample\\",\\n \\"description\\": \\"Alert Desc\\",\\n \\"configuration\\": {\\n \\"muteUntil\\": 1698907508,\\n \\"version\\": \\"2.0\\",\\n \\"type\\": \\"default\\",\\n \\"templateConfiguration\\": {\\n \\"id\\": \\"sls.app.ack.ip.not_enough\\",\\n \\"type\\": \\"sys\\",\\n \\"version\\": \\"1\\",\\n \\"lang\\": \\"cn\\",\\n \\"tokens\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"aonotations\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"dashboard\\": \\"DasnboardExample\\",\\n \\"threshold\\": 1,\\n \\"noDataFire\\": false,\\n \\"noDataSeverity\\": 6,\\n \\"sendResolved\\": false,\\n \\"queryList\\": [\\n {\\n \\"chartTitle\\": \\"chartExmaple\\",\\n \\"query\\": \\"* | select *\\",\\n \\"timeSpanType\\": \\"Relative\\",\\n \\"start\\": \\"-5m\\",\\n \\"end\\": \\"now\\",\\n \\"storeType\\": \\"log\\",\\n \\"project\\": \\"projectExample\\",\\n \\"store\\": \\"store Example\\",\\n \\"region\\": \\"cn-hangzhou\\",\\n \\"roleArn\\": \\"\\",\\n \\"dashboardId\\": \\"dashboardExample\\",\\n \\"powerSqlMode\\": \\"auto\\",\\n \\"ui\\": \\"\\"\\n }\\n ],\\n \\"annotations\\": [\\n {\\n \\"key\\": \\"title\\",\\n \\"value\\": \\"example value\\"\\n }\\n ],\\n \\"labels\\": [\\n {\\n \\"key\\": \\"title\\",\\n \\"value\\": \\"example value\\"\\n }\\n ],\\n \\"conditionConfiguration\\": {\\n \\"condition\\": \\"cnt > 100\\",\\n \\"countCondition\\": \\"__count__ > 5\\"\\n },\\n \\"severityConfigurations\\": [\\n {\\n \\"severity\\": 8,\\n \\"evalCondition\\": {\\n \\"condition\\": \\"cnt > 100\\",\\n \\"countCondition\\": \\"__count__ > 5\\"\\n }\\n }\\n ],\\n \\"joinConfigurations\\": [\\n {\\n \\"type\\": \\"left_join\\",\\n \\"condition\\": \\"$0.id == $1.id\\"\\n }\\n ],\\n \\"groupConfiguration\\": {\\n \\"type\\": \\"custom\\",\\n \\"fields\\": [\\n \\"id\\"\\n ]\\n },\\n \\"policyConfiguration\\": {\\n \\"alertPolicyId\\": \\"sls.builtin.dynamic\\",\\n \\"actionPolicyId\\": \\"example_action_policy\\",\\n \\"repeatInterval\\": \\"10m\\"\\n },\\n \\"autoAnnotation\\": false,\\n \\"sinkEventStore\\": {\\n \\"enabled\\": true,\\n \\"endpoint\\": \\"cn-shanghai-intranet.log.aliyuncs.com\\",\\n \\"project\\": \\"exampleProject\\",\\n \\"eventStore\\": \\"exampleStore\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\"\\n },\\n \\"sinkCms\\": {\\n \\"enabled\\": true\\n },\\n \\"sinkAlerthub\\": {\\n \\"enabled\\": true\\n },\\n \\"tags\\": [\\n \\"host\\"\\n ]\\n },\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"createTime\\": 1695090077,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"ENABLED/DISABLED\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetSlsService' => [ - 'summary' => 'Call the GetSlsService operation to retrieve the activation status of Simple Log Service. The endpoint must be China (Shanghai) or Singapore.', - 'path' => '/slsservice', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAnnotationData' => [ + 'summary' => 'Lists the data records in a specified dataset.', + 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '194671', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => 'The starting position of the paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'datasetId', + 'in' => 'path', + 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], ], - 'parameters' => [], 'responses' => [ 200 => [ - 'headers' => [ - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - 'Server' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => 'The list of data records.', + 'type' => 'array', + 'items' => ['description' => 'The data structure.', '$ref' => '#/components/schemas/MLDataParam', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], - ], - 'schema' => [ - 'description' => 'The response body.', - '$ref' => '#/components/schemas/serviceStatus', - 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": \\"NotExist\\",\\n \\"enabled\\": false\\n}","type":"json"}]', - 'title' => 'GetSlsService', - 'description' => 'This operation requires an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'An AccessKey pair for an Alibaba Cloud account grants full access to all APIs. This poses a high security threat. Create and use a RAM user for API access or routine operations and maintenance (O\\&M). The RAM user must have permissions to operate Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"annotationdataId\\": \\"dc74b0f569126bb310e1ba6454c351ac\\",\\n \\"dataHash\\": \\"59db060bd89468245d76416a68a510ac\\",\\n \\"datasetId\\": \\"cb8cc4eb51a85e823471cdb368fae9be\\",\\n \\"value\\": \\"xxx/xxx/xxx/\\",\\n \\"valueType\\": \\"oss\\",\\n \\"config\\": {\\n \\"key\\": \\"simulator-nginx-demo\\"\\n },\\n \\"annotations\\": {\\n \\"key\\": {\\n \\"annotatedBy\\": \\"xxxx\\",\\n \\"updateTime\\": 1694761550,\\n \\"results\\": [\\n {\\n \\"key\\": \\"SPIKE_UP_TYPE\\"\\n }\\n ]\\n }\\n },\\n \\"predictions\\": {\\n \\"key\\": {\\n \\"annotatedBy\\": \\"xxx\\",\\n \\"updateTime\\": 1694761550,\\n \\"results\\": [\\n {\\n \\"key\\": \\"SPIKE_UP_TYPE\\"\\n }\\n ]\\n }\\n },\\n \\"createTime\\": 1695094335,\\n \\"lastModifyTime\\": 1695094335\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', + 'title' => 'ListAnnotationData', + 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], - 'GetSqlInstance' => [ - 'summary' => 'Queries information about the Dedicated SQL instance of a project, such as the number of compute units (CUs) and whether the Dedicated SQL instance is enabled by default. Before you call this operation, you must create a Dedicated SQL instance by calling the CreateSqlInstance or UpdateSqlInstance operation.', - 'path' => '/sqlinstance', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAnnotationDataSets' => [ + 'summary' => 'Returns a list of dataset structs.', + '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' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '215092', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'Project Name', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => 'The line from which to start the query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'Dedicated SQL instance', - 'type' => 'array', - 'items' => [ - 'description' => 'Dedicated SQL instance', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => 'The value is group1. This is an internal parameter that you can ignore.', - 'type' => 'string', - 'title' => '', - 'example' => 'group1', - ], - 'cu' => [ - 'description' => 'The maximum number of CUs that the Dedicated SQL version can use. A CU is a compute core that can be used for parallel processing when the Dedicated SQL version is running.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '2', - ], - 'createTime' => [ - 'description' => 'The time when the configuration for the Dedicated SQL version was created. This is a UNIX timestamp.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '1710230272。Unix时间戳。', - ], - 'updateTime' => [ - 'description' => 'The time when the configuration for the Dedicated SQL version was updated. This is a UNIX timestamp.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '1710230272', - ], - 'useAsDefault' => [ - 'description' => 'Indicates whether the Dedicated SQL version is enabled by default for the project. If this parameter is set to true, all query and analysis operations in the project, such as alerts and dashboards, use the Dedicated SQL version.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'true', - ], + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'description' => 'The list of data that is returned.', + 'type' => 'array', + 'items' => ['description' => 'The dataset struct.', '$ref' => '#/components/schemas/MLDataSetParam', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], - 'title' => '', - 'example' => '', + 'total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], - 'title' => '', 'example' => '', ], ], ], - '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' => 'GetSqlInstance', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"datasetId\\": \\"d9bd488f6dd42d294495fb780858e83d\\",\\n \\"name\\": \\"sls_builtin_dataset_metric.shapeclassification.anomalydetection\\",\\n \\"description\\": \\"数据集A\\",\\n \\"dataType\\": \\"Metric\\",\\n \\"labelId\\": \\"a191ae4ca615b0ccb93c211fc8a998af\\",\\n \\"createTime\\": 1695090077,\\n \\"lastModifyTime\\": 1695090077,\\n \\"createBy\\": \\"sls-console\\",\\n \\"settingType\\": \\"Metric.ShapeClassification.AnomalyDetection\\"\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', + 'title' => 'ListAnnotationDataSets', + 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'log:GetSqlInstance', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'GetStoreView' => [ - 'summary' => 'Queries the configurations of a dataset by using the name of the dataset.', - 'path' => '/storeviews/{name}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListAnnotationLabels' => [ + 'summary' => 'Lists annotation label tables.', + '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' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '208676', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - 'title' => '', - ], + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => 'The starting line of the query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - 'title' => '', - ], + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The configurations of the dataset.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'storeType' => [ - 'title' => 'Id of the request', - 'description' => 'The type of the dataset.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* metricstore'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* logstore'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'metricstore' => 'metricstore', - 'logstore' => 'logstore', - ], - 'example' => 'logstore', - ], - 'stores' => [ - 'description' => 'The Logstores or Metricstores.'."\n", + 'data' => [ + 'description' => 'The list of annotation label table structs.', 'type' => 'array', - 'items' => [ - 'description' => 'The Logstore or Metricstore.'."\n", - '$ref' => '#/components/schemas/StoreViewStore', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The annotation label table struct.', '$ref' => '#/components/schemas/MLLabelParam', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], + 'total' => ['description' => 'The total number of entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'GetStoreView', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"labelId\\": \\"abbd488f6dd42d294495fb780858e83d\\",\\n \\"name\\": \\"标签表\\",\\n \\"description\\": \\"默认表\\",\\n \\"type\\": \\"xxx\\",\\n \\"settings\\": [\\n {\\n \\"mode\\": \\"builtin\\",\\n \\"type\\": \\"Trace.RCA\\",\\n \\"config\\": \\"\\\\\\"\\\\\\"\\",\\n \\"version\\": \\"0.01\\"\\n }\\n ],\\n \\"createTime\\": 1695090077,\\n \\"lastModifyTime\\": 1695090077\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', + 'title' => 'ListAnnotationLabels', + 'description' => 'This API operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'get', - 'ramAction' => [ - 'action' => 'log:GetStoreView', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], - '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"}]', + 'ramActions' => [], ], - 'GetStoreViewIndex' => [ - 'path' => '/storeviews/{name}/index', - 'methods' => [ - 'get', - ], - 'schemes' => [ - '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' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '212612', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '291245', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the dataset.', - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - 'title' => '', - ], + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => 'The number of tasks to skip before returning results. Default: 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of tasks to return per page. Range: 0 to 500. Default: 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'logstore', + 'in' => 'query', + 'schema' => ['description' => 'The name of the logstore. If specified, the operation returns only tasks from this logstore.', 'type' => 'string', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The index configurations of all Logstores in the dataset.', 'type' => 'object', 'properties' => [ - 'indexes' => [ - 'description' => 'The index configurations.', + 'total' => ['description' => 'The total number of tasks that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'count' => ['description' => 'The number of tasks returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'results' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'project' => [ - 'description' => 'The name of the project to which the Logstore belongs.', - 'type' => 'string', - 'example' => 'example-project', - 'title' => '', - ], - 'logstore' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'example' => 'my-logstore', - 'title' => '', - ], - 'index' => [ - 'description' => 'The index configurations of the Logstore.', - '$ref' => '#/components/schemas/index', - 'title' => '', - 'example' => '', - ], - ], - 'title' => '', - 'example' => '', - ], + 'items' => ['$ref' => '#/components/schemas/AzureBlobIngestion', 'description' => '', 'title' => '', 'example' => ''], + 'description' => 'A list of Azure Blob ingestion tasks.', 'title' => '', 'example' => '', ], ], + 'description' => 'The returned data.', + 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'GetStoreViewIndex', - 'summary' => 'Queries the indexes of a dataset by using the name of the dataset. Only datasets of the logstore type are supported.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAzureBlobIngestion', + 'summary' => 'Lists Azure Blob ingestion tasks.', '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"}]', + '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"}]', ], - 'ListAgentInstanceConfigs' => [ - 'summary' => 'This operation lists process-level configurations.', - 'path' => '/agentinstanceconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListCollectionPolicies' => [ + 'summary' => 'Lists the collection rules for logs from Alibaba Cloud services.', + 'path' => '/collectionpolicy', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '227400', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '192483', + 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ - 'name' => 'offset', + 'name' => 'productCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to skip. The default value is 0.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The code of the Alibaba Cloud service.', 'type' => 'string', 'required' => false, 'example' => 'oss', 'title' => ''], + ], + [ + 'name' => 'dataCode', + 'in' => 'query', + 'schema' => ['description' => 'The code of the log type.', 'type' => 'string', 'required' => false, 'example' => 'access_log', 'title' => ''], + ], + [ + 'name' => 'policyName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the collection rule.', 'type' => 'string', 'required' => false, 'example' => 'your_log_policy'."\n", 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return. The default value is 500.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - 'title' => '', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The number of collection rules to return on each page. Default value: 50. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '50', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'configType', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the process-level configuration.', - 'enumValueTitles' => [ - 'apm_biz_trace' => 'apm_biz_trace', - 'apm_self_protect' => 'apm_self_protect', - 'apm_convergence' => 'apm_convergence', - 'apm_custom_extract' => 'apm\\\\_custom\\\\_extract', - 'apm_pilot' => 'APM Pilot', - 'apm_trace' => 'apm_trace', - 'rum_app_config' => 'rum_app_config', - 'security_rasp' => 'security\\\\_rasp', - 'rum_web_config' => 'RUM Web Configuration', - 'apm_biz_trace_global' => 'apm\\\\_biz\\\\_trace\\\\_global', - 'apm_intacheap' => 'apm_intacheap', - 'apm_user_method' => 'apm\\\\_user\\\\_method', - 'apm_global' => 'apm_global', - 'apm_forward_process' => 'APM Forwarding Process', - ], - 'type' => 'string', - 'required' => false, - 'example' => 'apm_trace', - 'title' => '', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The row from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'default' => '0', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. Specify this parameter to query rules that match a specific instance. If you use this parameter, you must also specify productCode and dataCode.', 'type' => 'string', 'required' => false, 'example' => 'your-test-bucket1'."\n", 'title' => ''], + ], + [ + 'name' => 'centralProject', + 'in' => 'query', + 'schema' => ['description' => 'The destination project for centralized data shipping. Specify this parameter to query the number of rules that are configured to ship data to this project.', 'type' => 'string', 'required' => false, 'example' => 'your-central-project1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ - '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' => '服务器名称。', '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', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], ], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'size' => [ - 'description' => 'The number of data entries.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'title' => '', - ], - 'total' => [ - 'description' => 'The total number of data entries that meet the query conditions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'totalCount' => ['description' => 'The total number of collection rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'currentCount' => ['description' => 'The number of collection rules returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'data' => [ + 'description' => 'The collection rules that are returned on the current page.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the collection rule.', + 'type' => 'object', + 'properties' => [ + 'productCode' => ['description' => 'The code of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'oss', 'title' => ''], + 'dataCode' => ['description' => 'The code of the log type.', 'type' => 'string', 'example' => 'access_log', 'title' => ''], + 'policyName' => ['description' => 'The name of the collection rule.', 'type' => 'string', 'example' => 'your_log_policy', 'title' => ''], + 'enabled' => ['description' => 'Indicates whether the collection rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'policyConfig' => [ + 'description' => 'The configuration of the collection rule.', + 'type' => 'object', + 'properties' => [ + 'resourceMode' => ['description' => 'The resource collection mode.', 'type' => 'string', 'example' => 'all', 'title' => ''], + 'regions' => [ + 'description' => 'The regions to which the instances belong.', + 'type' => 'array', + 'items' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'instanceIds' => [ + 'description' => 'The IDs of the instances.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'your-test-bucket1'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'resourceTags' => ['description' => 'The resource tags.', 'type' => 'object', 'example' => '{"tag1":"value1","tag2":"value2"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'centralizeEnabled' => ['description' => 'Indicates whether centralized data shipping is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'centralizeConfig' => [ + 'description' => 'The configuration for centralized data shipping.', + 'type' => 'object', + 'properties' => [ + 'destRegion' => ['description' => 'The destination region for centralized data shipping.', 'type' => 'string', 'example' => 'cn-beijing'."\n", 'title' => ''], + 'destProject' => ['description' => 'The destination project for centralized data shipping.', 'type' => 'string', 'example' => 'your-sls-project-in-beijing'."\n", 'title' => ''], + 'destLogstore' => ['description' => 'The destination Logstore for centralized data shipping.', 'type' => 'string', 'example' => 'your-sls-logstore-in-beijing'."\n", 'title' => ''], + 'destTTL' => ['description' => 'The data retention period of the destination Logstore for centralized data shipping. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'resourceDirectory' => [ + 'description' => 'The configuration of the resource directory. This parameter is empty if no configuration is available.', + 'type' => 'object', + 'properties' => [ + 'accountGroupType' => ['description' => 'The mode for selecting accounts in the resource directory. Valid values: all and custom.', 'type' => 'string', 'example' => 'all,custom', 'title' => ''], + 'members' => [ + 'description' => 'The list of member accounts. This parameter is returned only if accountGroupType is set to custom.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '165***********50', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'dataConfig' => [ + 'description' => 'Configurations for global log types, such as sls. This parameter is empty for other log types.', + 'type' => 'object', + 'properties' => [ + 'dataRegion' => ['description' => 'The region where global logs are first collected. This parameter is used only for global log types, such as sls.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'dataProject' => ['description' => 'The project for global logs. This parameter is used only for global log types, such as sls. If this parameter is empty, logs are collected to the default project of the account in the region specified by dataRegion.', 'type' => 'string', 'example' => '""', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'internalPolicy' => ['description' => 'Indicates whether the policy is a built-in policy. Built-in policies cannot be modified or deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'policyUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the collection rule. If a resource directory administrator or delegated administrator creates the rule, this is the ID of that administrator\'s account.', 'type' => 'string', 'example' => '148***********50', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', + 'example' => '', ], - 'configs' => [ - 'description' => 'The process-level configurations.', - '$ref' => '#/components/schemas/ListAgentInstanceConfigs', + 'statistics' => [ + 'description' => 'Statistics returned based on the query conditions.', + 'type' => 'array', + 'items' => [ + 'description' => 'Statistics for collection rules, grouped by productCode.', + 'type' => 'object', + 'properties' => [ + 'productCode' => ['description' => 'The code of the Alibaba Cloud service.', 'type' => 'string', 'example' => 'oss', 'title' => ''], + 'policySourceList' => [ + 'description' => 'The list of collection rule sources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The source of the collection rule.', + 'type' => 'object', + 'properties' => [ + 'policyUid' => ['description' => 'The ID of the Alibaba Cloud account that owns the collection rule. If a resource directory administrator or delegated administrator creates the rule, this is the ID of that administrator\'s account.', 'type' => 'string', 'example' => '148***********50', 'title' => ''], + 'policyName' => ['description' => 'The name of the collection rule.', 'type' => 'string', 'example' => 'policy_name1_from148', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', 'example' => '', ], ], - 'description' => '', - 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'ListAgentInstanceConfigs', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"currentCount\\": 1,\\n \\"data\\": [\\n {\\n \\"productCode\\": \\"oss\\",\\n \\"dataCode\\": \\"access_log\\",\\n \\"policyName\\": \\"your_log_policy\\",\\n \\"enabled\\": true,\\n \\"policyConfig\\": {\\n \\"resourceMode\\": \\"all\\",\\n \\"regions\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"instanceIds\\": [\\n \\"your-test-bucket1\\\\n\\"\\n ],\\n \\"resourceTags\\": {\\n \\"tag1\\": \\"value1\\",\\n \\"tag2\\": \\"value2\\"\\n }\\n },\\n \\"centralizeEnabled\\": false,\\n \\"centralizeConfig\\": {\\n \\"destRegion\\": \\"cn-beijing\\\\n\\",\\n \\"destProject\\": \\"your-sls-project-in-beijing\\\\n\\",\\n \\"destLogstore\\": \\"your-sls-logstore-in-beijing\\\\n\\",\\n \\"destTTL\\": 0\\n },\\n \\"resourceDirectory\\": {\\n \\"accountGroupType\\": \\"all,custom\\",\\n \\"members\\": [\\n \\"165***********50\\"\\n ]\\n },\\n \\"dataConfig\\": {\\n \\"dataRegion\\": \\"cn-hangzhou\\",\\n \\"dataProject\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"internalPolicy\\": false,\\n \\"policyUid\\": \\"148***********50\\"\\n }\\n ],\\n \\"statistics\\": [\\n {\\n \\"productCode\\": \\"oss\\",\\n \\"policySourceList\\": [\\n {\\n \\"policyUid\\": \\"148***********50\\",\\n \\"policyName\\": \\"policy_name1_from148\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListCollectionPolicies', + 'description' => 'This API operation is available only at the endpoints in the following regions: China (Shanghai), Singapore, and Heyuan Automotive Compliance Cloud (cn-heyuan-acdr-1).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'description' => 'Retrieves a list of process-level configurations.', - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"size\\": 10,\\n \\"total\\": 10,\\n \\"configs\\": [\\n {\\n \\"configType\\": \\"apm_biz_trace\\",\\n \\"attributes\\": {\\n \\"key\\": \\"\\\\\\"workspace\\\\\\": \\\\\\"test-workspace\\\\\\"\\\\n\\\\\\"service\\\\\\": \\\\\\"test-service\\\\\\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', ], - 'ListAiTools' => [ - 'summary' => 'Lists the AI tools provided by the observability service, including Copilot capabilities for various services.', - 'path' => '/ml/tool/list', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListConfig' => [ + 'summary' => 'Queries all Logtail configurations in a project.', + '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' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '267809', - 'abilityTreeNodes' => [ - 'FEATUREslsC9CU66', + 'abilityTreeCode' => '8980', + 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], + [ + 'name' => 'logstoreName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], + ], + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 500.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'configName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Logtail configuration, which is used for fuzzy match.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'logtail-config-sample'], ], ], - 'parameters' => [], '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' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'fields' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - 'description' => 'The name of the field.', - 'title' => '', - 'example' => '', - ], - 'option' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => 'The valid values for the field.', - 'title' => '', - 'example' => '', - ], - 'required' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the field is required.', - 'title' => '', - 'example' => '', - ], - 'type' => [ - 'type' => 'string', - 'description' => 'The type of the field.', - 'title' => '', - 'example' => '', - ], - 'example' => [ - 'type' => 'string', - 'description' => 'An example of the field.', - 'title' => '', - 'example' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => 'The description of the field.', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => 'The fields of the tool.', - 'title' => '', - 'example' => '', - ], - 'name' => [ - 'type' => 'string', - 'description' => 'The name of the tool.', - 'title' => '', - 'example' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => 'The description of the tool.', - 'title' => '', - 'example' => '', - ], + 'type' => 'object', + 'properties' => [ + 'count' => ['description' => 'The number of Logtail configurations that are returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'total' => ['description' => 'The total number of Logtail configurations that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'configs' => [ + 'description' => 'The Logtail configurations that are returned on the current page.', + 'type' => 'array', + 'items' => ['description' => 'The Logtail configuration that is returned.', 'type' => 'string', 'example' => 'logtail-config-sample', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'description' => '', - 'title' => '', - 'example' => '', ], 'description' => '', 'title' => '', @@ -27177,1631 +15929,1130 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'title' => 'ListAiTools', - 'description' => 'The endpoint for this API is available only in the China (Shanghai) and Singapore regions.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 3,\\n \\"total\\": 2,\\n \\"configs\\": [\\n \\"logtail-config-sample\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListConfig', + 'description' => '### [](#)Usage notes'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist| The Project does not exist : projectName | Project不存在。 |'."\n" + .'| 404 | LogStoreNotExist| Logstore logstoreName does not exist. | Logstore不存在。 |'."\n" + .'| 404 | ConfigNotExist|config configName does not exist. | Logtail配置不存在。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"fields\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"option\\": [\\n \\"\\"\\n ],\\n \\"required\\": false,\\n \\"type\\": \\"\\",\\n \\"example\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n ],\\n \\"name\\": \\"\\",\\n \\"description\\": \\"\\"\\n }\\n]","type":"json"}]', - ], - 'ListAlerts' => [ - 'summary' => 'Lists the alert rules in a specified project.', - 'path' => '/alerts', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*'], + ], + ], + ], ], + ], + 'ListConsumeProcessors' => [ + 'summary' => 'Retrieves a list of consume processors that match the specified parameters.', + 'path' => '/consumeprocessors', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '199870', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], + 'abilityTreeCode' => '225118', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The project name.', - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'offset', + 'name' => 'processorName', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which to start the query. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '0', - ], + 'schema' => ['description' => 'The identity of the consume processor.', 'type' => 'string', 'required' => false, 'example' => 'consume-processor-1', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'displayName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of rows to return on each page for a paged query. The maximum value is 200. The default value is 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '10', - ], + 'schema' => ['description' => 'The display name of the consume processor.', 'type' => 'string', 'required' => false, 'example' => 'filter-get-request', 'title' => ''], ], [ - 'name' => 'logstore', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The Logstore from which to obtain alert rules. The default value is empty.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'The offset of the query. The default value is 0.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return. The default value is 200.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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'], ], ], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'The total number of alerts in the project.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '80', - ], - 'count' => [ - 'description' => 'The number of alerts returned in the current response.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '10', - ], - 'results' => [ - 'description' => 'The list of alert configurations.', + 'total' => ['description' => 'The total number of consume processors that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'count' => ['description' => 'The number of consume processors returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'processors' => [ + 'description' => 'The list of consume processors.', 'type' => 'array', - 'items' => [ - 'description' => 'The alert configuration.', - '$ref' => '#/components/schemas/Alert', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The information about the consume processor.', '$ref' => '#/components/schemas/ConsumeProcessor', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], - 'description' => '', - 'title' => '', 'example' => '', ], ], ], - '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/1h\\"\\n },\\n \\"createTime\\": 0,\\n \\"lastModifiedTime\\": 0,\\n \\"status\\": \\"ENABLED/DISABLED\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListAlerts', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 20,\\n \\"count\\": 10,\\n \\"processors\\": [\\n {\\n \\"processorName\\": \\"consume-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListConsumeProcessors', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'ListAnnotationData' => [ - 'summary' => 'Lists the data records in a specified dataset.', - 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListConsumerGroup' => [ + 'summary' => 'Queries all consumer groups of a Logstore.', + 'path' => '/logstores/{logstore}/consumergroups', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The starting position of the paged query.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '0', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '100', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['title' => 'Project name', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'datasetId', + 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique ID of the dataset.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['title' => 'Logstore name', 'description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response object.', - 'type' => 'object', - 'properties' => [ - 'data' => [ - 'description' => 'The list of data records.', - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure.', - '$ref' => '#/components/schemas/MLDataParam', - 'title' => '', - 'example' => '', - ], - 'title' => '', - 'example' => '', - ], - 'total' => [ - 'description' => 'The total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '20', - ], - ], - 'example' => '', + 'description' => 'The consumer groups.', + 'type' => 'array', + 'items' => ['description' => 'The information about the consumer group.', '$ref' => '#/components/schemas/ConsumerGroup', 'example' => 'test-consumer-group', 'title' => ''], + 'example' => '[{\'\'name\'\': \'\'test-consumer-group\'\', \'\'timeout\'\': 30, \'\'order\'\': False}]', + 'title' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"annotationdataId\\": \\"dc74b0f569126bb310e1ba6454c351ac\\",\\n \\"dataHash\\": \\"59db060bd89468245d76416a68a510ac\\",\\n \\"datasetId\\": \\"cb8cc4eb51a85e823471cdb368fae9be\\",\\n \\"value\\": \\"xxx/xxx/xxx/\\",\\n \\"valueType\\": \\"oss\\",\\n \\"config\\": {\\n \\"key\\": \\"simulator-nginx-demo\\"\\n },\\n \\"annotations\\": {\\n \\"key\\": {\\n \\"annotatedBy\\": \\"xxxx\\",\\n \\"updateTime\\": 1694761550,\\n \\"results\\": [\\n {\\n \\"key\\": \\"SPIKE_UP_TYPE\\"\\n }\\n ]\\n }\\n },\\n \\"predictions\\": {\\n \\"key\\": {\\n \\"annotatedBy\\": \\"xxx\\",\\n \\"updateTime\\": 1694761550,\\n \\"results\\": [\\n {\\n \\"key\\": \\"SPIKE_UP_TYPE\\"\\n }\\n ]\\n }\\n },\\n \\"createTime\\": 1695094335,\\n \\"lastModifyTime\\": 1695094335\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', - 'title' => 'ListAnnotationData', - 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"name\\": \\"test-consumer-group\\",\\n \\"timeout\\": 300,\\n \\"order\\": false\\n }\\n]","type":"json"}]', + 'title' => 'ListConsumerGroup', + 'description' => '### Usage notes'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" + ."\n" + .'### Authentication resources'."\n" + ."\n" + .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + ."\n" + .'| Action | Resource |'."\n" + .'| :---------------------- | :------------------------------------------------------------------------------------------------- |'."\n" + .'| `log:ListConsumerGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*` |', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'translator' => 'machine', - ], - 'ListAnnotationDataSets' => [ - 'summary' => 'Returns a list of dataset structs.', - 'path' => '/ml/annotationdataset', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListConsumerGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*'], + ], + ], + ], ], + ], + 'ListDashboard' => [ + 'summary' => 'Queries dashboards.', + 'path' => '/dashboards', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', + 'abilityTreeCode' => '10283', + 'abilityTreeNodes' => ['FEATUREslsHU53H2'], ], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which to start the query.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '0', - ], + 'schema' => ['description' => 'The line from which the query starts. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'required' => false, 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page for a paged query.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '100', - ], + 'schema' => ['description' => 'The number of entries to return on each page for a paged query. The maximum value is 500. The default value is 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '500', 'title' => '', 'required' => false], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'description' => 'A tag.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'description' => 'The tag information.', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'dashboardName', + 'in' => 'query', + 'schema' => ['description' => 'The dashboard name.', 'type' => 'string', 'required' => false, 'example' => 'dashboard-1609294922657-434834', 'title' => ''], + ], + [ + 'name' => 'displayName', + 'in' => 'query', + 'schema' => ['description' => 'The display name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The response schema.', + 'description' => 'The dashboard.', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => 'The list of data that is returned.', + 'dashboards' => [ + 'title' => '', + 'description' => 'A list of dashboard names. This corresponds to dashboardName.', + 'type' => 'array', + 'items' => ['description' => 'A list of dashboard names. This corresponds to dashboardName.', 'type' => 'string', 'example' => 'dashboard-1609294922657-434834', 'title' => ''], + 'example' => '', + ], + 'dashboardItems' => [ + 'description' => 'The dashboards.', 'type' => 'array', 'items' => [ - 'description' => 'The dataset struct.', - '$ref' => '#/components/schemas/MLDataSetParam', + 'description' => 'A dashboard.', + 'type' => 'object', + 'properties' => [ + 'dashboardName' => ['description' => 'The dashboard ID. The ID must be unique within a project. Fuzzy queries are supported. For example, if you enter da, all dashboards whose names start with da are returned.', 'type' => 'string', 'example' => 'dashboard-1609294922657-434834', 'title' => ''], + 'displayName' => ['description' => 'The display name of the dashboard.', 'type' => 'string', 'example' => 'data-ingest', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'tablet_ai', 'title' => ''], + ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], - 'total' => [ - 'description' => 'The total number of entries.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '20', - ], ], + 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"datasetId\\": \\"d9bd488f6dd42d294495fb780858e83d\\",\\n \\"name\\": \\"sls_builtin_dataset_metric.shapeclassification.anomalydetection\\",\\n \\"description\\": \\"数据集A\\",\\n \\"dataType\\": \\"Metric\\",\\n \\"labelId\\": \\"a191ae4ca615b0ccb93c211fc8a998af\\",\\n \\"createTime\\": 1695090077,\\n \\"lastModifyTime\\": 1695090077,\\n \\"createBy\\": \\"sls-console\\",\\n \\"settingType\\": \\"Metric.ShapeClassification.AnomalyDetection\\"\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', - 'title' => 'ListAnnotationDataSets', - 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"dashboards\\": [\\n \\"dashboard-1609294922657-434834\\"\\n ],\\n \\"dashboardItems\\": [\\n {\\n \\"dashboardName\\": \\"dashboard-1609294922657-434834\\",\\n \\"displayName\\": \\"data-ingest\\",\\n \\"description\\": \\"tablet_ai\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListDashboard', + 'description' => '### Description'."\n" + ."\n" + .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project name in the Host.'."\n" + ."\n" + .'- Create an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'An AccessKey pair for an Alibaba Cloud account has the permissions to call all API operations. This is a high-risk practice. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" + ."\n" + .'- Identify the name and region of the project that contains the logs you want to query. For more information, see [Manage projects](~~48984~~).', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 400 | ParameterInvalid | offset: offset is invalid. |offset参数取值无效。|'."\n" + .'| 400 | ParameterInvalid | size: size is invalid. |size参数取值无效。|'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'translator' => 'machine', - ], - 'ListAnnotationLabels' => [ - 'summary' => 'Lists annotation label tables.', - 'path' => '/ml/annotationlabel', - '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' => 'Queries the custom domain names that are bound to projects.', + 'path' => '/domains', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['title' => 'Project name', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], + ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The starting line of the query.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '0', - ], + 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '100', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 500. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'domainName', + 'in' => 'query', + 'schema' => ['description' => 'The domain name that is used to match custom domain names. For example, if you set domainName to `example.com`, the matched domain names are `a.example.com` and `b.example.com`.', 'type' => 'string', 'example' => 'example.com', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The response data.', + 'description' => 'The information about the domain names.', 'type' => 'object', 'properties' => [ - 'data' => [ - 'description' => 'The list of annotation label table structs.', + 'domains' => [ + 'description' => 'The domain names.', 'type' => 'array', - 'items' => [ - 'description' => 'The annotation label table struct.', - '$ref' => '#/components/schemas/MLLabelParam', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], 'title' => '', 'example' => '', ], - 'total' => [ - 'description' => 'The total number of entries that meet the query conditions.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '20', - ], + 'count' => ['description' => 'The number of domain names that are returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'total' => ['description' => 'The total number of domain names that are returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"data\\": [\\n {\\n \\"labelId\\": \\"abbd488f6dd42d294495fb780858e83d\\",\\n \\"name\\": \\"标签表\\",\\n \\"description\\": \\"默认表\\",\\n \\"type\\": \\"xxx\\",\\n \\"settings\\": [\\n {\\n \\"mode\\": \\"builtin\\",\\n \\"type\\": \\"Trace.RCA\\",\\n \\"config\\": \\"\\\\\\"\\\\\\"\\",\\n \\"version\\": \\"0.01\\"\\n }\\n ],\\n \\"createTime\\": 1695090077,\\n \\"lastModifyTime\\": 1695090077\\n }\\n ],\\n \\"total\\": 20\\n}","type":"json"}]', - 'title' => 'ListAnnotationLabels', - 'description' => 'This API operation is available only in the China (Shanghai) and Singapore regions.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domains\\": [\\n \\"example.com\\"\\n ],\\n \\"count\\": 1,\\n \\"total\\": 1\\n}","type":"json"}]', + 'title' => 'ListDomains', + 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- Only one custom domain name can be bound to each project.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'translator' => 'machine', - ], - 'ListAzureBlobIngestion' => [ - 'summary' => 'Lists the import tasks for Azure BLOB files.', - 'path' => '/azureblobingestions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListDomains', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/*'], + ], + ], + ], ], + ], + 'ListDownloadJobs' => [ + 'summary' => 'Lists the log download jobs in a specified project.', + 'path' => '/downloadjobs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '291245', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeCode' => '216707', + 'abilityTreeNodes' => ['FEATUREsls1J4K38'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The line from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The number of log download jobs to return in a single request.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [ - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - ], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information about all log download jobs.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'count' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'count' => ['description' => 'The number of log download jobs returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], 'results' => [ + 'title' => '', + 'description' => 'An array that contains the list of log download jobs.', 'type' => 'array', 'items' => [ - '$ref' => '#/components/schemas/AzureBlobIngestion', - 'description' => '', - 'title' => '', - 'example' => '', + 'title' => 'DownloadJobItemType', + 'description' => 'The information about a log download job.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the log download job.', 'type' => 'string', 'title' => '', 'example' => 'a download job'], + 'configuration' => [ + 'title' => '', + 'description' => 'The download configuration.', + 'type' => 'object', + 'properties' => [ + 'logstore' => ['description' => 'The source Logstore.', 'type' => 'string', 'title' => '', 'example' => 'ali-test-logstore'], + 'fromTime' => ['description' => 'The start time of the query. This is a UNIX timestamp that is accurate to the second.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722409260'], + 'toTime' => ['description' => 'The end time of the query. This is a UNIX timestamp that is accurate to the second.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1722411060'], + 'query' => ['description' => 'The query statement.', 'type' => 'string', 'title' => '', 'example' => '* | select *'], + 'powerSql' => ['description' => 'Specifies whether to enable PowerSQL.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'allowInComplete' => ['description' => 'Specifies whether to allow the download of incomplete results.', 'type' => 'string', 'example' => 'false', 'title' => ''], + 'sink' => [ + 'title' => '', + 'description' => 'The sink configuration.', + 'type' => 'object', + 'properties' => [ + 'compressionType' => ['description' => 'The compression format.', 'type' => 'string', 'title' => '', 'example' => 'none'], + 'contentType' => ['description' => 'The file format of the downloaded file.', 'type' => 'string', 'title' => '', 'example' => 'csv'], + 'roleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role that is used for the download.', 'type' => 'string', 'title' => '', 'example' => 'acs:ram::123456:role/aliyunlogimportossrole'], + 'bucket' => ['description' => 'The destination OSS bucket.', 'type' => 'string', 'title' => '', 'example' => 'ali-test-oss-bucket'], + 'prefix' => ['description' => 'The prefix of the object that is downloaded to the destination OSS bucket.', 'type' => 'string', 'example' => 'download/', 'title' => ''], + 'type' => ['description' => 'The type of the sink. The value is fixed as AliyunOSS.', 'type' => 'string', 'example' => 'AliyunOSS', 'title' => ''], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'displayName' => ['description' => 'Display name', 'type' => 'string', 'title' => '', 'example' => 'download-123'], + 'executionDetails' => [ + 'title' => '', + 'description' => 'The execution details of the job.', + 'type' => 'object', + 'properties' => [ + 'progress' => ['description' => 'The download progress as a percentage.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'filePath' => ['description' => 'The URL of the downloaded file.', 'type' => 'string', 'title' => '', 'example' => 'https://sls-downloaded-xxxx.csv.gzip?Expiresxxx'], + 'fileSize' => ['description' => 'The size of the downloaded file in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123456'], + 'executeTime' => ['description' => 'The running time of the download.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], + 'logCount' => ['description' => 'The number of downloaded log entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], + 'errorMessage' => ['description' => 'The error message that is returned if the job fails.', 'type' => 'string', 'title' => '', 'example' => 'timeout'], + 'checkSum' => ['description' => 'The ETag of the file.', 'type' => 'string', 'example' => 'ETASFGASDASQWDasd', 'title' => ''], + 'notice' => ['description' => 'The notification message.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'example' => '', + ], + 'name' => ['description' => 'The name of the log download job.', 'type' => 'string', 'title' => '', 'example' => 'download-123'], + 'createTime' => ['description' => 'The time when the log download job was created. This is a UNIX timestamp in seconds.', 'type' => 'string', 'example' => '1722411060', 'title' => ''], + 'status' => ['description' => 'The status of the Job.', 'type' => 'string', 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR', 'title' => ''], + ], + 'example' => '', ], - 'description' => '', - 'title' => '', 'example' => '', ], ], - 'description' => 'Schema of Response', - 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"description\\": \\"a download job\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"ali-test-logstore\\",\\n \\"fromTime\\": 1722409260,\\n \\"toTime\\": 1722411060,\\n \\"query\\": \\"* | select *\\",\\n \\"powerSql\\": true,\\n \\"allowInComplete\\": \\"false\\",\\n \\"sink\\": {\\n \\"compressionType\\": \\"none\\",\\n \\"contentType\\": \\"csv\\",\\n \\"roleArn\\": \\"acs:ram::123456:role/aliyunlogimportossrole\\",\\n \\"bucket\\": \\"ali-test-oss-bucket\\",\\n \\"prefix\\": \\"download/\\",\\n \\"type\\": \\"AliyunOSS\\"\\n }\\n },\\n \\"displayName\\": \\"download-123\\",\\n \\"executionDetails\\": {\\n \\"progress\\": 100,\\n \\"filePath\\": \\"https://sls-downloaded-xxxx.csv.gzip?Expiresxxx\\",\\n \\"fileSize\\": 123456,\\n \\"executeTime\\": 123,\\n \\"logCount\\": 123,\\n \\"errorMessage\\": \\"timeout\\",\\n \\"checkSum\\": \\"ETASFGASDASQWDasd\\",\\n \\"notice\\": \\"test\\"\\n },\\n \\"name\\": \\"download-123\\",\\n \\"createTime\\": \\"1722411060\\",\\n \\"status\\": \\"STARTING、RUNNING、SUCCEEDED、ERROR\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListDownloadJobs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'title' => 'ListAzureBlobIngestion', - ], - 'ListCollectionPolicies' => [ - 'summary' => 'Lists the collection rules for logs from Alibaba Cloud services.', - 'path' => '/collectionpolicy', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListDownloadJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListETLs' => [ + 'summary' => 'Lists the data transformation jobs in a project.', + 'path' => '/etls', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '192483', - 'abilityTreeNodes' => [ - 'FEATUREsls9NGCVR', - ], + 'abilityTreeCode' => '203166', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ - 'name' => 'productCode', + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the Alibaba Cloud service.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'oss', - ], + 'schema' => ['description' => 'The line from which the query starts. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'dataCode', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the log type.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'access_log', - ], + 'schema' => ['description' => 'The number of data transformation jobs to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'policyName', + 'name' => 'logstore', 'in' => 'query', + 'schema' => ['description' => 'The Logstore name.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + ], 'schema' => [ - 'description' => 'The name of the collection rule.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'your_log_policy'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'The total number of data transformation jobs in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'count' => ['description' => 'The number of data transformation jobs returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'results' => [ + 'description' => 'A list of data transformation results.', + 'type' => 'array', + 'items' => ['description' => 'The data transformation configuration.', '$ref' => '#/components/schemas/ETL', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ETL\\",\\n \\"description\\": \\"ETL\\",\\n \\"displayName\\": \\"ETL\\",\\n \\"configuration\\": {\\n \\"script\\": \\"e_set(\\\\\\"key\\\\\\",\\\\\\"value\\\\\\")\\",\\n \\"lang\\": \\"SPL\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"fromTime\\": 0,\\n \\"toTime\\": 0,\\n \\"sinks\\": [\\n {\\n \\"name\\": \\"test-etljob\\",\\n \\"endpoint\\": \\"\\",\\n \\"project\\": \\"test-project\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"datasets\\": [\\n \\"__UNNAMED__\\"\\n ],\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\"\\n }\\n ],\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714274900,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"f0eb655e501a8780808d1970ef6d04c4\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListETLs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'size', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The number of collection rules to return on each page. Default value: 50. Maximum value: 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'default' => '50', - 'title' => '', - 'example' => '50', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListETLs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListElasticsearchIngestions' => [ + 'path' => '/elasticsearchingestions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '273942', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], [ 'name' => 'offset', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The row from which the query starts. Default value: 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '0', - 'default' => '0', - 'title' => '', - 'example' => '0', - ], + 'schema' => ['description' => 'The line from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'instanceId', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID. Specify this parameter to query rules that match a specific instance. If you use this parameter, you must also specify productCode and dataCode.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'your-test-bucket1'."\n", - ], + 'schema' => ['description' => 'The number of entries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'centralProject', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'description' => 'The destination project for centralized data shipping. Specify this parameter to query the number of rules that are configured to ship data to this project.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'your-central-project1', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], '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', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', + ], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'The total number of Elasticsearch/OpenSearch import jobs in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'count' => ['description' => 'The number of Elasticsearch/OpenSearch import jobs returned in the current request.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'results' => [ + 'type' => 'array', + 'items' => ['description' => 'The configuration of the Elasticsearch/OpenSearch import job.', '$ref' => '#/components/schemas/ESIngestion', 'title' => '', 'example' => ''], + 'description' => 'The list of Elasticsearch/OpenSearch import jobs.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListElasticsearchIngestions', + 'summary' => 'Lists the Elasticsearch and OpenSearch ingestion jobs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-es-123456\\",\\n \\"description\\": \\"es ingestion\\",\\n \\"displayName\\": \\"es ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"test-logstore\\",\\n \\"source\\": {\\n \\"BootstrapServers\\": \\"\\",\\n \\"Index\\": \\"\\",\\n \\"Username\\": \\"\\",\\n \\"Password\\": \\"\\",\\n \\"TimeFieldName\\": \\"\\",\\n \\"TimeFormat\\": \\"\\",\\n \\"TimeZone\\": \\"\\",\\n \\"Query\\": \\"\\",\\n \\"ConnectorMode\\": \\"\\",\\n \\"StartTime\\": 0,\\n \\"EndTime\\": 0,\\n \\"MaxDataDelaySec\\": 0,\\n \\"MinFragRangeSec\\": 0,\\n \\"VpcId\\": \\"\\"\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListGCSIngestions' => [ + 'summary' => 'Lists Google Cloud Storage (GCS) file import jobs.', + 'path' => '/gcsingestions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'testproject'], + ], + [ + 'name' => 'offset', + 'in' => 'query', + 'schema' => ['description' => 'The position from which to start returning results. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of results to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'logstore', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'totalCount' => [ - 'description' => 'The total number of collection rules.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '1', - ], - 'currentCount' => [ - 'description' => 'The number of collection rules returned on the current page.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '1', - ], - 'data' => [ - 'description' => 'The collection rules that are returned on the current page.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the collection rule.', - 'type' => 'object', - 'properties' => [ - 'productCode' => [ - 'description' => 'The code of the Alibaba Cloud service.', - 'type' => 'string', - 'title' => '', - 'example' => 'oss', - ], - 'dataCode' => [ - 'description' => 'The code of the log type.', - 'type' => 'string', - 'title' => '', - 'example' => 'access_log', - ], - 'policyName' => [ - 'description' => 'The name of the collection rule.', - 'type' => 'string', - 'title' => '', - 'example' => 'your_log_policy', - ], - 'enabled' => [ - 'description' => 'Indicates whether the collection rule is enabled.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'true', - ], - 'policyConfig' => [ - 'description' => 'The configuration of the collection rule.', - 'type' => 'object', - 'properties' => [ - 'resourceMode' => [ - 'description' => 'The resource collection mode.', - 'type' => 'string', - 'title' => '', - 'example' => 'all', - ], - 'regions' => [ - 'description' => 'The regions to which the instances belong.', - 'type' => 'array', - 'items' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'title' => '', - 'example' => 'cn-hangzhou', - ], - 'title' => '', - 'example' => '', - ], - 'instanceIds' => [ - 'description' => 'The IDs of the instances.', - 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID.', - 'type' => 'string', - 'title' => '', - 'example' => 'your-test-bucket1'."\n", - ], - 'title' => '', - 'example' => '', - ], - 'resourceTags' => [ - 'description' => 'The resource tags.', - 'type' => 'object', - 'title' => '', - 'example' => '{"tag1":"value1","tag2":"value2"}', - ], - ], - 'title' => '', - 'example' => '', - ], - 'centralizeEnabled' => [ - 'description' => 'Indicates whether centralized data shipping is enabled.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'false', - ], - 'centralizeConfig' => [ - 'description' => 'The configuration for centralized data shipping.', - 'type' => 'object', - 'properties' => [ - 'destRegion' => [ - 'description' => 'The destination region for centralized data shipping.', - 'type' => 'string', - 'title' => '', - 'example' => 'cn-beijing'."\n", - ], - 'destProject' => [ - 'description' => 'The destination project for centralized data shipping.', - 'type' => 'string', - 'title' => '', - 'example' => 'your-sls-project-in-beijing'."\n", - ], - 'destLogstore' => [ - 'description' => 'The destination Logstore for centralized data shipping.', - 'type' => 'string', - 'title' => '', - 'example' => 'your-sls-logstore-in-beijing'."\n", - ], - 'destTTL' => [ - 'description' => 'The data retention period of the destination Logstore for centralized data shipping. Unit: days.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '0', - ], - ], - 'title' => '', - 'example' => '', - ], - 'resourceDirectory' => [ - 'description' => 'The configuration of the resource directory. This parameter is empty if no configuration is available.', - 'type' => 'object', - 'properties' => [ - 'accountGroupType' => [ - 'description' => 'The mode for selecting accounts in the resource directory. Valid values: all and custom.', - 'type' => 'string', - 'title' => '', - 'example' => 'all,custom', - ], - 'members' => [ - 'description' => 'The list of member accounts. This parameter is returned only if accountGroupType is set to custom.', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the Alibaba Cloud account.', - 'type' => 'string', - 'title' => '', - 'example' => '165***********50', - ], - 'title' => '', - 'example' => '', - ], - ], - 'title' => '', - 'example' => '', - ], - 'dataConfig' => [ - 'description' => 'Configurations for global log types, such as sls. This parameter is empty for other log types.', - 'type' => 'object', - 'properties' => [ - 'dataRegion' => [ - 'description' => 'The region where global logs are first collected. This parameter is used only for global log types, such as sls.', - 'type' => 'string', - 'title' => '', - 'example' => 'cn-hangzhou', - ], - 'dataProject' => [ - 'description' => 'The project for global logs. This parameter is used only for global log types, such as sls. If this parameter is empty, logs are collected to the default project of the account in the region specified by dataRegion.', - 'type' => 'string', - 'title' => '', - 'example' => '""', - ], - ], - 'title' => '', - 'example' => '', - ], - 'internalPolicy' => [ - 'description' => 'Indicates whether the policy is a built-in policy. Built-in policies cannot be modified or deleted.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'false', - ], - 'policyUid' => [ - 'description' => 'The ID of the Alibaba Cloud account that owns the collection rule. If a resource directory administrator or delegated administrator creates the rule, this is the ID of that administrator\'s account.', - 'type' => 'string', - 'title' => '', - 'example' => '148***********50', - ], - ], - 'title' => '', - 'example' => '', - ], - 'title' => '', - 'example' => '', - ], - 'statistics' => [ - 'description' => 'Statistics returned based on the query conditions.', + 'total' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'count' => ['description' => 'The number of jobs returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'results' => [ 'type' => 'array', - 'items' => [ - 'description' => 'Statistics for collection rules, grouped by productCode.', - 'type' => 'object', - 'properties' => [ - 'productCode' => [ - 'description' => 'The code of the Alibaba Cloud service.', - 'type' => 'string', - 'title' => '', - 'example' => 'oss', - ], - 'policySourceList' => [ - 'description' => 'The list of collection rule sources.', - 'type' => 'array', - 'items' => [ - 'description' => 'The source of the collection rule.', - 'type' => 'object', - 'properties' => [ - 'policyUid' => [ - 'description' => 'The ID of the Alibaba Cloud account that owns the collection rule. If a resource directory administrator or delegated administrator creates the rule, this is the ID of that administrator\'s account.', - 'type' => 'string', - 'title' => '', - 'example' => '148***********50', - ], - 'policyName' => [ - 'description' => 'The name of the collection rule.', - 'type' => 'string', - 'title' => '', - 'example' => 'policy_name1_from148', - ], - ], - 'title' => '', - 'example' => '', - ], - 'title' => '', - 'example' => '', - ], - ], - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The details of the job configuration.', '$ref' => '#/components/schemas/GCSIngestion', 'title' => '', 'example' => ''], + 'description' => 'The details of the job configurations.', 'title' => '', 'example' => '', ], ], + 'title' => '', + 'description' => 'The schema of the response.', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1,\\n \\"currentCount\\": 1,\\n \\"data\\": [\\n {\\n \\"productCode\\": \\"oss\\",\\n \\"dataCode\\": \\"access_log\\",\\n \\"policyName\\": \\"your_log_policy\\",\\n \\"enabled\\": true,\\n \\"policyConfig\\": {\\n \\"resourceMode\\": \\"all\\",\\n \\"regions\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"instanceIds\\": [\\n \\"your-test-bucket1\\\\n\\"\\n ],\\n \\"resourceTags\\": {\\n \\"tag1\\": \\"value1\\",\\n \\"tag2\\": \\"value2\\"\\n }\\n },\\n \\"centralizeEnabled\\": false,\\n \\"centralizeConfig\\": {\\n \\"destRegion\\": \\"cn-beijing\\\\n\\",\\n \\"destProject\\": \\"your-sls-project-in-beijing\\\\n\\",\\n \\"destLogstore\\": \\"your-sls-logstore-in-beijing\\\\n\\",\\n \\"destTTL\\": 0\\n },\\n \\"resourceDirectory\\": {\\n \\"accountGroupType\\": \\"all,custom\\",\\n \\"members\\": [\\n \\"165***********50\\"\\n ]\\n },\\n \\"dataConfig\\": {\\n \\"dataRegion\\": \\"cn-hangzhou\\",\\n \\"dataProject\\": \\"\\\\\\"\\\\\\"\\"\\n },\\n \\"internalPolicy\\": false,\\n \\"policyUid\\": \\"148***********50\\"\\n }\\n ],\\n \\"statistics\\": [\\n {\\n \\"productCode\\": \\"oss\\",\\n \\"policySourceList\\": [\\n {\\n \\"policyUid\\": \\"148***********50\\",\\n \\"policyName\\": \\"policy_name1_from148\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListCollectionPolicies', - 'description' => 'This API operation is available only at the endpoints in the following regions: China (Shanghai), Singapore, and Heyuan Automotive Compliance Cloud (cn-heyuan-acdr-1).', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListGCSIngestions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 100,\\n \\"count\\": 100,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-gcs-123456\\",\\n \\"description\\": \\"gcs ingestion\\",\\n \\"displayName\\": \\"gcs ingestion\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"gcsbucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"never\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"restoreObjectEnabled\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"tagPackId\\": false,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"format\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"lastModifiedTime\\": 1714360581\\n }\\n ]\\n}","type":"json"}]', ], - 'ListConfig' => [ - 'summary' => 'Queries all Logtail configurations in a project.', - 'path' => '/configs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListIngestProcessors' => [ + 'summary' => 'Lists ingest processors that meet the specified conditions.', + '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' => '8980', - 'abilityTreeNodes' => [ - 'FEATUREslsYP6SBU', - ], + 'abilityTreeCode' => '225111', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ - 'name' => 'logstoreName', + 'name' => 'processorName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The identifier of the ingest processor.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'parse-nginx-log'], ], [ - 'name' => 'offset', + 'name' => 'displayName', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which the query starts. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The display name of the ingest processor.', 'type' => 'string', 'example' => 'Parse Nginx log', 'title' => '', 'required' => false], ], [ - 'name' => 'size', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The offset value. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'title' => '', 'required' => false], ], [ - 'name' => 'configName', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logtail configuration, which is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'logtail-config-sample', - ], + 'schema' => ['description' => 'The number of entries to return. The default value is 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'default' => '200', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'count' => [ - 'description' => 'The number of Logtail configurations that are returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - 'title' => '', - ], - 'total' => [ - 'description' => 'The total number of Logtail configurations that meet the query conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], - 'configs' => [ - 'description' => 'The Logtail configurations that are returned on the current page.'."\n", + 'total' => ['description' => 'The total number of entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'count' => ['description' => 'The number of entries returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'processors' => [ + 'description' => 'A list of ingest processors that meet the query conditions.', 'type' => 'array', - 'items' => [ - 'description' => 'The Logtail configuration that is returned.'."\n", - 'type' => 'string', - 'example' => 'logtail-config-sample', - 'title' => '', - ], + 'items' => ['description' => 'The information about the ingest processor.', '$ref' => '#/components/schemas/IngestProcessor', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], - 'description' => '', - 'title' => '', 'example' => '', ], ], ], - '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' => 'ListConfig', - 'description' => '### [](#)Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n", - '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\\": 10,\\n \\"count\\": 5,\\n \\"processors\\": [\\n {}\\n ]\\n}","type":"json"}]', + 'title' => 'ListIngestProcessors', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'log:ListConfig', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'translator' => 'manual', ], - 'ListConsumeProcessors' => [ - 'summary' => 'Retrieves a list of consume processors that match the specified parameters.', - 'path' => '/consumeprocessors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListLogStores' => [ + 'summary' => 'Queries all Logstores or Logstores that match specific conditions in a project.', + 'path' => '/logstores', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '225118', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'processorName', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The identity of the consume processor.', - 'type' => 'string', - 'required' => false, - 'example' => 'consume-processor-1', - 'title' => '', - ], + 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'required' => false, 'title' => ''], ], [ - 'name' => 'displayName', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The display name of the consume processor.', - 'type' => 'string', - 'required' => false, - 'example' => 'filter-get-request', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 500. Default value: 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '500', 'title' => '', 'required' => false], ], [ - 'name' => 'offset', + 'name' => 'logstoreName', 'in' => 'query', - 'schema' => [ - 'description' => 'The offset of the query. The default value is 0.', - 'type' => 'string', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logstore. Fuzzy match is supported. For example, if you enter test, Logstores whose name contains test are returned.', 'type' => 'string', 'required' => false, 'example' => 'my-logstore', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'telemetryType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return. The default value is 200.', - 'type' => 'string', - 'required' => false, - 'example' => '100', - 'title' => '', - ], + 'schema' => ['description' => 'The type of the data that you want to query. Valid values:'."\n" + ."\n" + .'- None: logs'."\n" + ."\n" + .'- Metrics: metrics', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''], + ], + [ + 'name' => 'mode', + 'in' => 'query', + 'schema' => ['description' => 'The type of the Logstore. Valid values: standard and query.'."\n" + ."\n" + .'- **standard**: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system.'."\n" + ."\n" + .'- **query**: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the volume of data is large, the log retention period is long, or log analysis is not required. Log retention periods of weeks or months are considered long.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'The response schema.', + 'title' => '', + 'description' => 'The body of the response.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'The total number of consume processors that meet the query conditions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'count' => [ - 'description' => 'The number of consume processors returned in the current response.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'processors' => [ - 'description' => 'The list of consume processors.', + 'total' => ['description' => 'The number of the Logstores that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2'], + 'logstores' => [ + 'description' => 'The Logstores that meet the query conditions.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about the consume processor.', - '$ref' => '#/components/schemas/ConsumeProcessor', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The information about the Logstore.', 'type' => 'string', 'example' => 'test-1,test-2', 'title' => ''], + 'example' => '["test-1","test-2"]', 'title' => '', - 'example' => '', ], ], 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 20,\\n \\"count\\": 10,\\n \\"processors\\": [\\n {\\n \\"processorName\\": \\"consume-processor-1\\",\\n \\"displayName\\": \\"字段过滤处理\\",\\n \\"description\\": \\"过滤content字段\\",\\n \\"configuration\\": {\\n \\"spl\\": \\"* | project content\\"\\n },\\n \\"createTime\\": 1717171200,\\n \\"updateTime\\": 1717171200\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListConsumeProcessors', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - 'ListConsumerGroup' => [ - 'summary' => 'Queries all consumer groups of a Logstore.', - 'path' => '/logstores/{logstore}/consumergroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => 'Project name', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'title' => 'Logstore name', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The consumer groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the consumer group.'."\n", - 'example' => 'test-consumer-group', - '$ref' => '#/components/schemas/ConsumerGroup', - 'title' => '', - ], - 'example' => '[{\'\'name\'\': \'\'test-consumer-group\'\', \'\'timeout\'\': 30, \'\'order\'\': False}]', - 'title' => '', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"name\\": \\"test-consumer-group\\",\\n \\"timeout\\": 300,\\n \\"order\\": false\\n }\\n]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListConsumerGroup', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 2,\\n \\"count\\": 2,\\n \\"logstores\\": [\\n \\"test-1,test-2\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListLogStores', 'description' => '### Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:ListConsumerGroup`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*`|', + .'| 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" - .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", + .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -28810,1300 +17061,595 @@ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:ListConsumerGroup', + 'action' => 'log:ListLogStores', '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/*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/*'], ], ], ], ], ], - 'ListDashboard' => [ - 'summary' => 'Queries dashboards.', - 'path' => '/dashboards', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListLogtailPipelineConfig' => [ + 'summary' => 'Lists the names of Logtail pipeline configurations that meet specified criteria.', + 'path' => '/pipelineconfigs', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '10283', - 'abilityTreeNodes' => [ - 'FEATUREslsHU53H2', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191816', + 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The project name.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which the query starts. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'default' => '0', - 'required' => false, - 'title' => '', - ], + 'schema' => ['description' => 'The line from which to start the query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '0', 'default' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page for a paged query. The maximum value is 500. The default value is 500.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'default' => '500', - 'title' => '', - 'required' => false, - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The number of pipeline configurations to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20', 'default' => '500', 'title' => ''], ], [ - 'name' => 'tags', + 'name' => 'logstoreName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => 'The tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - 'title' => '', - ], - 'value' => [ - 'description' => 'The tag value.', - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - 'title' => '', - ], - ], - 'required' => false, - 'description' => 'A tag.', - 'title' => '', - 'example' => '', - ], - 'required' => false, - 'description' => 'The tag information.', - 'title' => '', - 'example' => '', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'example' => 'test-logstore', 'title' => '', 'required' => false], ], [ - 'name' => 'dashboardName', + 'name' => 'configName', 'in' => 'query', - 'schema' => [ - 'description' => 'The dashboard name.', - 'type' => 'string', - 'required' => false, - 'example' => 'dashboard-1609294922657-434834', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the pipeline configuration.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'logtail-config-sample'], ], [ - 'name' => 'displayName', + 'name' => 'configType', 'in' => 'query', - 'schema' => [ - 'description' => 'The display name.', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - 'title' => '', - ], + 'allowEmptyValue' => false, + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], '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' => 'The dashboard.', + 'title' => '', + 'description' => '', 'type' => 'object', 'properties' => [ - 'dashboards' => [ + 'count' => ['description' => 'The number of Logtail pipeline configurations returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'total' => ['description' => 'The total number of Logtail pipeline configurations in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'configs' => [ 'title' => '', - 'description' => 'A list of dashboard names. This corresponds to dashboardName.', - 'type' => 'array', - 'items' => [ - 'description' => 'A list of dashboard names. This corresponds to dashboardName.', - 'type' => 'string', - 'example' => 'dashboard-1609294922657-434834', - 'title' => '', - ], - 'example' => '', - ], - 'dashboardItems' => [ - 'description' => 'The dashboards.', + 'description' => 'The list of Logtail pipeline configurations returned on the current page.', 'type' => 'array', - 'items' => [ - 'description' => 'A dashboard.', - 'type' => 'object', - 'properties' => [ - 'dashboardName' => [ - 'description' => 'The dashboard ID. The ID must be unique within a project. Fuzzy queries are supported. For example, if you enter da, all dashboards whose names start with da are returned.', - 'type' => 'string', - 'example' => 'dashboard-1609294922657-434834', - 'title' => '', - ], - 'displayName' => [ - 'description' => 'The display name of the dashboard.', - 'type' => 'string', - 'example' => 'data-ingest', - 'title' => '', - ], - 'description' => [ - 'description' => 'The description.', - 'type' => 'string', - 'example' => 'tablet_ai', - 'title' => '', - ], - ], - 'title' => '', - 'example' => '', - ], - 'title' => '', + 'items' => ['description' => 'The name of the Logtail pipeline configuration.', 'type' => 'string', 'title' => '', 'example' => 'test_logstore'], 'example' => '', ], ], - 'title' => '', 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"dashboards\\": [\\n \\"dashboard-1609294922657-434834\\"\\n ],\\n \\"dashboardItems\\": [\\n {\\n \\"dashboardName\\": \\"dashboard-1609294922657-434834\\",\\n \\"displayName\\": \\"data-ingest\\",\\n \\"description\\": \\"tablet_ai\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListDashboard', - 'description' => '### Description'."\n" - ."\n" - .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. You must specify the project name in the Host.'."\n" - ."\n" - .'- Create an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'An AccessKey pair for an Alibaba Cloud account has the permissions to call all API operations. This is a high-risk practice. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" - ."\n" - .'- Identify the name and region of the project that contains the logs you want to query. For more information, see [Manage projects](~~48984~~).', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" - .'| 400 | ParameterInvalid | offset: offset is invalid. |offset参数取值无效。|'."\n" - .'| 400 | ParameterInvalid | size: size is invalid. |size参数取值无效。|'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" - ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 10,\\n \\"total\\": 20,\\n \\"configs\\": [\\n \\"test_logstore\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListLogtailPipelineConfig', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - '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/*', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'ListDatasets' => [ - 'summary' => 'Lists datasets.', - 'path' => '/datasets', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListMachineGroup' => [ + 'summary' => 'Queries the machine groups of a 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' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '296327', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'A short description of the struct.', - 'type' => 'string', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'offset', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '2000', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'groupName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the machine group. This parameter is used to filter machine groups. Partial match is supported.', 'type' => 'string', 'example' => 'test-machine-group', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'count' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', + 'count' => ['description' => 'The number of machine groups that are returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'total' => ['description' => 'The total number of machine groups that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'machinegroups' => [ 'title' => '', - 'example' => '', - ], - 'datasets' => [ + 'description' => 'The machine groups that meet the query conditions.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'createTime' => [ - 'description' => 'The time when the dataset was created.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '', - ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', + 'items' => ['description' => 'The name of the machine group.', 'type' => 'string', 'example' => 'test-group', 'title' => ''], + 'example' => '[ "test-machine-group-1", "test-machine-group-2" ]', ], ], - 'title' => '', - 'description' => 'The schema of the response.', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 1,\\n \\"total\\": 1,\\n \\"machinegroups\\": [\\n \\"test-group\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListMachineGroup', + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 500 | InternalServerError | internal server error. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[错误码对照表](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - '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"}]', - 'title' => 'ListDatasets', - ], - 'ListDomains' => [ - 'summary' => 'Queries the custom domain names that are bound to projects.', - 'path' => '/domains', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListMachineGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*'], + ], + ], + ], ], + ], + 'ListMachines' => [ + 'summary' => 'Queries a list of machines that are connected to Simple Log Service in a specified machine group.', + 'path' => '/machinegroups/{machineGroup}/machines', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which the query starts. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'name' => 'machineGroup', + 'in' => 'path', + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-group', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 500. Maximum value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', 'title' => ''], ], [ - 'name' => 'domainName', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The domain name that is used to match custom domain names. For example, if you set domainName to `example.com`, the matched domain names are `a.example.com` and `b.example.com`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 100. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '2000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The information about the domain names.'."\n", + 'description' => 'The machines that are returned.', 'type' => 'object', 'properties' => [ - 'domains' => [ - 'description' => 'The domain names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - 'title' => '', - ], + 'count' => ['description' => 'The number of machines that are returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'total' => ['description' => 'The total number of machines.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'machines' => [ 'title' => '', + 'description' => 'The machines that are returned.', + 'type' => 'array', + 'items' => ['description' => 'The information about the machine.', '$ref' => '#/components/schemas/machine', 'title' => '', 'example' => '[{"ip": "10.***.***.***", "machine-uniqueid": "", "userdefined-id": "", "lastHeartbeatTime": 1447182247},{"ip": "10.***.***.***", "machine-uniqueid": "","userdefined-id": "","lastHeartbeatTime": 1447182246}]'], 'example' => '', ], - 'count' => [ - 'description' => 'The number of domain names that are returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'total' => [ - 'description' => 'The total number of domain names that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], ], 'title' => '', 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"domains\\": [\\n \\"example.com\\"\\n ],\\n \\"count\\": 1,\\n \\"total\\": 1\\n}","type":"json"}]', - 'title' => 'ListDomains', - 'description' => '* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* Only one custom domain name can be bound to each project.'."\n", - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 3,\\n \\"total\\": 8,\\n \\"machines\\": [\\n {\\n \\"ip\\": \\"192.168.xx.x\\",\\n \\"machine-uniqueid\\": \\"3B70F4F1-80F7-46C4-A6C1-100****EE647\\",\\n \\"lastHeartbeatTime\\": 1447182247,\\n \\"userdefined-id\\": \\"无\\",\\n \\"host-id\\": \\"test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListMachines', + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 404 | MachineGroupNotExist| MachineGroup groupName does not exist. | 机器组不存在。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:ListDomains', + 'action' => 'log:ListMachines', '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/{#MachineGroupName}'], ], ], ], ], ], - 'ListDownloadJobs' => [ - 'summary' => 'Lists the log download jobs in a specified project.', - 'path' => '/downloadjobs', - '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' => '216707', - 'abilityTreeNodes' => [ - 'FEATUREsls1J4K38', - ], + 'riskType' => 'none', + 'abilityTreeCode' => '294478', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project that contains the materialized views.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'offset', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which to start the query. The default value is 0.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the materialized view. Use this to query for a specific materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'size', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of log download jobs to return in a single request.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries to skip before returning results. This parameter is used for pagination. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], [ - 'name' => 'logstore', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The maximum number of materialized views to return per page. Default value: 100. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The information about all log download jobs.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'The total number of records.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '10', - ], - 'count' => [ - 'description' => 'The number of log download jobs returned in the current response.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '10', - ], - 'results' => [ - 'title' => '', - 'description' => 'An array that contains the list of log download jobs.', + 'count' => ['description' => 'The number of materialized views returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'total' => ['description' => 'The total number of materialized views that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'materializedViews' => [ 'type' => 'array', - 'items' => [ - 'title' => 'DownloadJobItemType', - 'description' => 'The information about a log download job.', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'The description of the log download job.', - 'type' => 'string', - 'title' => '', - 'example' => 'a download job', - ], - 'configuration' => [ - 'title' => '', - 'description' => 'The download configuration.', - 'type' => 'object', - 'properties' => [ - 'logstore' => [ - 'description' => 'The source Logstore.', - 'type' => 'string', - 'title' => '', - 'example' => 'ali-test-logstore', - ], - 'fromTime' => [ - 'description' => 'The start time of the query. This is a UNIX timestamp that is accurate to the second.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '1722409260', - ], - 'toTime' => [ - 'description' => 'The end time of the query. This is a UNIX timestamp that is accurate to the second.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '1722411060', - ], - 'query' => [ - 'description' => 'The query statement.', - 'type' => 'string', - 'title' => '', - 'example' => '* | select *', - ], - 'powerSql' => [ - 'description' => 'Specifies whether to enable PowerSQL.', - 'type' => 'boolean', - 'title' => '', - 'example' => 'true', - ], - 'allowInComplete' => [ - 'description' => 'Specifies whether to allow the download of incomplete results.', - 'type' => 'string', - 'example' => 'false', - 'title' => '', - ], - 'sink' => [ - 'title' => '', - 'description' => 'The sink configuration.', - 'type' => 'object', - 'properties' => [ - 'compressionType' => [ - 'description' => 'The compression format.', - 'type' => 'string', - 'title' => '', - 'example' => 'none', - ], - 'contentType' => [ - 'description' => 'The file format of the downloaded file.', - 'type' => 'string', - 'title' => '', - 'example' => 'csv', - ], - 'roleArn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the RAM role that is used for the download.', - 'type' => 'string', - 'title' => '', - 'example' => 'acs:ram::123456:role/aliyunlogimportossrole', - ], - 'bucket' => [ - 'description' => 'The destination OSS bucket.', - 'type' => 'string', - 'title' => '', - 'example' => 'ali-test-oss-bucket', - ], - 'prefix' => [ - 'description' => 'The prefix of the object that is downloaded to the destination OSS bucket.', - 'type' => 'string', - 'example' => 'download/', - 'title' => '', - ], - 'type' => [ - 'description' => 'The type of the sink. The value is fixed as AliyunOSS.', - 'type' => 'string', - 'example' => 'AliyunOSS', - 'title' => '', - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'displayName' => [ - 'description' => 'Display name', - 'type' => 'string', - 'title' => '', - 'example' => 'download-123', - ], - 'executionDetails' => [ - 'title' => '', - 'description' => 'The execution details of the job.', - 'type' => 'object', - 'properties' => [ - 'progress' => [ - 'description' => 'The download progress as a percentage.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '100', - ], - 'filePath' => [ - 'description' => 'The URL of the downloaded file.', - 'type' => 'string', - 'title' => '', - 'example' => 'https://sls-downloaded-xxxx.csv.gzip?Expiresxxx', - ], - 'fileSize' => [ - 'description' => 'The size of the downloaded file in bytes.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '123456', - ], - 'executeTime' => [ - 'description' => 'The running time of the download.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '123', - ], - 'logCount' => [ - 'description' => 'The number of downloaded log entries.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '123', - ], - 'errorMessage' => [ - 'description' => 'The error message that is returned if the job fails.', - 'type' => 'string', - 'title' => '', - 'example' => 'timeout', - ], - 'checkSum' => [ - 'description' => 'The ETag of the file.', - 'type' => 'string', - 'example' => 'ETASFGASDASQWDasd', - 'title' => '', - ], - 'notice' => [ - 'description' => 'The notification message.', - 'type' => 'string', - 'example' => 'test', - 'title' => '', - ], - ], - 'example' => '', - ], - 'name' => [ - 'description' => 'The name of the log download job.', - 'type' => 'string', - 'title' => '', - 'example' => 'download-123', - ], - 'createTime' => [ - 'description' => 'The time when the log download job was created. This is a UNIX timestamp in seconds.', - 'type' => 'string', - 'example' => '1722411060', - 'title' => '', - ], - 'status' => [ - 'description' => 'The status of the Job.', - 'type' => 'string', - 'example' => 'STARTING、RUNNING、SUCCEEDED、ERROR', - 'title' => '', - ], - ], - 'example' => '', - ], + 'items' => ['description' => 'The name of the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'A list of materialized views.', + 'title' => '', 'example' => '', ], ], + 'description' => 'The response body.', + 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"description\\": \\"a download job\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"ali-test-logstore\\",\\n \\"fromTime\\": 1722409260,\\n \\"toTime\\": 1722411060,\\n \\"query\\": \\"* | select *\\",\\n \\"powerSql\\": true,\\n \\"allowInComplete\\": \\"false\\",\\n \\"sink\\": {\\n \\"compressionType\\": \\"none\\",\\n \\"contentType\\": \\"csv\\",\\n \\"roleArn\\": \\"acs:ram::123456:role/aliyunlogimportossrole\\",\\n \\"bucket\\": \\"ali-test-oss-bucket\\",\\n \\"prefix\\": \\"download/\\",\\n \\"type\\": \\"AliyunOSS\\"\\n }\\n },\\n \\"displayName\\": \\"download-123\\",\\n \\"executionDetails\\": {\\n \\"progress\\": 100,\\n \\"filePath\\": \\"https://sls-downloaded-xxxx.csv.gzip?Expiresxxx\\",\\n \\"fileSize\\": 123456,\\n \\"executeTime\\": 123,\\n \\"logCount\\": 123,\\n \\"errorMessage\\": \\"timeout\\",\\n \\"checkSum\\": \\"ETASFGASDASQWDasd\\",\\n \\"notice\\": \\"test\\"\\n },\\n \\"name\\": \\"download-123\\",\\n \\"createTime\\": \\"1722411060\\",\\n \\"status\\": \\"STARTING、RUNNING、SUCCEEDED、ERROR\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListDownloadJobs', + 'staticInfo' => ['returnType' => 'synchronous'], + 'summary' => 'Lists the materialized views in a project.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'log:ListDownloadJobs', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], - ], - 'ListETLs' => [ - 'summary' => 'Lists the data transformation jobs in a project.', - 'path' => '/etls', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 0,\\n \\"total\\": 0,\\n \\"materializedViews\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListMaterializedView', + ], + 'ListMaterializedViews' => [ + 'summary' => 'Lists materialized views.', + 'path' => '/materializedviews', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '203166', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'riskType' => 'none', + 'abilityTreeCode' => '294661', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The project name.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'offset', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which the query starts. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the materialized view. Fuzzy search is supported.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'size', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of data transformation jobs to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The position from which to start returning results for pagination. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], [ - 'name' => 'logstore', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The Logstore name.', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The number of materialized views to return. The actual number of returned materialized views may be less than the specified value. If you do not specify this parameter, a system default is used.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'The total number of data transformation jobs in the project.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'count' => [ - 'description' => 'The number of data transformation jobs returned in the current response.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'results' => [ - 'description' => 'A list of data transformation results.', + 'count' => ['description' => 'The number of materialized views returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'total' => ['description' => 'The total number of materialized views that match the query.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'materializedViews' => [ 'type' => 'array', - 'items' => [ - 'description' => 'The data transformation configuration.', - '$ref' => '#/components/schemas/ETL', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The name of a materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], + 'description' => 'An array of materialized view names.', 'title' => '', 'example' => '', ], ], + 'description' => 'The response body.', + 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ETL\\",\\n \\"description\\": \\"ETL\\",\\n \\"displayName\\": \\"ETL\\",\\n \\"configuration\\": {\\n \\"script\\": \\"e_set(\\\\\\"key\\\\\\",\\\\\\"value\\\\\\")\\",\\n \\"lang\\": \\"SPL\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\",\\n \\"fromTime\\": 0,\\n \\"toTime\\": 0,\\n \\"sinks\\": [\\n {\\n \\"name\\": \\"test-etljob\\",\\n \\"endpoint\\": \\"\\",\\n \\"project\\": \\"test-project\\",\\n \\"logstore\\": \\"test-logstore\\",\\n \\"datasets\\": [\\n \\"__UNNAMED__\\"\\n ],\\n \\"roleArn\\": \\"acs:ram::13234:role/logtarget\\",\\n \\"accessKeyId\\": \\"\\",\\n \\"accessKeySecret\\": \\"\\"\\n }\\n ],\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714274900,\\n \\"lastModifiedTime\\": 1714274900,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"f0eb655e501a8780808d1970ef6d04c4\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListETLs', + 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'log:ListETLs', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 0,\\n \\"total\\": 0,\\n \\"materializedViews\\": [\\n \\"\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListMaterializedViews', ], - 'ListIngestProcessors' => [ - 'summary' => 'Lists ingest processors that meet the specified conditions.', - 'path' => '/ingestprocessors', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListMaxComputeExports' => [ + 'summary' => 'Lists MaxCompute delivery tasks.', + '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' => 'list', - 'abilityTreeCode' => '225111', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeCode' => '203415', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'processorName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The identifier of the ingest processor.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => 'parse-nginx-log', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'displayName', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The display name of the ingest processor.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => '解析Nginx日志', - ], + 'schema' => ['description' => 'The position from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'offset', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The offset value. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - 'default' => '0', - 'title' => '', - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return. The default value is 200.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - 'default' => '200', - 'title' => '', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'my-logstore', 'title' => ''], ], ], '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', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - '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' => [ 'title' => 'Schema of Response', - 'description' => 'The schema of the response.', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'The total number of entries that meet the query conditions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'count' => [ - 'description' => 'The number of entries returned in the current response.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - 'title' => '', - ], - 'processors' => [ - 'description' => 'A list of ingest processors that meet the query conditions.', + 'total' => ['description' => 'The total number of MaxCompute delivery tasks in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'count' => ['description' => 'The number of MaxCompute delivery tasks that are returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'results' => [ + 'description' => 'The list of MaxCompute delivery tasks.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about the ingest processor.', - '$ref' => '#/components/schemas/IngestProcessor', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The details of the task configuration.', '$ref' => '#/components/schemas/MaxComputeExport', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], @@ -30112,439 +17658,202 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 5,\\n \\"processors\\": [\\n {}\\n ]\\n}","type":"json"}]', - 'title' => 'ListIngestProcessors', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"MaxComputeExport\\",\\n \\"description\\": \\"MaxComputeExport\\",\\n \\"displayName\\": \\"MaxComputeExport\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\\\n\\",\\n \\"sink\\": {\\n \\"odpsEndpoint\\": \\"https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api\\",\\n \\"odpsTunnelEndpoint\\": \\"https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com\\",\\n \\"odpsProject\\": \\"demo_project\\",\\n \\"odpsTable\\": \\"demo_table\\",\\n \\"odpsRolearn\\": \\"acs:ram::xxxxxxx\\",\\n \\"odpsAccessKeyId\\": \\"axxxxxxxxxxxb\\",\\n \\"odpsAccessSecret\\": \\"aaxxxxxxxxxxxxxxxxxxxxxbb\\",\\n \\"partitionTimeFormat\\": \\"%Y_%m_%d\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"fields\\": [\\n \\"\'f1\'\\"\\n ],\\n \\"partitionColumn\\": [\\n \\"\'p1\'\\"\\n ],\\n \\"filterInvalid\\": true,\\n \\"timeFormatType\\": \\"StrfTimeFormat\\",\\n \\"bufferInterval\\": \\"1800\\"\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718390800\\n },\\n \\"createTime\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListMaxComputeExports', + 'description' => '- The Host consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.'."\n" + ."\n" + .'- Create and obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'An AccessKey pair for an Alibaba Cloud account has permissions to access all APIs. This poses a high security risk. We recommend that you create and use a Resource Access Management (RAM) user for API access or daily O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" + ."\n" + .'- Identify the name and region of the project that contains the logs to query. For more information, see [Manage projects](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'ListLogStores' => [ - 'summary' => 'Queries all Logstores or Logstores that match specific conditions in a project.', - 'path' => '/logstores', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMetricStores' => [ + 'summary' => 'Queries the list of Metricstores in a project. You can use fuzzy search to query the Metricstores by Metricstore name.', + 'path' => '/metricstores', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => [], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '225690', + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'my-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which the query starts. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The start position of the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'title' => '', 'required' => false], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Maximum value: 500. Default value: 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '500', - ], - ], - [ - 'name' => 'logstoreName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore. Fuzzy match is supported. For example, if you enter test, Logstores whose name contains test are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '500', 'title' => '', 'required' => false], ], [ - 'name' => 'telemetryType', + 'name' => 'mode', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data that you want to query. Valid values:'."\n" - ."\n" - .'* None: logs'."\n" - .'* Metrics: metrics'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'None', - 'title' => '', - ], + 'schema' => ['description' => 'The type of the Metricstore. For example, you can set the parameter to standard to query Standard Metricstores.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'standard'], ], [ - 'name' => 'mode', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the Logstore. Valid values: standard and query.'."\n" - ."\n" - .'* **standard**: Standard Logstore. This type of Logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of Logstore to build a comprehensive observability system.'."\n" - .'* **query**: Query Logstore. This type of Logstore supports high-performance queries. The index traffic fee of a Query Logstore is approximately half that of a Standard Logstore. Query Logstores do not support SQL analysis. Query Logstores are suitable for scenarios in which the volume of data is large, the log retention period is long, or log analysis is not required. Log retention periods of weeks or months are considered long.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Metricstore. Fuzzy search is supported. If you do not specify this parameter, all Metricstores are involved.', 'type' => 'string', 'example' => 'metric_store', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The body of the response.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'total' => [ - 'title' => '', - 'description' => 'The number of the Logstores that meet the query conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'count' => [ + 'count' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'total' => ['description' => 'The total number of queried Metricstores.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'], + 'metricstores' => [ 'title' => '', - 'description' => 'The number of entries returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'logstores' => [ - 'description' => 'The Logstores that meet the query conditions.'."\n", + 'description' => 'The names of the Metricstores.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about the Logstore.'."\n", - 'type' => 'string', - 'example' => 'test-1,test-2', - 'title' => '', - ], - 'example' => '["test-1","test-2"]', - 'title' => '', + 'items' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'example' => 'my_metric_store', 'title' => ''], + 'example' => '', ], ], 'example' => '', ], ], ], - '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' => 'ListLogStores', - 'description' => '### Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" - ."\n" - .'### Authentication resources'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 10,\\n \\"total\\": 100,\\n \\"metricstores\\": [\\n \\"my_metric_store\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListMetricStores', + 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" - .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:ListLogStores`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/*`|', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + .'- The information that is required to query metric data is obtained. The information includes the name of the project to which the metric data belong and the region of the project. For more information, see [Manage a project](~~48984~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - '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' => [], ], - 'ListLogtailPipelineConfig' => [ - 'summary' => 'Lists the names of Logtail pipeline configurations that meet specified criteria.', - 'path' => '/pipelineconfigs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListOSSExports' => [ + 'summary' => 'Queries the OSS shipping jobs in a specified project.', + 'path' => '/ossexports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '191816', - 'abilityTreeNodes' => [ - 'FEATUREsls9GTH7Z', - ], + 'abilityTreeCode' => '203471', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which to start the query.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '0', - 'default' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The line number from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The number of pipeline configurations to return on each page.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '20', - 'default' => '500', - 'title' => '', - ], + 'schema' => ['description' => 'The number of jobs to return. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'logstoreName', + 'name' => 'logstore', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'example' => 'test-logstore', - 'title' => '', - 'required' => false, - ], - ], - [ - 'name' => 'configName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the pipeline configuration.', - 'type' => 'string', - 'title' => '', - 'required' => false, - 'example' => 'logtail-config-sample', - ], - ], - [ - 'name' => 'configType', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The number of entries to return. The default value is 10.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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' => '', - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Response schema', 'type' => 'object', 'properties' => [ - 'count' => [ - 'description' => 'The number of Logtail pipeline configurations returned on the current page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'total' => [ - 'description' => 'The total number of Logtail pipeline configurations in the project.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - 'title' => '', - ], - 'configs' => [ - 'title' => '', - 'description' => 'The list of Logtail pipeline configurations returned on the current page.', + 'total' => ['description' => 'The total number of OSS shipping jobs in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'count' => ['description' => 'The number of OSS shipping jobs returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'results' => [ + 'description' => 'The list of OSS shipping jobs.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the Logtail pipeline configuration.', - 'type' => 'string', - 'title' => '', - 'example' => 'test_logstore', - ], + 'items' => ['description' => 'The detailed configuration of the job.', '$ref' => '#/components/schemas/OSSExport', 'title' => '', 'example' => ''], + 'title' => '', 'example' => '', ], ], @@ -30552,1410 +17861,796 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 10,\\n \\"total\\": 20,\\n \\"configs\\": [\\n \\"test_logstore\\"\\n ]\\n}","type":"json"}]', - 'title' => 'ListLogtailPipelineConfig', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"https://oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"bucket\\": \\"my-bucket\\",\\n \\"prefix\\": \\"prefix-demo/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"pathFormat\\": \\"%Y/%m/%d/%H/%M\\",\\n \\"pathFormatType\\": \\"time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"csv\\",\\n \\"contentDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"your log key1\\\\\\",\\\\n \\\\\\"your log key2\\\\\\",\\\\n \\\\\\"your log key3\\\\\\",\\\\n ],\\\\n \\\\\\"delimiter\\\\\\": \\\\\\" \\\\\\",\\\\n \\\\\\"header\\\\\\": true,\\\\n \\\\\\"lineFeed\\\\\\": \\\\\\"\\\\\\\\n\\\\\\",\\\\n \\\\\\"null\\\\\\": \\\\\\"-\\\\\\",\\\\n \\\\\\"quote\\\\\\": \\\\\\"\\\\\\\\\\\\\\"\\\\\\"\\\\n},\\"\\n },\\n \\"compressionType\\": \\"snappy\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718380800,\\n \\"sourceSecureTransport\\": false\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListOSSExports', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'ListMachineGroup' => [ - 'summary' => 'Queries the machine groups of a project.', - 'path' => '/machinegroups', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListOSSExports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListOSSHDFSExports' => [ + 'summary' => 'Lists the OSS-HDFS export tasks in a specified project.', + 'path' => '/osshdfsexports', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The line from which the query starts. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The line from which to start the query. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Maximum value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '2000', - ], + 'schema' => ['description' => 'The number of entries to return. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'groupName', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the machine group. This parameter is used to filter machine groups. Partial match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-machine-group', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], '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' => '', - 'description' => 'Schema of Response'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '', - 'description' => 'The number of machine groups that are returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'total' => [ - 'title' => '', - 'description' => 'The total number of machine groups that meet the query conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'machinegroups' => [ - 'title' => '', - 'description' => 'The machine groups that meet the query conditions.'."\n", + 'total' => ['description' => 'The total number of OSS-HDFS export tasks in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'count' => ['description' => 'The number of OSS-HDFS export tasks returned in the current response.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'results' => [ + 'description' => 'The list of OSS-HDFS export tasks.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'example' => 'test-group', - ], - 'example' => '[ "test-machine-group-1", "test-machine-group-2" ]', + 'items' => ['description' => 'The details of the task configuration.', '$ref' => '#/components/schemas/OSSExport', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"count\\": 1,\\n \\"total\\": 1,\\n \\"machinegroups\\": [\\n \\"test-group\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListMachineGroup', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 500 | InternalServerError | internal server error. | 内部服务调用错误。 |'."\n" - ."\n" - .'更多信息，请参见[错误码对照表](~~29013~~)。'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"https://oss-cn-hangzhou-internal.aliyuncs.com\\",\\n \\"bucket\\": \\"my-bucket\\",\\n \\"prefix\\": \\"prefix-demo/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\",\\n \\"pathFormat\\": \\"%Y/%m/%d/%H/%M\\",\\n \\"pathFormatType\\": \\"time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"csv\\",\\n \\"contentDetail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"columns\\\\\\": [\\\\n \\\\\\"your log key1\\\\\\",\\\\n \\\\\\"your log key2\\\\\\",\\\\n \\\\\\"your log key3\\\\\\",\\\\n ],\\\\n \\\\\\"delimiter\\\\\\": \\\\\\" \\\\\\",\\\\n \\\\\\"header\\\\\\": true,\\\\n \\\\\\"lineFeed\\\\\\": \\\\\\"\\\\\\\\n\\\\\\",\\\\n \\\\\\"null\\\\\\": \\\\\\"-\\\\\\",\\\\n \\\\\\"quote\\\\\\": \\\\\\"\\\\\\\\\\\\\\"\\\\\\"\\\\n},\\"\\n },\\n \\"compressionType\\": \\"snappy\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718380800,\\n \\"sourceSecureTransport\\": false\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListOSSHDFSExports', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:ListMachineGroup', - '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/*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], - 'ListMachines' => [ - 'summary' => 'Queries a list of machines that are connected to Simple Log Service in a specified machine group.', - 'path' => '/machinegroups/{machineGroup}/machines', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'get', + 'operationType' => 'list', + 'abilityTreeCode' => '203123', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'machineGroup', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], + 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The line from which the query starts. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The number of entries to skip for pagination. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Default value: 100. Maximum value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'default' => '2000', - ], + 'schema' => ['description' => 'The maximum number of OSS import tasks to return in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'."\n", 'title' => ''], + ], + [ + 'name' => 'logstore', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ - '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' => 'The machines that are returned.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '', - 'description' => 'The number of machines that are returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'total' => [ - 'title' => '', - 'description' => 'The total number of machines.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'machines' => [ - 'title' => '', - 'description' => 'The machines that are returned.'."\n", + 'total' => ['description' => 'The total number of OSS import tasks in the Project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'count' => ['description' => 'The number of OSS import tasks returned in this response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'results' => [ + 'description' => 'A list of OSS import tasks.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The information about the machine.'."\n", - 'example' => '[{"ip": "10.***.***.***", "machine-uniqueid": "", "userdefined-id": "", "lastHeartbeatTime": 1447182247},{"ip": "10.***.***.***", "machine-uniqueid": "","userdefined-id": "","lastHeartbeatTime": 1447182246}]', - '$ref' => '#/components/schemas/machine', - ], + 'items' => ['description' => 'The configuration of an OSS import task.', '$ref' => '#/components/schemas/OSSIngestion', 'title' => '', 'example' => ''], + 'title' => '', 'example' => '', ], ], - 'title' => '', 'example' => '', ], ], ], - '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' => 'ListMachines', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", - '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", + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListOSSIngestions', + 'summary' => 'Lists OSS import tasks in a specified Project.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'get', + 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:ListMachines', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], + 'action' => 'log:ListOSSIngestions', + 'authLevel' => 'operate', + 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-oss-123456\\",\\n \\"description\\": \\"oss ingestion\\",\\n \\"displayName\\": \\"oss ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"ossbucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"never\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"restoreObjectEnabled\\": true,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"useMetaIndex\\": false,\\n \\"roleARN\\": \\"acs:ram::12345:role/aliyunlogdefaultrole\\",\\n \\"tagPackId\\": true,\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"Line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListMaxComputeExports' => [ - 'summary' => 'Lists MaxCompute delivery tasks.', - 'path' => '/maxcomputeexports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'list', - 'abilityTreeCode' => '203415', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '8912', + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'my-project', - ], + 'name' => 'projectName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the project. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The position from which to start the query. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '0', - ], + 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'default' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return. The default value is 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '10', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page in a paged query. Default value: 100. A maximum of 500 project entries can be returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '500'], ], [ - 'name' => 'logstore', + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzf******sxby', 'title' => ''], + ], + [ + 'name' => 'fetchQuota', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', + 'description' => 'Specifies whether to retrieve the project quota information.', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', 'required' => false, + 'example' => 'false', 'title' => '', - 'example' => 'my-logstore', ], ], + [ + 'name' => 'description', + 'in' => 'query', + 'schema' => ['description' => 'The project description, used for filtering.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'x-log-requestid' => [ + 'schema' => ['type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'Server' => [ + 'schema' => ['type' => 'string', 'example' => 'nginx'], ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], + 'Access-Control-Allow-Origin' => [ + 'schema' => ['type' => 'string', 'example' => '*'], ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'example' => 'close'], ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + 'Content-Length' => [ + 'schema' => ['type' => 'string', 'example' => '0'], + ], + 'Date' => [ + 'schema' => ['type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], ], ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response body.', + 'description' => 'The project list.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'The total number of MaxCompute delivery tasks in the project.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '10', - ], - 'count' => [ - 'description' => 'The number of MaxCompute delivery tasks that are returned.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '2', - ], - 'results' => [ - 'description' => 'The list of MaxCompute delivery tasks.', + 'count' => ['description' => 'The number of projects returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'total' => ['description' => 'The total number of projects that meet the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], + 'projects' => [ + 'description' => 'The list of projects that meet the query conditions.', 'type' => 'array', - 'items' => [ - 'description' => 'The details of the task configuration.', - '$ref' => '#/components/schemas/MaxComputeExport', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The project that meets the query conditions.', '$ref' => '#/components/schemas/project', 'example' => '不涉及', 'title' => ''], + 'example' => 'Not applicable', 'title' => '', - 'example' => '', ], ], + 'title' => '', 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"MaxComputeExport\\",\\n \\"description\\": \\"MaxComputeExport\\",\\n \\"displayName\\": \\"MaxComputeExport\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"my-logstore\\",\\n \\"roleArn\\": \\"acs:ram::1234567890:role/aliyunlogdefaultrole\\\\n\\",\\n \\"sink\\": {\\n \\"odpsEndpoint\\": \\"https://service.cn-hangzhou-intranet.maxcompute.aliyun-inc.com/api\\",\\n \\"odpsTunnelEndpoint\\": \\"https://dt.cn-hangzhou-intranet.maxcompute.aliyun-inc.com\\",\\n \\"odpsProject\\": \\"demo_project\\",\\n \\"odpsTable\\": \\"demo_table\\",\\n \\"odpsRolearn\\": \\"acs:ram::xxxxxxx\\",\\n \\"odpsAccessKeyId\\": \\"axxxxxxxxxxxb\\",\\n \\"odpsAccessSecret\\": \\"aaxxxxxxxxxxxxxxxxxxxxxbb\\",\\n \\"partitionTimeFormat\\": \\"%Y_%m_%d\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"fields\\": [\\n \\"\'f1\'\\"\\n ],\\n \\"partitionColumn\\": [\\n \\"\'p1\'\\"\\n ],\\n \\"filterInvalid\\": true,\\n \\"timeFormatType\\": \\"StrfTimeFormat\\",\\n \\"bufferInterval\\": \\"1800\\"\\n },\\n \\"fromTime\\": 1718380800,\\n \\"toTime\\": 1718390800\\n },\\n \\"createTime\\": 1718787534,\\n \\"lastModifiedTime\\": 1718787681,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListMaxComputeExports', - 'description' => '- The Host consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.'."\n" - ."\n" - .'- Create and obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List project information', + 'summary' => 'Lists project information that meets the specified conditions.', + 'description' => '### Operation description'."\n" + .'The Host consists of the project name and the Simple Log Service endpoint. You must specify the project in the Host.', + 'requestParamsDescription' => 'Request example:'."\n" ."\n" - .'An AccessKey pair for an Alibaba Cloud account has permissions to access all APIs. This poses a high security risk. We recommend that you create and use a Resource Access Management (RAM) user for API access or daily O\\&M. The RAM user must have the permissions to manage Simple Log Service resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" + .'GET /?projectName=ali-test-project&offset=0&size=10 HTTP/1.1'."\n" + .'Host:ali-test-project.ap-southeast-1.log.aliyuncs.com'."\n" + .'Content-Type:application/json.', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | Description |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ParameterInvalid | offset : offset pair is invalid | The value of the offset parameter is invalid. |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | An internal service invocation error occurred. |'."\n" ."\n" - .'- Identify the name and region of the project that contains the logs to query. For more information, see [Manage projects](~~48984~~).', + .'For more information, see [Common error codes](~~29013~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'ListMemoryStores' => [ - 'summary' => 'Queries the list of scmc databases.', - 'path' => '/memorystores', - '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' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '263587', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'testproject', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The starting position of the results to return. The default value is 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The number of rows per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'offset', + 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + ], 'schema' => [ 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'description' => 'Request ID', - 'type' => 'string', - 'title' => '', - 'example' => '', - ], - 'total' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'memoryStores' => [ + 'total' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'count' => ['description' => 'The number of tasks returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'results' => [ 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'createTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'name' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'count' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', + 'items' => ['description' => 'The details of the task configurations.', '$ref' => '#/components/schemas/S3Ingestion', 'title' => '', 'example' => ''], + 'description' => 'The details of the task configurations.', 'title' => '', 'example' => '', ], ], - 'description' => '', 'title' => '', + 'description' => 'Schema of Response', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'title' => 'ListS3Ingestions', + 'summary' => 'Lists S3 import tasks.', '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"}]', - 'title' => 'ListMemoryStores', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 3,\\n \\"count\\": 3,\\n \\"results\\": [\\n {\\n \\"name\\": \\"ingest-s3-123456\\",\\n \\"description\\": \\"s3 ingestion\\",\\n \\"displayName\\": \\"s3 ingestion\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"createTime\\": 1714360481,\\n \\"lastModifiedTime\\": 1714360481,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"awsRegion\\": \\"ap-northeast-1\\",\\n \\"awsAccessKey\\": \\"AKIxxxxxxxxxxYJE\\",\\n \\"awsAccessKeySecret\\": \\"123xxxxxxxxxxfjf\\",\\n \\"bucket\\": \\"s3bucket\\",\\n \\"compressionCodec\\": \\"none\\",\\n \\"encoding\\": \\"UTF-8\\",\\n \\"interval\\": \\"30m\\",\\n \\"pattern\\": \\".*\\",\\n \\"prefix\\": \\"prefix\\",\\n \\"awsUseSQS\\": false,\\n \\"awsSQSQueueUrl\\": \\"https://sqs.ap-northeast-1.amazonaws.com/123456788/chifan\\",\\n \\"useAwsSQSOnly\\": false,\\n \\"tagPackId\\": false,\\n \\"startTime\\": 1714274081,\\n \\"endTime\\": 1714360481,\\n \\"timeField\\": \\"__time__\\",\\n \\"timeFormat\\": \\"yyyy-MM-dd HH:mm:ss\\",\\n \\"timePattern\\": \\"[0-9]{0,2}\\\\\\\\/[0-9a-zA-Z]+\\\\\\\\/[0-9:,]+\\",\\n \\"timeZone\\": \\"GMT+08:00\\",\\n \\"processorId\\": \\"ingest-processor-1756802123-953901\\",\\n \\"endpoint\\": \\"s3.us-east-1.amazonaws.com\\",\\n \\"cloudFrontEndpoint\\": \\"dtfsb7voqy76q.cloudfront.net \\",\\n \\"cloudFrontToken\\": \\"@test-s3-access/ABS\\",\\n \\"useCloudFront\\": false,\\n \\"format\\": {\\n \\"key\\": \\"{\\\\\\"type\\\\\\": \\\\\\"line\\\\\\"}\\"\\n },\\n \\"advancedParameters\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', ], - 'ListMetricStores' => [ - 'summary' => 'Queries the list of Metricstores in a project. You can use fuzzy search to query the Metricstores by Metricstore name.', - 'path' => '/metricstores', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListSavedSearch' => [ + 'summary' => 'Queries a list of saved searches.', + 'path' => '/savedsearches', + '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', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-project'], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The start position of the query.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The line from which the query starts. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'default' => '0', 'required' => false, 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'default' => '500', - ], - ], - [ - 'name' => 'mode', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The type of the Metricstore. For example, you can set the parameter to standard to query Standard Metricstores.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Metricstore. Fuzzy search is supported. If you do not specify this parameter, all Metricstores are involved.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'metric_store', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '500', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'count' => [ - 'title' => '', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'total' => [ - 'title' => '', - 'description' => 'The total number of queried Metricstores.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'metricstores' => [ - 'title' => '', - 'description' => 'The names of the Metricstores.'."\n", + 'total' => ['description' => 'The total number of saved searches that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'count' => ['description' => 'The number of saved searches returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'savedsearchItems' => [ + 'description' => 'The saved searches.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The name of the Metricstore.'."\n", - 'type' => 'string', - 'example' => 'my_metric_store', - ], - 'example' => '', + 'items' => ['description' => 'The saved search.', '$ref' => '#/components/schemas/SavedSearch', 'example' => 'test-1', 'title' => ''], + 'example' => '[ "test-1", "test-2" ]', + 'title' => '', ], ], + 'description' => '', + 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 10,\\n \\"total\\": 100,\\n \\"metricstores\\": [\\n \\"my_metric_store\\"\\n ]\\n}","type":"json"}]', - 'title' => 'ListMetricStores', - 'description' => '* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 4,\\n \\"count\\": 4,\\n \\"savedsearchItems\\": [\\n {\\n \\"savedsearchName\\": \\"savedsearch-name\\",\\n \\"searchQuery\\": \\"status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5\\",\\n \\"logstore\\": \\"aliyun-test-logstore\\",\\n \\"topic\\": \\"topic-test\\",\\n \\"displayName\\": \\"Method\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListSavedSearch', + 'description' => '### Usage notes'."\n" ."\n" - .'* The information that is required to query metric data is obtained. The information includes the name of the project to which the metric data belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n", + .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'ListOSSExports' => [ - 'summary' => 'Queries the OSS shipping jobs in a specified project.', - 'path' => '/ossexports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListSavedSearch', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*'], + ], + ], + ], ], + ], + 'ListScheduledSQLs' => [ + 'summary' => 'Lists the Scheduled SQLs in a specified project.', + 'path' => '/scheduledsqls', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '203471', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '209929', + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'my-project'."\n", - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'."\n"], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The line number from which to start the query. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '0', - ], + 'schema' => ['description' => 'The line from which to start the query. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of jobs to return. The default value is 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries to return. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The number of entries to return. The default value is 10.', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], ], ], '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' => 'Response schema', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'The total number of OSS shipping jobs in the project.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '10', - ], - 'count' => [ - 'description' => 'The number of OSS shipping jobs returned.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '2', - ], + 'total' => ['description' => 'The total number of Scheduled SQL jobs in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'count' => ['description' => 'The number of Scheduled SQL jobs returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'results' => [ - 'description' => 'The list of OSS shipping jobs.', + 'description' => 'The list of Scheduled SQL jobs.', 'type' => 'array', - 'items' => [ - 'description' => 'The detailed configuration of the job.', - '$ref' => '#/components/schemas/OSSExport', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The configuration of the Scheduled SQL job.', '$ref' => '#/components/schemas/ScheduledSQL', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], + 'description' => '', + 'title' => '', 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"http://xxxxxxxx\\",\\n \\"bucket\\": \\"test-bucket\\",\\n \\"prefix\\": \\"prefixxxx/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::xxxxxxx\\",\\n \\"pathFormat\\": \\"%Y_%m_%d/good/bad\\",\\n \\"pathFormatType\\": \\"only support time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"json/parquet/csv/orc\\",\\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/gizp/zstd/none\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 123456789,\\n \\"toTime\\": 123456789\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListOSSExports', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"description\\": \\"This is a scheduled sql job\\",\\n \\"displayName\\": \\"This is a scheduled sql job\\",\\n \\"name\\": \\"test-scheduled-sql\\",\\n \\"schedule\\": {\\n \\"type\\": \\"FixedRate\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"+0800\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"60s\\"\\n },\\n \\"configuration\\": {\\n \\"script\\": \\"* | select *\\",\\n \\"sqlType\\": \\"searchQuery\\",\\n \\"destEndpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"destProject\\": \\"project-demo\\",\\n \\"sourceLogstore\\": \\"source-logstore-demo\\",\\n \\"destLogstore\\": \\"dest-logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"destRoleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"fromTimeExpr\\": \\"@m-1m\\",\\n \\"toTimeExpr\\": \\"@m\\",\\n \\"maxRunTimeInSeconds\\": 600,\\n \\"resourcePool\\": \\"enhanced\\",\\n \\"maxRetries\\": 20,\\n \\"fromTime\\": 1712592000,\\n \\"toTime\\": 0,\\n \\"dataFormat\\": \\"log2log\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714123644,\\n \\"lastModifiedTime\\": 1714123644,\\n \\"scheduleId\\": \\"e73f43732852064ad5d091914e39342f\\",\\n \\"status\\": \\"ENABLED\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListScheduledSQLs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'none', 'ramAction' => [ - 'action' => 'log:ListOSSExports', + 'action' => 'log:ListScheduledSQLs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], - 'ListOSSHDFSExports' => [ - 'summary' => 'Lists the OSS-HDFS export tasks in a specified project.', - 'path' => '/osshdfsexports', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListShards' => [ + 'summary' => 'Queries a list of shards in a Logstore.', + 'path' => '/logstores/{logstore}/shards', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '203484', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project'."\n", - 'title' => '', - ], - ], - [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which to start the query. Default value: 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return. Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - 'title' => '', - ], + 'in' => 'path', + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], - ], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'total' => [ - 'description' => 'The total number of OSS-HDFS export tasks in the project.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'count' => [ - 'description' => 'The number of OSS-HDFS export tasks returned in the current response.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - 'title' => '', - ], - 'results' => [ - 'description' => 'The list of OSS-HDFS export tasks.', - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the task configuration.', - '$ref' => '#/components/schemas/OSSExport', - 'title' => '', - 'example' => '', - ], - 'title' => '', - 'example' => '', - ], - ], + 'title' => '', + 'description' => 'The shards in the Logstore.', + 'type' => 'array', + 'items' => ['description' => 'The shard struct.', '$ref' => '#/components/schemas/shard', 'title' => '', 'example' => ''], 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 10,\\n \\"count\\": 2,\\n \\"results\\": [\\n {\\n \\"name\\": \\"myossexportjob\\",\\n \\"description\\": \\"This is a oss export\\",\\n \\"displayName\\": \\"This is a oss export\\",\\n \\"configuration\\": {\\n \\"logstore\\": \\"logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogdefaultrole\\",\\n \\"sink\\": {\\n \\"endpoint\\": \\"http://xxxxxxxx\\",\\n \\"bucket\\": \\"test-bucket\\",\\n \\"prefix\\": \\"prefixxxx/\\",\\n \\"suffix\\": \\".json\\",\\n \\"roleArn\\": \\"acs:ram::xxxxxxx\\",\\n \\"pathFormat\\": \\"%Y_%m_%d/good/bad\\",\\n \\"pathFormatType\\": \\"only support time\\",\\n \\"timeZone\\": \\"+0800\\",\\n \\"contentType\\": \\"json/parquet/csv/orc\\",\\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/gizp/zstd/none\\",\\n \\"bufferInterval\\": 300,\\n \\"bufferSize\\": 256,\\n \\"delaySec\\": 123,\\n \\"delaySeconds\\": 900\\n },\\n \\"fromTime\\": 123456789,\\n \\"toTime\\": 123456789\\n },\\n \\"createTime\\": 123456789,\\n \\"lastModifiedTime\\": 123456789,\\n \\"status\\": \\"RUNNING\\",\\n \\"scheduleId\\": \\"c7f01719d9feb105fc9d8df92af62010\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListOSSHDFSExports', + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shardID\\": 0,\\n \\"status\\": \\"readwrite\\",\\n \\"inclusiveBeginKey\\": \\"00000000000000000000000000000000\\",\\n \\"exclusiveEndKey\\": \\"8000000000000000000000000000000\\",\\n \\"serverIp\\": \\"203.0.113.10\\",\\n \\"createTime\\": 1524222931\\n }\\n]","type":"json"}]', + 'title' => 'ListShards', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ - 'operationType' => 'list', + 'operationType' => 'get', 'ramAction' => [ - 'action' => 'log:ListOSSHDFSExports', - 'authLevel' => 'operate', - 'actionConditions' => [], + 'action' => 'log:ListShards', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], ], ], ], ], ], - 'ListOSSIngestions' => [ - 'summary' => 'Lists OSS import tasks in a specified project.', - 'path' => '/ossingestions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListStoreViews' => [ + 'summary' => 'Queries datasets in a project.', + 'path' => '/storeviews', + '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' => '203123', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '208670', + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The project name.', - 'title' => '', - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of datasets to return. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'offset', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which the query starts. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '0', - ], + 'schema' => ['description' => 'The offset of the datasets to return. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of OSS import tasks to return.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'title' => '', - 'example' => '10'."\n", - ], + 'schema' => ['description' => 'The dataset name that is used for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'my_storeview', 'title' => ''], ], [ - 'name' => 'logstore', + 'name' => 'storeType', 'in' => 'query', 'schema' => [ + 'description' => 'The type of the datasets to return. By default, datasets are not filtered by type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- metricstore'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- logstore'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'type' => 'string', 'required' => false, - 'description' => '', + 'example' => 'logstore', 'title' => '', - 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], - ], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.', + 'description' => 'The datasets.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'The total number of OSS import tasks in the project.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '80', - ], - 'count' => [ - 'description' => 'The number of OSS import tasks returned in the current response.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'example' => '10', - ], - 'results' => [ - 'description' => 'A list of the OSS import tasks.', + 'count' => ['description' => 'The number of returned datasets.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'total' => ['description' => 'The total number of datasets in the project.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'storeviews' => [ + 'description' => 'The dataset names.', 'type' => 'array', - 'items' => [ - 'description' => 'The configuration of an OSS import task.', - '$ref' => '#/components/schemas/OSSIngestion', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The dataset name.', 'type' => 'string', 'example' => 'my_storeview', 'title' => ''], 'title' => '', 'example' => '', ], @@ -31964,11 +18659,9 @@ ], ], ], - '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/1h\\"\\n },\\n \\"configuration\\": {\\n \\"logstore\\": \\"myLogstore\\",\\n \\"source\\": {\\n \\"endpoint\\": \\"oss-cn-hangzhou.aliyuncs.com\\",\\n \\"bucket\\": \\"ossbucket\\",\\n \\"compressionCodec\\": \\"none,snappy,gzip\\",\\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' => 'ListOSSIngestions', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 100,\\n \\"total\\": 100,\\n \\"storeviews\\": [\\n \\"my_storeview\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListStoreViews', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -31977,115 +18670,102 @@ [ 'operationType' => 'list', 'ramAction' => [ - 'action' => 'log:ListOSSIngestions', + 'action' => 'log:ListStoreViews', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], - 'ListProject' => [ - 'summary' => 'Lists projects that meet the specified criteria.', - 'path' => '/', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTagResources' => [ + 'summary' => 'Queries a list of tags for one or more resources. You can query tags for resources by resource type or filter resources by tag. Each tag is a key-value pair.', + 'path' => '/tags', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => 'The name of the project. Fuzzy queries are supported.', + 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'- project'."\n" + ."\n" + .'- logstore'."\n" + ."\n" + .'- dashboard'."\n" + ."\n" + .'- machinegroup'."\n" + ."\n" + .'- logtailconfig', + 'enumValueTitles' => ['project' => 'project'], 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which the query starts. The default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'default' => '0', + 'required' => true, + 'example' => 'project', 'title' => '', - 'example' => '0', ], ], [ - 'name' => 'size', + 'name' => 'resourceId', 'in' => 'query', + 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The number of rows to return on each page for a paged query. The default value is 100. A maximum of 500 projects can be returned.', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The IDs of the resources whose tags you want to query. You must specify at least one of resourceId and tags.', + 'type' => 'array', + 'items' => ['title' => 'resource id。', 'description' => 'The resource ID. In this example, a Logstore is used. projectName specifies the project name. # is used to concatenate strings. logstore specifies the Logstore name.'."\n" + ."\n" + .'- project: projectName'."\n" + ."\n" + .'- logstore: projectName#logstore'."\n" + ."\n" + .'- dashboard: projectName#dashboard'."\n" + ."\n" + .'- machinegroup: projectName#machinegroup'."\n" + ."\n" + .'- logtailconfig: projectName#logtailconfig', 'type' => 'string', 'example' => 'ali-test-project', 'required' => false], 'required' => false, - 'default' => '500', - 'example' => '10', + 'maxItems' => 1, + 'example' => '', ], ], [ - 'name' => 'resourceGroupId', + 'name' => 'tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the resource group.', - 'type' => 'string', - 'required' => false, 'title' => '', - 'example' => 'rg-aekzf******sxby', - ], - ], - [ - 'name' => 'fetchQuota', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - 'description' => 'Specifies whether to retrieve the quota information for the project.', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', + 'description' => 'The tags that you want to use to filter resources based on exact match. Each tag is a key-value pair. You must specify at least one of resourceId and tags.'."\n" + ."\n" + .'You can enter up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the tag that you want to use to filter resources. For example, if you set the key to `"test-key"`, only resources to which the key is added are returned.\\`\\`', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], + 'value' => ['description' => 'The value of the tag that you want to use to filter resources. If you set the value to null, resources are filtered based only on the key of the tag.', 'type' => 'string', 'example' => 'value1', 'title' => '', 'required' => false], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'title' => '', - 'example' => 'false', + 'required' => false, + 'maxItems' => 20, + 'example' => '', ], ], ], @@ -32093,97 +18773,74 @@ 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' => 'The list of projects.', + 'title' => 'Schema of Response', + 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ - 'count' => [ - 'description' => 'The number of projects returned on the current page.', - 'type' => 'integer', - 'format' => 'int64', - 'title' => '', - 'example' => '2', - ], - 'total' => [ - 'description' => 'The total number of projects that meet the query criteria.', - 'type' => 'integer', - 'format' => 'int64', + 'nextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'tagResources' => [ 'title' => '', - 'example' => '11', - ], - 'projects' => [ - 'description' => 'The list of projects that meet the query criteria.', + 'description' => 'The returned tags.', 'type' => 'array', 'items' => [ - 'description' => 'A project that meets the query criteria.', - '$ref' => '#/components/schemas/project', 'title' => '', - 'example' => '不涉及', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'resourceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'example' => 'ali-test-project', 'title' => ''], + 'resourceType' => ['description' => 'The type of the resource.', 'type' => 'string', 'example' => 'project', 'title' => ''], + 'tagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'tagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'example' => '', ], - 'example' => '不涉及', - 'title' => '', + 'example' => '', ], ], - 'title' => '', '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' => 'ListProject', - 'description' => '### API description'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"nextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"tagResources\\": [\\n {\\n \\"resourceId\\": \\"ali-test-project\\",\\n \\"resourceType\\": \\"project\\",\\n \\"tagKey\\": \\"key1\\",\\n \\"tagValue\\": \\"value1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListTagResources', + 'description' => '### Usage notes'."\n" ."\n" - .'The host consists of a project name and a Simple Log Service endpoint. You must specify the project in the host.', - 'requestParamsDescription' => 'Sample request:'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\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" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n" + ."\n" + .'- For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" + ."\n" + .'### Authentication resources'."\n" + ."\n" + .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + ."\n" + .'| Action | Resource |'."\n" + .'| :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `log:ListTagResources` | The resource format varies based on the resource type.-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -32192,914 +18849,642 @@ [ '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}'], ], ], ], ], - 'translator' => 'machine', ], - 'ListS3Ingestions' => [ - 'summary' => 'Lists S3 import tasks.', - 'path' => '/s3ingestions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'MergeShard' => [ + 'summary' => 'Merges adjacent read/write shards.', + 'path' => '/logstores/{logstore}/shards/{shard}?action=merge', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - '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' => [ - 'type' => 'string', - 'description' => 'The name of the project.', - 'required' => false, - 'title' => '', - 'example' => 'testproject', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => 'The starting position of the results to return. The default value is 0.', - 'required' => false, - 'title' => '', - 'example' => '0', - ], + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['description' => 'The logstore name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore', 'title' => ''], ], [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => 'The number of rows per page for a paged query.', - 'required' => false, - 'title' => '', - 'example' => '100', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'description' => 'The name of the Logstore.', - 'required' => false, - 'title' => '', - 'example' => 'test', - ], + 'name' => 'shard', + 'in' => 'path', + 'schema' => ['description' => 'The shard ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => [ - 'type' => 'object', - 'properties' => [ - 'total' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'The total number of entries that match the query.', - 'title' => '', - 'example' => '3', - ], - 'count' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'The number of tasks returned on the current page.', - 'title' => '', - 'example' => '3', - ], - 'results' => [ - 'type' => 'array', - 'items' => [ - '$ref' => '#/components/schemas/S3Ingestion', - 'description' => 'The details of the task configurations.', - 'title' => '', - 'example' => '', - ], - 'description' => 'The details of the task configurations.', - 'title' => '', - 'example' => '', - ], - ], + 'description' => 'The data structure of the shard.', + 'type' => 'array', + 'items' => ['description' => 'An array that consists of three shard elements. The first element is the shard after the merge. The other two elements are the shards before the merge.', '$ref' => '#/components/schemas/shard', 'title' => '', 'example' => ''], 'title' => '', - 'description' => 'Schema of Response', 'example' => '', ], ], ], - 'title' => 'ListS3Ingestions', + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shardID\\": 0,\\n \\"status\\": \\"readwrite\\",\\n \\"inclusiveBeginKey\\": \\"00000000000000000000000000000000\\",\\n \\"exclusiveEndKey\\": \\"8000000000000000000000000000000\\",\\n \\"serverIp\\": \\"203.0.113.10\\",\\n \\"createTime\\": 1524222931\\n }\\n]","type":"json"}]', + 'title' => 'MergeShard', + 'description' => '### API description'."\n" + ."\n" + .'- The host consists of the project name and the Simple Log Service endpoint. You must specify the project in the host.'."\n" + ."\n" + .'- Each shard has a range, which is a left-closed, right-open MD5 interval of `[BeginKey,EndKey)`. The status of a shard can be readwrite or readonly. You can split and merge shards. For more information, see [Shards](~~28976~~).'."\n" + ."\n" + .'- You must have an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'An AccessKey pair for an Alibaba Cloud account has access permissions for all APIs. This poses a high security threat. We recommend that you create and use a RAM user for API calls or routine O\\&M. The RAM user must have the required permissions to manage Simple Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" + ."\n" + .'- You must have the project name, region, and Logstore name for the logs that you want to query. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" + .'| 400 | ParameterInvalid| invalid shard id.| 无效Shard ID。 |'."\n" + .'| 400 | ParameterInvalid| can not merge the last shard. | 无效merge。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[错误码对照表](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - '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/1h\\"\\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' => 'Queries a list of saved searches.', - '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' => 'Activates Simple Log Service. You must use the endpoint for Simple Log Service only in the China (Shanghai) or Singapore region.', + 'path' => '/slsservice', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-project', - ], - ], - [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which the query starts. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'default' => '0', - 'title' => '', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of entries per page. Maximum value: 500.'."\n", - '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' => 'The total number of saved searches that meet the query conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - 'title' => '', - ], - 'count' => [ - 'description' => 'The number of saved searches returned on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - 'title' => '', - ], - 'savedsearchItems' => [ - 'description' => 'The saved searches.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The saved search.'."\n", - 'example' => 'test-1', - '$ref' => '#/components/schemas/SavedSearch', - 'title' => '', - ], - 'example' => '[ "test-1", "test-2" ]', - 'title' => '', - ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], ], - 'description' => '', - 'title' => '', - 'example' => '', ], ], ], - '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' => 'ListSavedSearch', - 'description' => '### Usage notes'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'OpenSlsService', + 'description' => 'An AccessKey pair is required. For more information, see[AccessKey pair](~~29009~~).'."\n" ."\n" - .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations, which is high risk. We recommend that you create and use a RAM user to call API operations or perform routine O\\&M. The RAM user must have permissions to manage Simple Log Service resources. For more information, see[Create a RAM user and authorize the RAM user](~~47664~~).', + 'requestParamsDescription' => 'You must use the endpoint for Simple Log Service only in the China (Shanghai) or Singapore region.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - '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' => 'Lists the Scheduled SQLs in a specified project.', - 'path' => '/scheduledsqls', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'PullLogs' => [ + 'summary' => 'Call the PullLogs operation to retrieve log data from a specified cursor position. This operation retrieves raw logs. To query or analyze logs, call the GetLogsV2 operation.', + 'path' => '/logstores/{logStore}/shards/{shardId}?type=log', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - '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' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-project'."\n", - ], + 'in' => 'path', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ - 'name' => 'offset', + 'name' => 'logStore', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'."\n"], + ], + [ + 'name' => 'shardId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the shard in the Logstore.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], + ], + [ + 'name' => 'cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'The line from which to start the query. The default value is 0.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - 'title' => '', - ], + 'schema' => ['description' => 'The cursor that specifies the start position from which to read data.', 'type' => 'string', 'required' => true, 'example' => 'MTQ0NzMyOTQwMTEwMjEzMDkwNA', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'count', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return. The default value is 10.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'title' => '', - ], + 'schema' => ['description' => 'The number of LogGroups to return. The value must be an integer from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '1000', 'minimum' => '1', 'title' => '', 'example' => '1000'], ], [ - 'name' => 'logstore', + 'name' => 'end_cursor', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The cursor that specifies the end position at which to stop reading data.', 'type' => 'string', 'example' => 'MTU1NzA1NzQwMTEwMjEzMDkwCg', 'title' => '', 'required' => false], + ], + [ + 'name' => 'query', + 'in' => 'query', + 'schema' => ['description' => 'The filter statement in the Structured Process Language (SPL) syntax. For more information, see [SPL instructions](~~2536530~~).', 'type' => 'string', 'example' => '* | where userId=\'123\'', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Accept-Encoding', + 'in' => 'header', + 'schema' => ['description' => 'The compression format of the data that the server returns. Only the lz4 format is supported.', 'type' => 'string', 'example' => 'lz4', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ - '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' => ['description' => 'The compressed data in protobuf format.', '$ref' => '#/components/schemas/LogGroupList', 'title' => '', 'example' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"LogGroupList\\": [\\n {\\n \\"Topic\\": \\"topic-test\\",\\n \\"Source\\": \\"192.1.1.1\\",\\n \\"LogTags\\": [\\n {\\n \\"Key\\": \\"key-test\\",\\n \\"Value\\": \\"value-test\\"\\n }\\n ],\\n \\"LogItems\\": [\\n {\\n \\"Time\\": 1690254376,\\n \\"Contents\\": [\\n {\\n \\"Key\\": \\"key-test\\",\\n \\"Value\\": \\"value-test\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'PullLogs', + 'description' => '>'."\n" + ."\n" + .'This operation is not supported by the OpenAPI SDK. Use the [Simple Log Service SDK](~~29063~~).'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- Specify a shard to retrieve logs.'."\n" + ."\n" + .'- This operation supports reading data in only the [Protocol Buffer](~~29055~~) format.'."\n" + ."\n" + .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. Specify the project in the Host.', + 'requestParamsDescription' => 'The following request headers are specific to the PullLogs operation:'."\n" + ."\n" + .'- Accept: application/x-protobuf'."\n" + ."\n" + .'- Accept-Encoding: lz4'."\n" + ."\n" + .'The value of Accept-Encoding can be lz4, deflate, or double quotation marks ("").'."\n" + ."\n" + .'**Request example:**'."\n" + ."\n" + .'```'."\n" + .'GET /logstores/sls-test-logstore/shards/0?type=logs&cursor=MTQ0NzMyOTQwMTEwMjEzMDkwNA&count=1000 HTTP/1.1'."\n" + .'Host:ali-test-project.cn-hangzhou.log.aliyuncs.com'."\n" + .'Content-Type:application/json'."\n" + .'```', + 'responseParamsDescription' => 'The following response headers are specific to the PullLogs operation:'."\n" + ."\n" + .'- x-log-cursor: The cursor for the next log to be read.'."\n" + ."\n" + .'- x-log-end-of-cursor: The cursor of the last log that is read in the current request.'."\n" + ."\n" + .'- x-log-count: The number of logs returned.'."\n" + ."\n" + .'For information about the common response headers of Simple Log Service API operations, see [Common response headers](~~29011~~).'."\n" + ."\n" + .'The response body contains data that is serialized in the protobuf format. The data may be compressed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'PutAnnotationData' => [ + 'summary' => 'Stores annotation data in a dataset.', + 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => [], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'datasetId', + 'in' => 'path', + 'schema' => ['description' => 'The unique identifier of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], + ], + [ + 'name' => 'annotationdataId', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the data.', 'type' => 'string', 'required' => false, 'example' => '2156d560fc7c01420542df92cd6365ds', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'total' => [ - 'description' => 'The total number of Scheduled SQL jobs in the project.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - 'title' => '', - ], - 'count' => [ - 'description' => 'The number of Scheduled SQL jobs returned.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - 'title' => '', - ], - 'results' => [ - 'description' => 'The list of Scheduled SQL jobs.', + 'rawLog' => [ + 'description' => 'The raw log data.', 'type' => 'array', 'items' => [ - 'description' => 'The configuration of the Scheduled SQL job.', - '$ref' => '#/components/schemas/ScheduledSQL', + 'description' => 'The log data, which is a map of key-value pairs.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The key and value of a raw log entry. Both are strings.', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "time": "1694761550",'."\n" + .' "cnt": "45416",'."\n" + .' "cnt2": "12454"'."\n" + .' }'."\n" + .']', 'title' => ''], 'title' => '', 'example' => '', ], + 'required' => false, 'title' => '', 'example' => '', ], + 'mlDataParam' => ['description' => 'The data struct.', '$ref' => '#/components/schemas/MLDataParam', 'required' => false, 'title' => '', 'example' => ''], ], - 'description' => '', + 'required' => false, 'title' => '', 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"total\\": 80,\\n \\"count\\": 10,\\n \\"results\\": [\\n {\\n \\"description\\": \\"This is a scheduled sql job\\",\\n \\"displayName\\": \\"This is a scheduled sql job\\",\\n \\"name\\": \\"test-scheduled-sql\\",\\n \\"schedule\\": {\\n \\"type\\": \\"Cron\\",\\n \\"cronExpression\\": \\"0/5 * * * *\\",\\n \\"runImmediately\\": false,\\n \\"timeZone\\": \\"\\\\\\"+0800\\\\\\"\\",\\n \\"delay\\": 4,\\n \\"interval\\": \\"1m/1h\\"\\n },\\n \\"configuration\\": {\\n \\"script\\": \\"* | select *\\",\\n \\"sqlType\\": \\"searchQuery\\",\\n \\"destEndpoint\\": \\"cn-hangzhou-intranet.log.aliyuncs.com\\",\\n \\"destProject\\": \\"project-demo\\",\\n \\"sourceLogstore\\": \\"source-logstore-demo\\",\\n \\"destLogstore\\": \\"dest-logstore-demo\\",\\n \\"roleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"destRoleArn\\": \\"acs:ram::123456789:role/aliyunlogetlrole\\",\\n \\"fromTimeExpr\\": \\"@m-1m\\",\\n \\"toTimeExpr\\": \\"@m\\",\\n \\"maxRunTimeInSeconds\\": 600,\\n \\"resourcePool\\": \\"enhanced\\",\\n \\"maxRetries\\": 20,\\n \\"fromTime\\": 1712592000,\\n \\"toTime\\": 0,\\n \\"dataFormat\\": \\"log2log\\",\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"createTime\\": 1714123644,\\n \\"lastModifiedTime\\": 1714123644,\\n \\"scheduleId\\": \\"e73f43732852064ad5d091914e39342f\\",\\n \\"status\\": \\"ENABLED\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListScheduledSQLs', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [ - [ - 'operationType' => 'none', - 'ramAction' => [ - 'action' => 'log:ListScheduledSQLs', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + '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' => 'Queries a list of shards in a Logstore.', - 'path' => '/logstores/{logstore}/shards', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PutAnnotationData', + 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'PutConsumeProcessor' => [ + 'summary' => 'Creates or updates a consume processor.', + 'path' => '/consumeprocessors/{processorName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'logstore', + 'name' => 'processorName', 'in' => 'path', + 'schema' => ['description' => 'The ID of the consume processor.', 'type' => 'string', 'required' => true, 'example' => 'consume-processor-1', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'filter-get-request', 'title' => ''], + 'description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Filter only GET requests', 'required' => false, 'title' => ''], + 'configuration' => ['description' => 'The configuration of the consume processor.', 'required' => true, '$ref' => '#/components/schemas/ConsumeProcessorConfiguration', 'title' => '', 'example' => ''], + ], + 'required' => false, 'title' => '', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => '', - 'description' => 'The shards in the Logstore.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The shard struct.'."\n", - '$ref' => '#/components/schemas/shard', - 'example' => '', + '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'], ], - 'example' => '', ], ], ], - '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' => 'ListShards', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PutConsumeProcessor', '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' => [], + 'translator' => 'manual', ], - 'ListStoreViews' => [ - 'summary' => 'Queries datasets in a project.', - 'path' => '/storeviews', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'PutIngestProcessor' => [ + 'summary' => 'Creates or modifies an ingest processor.', + '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of datasets to return. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'title' => '', - ], - ], - [ - 'name' => 'offset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The offset of the datasets to return. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'title' => '', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dataset name that is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my_storeview', - 'title' => '', - ], + 'name' => 'processorName', + 'in' => 'path', + 'schema' => ['description' => 'The identifier of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'parse-nginx-log'], ], [ - 'name' => 'storeType', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The type of the datasets to return. By default, datasets are not filtered by type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* metricstore'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* logstore'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'metricstore' => 'metricstore', - 'logstore' => 'logstore', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => 'The display name of the ingest processor.', 'type' => 'string', 'example' => 'Nginx log parsing', 'required' => true, 'title' => ''], + 'description' => ['description' => 'The description of the ingest processor.', 'type' => 'string', 'example' => 'Extract fields from Nginx logs using regex.', 'title' => '', 'required' => false], + 'configuration' => ['description' => 'The configuration of the ingest processor.', 'required' => true, '$ref' => '#/components/schemas/IngestProcessorConfiguration', 'title' => '', 'example' => ''], ], - 'example' => 'logstore', + 'required' => false, 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The datasets.'."\n", - 'type' => 'object', - 'properties' => [ - 'count' => [ - 'description' => 'The number of returned datasets.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], - 'total' => [ - 'description' => 'The total number of datasets in the project.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'title' => '', - ], - 'storeviews' => [ - 'description' => 'The dataset names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The dataset name.'."\n", - 'type' => 'string', - 'example' => 'my_storeview', - 'title' => '', - ], - 'title' => '', - 'example' => '', - ], + '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'], ], - 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"count\\": 100,\\n \\"total\\": 100,\\n \\"storeviews\\": [\\n \\"my_storeview\\"\\n ]\\n}","type":"json"}]', - 'title' => 'ListStoreViews', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PutIngestProcessor', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'list', - 'ramAction' => [ - 'action' => 'log:ListStoreViews', - 'authLevel' => 'operate', - 'actionConditions' => [], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'translator' => 'manual', ], - 'ListTagResources' => [ - 'summary' => 'Queries a list of tags for one or more resources. You can query tags for resources by resource type or filter resources by tag. Each tag is a key-value pair.', - 'path' => '/tags', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + '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' => '', - 'description' => 'The type of the resource. Valid values:'."\n" - ."\n" - .'* project'."\n" - .'* logstore'."\n" - .'* dashboard'."\n" - .'* machinegroup'."\n" - .'* logtailconfig'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'project' => 'project', - ], - 'example' => 'project', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ - 'name' => 'resourceId', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '', - 'description' => 'The IDs of the resources whose tags you want to query. You must specify at least one of resourceId and tags.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'resource id。', - 'description' => 'The resource ID. In this example, a Logstore is used. projectName specifies the project name. # is used to concatenate strings. logstore specifies the Logstore name.'."\n" - ."\n" - .'* project: projectName'."\n" - .'* logstore: projectName#logstore'."\n" - .'* dashboard: projectName#dashboard'."\n" - .'* machinegroup: projectName#machinegroup'."\n" - .'* logtailconfig: projectName#logtailconfig'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], - 'required' => false, - 'maxItems' => 1, - 'example' => '', - ], + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], ], [ - 'name' => 'tags', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', 'style' => 'json', 'schema' => [ - 'title' => '', - 'description' => 'The tags that you want to use to filter resources based on exact match. Each tag is a key-value pair. You must specify at least one of resourceId and tags.'."\n" - ."\n" - .'You can enter up to 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '', - 'description' => 'The key of the tag that you want to use to filter resources. For example, if you set the key to `"test-key"`, only resources to which the key is added are returned.``'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '', - 'description' => 'The value of the tag that you want to use to filter resources. If you set the value to null, resources are filtered based only on the key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], + 'type' => 'object', + 'properties' => [ + 'clientIpHeaders' => [ + 'type' => 'array', + 'items' => ['description' => 'A header key, such as `X-Forwarded-For`, used to extract the client IP address. The key name is case-insensitive.', 'type' => 'string', 'required' => false, 'example' => 'X-Forwarded-For', 'title' => ''], + 'title' => '', + 'description' => 'Specifies a list of header keys from which to extract the client IP address during log ingestion. Simple Log Service (SLS) searches these headers in the specified order and uses the first valid IP address that it finds. The key names are case-insensitive, but their order is significant. To use this feature, you must also enable the `appendMeta` setting for the Logstore. This setting adds the extracted IP address as a log tag.', + 'required' => false, + 'example' => '', ], - 'required' => false, - 'title' => '', - 'example' => '', ], 'required' => false, - 'maxItems' => 20, + 'title' => '', + 'description' => 'The request body.', 'example' => '', ], ], @@ -33107,742 +19492,484 @@ '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' => 'Schema of Response', - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'nextToken' => [ - 'title' => '', - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'tagResources' => [ - 'title' => '', - 'description' => 'The returned tags.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'resourceId' => [ - 'title' => '', - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'example' => 'ali-test-project', - ], - 'resourceType' => [ - 'title' => '', - 'description' => 'The type of the resource.'."\n", - 'type' => 'string', - 'example' => 'project', - ], - 'tagKey' => [ - 'title' => '', - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'tagValue' => [ - 'title' => '', - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - 'example' => '', - ], - 'example' => '', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], - 'example' => '', ], ], ], - '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' => 'ListTagResources', - 'description' => '### Usage notes'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'PutLogStoreConfig', + 'summary' => 'Updates the configuration of a Logstore.', + 'description' => '- The `Host` in the request header must contain both the `Project` name and the Simple Log Service (SLS) endpoint.'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- This operation requires an AccessKey. For more information, see [Access Key](~~29009~~).'."\n" ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + .'An AccessKey for an Alibaba Cloud account grants full access to all APIs and poses a high security risk. We strongly recommend that you create and use a RAM user for API access and daily operations. The RAM user must have the necessary permissions to operate SLS resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n" - .'* For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" + .'- Identify the names of the target `Project`, `Region`, and `Logstore`. For more information, see [Manage Project](~~48984~~) and [Manage Logstore](~~48990~~).'."\n" ."\n" - .'### Authentication resources'."\n" + .'### Permissions'."\n" ."\n" - .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + .'To grant a RAM user or RAM role permission to call this operation, add the Action and Resource in the following table to a permission policy in Resource Access Management (RAM).'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:ListTagResources`|The resource format varies based on the resource type.\\-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}`|', + .'| Actions | Resource |'."\n" + .'| :---------------------- | :--------------------------------------------------------------------------------- |'."\n" + .'| `log:PutLogStoreConfig` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', + 'requestParamsDescription' => 'The request body must include at least one configuration parameter.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'PutLogs' => [ + 'summary' => 'Writes log data to a specified logstore.', + 'path' => '/logstores/{logstore}/shards/lb', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - '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}', - ], - ], - ], + 'AK' => [], ], ], - ], - 'MergeShard' => [ - 'summary' => 'Merges adjacent read/write shards.', - 'path' => '/logstores/{logstore}/shards/{shard}?action=merge', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + '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' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The project name.', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', + 'schema' => ['description' => 'The name of the logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], + ], + [ + 'name' => 'x-log-compresstype', + 'in' => 'header', 'schema' => [ - 'description' => 'The Logstore name.', + 'description' => 'The compression type of the logs. Valid values: lz4 and gzip.', 'type' => 'string', 'required' => true, + 'example' => 'lz4', + 'default' => 'lz4', + 'enum' => ['lz4'], 'title' => '', - 'example' => 'ali-test-logstore', ], ], [ - 'name' => 'shard', - 'in' => 'path', - 'schema' => [ - 'description' => 'The shard ID.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'title' => '', - 'example' => '3', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The compressed log data in protobuf format.', '$ref' => '#/components/schemas/LogGroup', 'title' => '', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'The data structure of the shard.', - 'type' => 'array', - 'items' => [ - 'description' => 'An array that consists of three shard elements. The first element is the shard after the merge. The other two elements are the shards before the merge.', - '$ref' => '#/components/schemas/shard', - 'title' => '', - 'example' => '', + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], ], - 'title' => '', - 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shardID\\": 0,\\n \\"status\\": \\"readwrite\\",\\n \\"inclusiveBeginKey\\": \\"00000000000000000000000000000000\\",\\n \\"exclusiveEndKey\\": \\"8000000000000000000000000000000\\",\\n \\"serverIp\\": \\"203.0.113.10\\",\\n \\"createTime\\": 1524222931\\n }\\n]","type":"json"}]', - 'title' => 'MergeShard', - 'description' => '### API description'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PutLogs', + 'description' => '> - The OpenAPI SDK does not support this operation. Use the [Simple Log Service (SLS) SDK](~~29063~~) instead.'."\n" ."\n" - .'- The host consists of the project name and the Simple Log Service endpoint. You must specify the project in the host.'."\n" + .'- The service checks the format of log data for each PutLogs request. If any log entry is invalid, the entire request fails and no logs are written.'."\n" ."\n" - .'- Each shard has a range, which is a left-closed, right-open MD5 interval of `[BeginKey,EndKey)`. The status of a shard can be readwrite or readonly. You can split and merge shards. For more information, see [Shards](~~28976~~).'."\n" + .'- This operation supports only log data in [protobuf format](~~29055~~). The log data is structured as a LogGroup.'."\n" ."\n" - .'- You must have an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Logs can be written in two modes:'."\n" ."\n" - .'An AccessKey pair for an Alibaba Cloud account has access permissions for all APIs. This poses a high security threat. We recommend that you create and use a RAM user for API calls or routine O\\&M. The RAM user must have the required permissions to manage Simple Log Service resources. For more information, see [Create a RAM user and grant permissions](~~47664~~).'."\n" + .' - LoadBalance mode: Data is automatically written to all writable shards in a logstore. This method provides high availability and is suitable for data consumption scenarios that do not require a specific order. Request syntax:'."\n" ."\n" - .'- You must have the project name, region, and Logstore name for the logs that you want to query. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" - .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" - .'| 400 | ParameterInvalid| invalid shard id.| 无效Shard ID。 |'."\n" - .'| 400 | ParameterInvalid| can not merge the last shard. | 无效merge。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + .' ```plaintext'."\n" + .' POST /logstores/logstoreName/shards/lb HTTP/1.1'."\n" + .' Authorization: LOG yourAccessKeyId:yourSignature'."\n" + .' Content-Type: application/x-protobuf'."\n" + .' Content-Length: Content Length'."\n" + .' Content-MD5: Content MD5'."\n" + .' Date: GMT Date'."\n" + .' Host: ProjectName.Endpoint'."\n" + .' x-log-apiversion: 0.6.0'."\n" + .' x-log-bodyrawsize: BodyRawSize'."\n" + .' x-log-compresstype: lz4'."\n" + .' x-log-signaturemethod: hmac-sha1'."\n" + .' '."\n" + .' ```'."\n" ."\n" - .'更多信息，请参见[错误码对照表](~~29013~~)。', + .' - KeyHash mode: Add a key parameter to the URL to determine which shard receives the data. This parameter is optional. If you do not set this parameter, the system automatically switches to the load balancing mode. For example, pin a producer, such as an instance, to a specific shard based on its name hash. This ensures that data written to and consumed from the shard is strictly ordered. During merge and split operations, a key is associated with only one shard at any given time. Request syntax:'."\n" + ."\n" + .' ```plaintext'."\n" + .' POST /logstores/logstoreName/shards/route?key=14d2f850ad6ea48e46e4547edbbb27e0'."\n" + .' Authorization: LOG yourAccessKeyId:yourSignature'."\n" + .' Content-Type: application/x-protobuf'."\n" + .' Content-Length: Content Length'."\n" + .' Content-MD5: Content MD5'."\n" + .' Date: GMT Date'."\n" + .' Host: ProjectName.Endpoint'."\n" + .' x-log-apiversion: 0.6.0'."\n" + .' x-log-bodyrawsize: BodyRawSize'."\n" + .' x-log-compresstype: lz4'."\n" + .' x-log-signaturemethod: hmac-sha1'."\n" + .' '."\n" + .' ```'."\n" + ."\n" + .'- The maximum size of raw logs for each PutLogs request is 10 MB. The Value of each log in a log group must not exceed 1 MB. Older SDK versions may have different limits. Upgrade to the latest SDK version.'."\n" + ."\n" + .'- SLS provides examples of how to use PutLogs with the Java and Python SDKs.'."\n" + ."\n" + .'## Protobuf data'."\n" + ."\n" + .'This section describes the fields for compressed log data in protobuf format. For more information, see [Data model](~~29054~~) and [Data encoding](~~29055~~).'."\n" + ."\n" + .'- Log'."\n" + ."\n" + .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" + .'| ------------- | ------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| Time | Integer | Yes | The time of the log. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 1970-1-1 00:00:00 UTC. |'."\n" + .'| Contents | List | Yes | A list of log fields. The list must contain at least one element. For the element type, see the Content table below. |'."\n" + ."\n" + .'- Content'."\n" + ."\n" + .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" + .'| ------------- | ------------- | ------------ | --------------------------------------------- |'."\n" + .'| Key | String | Yes | The custom key name. |'."\n" + .'| Value | String | Yes | The value that corresponds to the custom key. |'."\n" + ."\n" + .'- LogTag'."\n" + ."\n" + .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" + .'| ------------- | ------------- | ------------ | --------------------------------------------- |'."\n" + .'| Key | String | Yes | The custom key name. |'."\n" + .'| Value | String | Yes | The value that corresponds to the custom key. |'."\n" + ."\n" + .'- LogGroup'."\n" + ."\n" + .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" + .'| ------------- | ------------- | ------------ | --------------------------------------------------------------------------------------------- |'."\n" + .'| Logs | List | Yes | A list of logs. For each element, see the Log table. |'."\n" + .'| Topic | String | No | The topic of the logs. Use this custom field to distinguish log data with different features. |'."\n" + .'| Source | String | No | The source of the logs, such as the IP address of the machine that generated the logs. |'."\n" + .'| LogTags | List | Yes | A list of log tags. For each element, see the LogTag table. |', + 'requestParamsDescription' => '**Request headers**'."\n" + ."\n" + .'For information about the common request headers of SLS APIs, see [Common request headers](~~29010~~).'."\n" + ."\n" + .'**Request example**'."\n" + ."\n" + .'```'."\n" + .'POST /logstores/sls-test-logstore/shards/lb'."\n" + .'{'."\n" + .' "Content-Length": 118,'."\n" + .' "Content-Type":"application/x-protobuf",'."\n" + .' "x-log-bodyrawsize":1356,'."\n" + .' "Host": "ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com",'."\n" + .' "Content-MD5":"6554BD042149C844761C2C094A8FECCE",'."\n" + .' "Date":"Thu, 12 Nov 2015 06:54:26 GMT",'."\n" + .' "x-log-apiversion": "0.6.0",'."\n" + .' "x-log-compresstype":"lz4"'."\n" + .' "x-log-signaturemethod": "hmac-sha1",'."\n" + .' "Authorization":"LOG yourAccessKeyId:yourSignature"'."\n" + .'}'."\n" + .''."\n" + .'```', + 'responseParamsDescription' => '**Response headers**'."\n" + ."\n" + .'The PutLogs operation does not have specific response headers. For information about the common response headers of SLS APIs, see [Common response headers](~~29011~~).'."\n" + ."\n" + .'**Response elements**'."\n" + ."\n" + .'An HTTP status code of 200 indicates that the request was successful. No response elements are returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - '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}', - ], - ], - ], - ], - ], - 'translator' => 'machine', + 'ramActions' => [], ], - 'OpenSlsService' => [ - 'summary' => 'Activates Simple Log Service. You must use the endpoint for Simple Log Service only in the China (Shanghai) or Singapore region.', - 'path' => '/slsservice', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'PutProjectPolicy' => [ + 'summary' => 'Creates a project access 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' => 'The request parameters, which define the authorization policy.', 'type' => 'string', 'required' => false, 'example' => '{ "Version": "1", "Statement": [{ "Action": ["log:PostLogStoreLogs"], "Resource": "acs:log:*:*:project/exampleproject/*", "Effect": "Deny", "Condition": { "StringNotLike": { "acs:SourceVpc": ["vpc-*"] } } }] }'], + ], + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], ], - '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' => 'OpenSlsService', - 'description' => '该接口需要您已创建并获取AccessKey。更多信息，请参见[访问密钥](~~29009~~)。'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PutProjectPolicy', + 'description' => '###'."\n" ."\n" - .' 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作，请参见[创建RAM用户及授权](~~47664~~)。', - 'requestParamsDescription' => 'You must use the endpoint for Simple Log Service only in the China (Shanghai) or Singapore region.'."\n", - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - 'PullLogs' => [ - 'summary' => 'Call the PullLogs operation to retrieve log data from a specified cursor position. This operation retrieves raw logs. To query or analyze logs, call the GetLogsV2 operation.', - 'path' => '/logstores/{logStore}/shards/{shardId}?type=log', - 'methods' => [ - 'get', + .'- The Host in the request syntax consists of the project name and the Simple Log Service (SLS) endpoint. You must specify the project in the Host.'."\n" + ."\n" + .'- You have created an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'An AccessKey pair for an Alibaba Cloud account provides full access to all API operations. This is a high security risk. We recommend that you create and use a Resource Access Management (RAM) user for API access or daily O\\&M. The RAM user must have permissions to manage SLS resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" + ."\n" + .'- Obtain the project name, region, and Logstore name. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).'."\n" + ."\n" + .'- A project policy is an authorization policy for projects in SLS. You can use a project policy to grant other users access to your specified SLS resources.'."\n" + ."\n" + .' - Before you configure a project policy using policy syntax, you must understand the classification of SLS actions, resources, and conditions. For more information, see [Resource Access Management](~~128139~~).'."\n" + ."\n" + .' - When you configure a project policy, if you grant permissions to an anonymous account (\\*) and do not specify a condition, the policy applies to all users except the project owner. If you grant permissions to an anonymous account (\\*) and specify a condition, the policy applies to all users, including the project owner.'."\n" + ."\n" + .' - You can add multiple project policies, but their total size cannot exceed 16 KB.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:PutProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'PutProjectTransferAcceleration' => [ + 'summary' => 'Enables or disables transfer acceleration.', + 'path' => '/transferacceleration', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], + '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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'logStore', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore'."\n", - ], - ], - [ - 'name' => 'shardId', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the shard in the Logstore.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'cursor', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The cursor that specifies the start position from which to read data.', - 'type' => 'string', - 'required' => true, - 'example' => 'MTQ0NzMyOTQwMTEwMjEzMDkwNA', - ], - ], - [ - 'name' => 'count', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of LogGroups to return. The value must be an integer from 1 to 1000.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1000', - ], - ], - [ - 'name' => 'end_cursor', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The cursor that specifies the end position at which to stop reading data.', - 'type' => 'string', - 'required' => false, - 'example' => 'MTU1NzA1NzQwMTEwMjEzMDkwCg', - ], + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'query', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'title' => '', - 'description' => 'The filter statement in the Structured Process Language (SPL) syntax. For more information, see [SPL instructions](~~2536530~~).', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'enabled' => ['description' => 'Specifies whether to enable transfer acceleration.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + ], 'required' => false, - 'example' => '* | where userId=\'123\'', - ], - ], - [ - 'name' => 'Accept-Encoding', - 'in' => 'header', - 'schema' => [ 'title' => '', - 'description' => 'The compression format of the data that the server returns. Only the lz4 format is supported.', - 'type' => 'string', - 'required' => false, - 'example' => 'lz4', + 'example' => '', ], ], ], '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' => '', - 'description' => 'The compressed data in protobuf format.', - '$ref' => '#/components/schemas/LogGroupList', - 'example' => '', - ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"logGroupList\\": [\\n {\\n \\"Topic\\": \\"topic-test\\",\\n \\"Source\\": \\"192.1.1.1\\",\\n \\"LogTags\\": [\\n {\\n \\"Key\\": \\"key-test\\",\\n \\"Value\\": \\"value-test\\"\\n }\\n ],\\n \\"LogItems\\": [\\n {\\n \\"Time\\": 1690254376,\\n \\"Contents\\": [\\n {\\n \\"Key\\": \\"key-test\\",\\n \\"Value\\": \\"value-test\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'PullLogs', - 'description' => '>'."\n" - ."\n" - .'This operation is not supported by the OpenAPI SDK. Use the [Simple Log Service SDK](~~29063~~).'."\n" - ."\n" - .'>'."\n" - ."\n" - .'- Specify a shard to retrieve logs.'."\n" - ."\n" - .'- This operation supports reading data in only the [Protocol Buffer](~~29055~~) format.'."\n" - ."\n" - .'- The Host in the request syntax consists of the project name and the Simple Log Service endpoint. Specify the project in the Host.', - 'requestParamsDescription' => 'The following request headers are specific to the PullLogs operation:'."\n" - ."\n" - .'- Accept: application/x-protobuf'."\n" - ."\n" - .'- Accept-Encoding: lz4'."\n" - ."\n" - .'The value of Accept-Encoding can be lz4, deflate, or double quotation marks ("").'."\n" - ."\n" - .'**Request example:**'."\n" - ."\n" - .'```'."\n" - .'GET /logstores/sls-test-logstore/shards/0?type=logs&cursor=MTQ0NzMyOTQwMTEwMjEzMDkwNA&count=1000 HTTP/1.1'."\n" - .'Host:ali-test-project.cn-hangzhou.log.aliyuncs.com'."\n" - .'Content-Type:application/json'."\n" - .'```', - 'responseParamsDescription' => 'The following response headers are specific to the PullLogs operation:'."\n" - ."\n" - .'- x-log-cursor: The cursor for the next log to be read.'."\n" - ."\n" - .'- x-log-end-of-cursor: The cursor of the last log that is read in the current request.'."\n" - ."\n" - .'- x-log-count: The number of logs returned.'."\n" - ."\n" - .'For information about the common response headers of Simple Log Service API operations, see [Common response headers](~~29011~~).'."\n" - ."\n" - .'The response body contains data that is serialized in the protobuf format. The data may be compressed.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PutProjectTransferAcceleration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], - 'PutAnnotationData' => [ - 'summary' => 'Stores annotation data in a dataset.', - 'path' => '/ml/annotationdataset/{datasetId}/annotationdata', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'PutWebtracking' => [ + 'summary' => 'Sends multiple logs to Simple Log Service in one request.', + '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' => 'The unique identifier of the dataset.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'annotationdataId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the data.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '2156d560fc7c01420542df92cd6365ds', - ], + 'name' => 'logstoreName', + 'in' => 'path', + 'schema' => ['title' => 'A short description of struct', 'description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-logstore'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request struct.', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'rawLog' => [ - 'description' => 'The raw log data.', + '__topic__' => ['description' => 'The topic of the logs.', 'type' => 'string', 'required' => false, 'example' => 'topic', 'title' => ''], + '__source__' => ['description' => 'The source of the logs.', 'type' => 'string', 'required' => true, 'example' => 'source', 'title' => ''], + '__logs__' => [ + 'description' => 'The logs. Each element is a JSON object that indicates a log.'."\n" + ."\n" + .'> **Note**: The time in a log that is collected by using the web tracking feature is the time at which Simple Log Service receives the log. You do not need to configure the \\_\\_time\\_\\_ field for each log. If this field exists, it is overwritten by the time at which Simple Log Service receives the log.', 'type' => 'array', 'items' => [ - 'description' => 'The log data, which is a map of key-value pairs.', + 'description' => 'The logs.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The key and value of a raw log entry. Both are strings.', - 'title' => '', - 'example' => '['."\n" - .' {'."\n" - .' "time": "1694761550",'."\n" - .' "cnt": "45416",'."\n" - .' "cnt2": "12454"'."\n" - .' }'."\n" - .']', - ], + 'additionalProperties' => ['description' => 'The log content.', 'type' => 'string', 'example' => '{ "key1": "value1", "key2": "value2" }', 'title' => ''], 'title' => '', 'example' => '', ], - 'required' => false, + 'required' => true, 'title' => '', 'example' => '', ], - 'mlDataParam' => [ - 'description' => 'The data struct.', - 'required' => false, - '$ref' => '#/components/schemas/MLDataParam', + '__tags__' => [ + 'description' => 'The tags of the logs.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The tag of the log.', 'type' => 'string', 'example' => '{ "tag1": "value1", "tag2": "value2" }', 'title' => ''], 'title' => '', 'example' => '', ], ], - 'required' => false, + 'required' => true, 'title' => '', 'example' => '', ], @@ -33852,2686 +19979,1529 @@ 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' => 'PutAnnotationData', - 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', + 'title' => 'PutWebtracking', + 'description' => '### [](#)Usage notes'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" + ."\n" + .'- Use this operation to collect logs from web pages or clients.'."\n" + ."\n" + .'- If you use web tracking to collect logs and you do not call this operation, you can send only one log to Simple Log Service in a request. For more information, see [Use web tracking to collect logs](~~31752~~).'."\n" + ."\n" + .'- If you want to collect a large amount of log data, you can call this operation to send multiple logs to Simple Log Service in one request.'."\n" + ."\n" + .'- Before you can call this operation to send logs to a Logstore, you must enable web tracking for the Logstore. For more information, see [Use web tracking to collect logs](~~31752~~).'."\n" + ."\n" + .'- You cannot call this operation to send the logs of multiple topics to Simple Log Service at a time.'."\n" + ."\n" + .'- If you call this operation, anonymous users from the Internet are granted the write permissions on the Logstore. This may generate dirty data because AccessKey pair-based authentication is not performed.', + 'requestParamsDescription' => 'Only the following request headers are supported. The first two request headers are required when you call the PutWebTracking operation. For more information about the formats and descriptions of the request headers, see Common request headers.'."\n" + ."\n" + .'- x-log-apiversion: 0.6.0'."\n" + ."\n" + .'- x-log-bodyrawsize: 1234'."\n" + ."\n" + .'- x-log-compresstype: lz4'."\n" + ."\n" + .'The x-log-compresstype header is required only when you need to send compressed data. To send compressed data, you must use the LZ4 or DEFLATE algorithm. You can specify `x-log-compresstype: lz4` or `x-log-compresstype: deflate`. For more information about how to compress data, see [Data compression](~~449460~~).', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" + .'| 400 | PostBodyInvalid | Fail to parse protobuf. | Protobuffer内容不合法，无法解析。 |'."\n" + .'| 400 | PostBodyInvalid | Body invalid error message. | 请求的Body不合法。 |'."\n" + .'| 400 | PostBodyUncompressError | Post body uncompressed fail. | 日志内容解压失败。 |'."\n" + .'| 400 | PostBodyTooLarge | Body size bodySize must little than 10485760. | 请求Body （压缩前）不能超过10MB。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], - 'PutConsumeProcessor' => [ - 'summary' => 'Creates or updates a consume processor.', - 'path' => '/consumeprocessors/{processorName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'RefreshToken' => [ + 'summary' => 'Refreshes an access token using a ticket. The access token is used to call console API operations.', + 'path' => '/token/refresh', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - '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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], - ], - [ - 'name' => 'processorName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the consume processor.', - 'type' => 'string', - 'required' => true, - 'example' => 'consume-processor-1', - 'title' => '', - ], + 'name' => 'ticket', + 'in' => 'query', + 'schema' => ['description' => 'The logon-free ticket.', 'type' => 'string', 'required' => false, 'example' => 'eyJ***************.eyJ******************.KUT****************', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.', - 'type' => 'object', - 'properties' => [ - 'displayName' => [ - 'description' => 'The display name.', - 'type' => 'string', - 'required' => true, - 'example' => 'filter-get-request', - 'title' => '', - ], - 'description' => [ - 'description' => 'The description.', - 'type' => 'string', - 'required' => false, - 'example' => '仅过滤Get请求', - 'title' => '', - ], - 'configuration' => [ - 'description' => 'The configuration of the consume processor.', - 'required' => true, - '$ref' => '#/components/schemas/ConsumeProcessorConfiguration', - 'title' => '', - 'example' => '', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'name' => 'accessTokenExpirationTime', + 'in' => 'query', + 'schema' => ['description' => '- The expiration time of the access token in seconds. This specifies the period during which the token is valid for accessing page API operations. The default value is 86400 seconds (one day). The value must be an integer from 0 to 86400.'."\n" + ."\n" + .'- The actual expiration time of the access token is the minimum value of accessTokenExpirationTime and expirationTime.'."\n" + ."\n" + .'- If you call this operation using Security Token Service (STS), the actual expiration time of the access token is the minimum value of accessTokenExpirationTime, expirationTime, and the STS token expiration time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ - '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' => 'The response body.', + 'type' => 'object', + 'properties' => [ + 'accessToken' => ['title' => 'Id of the request', 'description' => 'The access token.', 'type' => 'string', 'example' => 'eyJ***************.eyJ******************.KUT****************'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'PutConsumeProcessor', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"accessToken\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', + 'title' => 'RefreshToken', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'PutIngestProcessor' => [ - 'summary' => 'Creates or modifies an ingest processor.', - 'path' => '/ingestprocessors/{processorName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'RemoveConfigFromMachineGroup' => [ + 'summary' => 'Removes a Logtail configuration from a machine group.', + 'path' => '/machinegroups/{machineGroup}/configs/{configName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'processorName', + 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The identifier of the ingest processor.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'parse-nginx-log', - ], + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-group', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'displayName' => [ - 'title' => '', - 'description' => 'The display name of the ingest processor.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Nginx日志解析', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the ingest processor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '将Nginx日志通过正则解析提取字段。', - ], - 'configuration' => [ - 'title' => '', - 'description' => 'The configuration of the ingest processor.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/IngestProcessorConfiguration', - 'example' => '', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'name' => 'configName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Logtail configuration.', 'type' => 'string', 'required' => true, 'example' => 'test-logtail', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'PutIngestProcessor', + 'title' => 'RemoveConfigFromMachineGroup', + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 404 | MachineGroupNotExist| MachineGroup groupName does not exist.| 机器组不存在。 |'."\n" + .'| 404 | ConfigNotExist| Config configName does not exist. | Logtail配置不存在。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'PutLogs' => [ - 'summary' => 'Writes log data to a specified logstore.', - 'path' => '/logstores/{logstore}/shards/lb', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SplitShard' => [ + 'summary' => 'Splits a shard in the readwrite state.', + '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' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the logstore.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-logstore', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'logstorename', 'title' => ''], ], [ - 'name' => 'x-log-compresstype', - 'in' => 'header', - 'schema' => [ - 'description' => 'The compression type of the logs. Valid values: lz4 and gzip.', - 'type' => 'string', - 'required' => true, - 'example' => 'lz4', - 'default' => 'lz4', - 'enum' => [ - 'lz4', - ], - 'title' => '', - ], + 'name' => 'shard', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the shard.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'The compressed log data in protobuf format.', - '$ref' => '#/components/schemas/LogGroup', - 'title' => '', - 'required' => false, - 'example' => '', - ], + 'name' => 'key', + 'in' => 'query', + 'schema' => ['description' => 'The position where the shard is split.', 'type' => 'string', 'example' => 'ef000000000000000000000000000000', 'title' => '', 'required' => false], + ], + [ + 'name' => 'shardCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of new shards that are generated after splitting.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'The shards that are returned. For example, if the shardCount parameter is set to 2, an array that consists of three shards is returned. The first shard is the original shard, and the last two shards are the new shards.', + 'type' => 'array', + 'items' => ['description' => 'The shard information.', '$ref' => '#/components/schemas/shard', 'title' => '', 'example' => ''], + 'example' => '', + ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'PutLogs', - 'description' => '> - The OpenAPI SDK does not support this operation. Use the [Simple Log Service (SLS) SDK](~~29063~~) instead.'."\n" - ."\n" - .'- The service checks the format of log data for each PutLogs request. If any log entry is invalid, the entire request fails and no logs are written.'."\n" - ."\n" - .'- This operation supports only log data in [protobuf format](~~29055~~). The log data is structured as a LogGroup.'."\n" - ."\n" - .'- Logs can be written in two modes:'."\n" - ."\n" - .' - LoadBalance mode: Data is automatically written to all writable shards in a logstore. This method provides high availability and is suitable for data consumption scenarios that do not require a specific order. Request syntax:'."\n" - ."\n" - .' ```plaintext'."\n" - .' POST /logstores/logstoreName/shards/lb HTTP/1.1'."\n" - .' Authorization: LOG yourAccessKeyId:yourSignature'."\n" - .' Content-Type: application/x-protobuf'."\n" - .' Content-Length: Content Length'."\n" - .' Content-MD5: Content MD5'."\n" - .' Date: GMT Date'."\n" - .' Host: ProjectName.Endpoint'."\n" - .' x-log-apiversion: 0.6.0'."\n" - .' x-log-bodyrawsize: BodyRawSize'."\n" - .' x-log-compresstype: lz4'."\n" - .' x-log-signaturemethod: hmac-sha1'."\n" - .' '."\n" - .' ```'."\n" - ."\n" - .' - KeyHash mode: Add a key parameter to the URL to determine which shard receives the data. This parameter is optional. If you do not set this parameter, the system automatically switches to the load balancing mode. For example, pin a producer, such as an instance, to a specific shard based on its name hash. This ensures that data written to and consumed from the shard is strictly ordered. During merge and split operations, a key is associated with only one shard at any given time. Request syntax:'."\n" - ."\n" - .' ```plaintext'."\n" - .' POST /logstores/logstoreName/shards/route?key=14d2f850ad6ea48e46e4547edbbb27e0'."\n" - .' Authorization: LOG yourAccessKeyId:yourSignature'."\n" - .' Content-Type: application/x-protobuf'."\n" - .' Content-Length: Content Length'."\n" - .' Content-MD5: Content MD5'."\n" - .' Date: GMT Date'."\n" - .' Host: ProjectName.Endpoint'."\n" - .' x-log-apiversion: 0.6.0'."\n" - .' x-log-bodyrawsize: BodyRawSize'."\n" - .' x-log-compresstype: lz4'."\n" - .' x-log-signaturemethod: hmac-sha1'."\n" - .' '."\n" - .' ```'."\n" - ."\n" - .'- The maximum size of raw logs for each PutLogs request is 10 MB. The Value of each log in a log group must not exceed 1 MB. Older SDK versions may have different limits. Upgrade to the latest SDK version.'."\n" - ."\n" - .'- SLS provides examples of how to use PutLogs with the Java and Python SDKs.'."\n" - ."\n" - .'## Protobuf data'."\n" - ."\n" - .'This section describes the fields for compressed log data in protobuf format. For more information, see [Data model](~~29054~~) and [Data encoding](~~29055~~).'."\n" - ."\n" - .'- Log'."\n" - ."\n" - .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" - .'| ------------- | ------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| Time | Integer | Yes | The time of the log. The value is a UNIX timestamp that represents the number of seconds that have elapsed since 1970-1-1 00:00:00 UTC. |'."\n" - .'| Contents | List | Yes | A list of log fields. The list must contain at least one element. For the element type, see the Content table below. |'."\n" - ."\n" - .'- Content'."\n" - ."\n" - .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" - .'| ------------- | ------------- | ------------ | --------------------------------------------- |'."\n" - .'| Key | String | Yes | The custom key name. |'."\n" - .'| Value | String | Yes | The value that corresponds to the custom key. |'."\n" - ."\n" - .'- LogTag'."\n" - ."\n" - .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" - .'| ------------- | ------------- | ------------ | --------------------------------------------- |'."\n" - .'| Key | String | Yes | The custom key name. |'."\n" - .'| Value | String | Yes | The value that corresponds to the custom key. |'."\n" - ."\n" - .'- LogGroup'."\n" - ."\n" - .'| **Parameter** | **Data type** | **Required** | **Description** |'."\n" - .'| ------------- | ------------- | ------------ | --------------------------------------------------------------------------------------------- |'."\n" - .'| Logs | List | Yes | A list of logs. For each element, see the Log table. |'."\n" - .'| Topic | String | No | The topic of the logs. Use this custom field to distinguish log data with different features. |'."\n" - .'| Source | String | No | The source of the logs, such as the IP address of the machine that generated the logs. |'."\n" - .'| LogTags | List | Yes | A list of log tags. For each element, see the LogTag table. |', - 'requestParamsDescription' => '**Request headers**'."\n" - ."\n" - .'For information about the common request headers of SLS APIs, see [Common request headers](~~29010~~).'."\n" - ."\n" - .'**Request example**'."\n" - ."\n" - .'```'."\n" - .'POST /logstores/sls-test-logstore/shards/lb'."\n" - .'{'."\n" - .' "Content-Length": 118,'."\n" - .' "Content-Type":"application/x-protobuf",'."\n" - .' "x-log-bodyrawsize":1356,'."\n" - .' "Host": "ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com",'."\n" - .' "Content-MD5":"6554BD042149C844761C2C094A8FECCE",'."\n" - .' "Date":"Thu, 12 Nov 2015 06:54:26 GMT",'."\n" - .' "x-log-apiversion": "0.6.0",'."\n" - .' "x-log-compresstype":"lz4"'."\n" - .' "x-log-signaturemethod": "hmac-sha1",'."\n" - .' "Authorization":"LOG yourAccessKeyId:yourSignature"'."\n" - .'}'."\n" - .''."\n" - .'```', - 'responseParamsDescription' => '**Response headers**'."\n" + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"shardID\\": 0,\\n \\"status\\": \\"readwrite\\",\\n \\"inclusiveBeginKey\\": \\"00000000000000000000000000000000\\",\\n \\"exclusiveEndKey\\": \\"8000000000000000000000000000000\\",\\n \\"serverIp\\": \\"203.0.113.10\\",\\n \\"createTime\\": 1524222931\\n }\\n]","type":"json"}]', + 'title' => 'SplitShard', + 'description' => '### Usage notes'."\n" ."\n" - .'The PutLogs operation does not have specific response headers. For information about the common response headers of SLS APIs, see [Common response headers](~~29011~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" ."\n" - .'**Response elements**'."\n" + .'- Each shard has an MD5 hash range, and each range is a left-closed, right-open interval. The interval is in the `[BeginKey,EndKey)` format. A shard can be in the readwrite or readonly state. You can split a shard and merge shards. For more information, see [Shard](~~28976~~).', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" + .'| 400 | ParameterInvalid| invalid shard id. | 无效Shard ID。 |'."\n" + .'| 400 | ParameterInvalid| invalid mid hash. | 无效分裂位置参数。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" - .'An HTTP status code of 200 indicates that the request was successful. No response elements are returned.', + .'更多信息，请参见[错误码对照表](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'PutProjectPolicy' => [ - 'summary' => 'Creates a project access 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' => 'The request parameters, which define the authorization policy.', - 'type' => 'string', - 'required' => false, - 'example' => '{ "Version": "1", "Statement": [{ "Action": ["log:PostLogStoreLogs"], "Resource": "acs:log:*:*:project/exampleproject/*", "Effect": "Deny", "Condition": { "StringNotLike": { "acs:SourceVpc": ["vpc-*"] } } }] }', - ], - ], [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The project name.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'azureBlobIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'PutProjectPolicy', - 'description' => '###'."\n" - ."\n" - .'- The Host in the request syntax consists of the project name and the Simple Log Service (SLS) endpoint. You must specify the project in the Host.'."\n" - ."\n" - .'- You have created an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'An AccessKey pair for an Alibaba Cloud account provides full access to all API operations. This is a high security risk. We recommend that you create and use a Resource Access Management (RAM) user for API access or daily O\\&M. The RAM user must have permissions to manage SLS resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" - ."\n" - .'- Obtain the project name, region, and Logstore name. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).'."\n" - ."\n" - .'- A project policy is an authorization policy for projects in SLS. You can use a project policy to grant other users access to your specified SLS resources.'."\n" - ."\n" - .' - Before you configure a project policy using policy syntax, you must understand the classification of SLS actions, resources, and conditions. For more information, see [Resource Access Management](~~128139~~).'."\n" - ."\n" - .' - When you configure a project policy, if you grant permissions to an anonymous account (\\*) and do not specify a condition, the policy applies to all users except the project owner. If you grant permissions to an anonymous account (\\*) and specify a condition, the policy applies to all users, including the project owner.'."\n" - ."\n" - .' - You can add multiple project policies, but their total size cannot exceed 16 KB.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StartAzureBlobIngestion', + 'summary' => 'Starts an Azure Blob ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'create', - 'ramAction' => [ - 'action' => 'log:PutProjectPolicy', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], - ], - 'PutProjectTransferAcceleration' => [ - 'summary' => 'Enables or disables transfer acceleration.', - 'path' => '/transferacceleration', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'StartETL' => [ + 'summary' => 'Starts a data transformation task.', + 'path' => '/etls/{etlName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + '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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.', - 'type' => 'object', - 'properties' => [ - 'enabled' => [ - 'description' => 'Specifies whether to enable transfer acceleration.', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'title' => '', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'name' => 'etlName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the data transformation task.', 'type' => 'string', 'required' => false, 'example' => 'etl-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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' => 'PutProjectTransferAcceleration', + 'title' => 'StartETL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'PutWebtracking' => [ - 'summary' => 'Sends multiple logs to Simple Log Service in one request.', - 'path' => '/logstores/{logstoreName}/track', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'logstoreName', + 'name' => 'elasticsearchIngestionName', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - '__topic__' => [ - 'description' => 'The topic of the logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'topic', - 'title' => '', - ], - '__source__' => [ - 'description' => 'The source of the logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'source', - 'title' => '', - ], - '__logs__' => [ - 'description' => 'The logs. Each element is a JSON object that indicates a log.'."\n" - ."\n" - .'> **Note**: The time in a log that is collected by using the web tracking feature is the time at which Simple Log Service receives the log. You do not need to configure the \\__time\\_\\_ field for each log. If this field exists, it is overwritten by the time at which Simple Log Service receives the log.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The logs.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The log content.'."\n", - 'example' => '{ "key1": "value1", "key2": "value2" }', - 'title' => '', - ], - 'title' => '', - 'example' => '', - ], - 'required' => true, - 'title' => '', - 'example' => '', - ], - '__tags__' => [ - 'description' => 'The tags of the logs.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The tag of the log.'."\n", - 'example' => '{ "tag1": "value1", "tag2": "value2" }', - 'title' => '', - ], - 'title' => '', - 'example' => '', - ], - ], - 'required' => true, - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the ES/OpenSearch ingestion task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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' => 'PutWebtracking', - 'description' => '### [](#)Usage notes'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - .'* You can call this operation to collect logs from web pages or clients.'."\n" - .'* If you use web tracking to collect logs and you do not call this operation, you can send only one log to Simple Log Service in a request. For more information, see [Use web tracking to collect logs](~~31752~~).'."\n" - .'* If you want to collect a large amount of log data, you can call this operation to send multiple logs to Simple Log Service in one request.'."\n" - .'* Before you can call this operation to send logs to a Logstore, you must enable web tracking for the Logstore. For more information, see [Use web tracking to collect logs](~~31752~~).'."\n" - .'* You cannot call this operation to send the logs of multiple topics to Simple Log Service at a time.'."\n" - .'* If you call this operation, anonymous users from the Internet are granted the write permissions on the Logstore. This may generate dirty data because AccessKey pair-based authentication is not performed.'."\n", - 'requestParamsDescription' => 'Only the following request headers are supported. The first two request headers are required when you call the PutWebTracking operation. For more information about the formats and descriptions of the request headers, see Common request headers.'."\n" - ."\n" - .'* x-log-apiversion: 0.6.0'."\n" - .'* x-log-bodyrawsize: 1234'."\n" - .'* x-log-compresstype: lz4'."\n" - ."\n" - .'The x-log-compresstype header is required only when you need to send compressed data. To send compressed data, you must use the LZ4 or DEFLATE algorithm. You can specify `x-log-compresstype: lz4` or `x-log-compresstype: deflate`. For more information about how to compress data, see [Data compression](~~449460~~).'."\n", - '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' => 'StartElasticsearchIngestion', + 'summary' => 'Starts an ES or OpenSearch ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'RefreshToken' => [ - 'summary' => 'Refreshes an access token using a ticket. The access token is used to call console API operations.', - 'path' => '/token/refresh', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'StartGCSIngestion' => [ + 'summary' => 'Starts a GCS file import task.', + 'path' => '/gcsingestions/{gcsIngestionName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => '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' => 'The logon-free ticket.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'eyJ***************.eyJ******************.KUT****************', - ], + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ - 'name' => 'accessTokenExpirationTime', - 'in' => 'query', - 'schema' => [ - 'description' => '- The expiration time of the access token in seconds. This specifies the period during which the token is valid for accessing page API operations. The default value is 86400 seconds (one day). The value must be an integer from 0 to 86400.'."\n" - ."\n" - .'- The actual expiration time of the access token is the minimum value of accessTokenExpirationTime and expirationTime.'."\n" - ."\n" - .'- If you call this operation using Security Token Service (STS), the actual expiration time of the access token is the minimum value of accessTokenExpirationTime, expirationTime, and the STS token expiration time.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'title' => '', - 'example' => '600', - ], + 'name' => 'gcsIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the GCS import task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ingest-gcs-123456'], ], ], 'responses' => [ 200 => [ 'headers' => [ - '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' => 'The response body.', - 'type' => 'object', - 'properties' => [ - 'accessToken' => [ - 'title' => 'Id of the request', - 'description' => 'The access token.', - 'type' => 'string', - 'example' => 'eyJ***************.eyJ******************.KUT****************', - ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], - 'example' => '', ], + 'schema' => ['description' => 'The response body.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"accessToken\\": \\"eyJ***************.eyJ******************.KUT****************\\"\\n}","type":"json"}]', - 'title' => 'RefreshToken', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StartGCSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', + 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', ], - 'RemoveConfigFromMachineGroup' => [ - 'summary' => 'Removes a Logtail configuration from a machine group.', - 'path' => '/machinegroups/{machineGroup}/configs/{configName}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartMaxComputeExport' => [ + 'summary' => 'Starts a MaxCompute data shipping job.', + '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'machineGroup', + 'name' => 'mcExportName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'StartMaxComputeExport', + 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'StartOSSExport' => [ + 'summary' => 'Starts an Object Storage Service (OSS) data shipping job.', + 'path' => '/ossexports/{ossExportName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '203474', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project'."\n", 'title' => ''], + ], [ - 'name' => 'configName', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logtail configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-logtail', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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'], ], ], ], ], - 'title' => 'RemoveConfigFromMachineGroup', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", - '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~~)。', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'StartOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'SearchMemories' => [ - 'path' => '/memorystores/{memoryStore}/search', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'StartOSSHDFSExport' => [ + 'summary' => 'Starts an OSS-HDFS data shipping job.', + 'path' => '/osshdfsexports/{ossExportName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - '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' => '203482', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'memoryStore', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n", 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'query' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'user_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'top_k' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'agent_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'app_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'run_id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'rerank' => [ - 'type' => 'boolean', - 'description' => '', - 'title' => '', - 'example' => '', - ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], ], - 'description' => '', - 'title' => '', - 'example' => '', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'StartOSSHDFSExport', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'StartOSSIngestion' => [ + 'summary' => 'Starts a specified OSS import task.', + 'path' => '/ossingestions/{ossIngestionName}?action=START', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '203141', + 'abilityTreeNodes' => ['FEATUREslsDQM02M'], + ], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], + ], + [ + 'name' => 'ossIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the OSS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], + ], + ], 'responses' => [ 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'results' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'actorId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'agentId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'createdAt' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'hash' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'id' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'memory' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'metadata' => [ - 'type' => 'object', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'role' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'runId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'score' => [ - 'type' => 'number', - 'format' => 'double', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'updatedAt' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'userId' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'relations' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'destination' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'relationship' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'source' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], ], - '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', - ], - ], + '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'], ], - 'description' => '', - 'title' => '', - 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'StartOSSIngestion', '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"}]', - 'title' => '', ], - 'SplitShard' => [ - 'summary' => 'Splits a shard in the readwrite state.', - 'path' => '/logstores/{logstore}/shards/{shard}?action=split', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopAzureBlobIngestion' => [ + 'path' => '/azureblobingestions/{azureBlobIngestionName}?action=STOP', + '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' => '291256', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'logstorename', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], [ - 'name' => 'shard', + 'name' => 'azureBlobIngestionName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The ID of the shard.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'key', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The position where the shard is split.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ef000000000000000000000000000000', - ], - ], - [ - 'name' => 'shardCount', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The number of new shards that are generated after splitting.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The name of the Azure Blob ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - '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', - ], - ], - ], - 'schema' => [ - 'title' => '', - 'description' => 'The shards that are returned. For example, if the shardCount parameter is set to 2, an array that consists of three shards is returned. The first shard is the original shard, and the last two shards are the new shards.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The shard information.'."\n", - '$ref' => '#/components/schemas/shard', - 'example' => '', + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], ], - 'example' => '', ], ], ], - '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' => 'SplitShard', - 'description' => '### Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* Each shard has an MD5 hash range, and each range is a left-closed, right-open interval. The interval is in the `[BeginKey,EndKey)` format. A shard can be in the readwrite or readonly state. You can split a shard and merge shards. For more information, see [Shard](~~28976~~).'."\n", - '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~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StopAzureBlobIngestion', + 'summary' => 'Stops an Azure Blob ingestion task.', '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' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'StartAzureBlobIngestion' => [ - 'summary' => 'Starts an Azure BLOB file import task.', - 'path' => '/azureblobingestions/{azureBlobIngestionName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopETL' => [ + 'summary' => 'Stops a specified data transformation task.', + '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' => '291253', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeCode' => '203170', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'azureBlobIngestionName', + 'name' => 'etlName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the data transformation task.', 'type' => 'string', 'required' => false, 'example' => 'etl-123456', 'title' => ''], ], ], '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' => 'StopETL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'StartAzureBlobIngestion', ], - 'StartETL' => [ - 'summary' => 'Starts a data transformation task.', - 'path' => '/etls/{etlName}?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' => '203160', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '287680', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => 'The name of the project.', - 'required' => false, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'etlName', + 'name' => 'elasticsearchIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the data transformation task.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'etl-123456', - ], + 'schema' => ['description' => 'The name of the ES/OpenSearch import job.', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'StartETL', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StopElasticsearchIngestion', + 'summary' => 'Stops an ES or OpenSearch import job.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'StartMaxComputeExport' => [ - 'summary' => 'Starts a MaxCompute data shipping job.', - 'path' => '/maxcomputeexports/{mcExportName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopGCSIngestion' => [ + 'summary' => 'Stops a GCP Cloud Storage file import task.', + 'path' => '/gcsingestions/{gcsIngestionName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203420', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['description' => 'Name of the project.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'ali-test-project'], ], [ - 'name' => 'mcExportName', + 'name' => 'gcsIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456', - 'title' => '', - ], + 'schema' => ['description' => 'Name of the GCS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'Response body.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'StartMaxComputeExport', - 'description' => '* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n", + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StopGCSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', ], - 'StartOSSExport' => [ - 'summary' => 'Starts an Object Storage Service (OSS) data shipping job.', - 'path' => '/ossexports/{ossExportName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopMaxComputeExport' => [ + 'summary' => 'Stops a MaxCompute data shipping job.', + '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' => '203474', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeCode' => '203421', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'ossExportName', + 'name' => 'mcExportName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'StartOSSExport', + 'title' => 'StopMaxComputeExport', + 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'StartOSSHDFSExport' => [ - 'summary' => 'Starts an OSS-HDFS data shipping job.', - 'path' => '/osshdfsexports/{ossExportName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopOSSExport' => [ + 'summary' => 'Stops an Object Storage Service (OSS) data shipping job.', + 'path' => '/ossexports/{ossExportName}?action=STOP', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203482', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'abilityTreeCode' => '203475', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-osshdfs-1234567890-123456'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'StartOSSHDFSExport', + 'title' => 'StopOSSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'StartOSSIngestion' => [ - 'summary' => 'Starts a specified OSS import task.', - 'path' => '/ossingestions/{ossIngestionName}?action=START', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopOSSHDFSExport' => [ + 'summary' => 'Stops an OSS-HDFS data shipping job.', + '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' => '203141', - 'abilityTreeNodes' => [ - 'FEATUREslsDQM02M', - ], + 'abilityTreeCode' => '203481', + 'abilityTreeNodes' => ['FEATUREsls6GHCRC'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The project name.', - 'title' => '', - 'example' => 'ali-test-project'."\n", - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ - 'name' => 'ossIngestionName', + 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the OSS import task.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ingest-oss-123456', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-123456789-123456'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'StartOSSIngestion', + 'title' => 'StopOSSHDFSExport', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], ], - 'StopAzureBlobIngestion' => [ - 'summary' => 'Start a file import task from Azure Blob', - 'path' => '/azureblobingestions/{azureBlobIngestionName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopOSSIngestion' => [ + 'summary' => 'Stops the specified OSS import task.', + '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' => '291256', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeCode' => '203142', + 'abilityTreeNodes' => ['FEATUREslsDQM02M'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'azureBlobIngestionName', + 'name' => 'ossIngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the OSS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123456', 'title' => ''], ], ], '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' => 'StopOSSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'StopAzureBlobIngestion', ], - 'StopETL' => [ - 'summary' => 'Stops a specified data transformation task.', - 'path' => '/etls/{etlName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SubmitAsyncSql' => [ + 'summary' => 'Submits an asynchronous SQL request.', + 'path' => '/asyncsql', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => [], 'produces' => [], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '203170', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '292852', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => 'The name of the project.', - 'required' => false, - 'title' => '', - 'example' => 'ali-test-project', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The idempotency token for the request.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'sls-demo-project'], ], [ - 'name' => 'etlName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the data transformation task.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'etl-123456', - ], + 'name' => 'Accept', + 'in' => 'header', + 'schema' => ['description' => 'The data format of the response. The value must be application/x-protobuf.', 'type' => 'string', 'example' => 'application/x-protobuf', 'default' => 'application/x-protobuf', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Accept-Encoding', + 'in' => 'header', + 'schema' => ['description' => 'The compression format of the response. The value can be lz4.', 'type' => 'string', 'example' => 'lz4', 'default' => 'lz4', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => ['description' => 'The format of the response parameters. The value is \\`protobuf\\`.', '$ref' => '#/components/schemas/SubmitAsyncSqlParams', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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'], ], ], + 'schema' => ['description' => 'The data returned in the response body. The data is in protobuf format.', '$ref' => '#/components/schemas/AsyncSqlResponseData', 'title' => '', 'example' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'StopETL', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'SubmitAsyncSql', + 'responseParamsDescription' => 'The error\\_code and error\\_message parameters are returned only when the state is FAILED.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"id\\": \\"690C4F2A16FBD65C40000484_14\\",\\n \\"state\\": \\"FINISHED\\",\\n \\"AsyncSqlMetaPB\\": {\\n \\"result_rows\\": 12000,\\n \\"processed_rows\\": 10000000,\\n \\"elapsed_milli\\": 30000,\\n \\"cpu_sec\\": 0.2,\\n \\"cpu_cores\\": 10,\\n \\"progress\\": \\"Complete\\",\\n \\"keys\\": [\\n \\"[\\\\\\"name\\\\\\", \\\\\\"age\\\\\\", \\\\\\"gender\\\\\\"]\\"\\n ]\\n },\\n \\"rows\\": [\\n [\\n \\"[\\\\\\"Jimmy\\\\\\", \\\\\\"20\\\\\\", \\\\\\"male\\\\\\"]\\"\\n ]\\n ],\\n \\"error_code\\": \\"InvalidQuery\\",\\n \\"error_message\\": \\"line 37:14: Column \'xyz\' cannot be resolved\\"\\n}","type":"json"}]', ], - 'StopMaxComputeExport' => [ - 'summary' => 'Stops a MaxCompute data shipping job.', - 'path' => '/maxcomputeexports/{mcExportName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TagResources' => [ + 'summary' => 'Creates and adds tags to a resource. You can add tags only to projects.', + 'path' => '/tag', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '203421', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], - ], - [ - 'name' => 'mcExportName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', + 'description' => 'The request struct.', + 'type' => 'object', + 'properties' => [ + 'resourceType' => ['description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'- project'."\n" + ."\n" + .'- logstore'."\n" + ."\n" + .'- dashboard'."\n" + ."\n" + .'- machinegroup'."\n" + ."\n" + .'- logtailconfig', 'type' => 'string', 'required' => true, 'example' => 'project', 'title' => ''], + 'resourceId' => [ + 'title' => '', + 'description' => 'The resource IDs. You can specify only one resource and add tags to the resource.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID. In this example, a Logstore is used. projectName indicates the project name. # is used to concatenate strings. logstore indicates the Logstore name.'."\n" + ."\n" + .'- project: projectName'."\n" + ."\n" + .'- logstore: projectName#logstore'."\n" + ."\n" + .'- dashboard: projectName#dashboard'."\n" + ."\n" + .'- machinegroup: projectName#machinegroup'."\n" + ."\n" + .'- logtailconfig: projectName#logtailconfig', 'type' => 'string', 'example' => 'ali-test-project', 'title' => '', 'required' => false], + 'required' => true, + 'example' => '', + ], + 'tags' => [ + 'title' => '', + 'description' => 'The tags that you want to add to the resource. You can specify up to 20 tags in each call. Each tag is a key-value pair.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The key of the tag. The key must meet the following requirements:'."\n" + ."\n" + .'- The key must be `1 to 128` characters in length.'."\n" + ."\n" + .'- The key cannot contain `http://` or `https://`.'."\n" + ."\n" + .'- The key cannot start with `acs:` or `aliyun`.', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], + 'value' => ['description' => 'The value of the tag. The value must meet the following requirements:'."\n" + ."\n" + .'- The value must be `1 to 128` characters in length.'."\n" + ."\n" + .'- The value cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => true, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], 'required' => true, - 'example' => 'export-mc-1234567890-123456', 'title' => '', + 'example' => '', ], ], ], @@ -36539,107 +21509,143 @@ 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' => 'StopMaxComputeExport', - 'description' => '* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + 'title' => 'TagResources', + 'description' => '### Usage notes'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n", + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n" + ."\n" + .'- For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" + ."\n" + .'### Authentication resources'."\n" + ."\n" + .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + ."\n" + .'| Action | Resource |'."\n" + .'| :----------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `log:TagResources` | The resource format varies based on the resource type.-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'StopOSSExport' => [ - 'summary' => 'Stops an Object Storage Service (OSS) data shipping job.', - 'path' => '/ossexports/{ossExportName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], ], + ], + 'UntagResources' => [ + 'summary' => 'Detaches one or more tags from a resource. You can detach tags only from Simple Log Service projects. You can detach multiple or all tags from a Simple Log Service project at a time.', + 'path' => '/untag', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '203475', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], - ], - [ - 'name' => 'ossExportName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456'."\n", + 'description' => 'The request struct.', + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'description' => 'The type of the resource. Valid values:'."\n" + ."\n" + .'- project'."\n" + ."\n" + .'- logstore'."\n" + ."\n" + .'- dashboard'."\n" + ."\n" + .'- machinegroup'."\n" + ."\n" + .'- logtailconfig', + 'enumValueTitles' => ['project' => 'project'], + 'type' => 'string', + 'required' => false, + 'example' => 'project', + 'title' => '', + ], + 'resourceId' => [ + 'description' => 'The resource IDs. Each time you call this operation, you can unbind tags only from a single resource. Therefore, you can enter only one resource ID.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID. In this example, a Logstore is used. projectName indicates the project name. # is used to concatenate strings. logstore indicates the Logstore name.'."\n" + ."\n" + .'- project: projectName'."\n" + ."\n" + .'- logstore: projectName#logstore'."\n" + ."\n" + .'- dashboard: projectName#dashboard'."\n" + ."\n" + .'- machinegroup: projectName#machinegroup'."\n" + ."\n" + .'- logtailconfig: projectName#logtailconfig', 'type' => 'string', 'required' => false, 'example' => 'ali-test-project', 'title' => ''], + 'required' => true, + 'example' => 'ali-test-project', + 'title' => '', + ], + 'all' => ['description' => 'Specifies whether to unbind all tags. Default value: false. Valid values:'."\n" + ."\n" + .'- false: unbinds only the tags that match the value of tags.'."\n" + ."\n" + .'- true: unbinds all tags that are bound to the resource.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'tags' => [ + 'description' => 'The tag keys. If you set all to false, only the tags that match the value of this parameter are unbound.', + 'type' => 'array', + 'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, 'title' => '', + 'example' => '', ], ], ], @@ -36647,203 +21653,220 @@ 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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'StopOSSExport', + 'title' => 'UntagResources', + 'description' => '### Usage notes'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~) For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" + ."\n" + .'### Authentication resources'."\n" + ."\n" + .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + ."\n" + .'| Action | Resource |'."\n" + .'| :------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `log:UntagResources` | The resource format varies based on the resource type.-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'StopOSSHDFSExport' => [ - 'summary' => 'Stops an OSS-HDFS data shipping job.', - 'path' => '/osshdfsexports/{ossExportName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + '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', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '203481', - 'abilityTreeNodes' => [ - 'FEATUREsls6GHCRC', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227394', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', + 'type' => 'object', + 'properties' => [ + 'config' => ['description' => 'The default configurations.', 'type' => 'string', 'required' => true, 'example' => '{}', 'title' => ''], + 'grayConfigs' => [ + 'type' => 'array', + 'items' => ['description' => 'A configuration for the canary release environment.', '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', 'required' => false, 'title' => '', 'example' => ''], + 'description' => 'The configurations for the canary release environment.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The request body.', + 'required' => false, 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ossExportName', + 'name' => 'configType', 'in' => 'path', 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", + 'description' => 'The type of the process-level configuration.', + 'enumValueTitles' => [ + 'apm_biz_trace' => 'apm\\_biz\\_trace', 'apm_self_protect' => 'apm\\_self\\_protect', 'apm_convergence' => 'apm\\_convergence', 'apm_custom_extract' => 'apm\\_custom\\_extract', 'apm_pilot' => 'apm\\_pilot', 'apm_trace' => 'apm\\_trace', 'rum_app_config' => 'rum\\_app\\_config', 'rum_web_config' => 'rum\\_web\\_config', 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', 'apm_intacheap' => 'apm\\_intacheap', + 'apm_user_method' => 'apm\\_user\\_method', 'apm_global' => 'apm\\_global', 'apm_forward_process' => 'apm\\_forward\\_process', + ], 'type' => 'string', 'required' => true, - 'example' => 'export-osshdfs-123456789-123456'."\n", + 'example' => 'apm_biz_trace', + 'title' => '', + ], + ], + [ + 'name' => 'attributes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The attributes that specify the scope of the process-level configuration.', 'type' => 'string', 'example' => '"workspace": "test-workspace"'."\n" + .'"service": "test-service"', 'title' => ''], + 'description' => 'The attributes that specify the scope of the process-level configuration.', + 'required' => false, 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + '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' => 'StopOSSHDFSExport', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateAgentInstanceConfig', + 'summary' => 'Updates process-level configurations.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'StopOSSIngestion' => [ - 'summary' => 'Stops the specified OSS import task.', - 'path' => '/ossingestions/{ossIngestionName}?action=STOP', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateAlert' => [ + 'summary' => 'Updates an alert rule.', + 'path' => '/alerts/{alertName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '203142', - 'abilityTreeNodes' => [ - 'FEATUREslsDQM02M', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '200217', + 'abilityTreeNodes' => ['FEATUREsls7LA3N2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The project name.', - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'ossIngestionName', + 'name' => 'alertName', 'in' => 'path', + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alert-0123456789-123456', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the OSS import task.', - 'type' => 'string', - 'required' => true, + 'description' => 'The new configurations of the alert rule.', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => 'The display name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'this is alert', 'title' => ''], + 'description' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'this is description', 'title' => ''], + 'configuration' => ['description' => 'The detailed configurations of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/AlertConfiguration', 'title' => '', 'example' => ''], + 'schedule' => ['description' => 'The scheduling settings of the alert rule.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], + ], + 'required' => false, 'title' => '', - 'example' => 'ingest-oss-123456', + 'example' => '', ], ], ], @@ -36851,489 +21874,210 @@ 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', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'StopOSSIngestion', + 'title' => 'UpdateAlert', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'SubmitAsyncSql' => [ - 'summary' => 'Submits an asynchronous SQL request.', - 'path' => '/asyncsql', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateAnnotationDataSet' => [ + 'summary' => 'Updates a dataset.', + 'path' => '/ml/annotationdataset/{datasetId}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [], + 'consumes' => ['application/json'], 'produces' => [], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '292852', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'project', - 'in' => 'host', - 'allowEmptyValue' => false, - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The idempotency token for the request.', - 'title' => '', - 'example' => 'sls-demo-project', - ], - ], - [ - 'name' => 'Accept', - 'in' => 'header', - 'schema' => [ - 'type' => 'string', - 'default' => 'application/x-protobuf', - 'description' => 'The data format of the response. The value must be application/x-protobuf.', - 'title' => '', - 'required' => false, - 'example' => 'application/x-protobuf', - ], - ], - [ - 'name' => 'Accept-Encoding', - 'in' => 'header', - 'schema' => [ - 'type' => 'string', - 'default' => 'lz4', - 'description' => 'The compression format of the response. The value can be lz4.', - 'title' => '', - 'required' => false, - 'example' => 'lz4', - ], + 'name' => 'datasetId', + 'in' => 'path', + 'schema' => ['description' => 'The unique ID of the dataset.', 'type' => 'string', 'required' => false, 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - '$ref' => '#/components/schemas/SubmitAsyncSqlParams', - 'description' => 'The format of the response parameters. The value is \\`protobuf\\`.', - 'title' => '', - 'example' => '', - 'required' => false, - ], + 'schema' => ['description' => 'The request body.', '$ref' => '#/components/schemas/MLDataSetParam', 'required' => false, 'title' => '', 'example' => ''], ], ], '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' => [ - '$ref' => '#/components/schemas/AsyncSqlResponseData', - 'description' => 'The data returned in the response body. The data is in protobuf format.', - 'title' => '', - 'example' => '', - ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'title' => 'SubmitAsyncSql', - 'responseParamsDescription' => 'The error\\_code and error\\_message parameters are returned only when the state is FAILED.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'UpdateAnnotationDataSet', + 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"id\\": \\"690C4F2A16FBD65C40000484_14\\",\\n \\"state\\": \\"FINISHED\\",\\n \\"AsyncSqlMetaPB\\": {\\n \\"result_rows\\": 12000,\\n \\"processed_rows\\": 10000000,\\n \\"elapsed_milli\\": 30000,\\n \\"cpu_sec\\": 0.2,\\n \\"cpu_cores\\": 10,\\n \\"progress\\": \\"Complete\\",\\n \\"keys\\": [\\n \\"[\\\\\\"name\\\\\\", \\\\\\"age\\\\\\", \\\\\\"gender\\\\\\"]\\"\\n ]\\n },\\n \\"rows\\": [\\n [\\n \\"[\\\\\\"Jimmy\\\\\\", \\\\\\"20\\\\\\", \\\\\\"male\\\\\\"]\\"\\n ]\\n ],\\n \\"error_code\\": \\"InvalidQuery\\",\\n \\"error_message\\": \\"line 37:14: Column \'xyz\' cannot be resolved\\"\\n}","type":"json"}]', ], - 'TagResources' => [ - 'summary' => 'Creates and adds tags to a resource. You can add tags only to projects.', - 'path' => '/tag', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateAnnotationLabel' => [ + 'summary' => 'Updates a label table. You can update only the names of labels in a label set.', + 'path' => '/ml/annotationlabel', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'resourceType' => [ - 'title' => '', - 'description' => 'The type of the resource. Valid values:'."\n" - ."\n" - .'* project'."\n" - .'* logstore'."\n" - .'* dashboard'."\n" - .'* machinegroup'."\n" - .'* logtailconfig'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'project', - ], - 'resourceId' => [ - 'title' => '', - 'description' => 'The resource IDs. You can specify only one resource and add tags to the resource.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The resource ID. In this example, a Logstore is used. projectName indicates the project name. # is used to concatenate strings. logstore indicates the Logstore name.'."\n" - ."\n" - .'* project: projectName'."\n" - .'* logstore: projectName#logstore'."\n" - .'* dashboard: projectName#dashboard'."\n" - .'* machinegroup: projectName#machinegroup'."\n" - .'* logtailconfig: projectName#logtailconfig'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - ], - 'required' => true, - 'example' => '', - ], - 'tags' => [ - 'title' => '', - 'description' => 'The tags that you want to add to the resource. You can specify up to 20 tags in each call. Each tag is a key-value pair.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '', - 'description' => 'The key of the tag. The key must meet the following requirements:'."\n" - ."\n" - .'* The key must be `1 to 128` characters in length.'."\n" - .'* The key cannot contain `http://` or `https://`.'."\n" - .'* The key cannot start with `acs:` or `aliyun`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'value' => [ - 'title' => '', - 'description' => 'The value of the tag. The value must meet the following requirements:'."\n" - ."\n" - .'* The value must be `1 to 128` characters in length.'."\n" - .'* The value cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'value1', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], - 'required' => true, - 'example' => '', - ], - ], - 'required' => true, - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The struct of the label table.', '$ref' => '#/components/schemas/MLLabelParam', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [ 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], + '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' => 'TagResources', - 'description' => '### Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n" - .'* For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" - ."\n" - .'### Authentication resources'."\n" - ."\n" - .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" - ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:TagResources`|The resource format varies based on the resource type.\\-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}`|', + 'title' => 'UpdateAnnotationLabel', + 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'create', - 'ramAction' => [ - 'action' => 'log:TagResources', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}', - ], - ], - ], - ], - ], + 'ramActions' => [], ], - 'UntagResources' => [ - 'summary' => 'Detaches one or more tags from a resource. You can detach tags only from Simple Log Service projects. You can detach multiple or all tags from a Simple Log Service project at a time.', - 'path' => '/untag', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateAzureBlobIngestion' => [ + 'path' => '/azureblobingestions/{azureBlobIngestionName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', + 'abilityTreeCode' => '291251', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The project that contains the Azure Blob ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'azureBlobIngestionName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Azure Blob ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request struct.'."\n", 'type' => 'object', 'properties' => [ - 'resourceType' => [ - 'description' => 'The type of the resource. Valid values:'."\n" - ."\n" - .'* project'."\n" - .'* logstore'."\n" - .'* dashboard'."\n" - .'* machinegroup'."\n" - .'* logtailconfig'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'project' => 'project', - ], - 'example' => 'project', - 'title' => '', - ], - 'resourceId' => [ - 'description' => 'The resource IDs. Each time you call this operation, you can unbind tags only from a single resource. Therefore, you can enter only one resource ID.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID. In this example, a Logstore is used. projectName indicates the project name. # is used to concatenate strings. logstore indicates the Logstore name.'."\n" - ."\n" - .'* project: projectName'."\n" - .'* logstore: projectName#logstore'."\n" - .'* dashboard: projectName#dashboard'."\n" - .'* machinegroup: projectName#machinegroup'."\n" - .'* logtailconfig: projectName#logtailconfig'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ali-test-project', - 'title' => '', - ], - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], - 'all' => [ - 'description' => 'Specifies whether to unbind all tags. Default value: false. Valid values:'."\n" - ."\n" - .'* false: unbinds only the tags that match the value of tags.'."\n" - .'* true: unbinds all tags that are bound to the resource.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], - 'tags' => [ - 'description' => 'The tag keys. If you set all to false, only the tags that match the value of this parameter are unbound.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - 'title' => '', - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'description' => ['description' => 'The updated description for the Azure Blob ingestion task.', 'type' => 'string', 'title' => '', 'example' => ''], + 'displayName' => ['description' => 'The updated display name for the Azure Blob ingestion task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ''], + 'schedule' => ['description' => 'The updated ingestion schedule.', '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], + 'configuration' => ['description' => 'The updated configuration for the Azure Blob ingestion task.', 'required' => true, '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', 'title' => '', 'example' => ''], ], - 'required' => false, + 'description' => 'The request body that contains the updated settings for the Azure Blob ingestion task.', 'title' => '', 'example' => '', ], @@ -37342,345 +22086,193 @@ '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' => 'UntagResources', - 'description' => '### Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~) For more information, see [Authorization rules](~~29049~~). The following types of resources are supported: project, Logstore, dashboard, machine group, and Logtail configuration.'."\n" - ."\n" - .'### Authentication resources'."\n" - ."\n" - .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" - ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:UntagResources`|The resource format varies based on the resource type.\\-`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/logstore/${logstoreName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/dashboard/${dashboardName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/machinegroup/${machineGroupName}`\\-`acs:log:${regionName}:${accountId}:project/${projectName}/logtailconfig/${logtailConfigName}`|', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateAzureBlobIngestion', + 'summary' => 'Updates an Azure Blob ingestion.', '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}', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'UpdateAgentInstanceConfig' => [ - 'path' => '/agentinstanceconfigs/{configType}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateConfig' => [ + 'summary' => 'Modifies a Logtail configuration.', + 'path' => '/configs/{configName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeCode' => '227394', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '9091', + 'abilityTreeNodes' => ['FEATUREslsYP6SBU'], ], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'configName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Logtail configuration file.', 'type' => 'string', 'required' => true, 'example' => 'test-sample', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'config' => [ - 'description' => 'The default configurations.', - 'type' => 'string', - 'required' => true, - 'example' => '{}', - 'title' => '', - ], - 'grayConfigs' => [ - 'type' => 'array', - 'items' => [ - 'description' => 'A configuration for the canary release environment.', - '$ref' => '#/components/schemas/AgentInstanceConfigGrayConfigs', - 'required' => false, - 'title' => '', - 'example' => '', - ], - 'description' => 'The configurations for the canary release environment.', - 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - 'description' => 'The request body.', - 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'configType', - 'in' => 'path', - 'schema' => [ - 'description' => 'The type of the process-level configuration.', - 'enumValueTitles' => [ - 'apm_biz_trace' => 'apm\\_biz\\_trace', - 'apm_self_protect' => 'apm\\_self\\_protect', - 'apm_convergence' => 'apm\\_convergence', - 'apm_custom_extract' => 'apm\\_custom\\_extract', - 'apm_pilot' => 'apm\\_pilot', - 'apm_trace' => 'apm\\_trace', - 'rum_app_config' => 'rum\\_app\\_config', - 'rum_web_config' => 'rum\\_web\\_config', - 'apm_biz_trace_global' => 'apm\\_biz\\_trace\\_global', - 'apm_intacheap' => 'apm\\_intacheap', - 'apm_user_method' => 'apm\\_user\\_method', - 'apm_global' => 'apm\\_global', - 'apm_forward_process' => 'apm\\_forward\\_process', - ], - 'type' => 'string', - 'required' => true, - 'example' => 'apm_biz_trace', - 'title' => '', - ], - ], - [ - 'name' => 'attributes', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The attributes that specify the scope of the process-level configuration.', - 'type' => 'string', - 'example' => '"workspace": "test-workspace"'."\n" - .'"service": "test-service"', - 'title' => '', - ], - 'description' => 'The attributes that specify the scope of the process-level configuration.', - 'required' => false, - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The body of the request.', '$ref' => '#/components/schemas/LogtailConfig', 'required' => false, 'title' => '', 'example' => ''], ], ], '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'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'title' => 'UpdateAgentInstanceConfig', - 'summary' => 'Updates process-level configurations.', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'UpdateConfig', + 'description' => '### [](#)Usage notes'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- After you update a Logtail configuration that is applied to a machine group, the new configuration immediately takes effect.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" + ."\n" + .'- The Logtail configuration is planned out. For more information, see [Logtail configurations](~~29058~~).', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ConfigNotExist| Config configName does not exist. | Logtail配置不存在。 |'."\n" + .'| 400 | InvalidParameter| invalid config resource json. | 无效Logtail配置参数。 |'."\n" + .'| 400 | BadRequest| Config resource configname does not match with request.| Logtail配置名称不符合要求。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - ], - 'UpdateAlert' => [ - 'summary' => 'Updates an alert rule.', - 'path' => '/alerts/{alertName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], + ], + ], + ], ], + ], + 'UpdateConsumerGroup' => [ + 'summary' => 'Updates the attributes of a consumer group.', + 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '200217', - 'abilityTreeNodes' => [ - 'FEATUREsls7LA3N2', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'alertName', + 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'alert-0123456789-123456', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'logstore-test', 'title' => ''], + ], + [ + 'name' => 'consumerGroup', + 'in' => 'path', + 'schema' => ['description' => 'The name of the consumer group.', 'type' => 'string', 'required' => true, 'example' => 'consumer-group-1', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The new configurations of the alert rule.'."\n", + 'description' => 'The request body. At least one of order and timeout has a value.', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => 'The display name of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'this is alert', - 'title' => '', - ], - 'description' => [ - 'description' => 'The description of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is description', - 'title' => '', - ], - 'configuration' => [ - 'description' => 'The detailed configurations of the alert rule.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/AlertConfiguration', - 'title' => '', - 'example' => '', - ], - 'schedule' => [ - 'description' => 'The scheduling settings of the alert rule.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - 'title' => '', - 'example' => '', - ], + 'order' => ['description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" + ."\n" + .'- true: If a shard is split, the data in the original shard is consumed first. Then, the data in the new shards is consumed at the same time. If shards are merged, the data in the original shards is consumed first. Then, the data in the new shard is consumed.'."\n" + ."\n" + .'- false: The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or shards are merged, the data in the new shard is immediately consumed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'timeout' => ['description' => 'The timeout period. If Simple Log Service does not receive heartbeats from a consumer within the timeout period, Simple Log Service deletes the consumer. Unit: seconds', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', 'title' => ''], ], - 'required' => false, + 'required' => true, 'title' => '', 'example' => '', ], @@ -37690,61 +22282,54 @@ 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' => 'UpdateAlert', + 'title' => 'UpdateConsumerGroup', + 'description' => '### Usage notes'."\n" + ."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" + ."\n" + .'### Authentication resources'."\n" + ."\n" + .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" + ."\n" + .'| Action | Resource |'."\n" + .'| :------------------------ | :---------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `log:UpdateConsumerGroup` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}` |', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 400 | JsonInfoInvalid| timeout is of error value type. | 参数timeout类型错误。 |'."\n" + .'| 400 | ConsumerGroupNotExist | consumer group not exist. | 消费组不存在。 |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -37753,62 +22338,77 @@ [ 'operationType' => 'update', 'ramAction' => [ - 'action' => 'log:UpdateAlert', + 'action' => 'log:UpdateConsumerGroup', 'authLevel' => 'resource', - 'actionConditions' => [], + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], ], ], ], ], ], - 'UpdateAnnotationDataSet' => [ - 'summary' => 'Updates a dataset.', - 'path' => '/ml/annotationdataset/{datasetId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDashboard' => [ + 'summary' => 'Updates a dashboard.', + 'path' => '/dashboards/{dashboardName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', + 'abilityTreeCode' => '10279', + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ - 'name' => 'datasetId', + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'dashboardName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique ID of the dataset.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'cb8cc4eb51a85e823471cdb368fae9be', - ], + 'schema' => ['description' => 'The name of the dashboard.', 'type' => 'string', 'required' => true, 'example' => 'dashboard-1609294922657-434834', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The request body.', + 'description' => 'The data structure of the dashboard.', + 'type' => 'object', + 'properties' => [ + 'dashboardName' => ['description' => 'The name of the dashboard.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dashboard-1609294922657-434834'], + 'displayName' => ['description' => 'The display name of the dashboard.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Method pv'], + 'description' => ['description' => 'The description of the dashboard.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test dashboard.'], + 'attribute' => [ + 'title' => '', + 'description' => 'The attribute values of the dashboard.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The attribute value of the dashboard.', 'type' => 'string', 'example' => '“”', 'title' => ''], + 'example' => '', + ], + 'charts' => [ + 'title' => '', + 'description' => 'The charts on the dashboard.', + 'type' => 'array', + 'items' => ['description' => 'The data structure of the chart.', '$ref' => '#/components/schemas/chart', 'required' => false, 'title' => '', 'example' => ''], + 'required' => true, + 'example' => '', + ], + ], 'required' => false, - '$ref' => '#/components/schemas/MLDataSetParam', 'title' => '', 'example' => '', ], @@ -37818,93 +22418,94 @@ 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' => 'UpdateAnnotationDataSet', - 'description' => 'The endpoint for this operation is available only in the China (Shanghai) and Singapore regions.', + 'title' => 'UpdateDashboard', + 'description' => '### [](#)Usage notes'."\n" + ."\n" + .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - 'translator' => 'machine', - ], - 'UpdateAnnotationLabel' => [ - 'summary' => 'Updates a label table. You can update only the names of labels in a label set.', - 'path' => '/ml/annotationlabel', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateDashboard', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], + ], + ], + ], + ], + ], + 'UpdateETL' => [ + 'summary' => 'Updates the configuration of a specified data transformation task and restarts it.', + 'path' => '/etls/{etlName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], ], + 'consumes' => ['application/json'], 'produces' => [], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', + 'abilityTreeCode' => '203169', + 'abilityTreeNodes' => ['FEATUREsls1DZPIM'], ], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], + [ + 'name' => 'etlName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the data transformation task.', 'type' => 'string', 'required' => true, 'example' => 'etl-123456', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The struct of the label table.', + 'description' => 'The updated configuration for the data transformation task.', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => 'The display name of the data transformation task.', 'type' => 'string', 'required' => true, 'example' => 'this is update', 'title' => ''], + 'description' => ['description' => 'The description of the data transformation task.', 'type' => 'string', 'required' => false, 'example' => 'this is description', 'title' => ''], + 'configuration' => ['description' => 'The detailed configuration of the data transformation task.', 'required' => true, '$ref' => '#/components/schemas/ETLConfiguration', 'title' => '', 'example' => ''], + ], 'required' => false, - '$ref' => '#/components/schemas/MLLabelParam', 'title' => '', 'example' => '', ], @@ -37914,113 +22515,63 @@ 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' => 'UpdateAnnotationLabel', - 'description' => 'This operation is available only in the China (Shanghai) and Singapore regions.', + 'title' => 'UpdateETL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'translator' => 'machine', ], - 'UpdateAzureBlobIngestion' => [ - 'summary' => 'Updates an Azure BLOB file import job.', - 'path' => '/azureblobingestions/{azureBlobIngestionName}', - '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' => '291251', - 'abilityTreeNodes' => [ - 'FEATUREsls0Z6RJ5', - ], + 'abilityTreeCode' => '287679', + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'Name of the project', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'azureBlobIngestionName', + 'name' => 'elasticsearchIngestionName', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'Name of the ES or OpenSearch ingestion task', 'type' => 'string', 'required' => true, 'example' => 'ingest-elasticsearch-123456', 'title' => ''], ], [ 'name' => 'body', @@ -38029,36 +22580,15 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'displayName' => [ - 'type' => 'string', - 'required' => true, - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'schedule' => [ - '$ref' => '#/components/schemas/Schedule', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'configuration' => [ - 'required' => true, - '$ref' => '#/components/schemas/AzureBlobIngestionConfiguration', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'description' => ['description' => 'Description of the ES or OpenSearch ingestion task', 'type' => 'string', 'required' => false, 'example' => 'es ingestion test', 'title' => ''], + 'displayName' => ['description' => 'Display name of the ES or OpenSearch ingestion task', 'type' => 'string', 'required' => true, 'example' => 'es-ingestion-test', 'title' => ''], + 'schedule' => ['description' => 'Scheduling type. Leave this field empty unless you need strict scheduling. For example, to run the ingestion task every Monday at 8:00 a.m., use a cron expression', '$ref' => '#/components/schemas/Schedule', 'required' => false, 'title' => '', 'example' => ''], + 'configuration' => ['description' => 'ES or OpenSearch ingestion configuration', 'required' => true, '$ref' => '#/components/schemas/ESIngestionConfiguration', 'title' => '', 'example' => ''], ], - 'description' => '', + 'description' => 'Request body', 'title' => '', 'example' => '', + 'required' => false, ], ], ], @@ -38066,115 +22596,80 @@ 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' => 'UpdateElasticsearchIngestion', + 'summary' => 'Updates an ES or OpenSearch ingestion task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateAzureBlobIngestion', ], - 'UpdateConfig' => [ - 'summary' => 'Modifies a Logtail configuration.', - 'path' => '/configs/{configName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateGCSIngestion' => [ + 'summary' => 'Updates a GCP Cloud Storage file ingestion task.', + 'path' => '/gcsingestions/{gcsIngestionName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'high', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '9091', - 'abilityTreeNodes' => [ - 'FEATUREslsYP6SBU', - ], + 'abilityTreeNodes' => ['FEATUREsls0Z6RJ5'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ - 'name' => 'configName', + 'name' => 'gcsIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logtail configuration file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-sample', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the GCS ingestion task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-gcs-123455', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The body of the request.'."\n", + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The description of the ingestion task.', 'type' => 'string', 'example' => 'Gcs import', 'required' => false, 'title' => ''], + 'displayName' => ['description' => 'The display name of the ingestion task.', 'type' => 'string', 'example' => 'Gcs import', 'required' => true, 'title' => ''], + 'configuration' => ['description' => 'The configuration of the ingestion task.', 'required' => true, '$ref' => '#/components/schemas/GCSIngestionConfiguration', 'title' => '', 'example' => ''], + ], + 'description' => 'The request body.', 'required' => false, - '$ref' => '#/components/schemas/LogtailConfig', 'title' => '', 'example' => '', ], @@ -38183,269 +22678,206 @@ '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' => ['description' => 'The response body.', 'type' => 'any', 'example' => '{}', 'title' => ''], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateConfig', - 'description' => '### [](#)Usage notes'."\n" - ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* After you update a Logtail configuration that is applied to a machine group, the new configuration immediately takes effect.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~).'."\n" - .'* The Logtail configuration is planned out. For more information, see [Logtail configurations](~~29058~~).'."\n", - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ConfigNotExist| Config configName does not exist. | Logtail配置不存在。 |'."\n" - .'| 400 | InvalidParameter| invalid config resource json. | 无效Logtail配置参数。 |'."\n" - .'| 400 | BadRequest| Config resource configname does not match with request.| Logtail配置名称不符合要求。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" - ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateGCSIngestion', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [ - [ - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'log:UpdateConfig', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}', - ], - ], - ], - ], - ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"\\"{}\\"","type":"json"}]', + 'translator' => 'machine', ], - 'UpdateConsumerGroup' => [ - 'summary' => 'Updates the attributes of a consumer group.', - 'path' => '/logstores/{logstore}/consumergroups/{consumerGroup}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'logstore-test', - 'title' => '', - ], - ], - [ - 'name' => 'consumerGroup', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the consumer group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'consumer-group-1', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body. At least one of order and timeout has a value.'."\n", + 'title' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'order' => [ - 'description' => 'Specifies whether to consume data in sequence. Valid values:'."\n" - ."\n" - .'* true: If a shard is split, the data in the original shard is consumed first. Then, the data in the new shards is consumed at the same time. If shards are merged, the data in the original shards is consumed first. Then, the data in the new shard is consumed.'."\n" - .'* false: The data in all shards is consumed at the same time. If a new shard is generated after a shard is split or shards are merged, the data in the new shard is immediately consumed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'keys' => [ 'title' => '', - ], - 'timeout' => [ - 'description' => 'The timeout period. If Simple Log Service does not receive heartbeats from a consumer within the timeout period, Simple Log Service deletes the consumer. Unit: seconds'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The configuration of field indexes. A field index is a key-value pair in which the key specifies the name of the field and the value specifies the index configuration of the field.', + 'type' => 'object', 'required' => false, - 'example' => '300', - 'title' => '', - ], - ], - 'required' => true, - 'title' => '', - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', + 'additionalProperties' => [ + 'title' => '', + 'description' => 'The index configuration of the field.', + 'type' => 'object', + 'properties' => [ + 'caseSensitive' => ['description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean'], + 'chn' => ['description' => 'Specifies whether to include Chinese characters. This parameter is required only when **type** is set to **text**. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean'], + 'type' => [ + 'description' => 'The data type of the field value. Valid values: text, json, double, and long.', + 'enumValueTitles' => ['double' => 'double', 'json' => 'json', 'text' => 'text', 'long' => 'long'], + 'type' => 'string', + ], + 'alias' => ['description' => 'The alias of the field.', 'type' => 'string'], + 'token' => [ + 'title' => '', + 'description' => 'The delimiters that are used to split text. This parameter is required only when type is set to text.', + 'type' => 'array', + 'items' => ['description' => 'The delimiter that is used to split text.', 'type' => 'string'], + 'required' => true, + ], + 'doc_value' => ['description' => 'Specifies whether to turn on Enable Analytics for the field.', 'type' => 'boolean'], + ], + 'required' => true, + ], ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', + 'line' => [ + 'title' => '', + 'description' => 'The configuration of full-text indexes.', + 'type' => 'object', + 'properties' => [ + 'chn' => ['description' => 'Specifies whether to include Chinese characters. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean'], + 'caseSensitive' => ['description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean'], + 'token' => [ + 'title' => '', + 'description' => 'The delimiters that are used to split text.', + 'type' => 'array', + 'items' => ['description' => 'The delimiter that is used to split text.', 'type' => 'string'], + 'required' => true, + ], + 'include_keys' => [ + 'title' => '', + 'description' => 'The included fields. You cannot specify both include\\_keys and exclude\\_keys.', + 'type' => 'array', + 'items' => ['description' => 'The included field.', 'type' => 'string'], + 'required' => false, + ], + 'exclude_keys' => [ + 'title' => '', + 'description' => 'The excluded fields. You cannot specify both include\\_keys and exclude\\_keys.', + 'type' => 'array', + 'items' => ['description' => 'The excluded field.', 'type' => 'string'], + 'required' => false, + ], + ], + 'required' => false, + ], + 'ttl' => ['description' => 'The retention period of data. Unit: days. Valid values: 7, 30, and 90.', 'type' => 'integer'], + 'max_text_len' => ['description' => 'The maximum length of a field value that can be retained.', 'type' => 'integer'], + 'log_reduce' => ['description' => 'Specifies whether to turn on LogReduce. If you turn on LogReduce, only one of `log_reduce_white_list` and `log_reduce_black_list` takes effect.', 'type' => 'boolean'], + 'log_reduce_white_list' => [ + 'title' => '', + 'description' => 'The fields in the whitelist that you want to use to cluster logs.', + 'type' => 'array', + 'items' => ['description' => 'The field in the whitelist.', 'type' => 'string'], + 'required' => false, + ], + 'log_reduce_black_list' => [ + 'title' => '', + 'description' => 'The fields in the blacklist that you want to use to cluster logs.', + 'type' => 'array', + 'items' => ['description' => 'The field in the blacklist.', 'type' => 'string'], + 'required' => false, ], ], + 'required' => false, + '$ref' => '#/components/schemas/index', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], + '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'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateConsumerGroup', + 'title' => 'UpdateIndex', + 'summary' => 'Updates the indexes of a Logstore.', 'description' => '### Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - ."\n" - .'### Authentication resources'."\n" - ."\n" - .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" - ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:UpdateConsumerGroup`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}`|', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 400 | JsonInfoInvalid| timeout is of error value type. | 参数timeout类型错误。 |'."\n" - .'| 400 | ConsumerGroupNotExist | consumer group not exist. | 消费组不存在。 |'."\n" - .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" - .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" - ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。'."\n", + .'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -38454,135 +22886,96 @@ [ 'operationType' => 'update', 'ramAction' => [ - 'action' => 'log:UpdateConsumerGroup', + 'action' => 'log:UpdateIndex', '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/{#project}/logstore/{#logstore}'], ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', ], - 'UpdateDashboard' => [ - 'summary' => 'Updates a dashboard.', - 'path' => '/dashboards/{dashboardName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateLogStore' => [ + 'summary' => 'Updates the properties of a Logstore.', + 'path' => '/logstores/{logstore}', + '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', - ], + 'abilityTreeCode' => '115728', + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ - 'name' => 'dashboardName', + 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the dashboard.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The data structure of the dashboard.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'dashboardName' => [ - 'title' => '', - 'description' => 'The name of the dashboard.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dashboard-1609294922657-434834', - ], - 'displayName' => [ - 'title' => '', - 'description' => 'The display name of the dashboard.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Method pv', - ], - 'description' => [ - 'title' => '', - 'description' => 'The description of the dashboard.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test dashboard.', - ], - 'attribute' => [ - 'title' => '', - 'description' => 'The attribute values of the dashboard.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '“”', - 'description' => 'The attribute value of the dashboard.'."\n", - 'title' => '', - ], - 'example' => '', - ], - 'charts' => [ - 'title' => '', - 'description' => 'The charts on the dashboard.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data structure of the chart.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/chart', - 'title' => '', - 'example' => '', - ], - 'required' => true, - 'example' => '', - ], + 'logstoreName' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], + 'shardCount' => ['description' => 'The number of shards.'."\n" + ."\n" + .'> You cannot update the number of shards with this operation. To change the number of shards, call the SplitShard or MergeShards operation.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '2', 'title' => ''], + 'ttl' => ['description' => 'The data retention period. Unit: days. Valid values: 1 to 3650. If you set this parameter to 3650, the data is permanently retained.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30', 'title' => ''], + 'encrypt_conf' => ['description' => 'The encryption configuration.', 'required' => false, '$ref' => '#/components/schemas/EncryptConf', 'title' => '', 'example' => ''], + 'autoSplit' => ['description' => 'Specifies whether to automatically split a shard.'."\n" + ."\n" + .'- true: automatically splits a shard.'."\n" + ."\n" + .'- false: does not automatically split a shard.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'enable_tracking' => ['description' => 'Specifies whether to enable web tracking. Default value: false.'."\n" + ."\n" + .'- true: enables web tracking.'."\n" + ."\n" + .'- false: does not enable web tracking.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'appendMeta' => ['description' => 'Specifies whether to record public IP addresses. Default value: false.'."\n" + ."\n" + .'- true: records public IP addresses.'."\n" + ."\n" + .'- false: does not record public IP addresses.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'maxSplitShard' => ['description' => 'The maximum number of shards to which a shard can be split. The value must be an integer from 1 to 256.'."\n" + ."\n" + .'> This parameter is required if autoSplit is set to true.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '64', 'title' => ''], + 'telemetryType' => ['description' => 'The type of observable data. Valid values:'."\n" + ."\n" + .'- None: logs. This is the default value.'."\n" + ."\n" + .'- Metrics: metrics.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'None', 'title' => ''], + 'hot_ttl' => ['description' => 'The retention period of data in the hot tier of the Logstore. Minimum value: 7. Unit: days. Valid values: 7 to 3000. After the retention period of the hot tier ends, the data is moved to the Infrequent Access (IA) storage class. For more information, see [Automatic Storage Tiering](~~308645~~).', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '60'], + 'mode' => ['description' => 'SLS provides two types of Logstores: Standard and Query.'."\n" + ."\n" + .'- **standard**: supports one-stop data analytics. This type of Logstore is suitable for scenarios such as real-time monitoring, interactive analysis, and building a complete observability system.'."\n" + ."\n" + .'- **query**: supports high-performance queries. The index traffic cost of a Query Logstore is about half that of a Standard Logstore. However, a Query Logstore does not support SQL analysis. This type of Logstore is suitable for scenarios that involve large data volumes, long retention periods of weeks or months, and no log analysis.', 'type' => 'string', 'required' => false, 'example' => 'standard', 'title' => ''], + 'infrequentAccessTTL' => ['description' => 'The retention period for data in the IA storage class. Data in this storage class has no minimum retention period. Data must be stored for at least 30 days before it is moved to Archive storage.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], + 'shardingPolicy' => ['description' => 'The hash-based write configuration.', '$ref' => '#/components/schemas/ShardingPolicy', 'title' => '', 'required' => false, 'example' => ''], ], - 'required' => false, + 'required' => true, 'title' => '', 'example' => '', ], @@ -38592,56 +22985,61 @@ 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' => 'UpdateDashboard', - 'description' => '### [](#)Usage notes'."\n" + 'title' => 'UpdateLogStore', + 'description' => '### Usage notes'."\n" ."\n" - .'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", - 'changeSet' => [], + .'- Before you update a Logstore, call the GetLogStore operation to retrieve the configuration of the Logstore. Then, modify the configuration and pass it to the UpdateLogStore operation.'."\n" + ."\n" + .'- The Host in the request syntax consists of a project name and a Simple Log Service (SLS) endpoint. You must specify the project in the Host.'."\n" + ."\n" + .'- Obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'An AccessKey pair for an Alibaba Cloud account has permissions on all API operations. This poses a high security risk. We recommend that you create and use a Resource Access Management (RAM) user to make API calls or perform routine O\\&M. The RAM user must be granted the required permissions to operate SLS resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" + ."\n" + .'- Obtain the project name, the Logstore name, and the region where the project resides. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).'."\n" + ."\n" + .'### Authorization'."\n" + ."\n" + .'The following table describes the authorization required for this operation. To grant a RAM user or RAM role permission to call this operation, add the required action to the Action element of a RAM policy.'."\n" + ."\n" + .'| Action | Resource description in an authorization policy |'."\n" + .'| :------------------- | :--------------------------------------------------------------------------------- |'."\n" + .'| `log:UpdateLogStore` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', + 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" + .'| :------------ | :------------ | :------------ | :------------ |'."\n" + .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" + .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" + .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + ."\n" + .'更多信息，请参见[通用错误码](~~29013~~)。', + 'changeSet' => [ + ['createdAt' => '2025-12-03T01:37:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-12-02T11:55:07.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], + ], 'flowControl' => [ 'flowControlList' => [], ], @@ -38649,42 +23047,30 @@ [ 'operationType' => 'update', 'ramAction' => [ - 'action' => 'log:UpdateDashboard', + 'action' => 'log:UpdateLogStore', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ['conditionKey' => 'log:Encrypted', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], ], ], ], ], ], - 'UpdateDataset' => [ - 'path' => '/datasets/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateLogStoreEncryption' => [ + 'summary' => 'Updates the encryption configuration of a Logstore. You can create encryption configurations for the Logstore and enable or disable the encryption feature.', + 'path' => '/logstores/{logstore}/encryption', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -38692,145 +23078,159 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '296326', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '250787', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The Simple Log Service project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The Logstore.', 'type' => 'string', 'required' => true, 'example' => 'test-logstore', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'title' => '', + 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'description' => [ + 'enable' => ['description' => 'Specifies whether to enable the encryption feature. After you update the encryption configuration of the Logstore, you can modify only the enable parameter in subsequent update requests. You cannot modify the encryptType or userCmkInfo parameters.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], + 'encryptType' => [ + 'description' => 'The encryption algorithm. Valid values: default, m4, sm4\\_ecb, sm4\\_cbc, sm4\\_gcm, aes\\_ecb, aes\\_cbc, aes\\_cfb, aes\\_ofb, and aes\\_gcm.', 'type' => 'string', - 'description' => '', + 'enum' => ['default', 'm4', 'sm4_ecb', 'sm4_cbc', 'sm4_gcm', 'aes_ecb', 'aes_cbc', 'aes_cfb', 'aes_ofb', 'aes_gcm'], + 'title' => '', + 'required' => false, + 'example' => 'default', + ], + 'userCmkInfo' => [ 'title' => '', + 'description' => 'Optional. If you use a BYOK key to encrypt logs, you must specify this parameter. If you use the service key of Simple Log Service to encrypt logs, you do not need to specify this parameter.', + 'type' => 'object', + 'properties' => [ + 'keyId' => ['description' => 'The ID of the CMK to which the BYOK key belongs. You can create a CMK in KMS. The CMK must be in the same region as the endpoint of Simple Log Service.', 'type' => 'string', 'example' => 'f5136b95-2420-ab31-xxxxxxxxx', 'title' => '', 'required' => false], + 'roleArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.The value is in the acs:ram::12344\\*\\*\\*:role/xxxxx format. To use a BYOK key to encrypt logs, you must create a RAM role and grant the AliyunKMSReadOnlyAccess and AliyunKMSCryptoUserAccess permissions to the RAM role. You must grant the API caller the PassRole permission on the RAM role.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'acs:ram::12344***:role/xxxxx'], + 'regionId' => ['description' => 'The region ID. Example: cn-hangzhou.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'], + ], + 'required' => false, 'example' => '', ], ], - 'description' => '', - 'title' => '', + 'required' => false, 'example' => '', ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'ProjectNotExist', 'errorMessage' => 'The Project does not exist: xxxx.', 'description' => 'The log entry does not exist.'], + ['errorCode' => 'LogStoreNotExist', 'errorMessage' => 'logstore xxxx does not exist.', 'description' => 'The Logstore does not exist.'], + ], ], - 'summary' => 'Updates a dataset.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'UpdateLogStoreEncryption', + 'description' => '## [](#)Limits'."\n" + ."\n" + .'If you specify a data encryption method when you configure data encryption settings, you cannot switch to the other method after the configuration. In addition, you cannot change the encryption algorithm or the encryption type. You can only enable or disable the encryption feature by using the enable parameter. If you specify the encryption method by using the service key of Simple Log Service when you configure data encryption settings, you cannot switch to the encryption method by using Bring Your Own Key (BYOK) keys after the configuration.'."\n" + ."\n" + .'## [](#)Create encryption configurations'."\n" + ."\n" + .'### [](#)Encryption by using service keys'."\n" + ."\n" + .'Simple Log Service is fully responsible for data encryption and key management. No additional operations are required. When you create encryption configurations for the Logstore, you must specify the enable and encryptType parameters.'."\n" + ."\n" + .'### [](#byok)Encryption by using BYOK keys'."\n" + ."\n" + .'You must create a customer master key (CMK) in Key Management Service (KMS). Then, Simple Log Service encrypts logs by using the CMK. When you create encryption configurations for the Logstore, you must specify the enable, encryptType, and userCmkInfo parameters.'."\n" + ."\n" + .'## [](#)Enable or disable the encryption feature'."\n" + ."\n" + .'After you create encryption configurations for the Logstore, you cannot modify the encryptType or userCmkInfo parameters. However, you can enable and disable the encryption feature by using the enable parameter.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateDataset', ], - 'UpdateETL' => [ - 'summary' => 'Updates the configuration of a specified data transformation task and restarts it.', - 'path' => '/etls/{etlName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateLogStoreMeteringMode' => [ + 'summary' => 'Changes the billing mode of a Logstore.', + 'path' => '/logstores/{logstore}/meteringmode', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '203169', - 'abilityTreeNodes' => [ - 'FEATUREsls1DZPIM', - ], + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'description' => 'The name of the project.', - 'title' => '', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'projectName', 'title' => ''], ], [ - 'name' => 'etlName', + 'name' => 'logstore', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the data transformation task.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'etl-123456', - ], + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => true, 'example' => 'logstoreName', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The updated configuration for the data transformation task.', + 'description' => 'The body of the request.', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => 'The display name of the data transformation task.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'this is update', - ], - 'description' => [ - 'description' => 'The description of the data transformation task.', + 'meteringMode' => [ + 'description' => 'The billing mode. Valid values: ChargeByFunction and ChargeByDataIngest. Default value: ChargeByFunction. The value ChargeByFunction specifies the pay-by-feature billing mode. The value ChargeByDataIngest specifies the pay-by-ingested-data billing mode.', 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => 'this is description', - ], - 'configuration' => [ - 'description' => 'The detailed configuration of the data transformation task.', 'required' => true, - '$ref' => '#/components/schemas/ETLConfiguration', + 'example' => 'ChargeByFunction', + 'default' => 'ChargeByFunction', + 'enum' => ['ChargeByDataIngest', 'ChargeByFunction', 'ChargeByDataIngest_15', 'ChargeByDataIngest_7', 'ChargeByDataIngest_3'], 'title' => '', - 'example' => '', ], ], 'required' => false, @@ -38842,106 +23242,153 @@ 'responses' => [ 200 => [ 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], ], 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], ], '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-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateETL', + 'title' => 'UpdateLogStoreMeteringMode', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], - 'ramActions' => [], - ], - 'UpdateIndex' => [ - 'path' => '/logstores/{logstore}/index', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateLogStoreMeteringMode', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'UpdateLogStoreProcessor' => [ + 'summary' => 'Updates the ingest processor for a Logstore.', + 'path' => '/logstores/{logstore}/processor', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '8958', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240235', + 'abilityTreeNodes' => ['FEATUREslsTA08U2'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'logstore', 'in' => 'path', + 'schema' => ['description' => 'The name of the logstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-logstore'], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'processorName' => ['description' => 'The name of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'parse-nginx-log'], + ], + 'required' => false, 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'UpdateLogStoreProcessor', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateLogging' => [ + 'summary' => 'Updates the service log configurations of a project.', + 'path' => '/logging', + 'methods' => ['put'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', @@ -38951,402 +23398,344 @@ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'keys' => [ + 'loggingProject' => ['description' => 'The name of the project to which you want to save service logs.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], + 'loggingDetails' => [ 'title' => '', - 'description' => 'The configuration of field indexes. A field index is a key-value pair in which the key specifies the name of the field and the value specifies the index configuration of the field.', - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ + 'description' => 'The configurations of service logs.', + 'type' => 'array', + 'items' => [ 'title' => '', - 'description' => 'The index configuration of the field.', + 'description' => '', 'type' => 'object', 'properties' => [ - 'caseSensitive' => [ - 'description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" + 'type' => [ + 'description' => 'The type of service logs. Valid values:'."\n" ."\n" - .'- true'."\n" + .'- consumergroup\\_log: the consumption delay logs of consumer groups.'."\n" ."\n" - .'- false', - 'type' => 'boolean', - ], - 'chn' => [ - 'description' => 'Specifies whether to include Chinese characters. This parameter is required only when **type** is set to **text**. Valid values:'."\n" + .'- logtail\\_alarm: the alert logs of Logtail.'."\n" ."\n" - .'- true'."\n" + .'- operation\\_log: the operation logs.'."\n" ."\n" - .'- false', - 'type' => 'boolean', - ], - 'type' => [ - 'description' => 'The data type of the field value. Valid values: text, json, double, and long.', - 'enumValueTitles' => [ - 'double' => 'double', - 'json' => 'json', - 'text' => 'text', - 'long' => 'long', - ], - 'type' => 'string', - ], - 'alias' => [ - 'description' => 'The alias of the field.', + .'- logtail\\_profile: the collection logs of Logtail.'."\n" + ."\n" + .'- metering: the metering logs.'."\n" + ."\n" + .'- logtail\\_status: the status logs of Logtail.'."\n" + ."\n" + .'- scheduledsqlalert: the operational logs of Scheduled SQL jobs.'."\n" + ."\n" + .'- etl\\_alert: the operational logs of data transformation jobs.', 'type' => 'string', - ], - 'token' => [ - 'title' => '', - 'description' => 'The delimiters that are used to split text. This parameter is required only when type is set to text.', - 'type' => 'array', - 'items' => [ - 'description' => 'The delimiter that is used to split text.', - 'type' => 'string', - ], 'required' => true, + 'example' => 'consumergroup_log', + 'enum' => ['consumergroup_log', 'logtail_alarm', 'operation_log', 'logtail_profile', 'metering', 'logtail_status', 'scheduled_sql_alert', 'etl_alert'], + 'title' => '', ], - 'doc_value' => [ - 'description' => 'Specifies whether to turn on Enable Analytics for the field.', - 'type' => 'boolean', - ], + 'logstore' => ['description' => 'The name of the Logstore to which you want to save service logs.', 'type' => 'string', 'required' => true, 'example' => 'my-logstore', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'example' => '', ], + 'required' => true, + 'example' => '', ], - 'line' => [ - 'title' => '', - 'description' => 'The configuration of full-text indexes.', - 'type' => 'object', - 'properties' => [ - 'chn' => [ - 'description' => 'Specifies whether to include Chinese characters. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - ], - 'caseSensitive' => [ - 'description' => 'Specifies whether to enable case sensitivity. Valid values:'."\n" - ."\n" - .'- true'."\n" - ."\n" - .'- false', - 'type' => 'boolean', - ], - 'token' => [ - 'title' => '', - 'description' => 'The delimiters that are used to split text.', - 'type' => 'array', - 'items' => [ - 'description' => 'The delimiter that is used to split text.', - 'type' => 'string', - ], - 'required' => true, - ], - 'include_keys' => [ - 'title' => '', - 'description' => 'The included fields. You cannot specify both include\\_keys and exclude\\_keys.', - 'type' => 'array', - 'items' => [ - 'description' => 'The included field.', - 'type' => 'string', - ], - 'required' => false, - ], - 'exclude_keys' => [ - 'title' => '', - 'description' => 'The excluded fields. You cannot specify both include\\_keys and exclude\\_keys.', - 'type' => 'array', - 'items' => [ - 'description' => 'The excluded field.', - 'type' => 'string', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'ttl' => [ - 'description' => 'The retention period of data. Unit: days. Valid values: 7, 30, and 90.', - 'type' => 'integer', - ], - 'max_text_len' => [ - 'description' => 'The maximum length of a field value that can be retained.', - 'type' => 'integer', - ], - 'log_reduce' => [ - 'description' => 'Specifies whether to turn on LogReduce. If you turn on LogReduce, only one of `log_reduce_white_list` and `log_reduce_black_list` takes effect.', - 'type' => 'boolean', - ], - 'log_reduce_white_list' => [ - 'title' => '', - 'description' => 'The fields in the whitelist that you want to use to cluster logs.', - 'type' => 'array', - 'items' => [ - 'description' => 'The field in the whitelist.', - 'type' => 'string', - ], - 'required' => false, - ], - 'log_reduce_black_list' => [ - 'title' => '', - 'description' => 'The fields in the blacklist that you want to use to cluster logs.', - 'type' => 'array', - 'items' => [ - 'description' => 'The field in the blacklist.', - 'type' => 'string', - ], - 'required' => false, - ], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string', 'example' => 'nginx'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string', 'example' => 'application/json'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string', 'example' => '0'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string', 'example' => 'close'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string', 'example' => 'Sun, 27 May 2018 08:25:04 GMT'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string', 'example' => '5B0A6B60BB6EE39764D458B5'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'UpdateLogging', + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateLogging', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], + ], + ], + ], + ], + ], + 'UpdateLogs' => [ + 'path' => '/logstores/{logstore}/updatelogs', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'Request body', + 'type' => 'object', + 'properties' => [ + 'from' => ['description' => 'The start time of the query. This time refers to the log time specified when the log data was written.'."\n" + ."\n" + .'The time range defined by the request parameters from and to follows the left-closed, right-open principle. That is, the time range includes the start time but does not include the end time. If the values of from and to are the same, the range is invalid and the function returns an error directly.'."\n" + .'Unix timestamp format, representing the number of seconds since 1970-01-01 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268185', 'title' => ''], + 'to' => ['description' => 'The end time of the query. This time refers to the log time specified when the log data was written.'."\n" + ."\n" + .'The time range defined by the request parameters from and to follows the left-closed, right-open principle. That is, the time range includes the start time but does not include the end time. If the values of from and to are the same, the range is invalid and the function returns an error directly.'."\n" + .'Unix timestamp format, representing the number of seconds since 1970-01-01 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1627268200', 'title' => ''], + 'query' => ['description' => 'Optional: A query statement used to filter the logs to be updated. For more information, see [Query overview](~~43772~~).'."\n" + ."\n" + .'Note: This parameter only supports query statements and does not support analysis statements such as SPL or SQL.', 'type' => 'string', 'required' => false, 'example' => 'status: 401 ', 'title' => ''], + 'rowId' => ['description' => 'Optional: The value of the built-in field __rowid__ that is automatically returned in the query results.'."\n" + ."\n" + .'One of the two fields, rowId and query, must be specified. If both are specified, rowId takes higher priority.', 'type' => 'string', 'required' => false, 'example' => '0|1000001|638732499', 'title' => ''], + 'updateMode' => ['description' => 'Optional: The value can be full or partial. The default value is partial.'."\n" + .' - full —— The request body must contain all fields of the row. The server overwrites the entire old record with the new values.'."\n" + .' - partial —— The request body only needs to contain the fields to be modified. Fields that are not provided retain their original values.', 'type' => 'string', 'required' => false, 'example' => 'partial', 'title' => ''], + 'data' => ['description' => 'The data to be updated, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"status":"success"}', 'title' => ''], ], 'required' => false, - '$ref' => '#/components/schemas/index', + 'title' => '', 'example' => '', ], ], + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the Project.', 'type' => 'string', 'required' => false, 'example' => 'ali-project-test', 'title' => ''], + ], + [ + 'name' => 'logstore', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Logstore.', 'type' => 'string', 'required' => false, 'example' => 'ali-test-logstore', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'headers' => [ 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - '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' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'affectedRows' => ['description' => 'The number of updated log rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'example' => '', ], ], ], - 'title' => 'UpdateIndex', - 'summary' => 'Updates the indexes of a Logstore.', - 'description' => '### Usage notes'."\n" - ."\n" - .'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update Logs', + 'summary' => 'Updates log data in a specified Logstore under the specified Project.', + 'description' => 'The Host consists of the Project name and the Log Service endpoint. You need to specify the Project in the Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"affectedRows\\": 10\\n}","type":"json"}]', ], - 'UpdateLogStore' => [ - 'summary' => 'Updates the properties of a Logstore.', - 'path' => '/logstores/{logstore}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateLogtailPipelineConfig' => [ + 'summary' => 'Updates a Logtail pipeline configuration.', + 'path' => '/pipelineconfigs/{configName}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '115728', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191814', + 'abilityTreeNodes' => ['FEATUREsls9GTH7Z'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ - 'name' => 'logstore', + 'name' => 'configName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the Logtail pipeline configuration.', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.', + 'title' => '', + 'description' => 'The content of the Logtail pipeline configuration.', 'type' => 'object', 'properties' => [ - 'logstoreName' => [ - 'description' => 'The name of the Logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', + 'configName' => ['description' => 'The name of the configuration.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The name must be the same as the value of the configName parameter in the request path.'."\n" + ."\n" + .'>', 'type' => 'string', 'required' => true, 'example' => 'test-config', 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', 'title' => ''], + 'logSample' => ['description' => 'A sample log. Multiple logs are supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world'], + 'global' => ['description' => 'The global configuration.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => ''], + 'inputs' => [ 'title' => '', - ], - 'shardCount' => [ - 'description' => 'The number of shards.'."\n" + 'description' => 'The list of input plug-ins.'."\n" ."\n" - .'> You cannot update the number of shards with this operation. To change the number of shards, call the SplitShard or MergeShards operation.', - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => true, - 'required' => false, - 'example' => '2', - 'title' => '', - ], - 'ttl' => [ - 'description' => 'The data retention period. Unit: days. Valid values: 1 to 3650. If you set this parameter to 3650, the data is permanently retained.', - 'type' => 'integer', - 'format' => 'int32', + .'>'."\n" + ."\n" + .'Currently, you can configure only one input plug-in.'."\n" + ."\n" + .'>', + 'type' => 'array', + 'items' => ['description' => 'The input plug-in.'."\n" + ."\n" + .'> For the parameters of the file input plug-in, see [File plug-in](~~65064~~). For the parameters of other input plug-ins, see [Processing plug-ins](~~64957~~).', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "Type": "input_file",'."\n" + .' "FilePaths": ["/var/log/*.log"]'."\n" + .'}'], 'required' => true, - 'example' => '30', - 'title' => '', - ], - 'encrypt_conf' => [ - 'description' => 'The encryption configuration.', - 'required' => false, - '$ref' => '#/components/schemas/EncryptConf', - 'title' => '', + 'minItems' => 1, 'example' => '', ], - 'autoSplit' => [ - 'description' => 'Specifies whether to automatically split a shard.'."\n" - ."\n" - .'- true: automatically splits a shard.'."\n" - ."\n" - .'- false: does not automatically split a shard.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'processors' => [ 'title' => '', - ], - 'enable_tracking' => [ - 'description' => 'Specifies whether to enable web tracking. Default value: false.'."\n" + 'description' => 'The list of processing plug-ins.'."\n" ."\n" - .'- true: enables web tracking.'."\n" + .'> Processing plug-ins are classified into native processing plug-ins and extension processing plug-ins. For more information, see [Processing plug-ins](~~64957~~).'."\n" ."\n" - .'- false: does not enable web tracking.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'title' => '', - ], - 'appendMeta' => [ - 'description' => 'Specifies whether to record public IP addresses. Default value: false.'."\n" + .'>'."\n" + ."\n" + .'> - Native plug-ins can be used only to collect text logs.'."\n" + .'>'."\n" + .'> - You cannot add native plug-ins and extension plug-ins at the same time.'."\n" + .'>'."\n" + .'> - When you use native plug-ins, the following requirements must be met:'."\n" + .'>'."\n" + .'> - The first processing plug-in must be a regular expression-based parsing plug-in, a separator-based parsing plug-in, a JSON-based parsing plug-in, an NGINX-based parsing plug-in, an Apache-based parsing plug-in, or an IIS-based parsing plug-in.'."\n" + .'>'."\n" + .'> - After the first processing plug-in, you can add only one time parsing plug-in, one filter plug-in, and multiple data masking plug-ins.'."\n" ."\n" - .'- true: records public IP addresses.'."\n" + .'>', + 'type' => 'array', + 'items' => ['description' => 'The processing plug-in.'."\n" ."\n" - .'- false: does not record public IP addresses.', - 'type' => 'boolean', + .'> For more information, see [Processing plug-ins](~~64957~~).', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "Type": "processor_parse_json_native",'."\n" + .' "SourceKey": "content"'."\n" + .'}'], 'required' => false, - 'example' => 'false', - 'title' => '', + 'minItems' => 1, + 'example' => '', ], - 'maxSplitShard' => [ - 'description' => 'The maximum number of shards to which a shard can be split. The value must be an integer from 1 to 256.'."\n" - ."\n" - .'> This parameter is required if autoSplit is set to true.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', + 'aggregators' => [ 'title' => '', - ], - 'telemetryType' => [ - 'description' => 'The type of observable data. Valid values:'."\n" + 'description' => 'The list of aggregator plug-ins.'."\n" ."\n" - .'- None: logs. This is the default value.'."\n" + .'>'."\n" ."\n" - .'- Metrics: metrics.', - 'type' => 'string', - 'deprecated' => true, + .'This parameter is valid only when you use an extension processing plug-in. You can use a maximum of one aggregator plug-in.'."\n" + ."\n" + .'>', + 'type' => 'array', + 'items' => ['description' => 'The aggregator plug-in.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => ''], 'required' => false, - 'example' => 'None', - 'title' => '', + 'minItems' => 1, + 'example' => '', ], - 'hot_ttl' => [ - 'description' => 'The retention period of data in the hot tier of the Logstore. Minimum value: 7. Unit: days. Valid values: 7 to 3000.'."\n" - .'After the retention period of the hot tier ends, the data is moved to the Infrequent Access (IA) storage class. For more information, see [Automatic Storage Tiering](~~308645~~).', - 'type' => 'integer', - 'format' => 'int32', + 'flushers' => [ 'title' => '', - 'required' => false, - 'example' => '60', - ], - 'mode' => [ - 'description' => 'SLS provides two types of Logstores: Standard and Query.'."\n" + 'description' => 'The list of output plug-ins.'."\n" ."\n" - .'- **standard**: supports one-stop data analytics. This type of Logstore is suitable for scenarios such as real-time monitoring, interactive analysis, and building a complete observability system.'."\n" + .'>'."\n" ."\n" - .'- **query**: supports high-performance queries. The index traffic cost of a Query Logstore is about half that of a Standard Logstore. However, a Query Logstore does not support SQL analysis. This type of Logstore is suitable for scenarios that involve large data volumes, long retention periods of weeks or months, and no log analysis.', - 'type' => 'string', - 'required' => false, - 'example' => 'standard', - 'title' => '', - ], - 'infrequentAccessTTL' => [ - 'description' => 'The retention period for data in the IA storage class. Data in this storage class has no minimum retention period. Data must be stored for at least 30 days before it is moved to Archive storage.', - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'example' => '30', - ], - 'shardingPolicy' => [ - 'description' => 'The hash-based write configuration.', - '$ref' => '#/components/schemas/ShardingPolicy', - 'title' => '', - 'required' => false, + .'Currently, you can add only one SLS output plug-in.'."\n" + ."\n" + .'>', + 'type' => 'array', + 'items' => ['description' => 'The output plug-in.', 'type' => 'object', 'title' => '', 'required' => false, 'example' => '{'."\n" + .' "Type": "flusher_sls",'."\n" + .' "Logstore": "test"'."\n" + .'}'], + 'required' => true, + 'minItems' => 1, 'example' => '', ], + 'task' => ['type' => 'object', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], - 'required' => true, - 'title' => '', + 'required' => false, 'example' => '', ], ], @@ -39355,1200 +23744,156 @@ 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' => 'UpdateLogStore', - 'description' => '### Usage notes'."\n" + 'title' => 'UpdateLogtailPipelineConfig', + 'requestParamsDescription' => '## Global configuration'."\n" ."\n" - .'- Before you update a Logstore, call the GetLogStore operation to retrieve the configuration of the Logstore. Then, modify the configuration and pass it to the UpdateLogStore operation.'."\n" + .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" + .'| ------------------------- | -------- | ----------------------------------------------- | ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| TopicType | string | No | Empty | filepath | The type of the topic. Valid values:* filepath: extracts information from the log file path as the topic. This value is valid only when the input plug-in is input\\_file.
* machine\\_group\\_topic: uses the topic of the machine group to which the configuration is applied.
* custom: uses a custom topic. For more information, see [Log topic](~~60069~~). |'."\n" + .'| TopicFormat | string | Yes, if TopicType is set to filepath or custom. | / | /var/log/(.*).log | The format of the topic. |'."\n" + .'| EnableTimestampNanosecond | bool | No | false | false | Specifies whether to enable nanosecond precision for timestamps. |'."\n" + .'| PipelineMetaTagKey | object | No | Empty | {"HOST_NAME":"__hostname__"} | >This parameter is supported only by LoongCollector 3.0.10 and later.> Controls the tags related to LoongCollector information. The key is the tag parameter name, and the value is the field name of the tag in the log. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. The following tags can be configured:* HOST\\_NAME: the hostname. This tag is added by default. The default value is "\\_\\_hostname\\_\\_".
* AGENT\\_TAG: the custom identifier. This tag is added by default. The default value is "\\_\\_user\\_defined\\_id\\_\\_".
* HOST\\_ID: the host ID. This tag is not added by default. The default value is "\\_\\_host\\_id\\_\\_".
* CLOUD\\_PROVIDER: This tag is not added by default. The default value is "\\_\\_cloud\\_provider\\_\\_". |'."\n" ."\n" - .'- The Host in the request syntax consists of a project name and a Simple Log Service (SLS) endpoint. You must specify the project in the Host.'."\n" + .'## Input plug-ins'."\n" ."\n" - .'- Obtain an AccessKey pair. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'### File input plug-in'."\n" ."\n" - .'An AccessKey pair for an Alibaba Cloud account has permissions on all API operations. This poses a high security risk. We recommend that you create and use a Resource Access Management (RAM) user to make API calls or perform routine O\\&M. The RAM user must be granted the required permissions to operate SLS resources. For more information, see [Create and authorize a RAM user](~~47664~~).'."\n" + .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" + .'| -------------------------------------- | --------- | ---------------------------------------------- | ----------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| Type | string | Yes | / | input_file | The type of the plug-in. Set the value to input_file. |'."\n" + .'| FilePaths | \\[string] | Yes | / | \\["/var/log/*.log"] | The list of paths to the log files to be collected. Currently, only one path is allowed. You can use the asterisk (*) and double asterisk (**) wildcard characters in the path. The double asterisk (**) wildcard character can appear only once and must be used before the filename. |'."\n" + .'| MaxDirSearchDepth | uint | No | 0 | 0 | The maximum depth of the subdirectories that the double asterisk (**) wildcard character can match in a file path. This parameter is valid only when the double asterisk (**) wildcard character is used in the log path. Valid values: 0 to 1000. |'."\n" + .'| ExcludeFilePaths | \\[string] | No | Empty | \\["/home/admin/*.log"] | The blacklist of file paths. The path must be an absolute path. The asterisk (*) wildcard character is supported. |'."\n" + .'| ExcludeFiles | \\[string] | No | Empty | \\["app*.log", "password"] | The blacklist of filenames. The asterisk (*) wildcard character is supported. |'."\n" + .'| ExcludeDirs | \\[string] | No | Empty | \\["/home/admin/dir1", "/home/admin/dir2*"] | The blacklist of directories. The path must be an absolute path. The asterisk (*) wildcard character is supported. |'."\n" + .'| FileEncoding | string | No | utf8 | utf8 | The encoding format of the file. Valid values: utf8 and gbk. |'."\n" + .'| TailSizeKB | uint | No | 1024 | 1024 | The starting collection position of a matched file when the configuration first takes effect, measured from the end of the file. If the file size is smaller than this value, collection starts from the beginning. Valid values: 0 to 10485760 KB. |'."\n" + .'| Multiline | object | No | Empty | / | The multiline aggregation options. |'."\n" + .'| Multiline.Mode | string | No | custom | custom | The multiline aggregation mode. Valid values: custom and JSON. |'."\n" + .'| Multiline.StartPattern | string | Required when Multiline.Mode is set to custom. | Empty | \\d+-\\d+-\\d+.* | The regular expression for the start of a line. |'."\n" + .'| EnableContainerDiscovery | bool | No | false | true | Specifies whether to enable container discovery. This parameter is valid only when Logtail runs in DaemonSet mode and the collected file path is a path within the container. |'."\n" + .'| ContainerFilters | object | No | Empty | / | The container filtering options. The relationship between multiple options is "AND". This parameter is valid only when EnableContainerDiscovery is set to true. |'."\n" + .'| ContainerFilters.K8sNamespaceRegex | string | No | Empty | default | For containers deployed in a Kubernetes environment, specifies the condition for the namespace of the pod to which the container to be collected belongs. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" + .'| ContainerFilters.K8sPodRegex | string | No | Empty | test-pod | For containers deployed in a Kubernetes environment, specifies the condition for the name of the pod to which the container to be collected belongs. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" + .'| ContainerFilters.IncludeK8sLabel | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the label condition for the pod to which the container to be collected belongs. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of a pod label, and the value is the value of the pod label. The following rules apply:* If the value in the map is empty, any pod that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a pod is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a pod is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" + .'| ContainerFilters.ExcludeK8sLabel | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the label condition for the pod to which the container to be excluded from collection belongs. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of a pod label, and the value is the value of the pod label. The following rules apply:* If the value in the map is empty, any pod that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a pod is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a pod is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" + .'| ContainerFilters.K8sContainerRegex | string | No | Empty | test-container | For containers deployed in a Kubernetes environment, specifies the condition for the name of the container to be collected. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" + .'| ContainerFilters.IncludeEnv | map | No | Empty | / | Specifies the environment variable condition for the container to be collected. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of an environment variable, and the value is the value of the environment variable. The following rules apply:* If the value in the map is empty, any container that has an environment variable with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has an environment variable with the specified key and the variable value matches the regular expression.
- In other cases, a container is matched if it has an environment variable with the specified key and the variable value is the same as the specified value. |'."\n" + .'| ContainerFilters.ExcludeEnv | map | No | Empty | / | Specifies the environment variable condition for the container to be excluded from collection. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of an environment variable, and the value is the value of the environment variable. The following rules apply:* If the value in the map is empty, any container that has an environment variable with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has an environment variable with the specified key and the variable value matches the regular expression.
- In other cases, a container is matched if it has an environment variable with the specified key and the variable value is the same as the specified value. |'."\n" + .'| ContainerFilters.IncludeContainerLabel | map | No | Empty | / | Specifies the label condition for the container to be collected. The relationship between multiple conditions is "OR". If you do not add this parameter, the default value is empty, which means all containers are collected. Regular expressions are supported. The key of the map is the name of a container label, and the value is the value of the container label. The following rules apply:* If the value in the map is empty, any container that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a container is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" + .'| ContainerFilters.ExcludeContainerLabel | map | No | Empty | / | Specifies the label condition for the container to be excluded from collection. The relationship between multiple conditions is "OR". If you do not add this parameter, the default value is empty, which means all containers are collected. Regular expressions are supported. The key of the map is the name of a container label, and the value is the value of the container label. The following rules apply:* If the value in the map is empty, any container that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a container is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" + .'| ExternalK8sLabelTag | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the pod label-related tags to be added to the logs. The key of the map is the name of a pod label, and the value is the corresponding tag name. For example, if you add `app: k8s_label_app` to the map, and a pod has the label `app=serviceA`, this information is added to the log as a tag, which means the field `__tag__:k8s_label_app: serviceA` is added. If the pod does not have the `app` label, the empty field `__tag__:k8s_label_app: `is added. |'."\n" + .'| ExternalEnvTag | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the container environment variable-related tags to be added to the logs. The key of the map is the name of an environment variable, and the value is the corresponding tag name. For example, if you add `VERSION: env_version` to the map, and a container has the environment variable `VERSION=v1.0.0`, this information is added to the log as a tag, which means the field `__tag__:env_version: v1.0.0` is added. If the container does not have the `VERSION` environment variable, the empty field `__tag__:env_version: `is added. |'."\n" + .'| CollectingContainersMeta | bool | No | false | true | Specifies whether to enable container metadata preview. |'."\n" + .'| AppendingLogPositionMeta | bool | No | false | false | Specifies whether to add the metadata of the file to which the log belongs to the log. The metadata includes the __tag__:__inode__ field and the __file_offset__ field. |'."\n" + .'| AllowingIncludedByMultiConfigs | bool | No | false | false | Specifies whether to allow the current configuration to collect files that have been matched by other configurations. |'."\n" + .'| Tags | object | No | Empty | {"FileInodeTagKey":"__inode__"} | >This parameter is supported only by LoongCollector 3.0.10 and later.> Controls the tags related to file collection. The key is the tag parameter name, and the value is the field name of the tag in the log. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. The following tags can be configured:* FileInodeTagKey: the file inode. This tag is not added by default. The default value is "\\_\\_inode\\_\\_".
* FilePathTagKey: the file path. This tag is added by default. The default value is "\\_\\_path\\_\\_".The following parameters are valid only when the EnableContainerDiscovery parameter is set to true.* K8sNamespaceTagKey: the namespace of the container where the file is located. This tag is added by default. The default value is "\\_namespace\\_".
* K8sPodNameTagKey: the name of the pod where the file is located. This tag is added by default. The default value is "\\_pod\\_name\\_".
* K8sPodUidTagKey: the UID of the pod where the file is located. This tag is added by default. The default value is "\\_pod\\_uid\\_".
* ContainerNameTagKey: the name of the container where the file is located. This tag is added by default. The default value is "\\_container\\_name\\_".
* ContainerIpTagKey: the IP address of the container where the file is located. This tag is added by default. The default value is "\\_container\\_ip\\_".
* ContainerImageNameTagKey: the image of the container where the file is located. This tag is added by default. The default value is "\\_image\\_name\\_". |'."\n" + .'| FileOffsetKey | string | No | Empty | \\__file_offset__ | >This parameter is supported only by LoongCollector 3.0.10 and later.> The tag for the log\'s position in the file. This tag is not added by default. The default value is __file_offset__. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. If the EnableLogPositionMeta parameter exists at the same time as the Tags.FileInodeTagKey or FileOffsetKey parameter, the EnableLogPositionMeta parameter is ignored. |'."\n" ."\n" - .'- Obtain the project name, the Logstore name, and the region where the project resides. For more information, see [Manage projects](~~48984~~) and [Manage Logstores](~~48990~~).'."\n" + .'### Container stdout (legacy)'."\n" ."\n" - .'### Authorization'."\n" + .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" + .'| ----------------- | --------------------------------------------------------- | ------------ | ----------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| Type | string | Yes | / | service_docker_stdout | The type of the plug-in. Set the value to service_docker_stdout. |'."\n" + .'| Stdout | Boolean | No | true | true | Specifies whether to collect standard output (stdout). |'."\n" + .'| Stderr | Boolean | No | true | true | Specifies whether to collect standard error (stderr). |'."\n" + .'| StartLogMaxOffset | Integer | No | 128 × 1024 | 131072 | The length of historical data to be retrieved during the first collection, in bytes. We recommend a value between 131072 and 1048576. |'."\n" + .'| IncludeLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The whitelist of container labels, used to specify the containers to be collected. The default value is empty, which means the standard output of all containers is collected. If you want to set a container label whitelist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a label with the specified LabelKey is matched.
- If LabelValue is not empty, only containers that have a label with the specified LabelKey=LabelValue are matched.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the container label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `io.kubernetes.container.name` and LabelValue to `^(nginx|cube)$`, containers named nginx or cube are matched.
The relationship between multiple whitelist conditions is "OR", meaning a container is matched if its label satisfies any of the whitelist conditions. |'."\n" + .'| ExcludeLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The blacklist of container labels, used to exclude containers from collection. The default value is empty, which means no containers are excluded. If you want to set a container label blacklist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a label with the specified LabelKey is excluded.
- If LabelValue is not empty, only containers that have a label with the specified LabelKey=LabelValue are excluded.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the container label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `io.kubernetes.container.name` and LabelValue to `^(nginx|cube)$`, containers named nginx or cube are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its label satisfies any of the blacklist conditions. |'."\n" + .'| IncludeEnv | Map, where EnvKey and EnvValue are of the String type | No | Empty | | The whitelist of environment variables, used to specify the containers to be collected. The default value is empty, which means the standard output of all containers is collected. If you want to set an environment variable whitelist, EnvKey is required, and EnvValue is optional.
- If EnvValue is empty, any container that has an environment variable with the specified EnvKey is matched.
- If EnvValue is not empty, only containers that have an environment variable with the specified EnvKey=EnvValue are matched.
By default, EnvValue is matched as a string, meaning a match occurs only if the EnvValue is identical to the environment variable\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set EnvKey to `NGINX_SERVICE_PORT` and EnvValue to \\`^(80 |'."\n" + .'| ExcludeEnv | Map, where EnvKey and EnvValue are of the String type | No | Empty | | The blacklist of environment variables, used to exclude containers from collection. The default value is empty, which means no containers are excluded. If you want to set an environment variable blacklist, EnvKey is required, and EnvValue is optional.
- If EnvValue is empty, the logs of any container that has an environment variable with the specified EnvKey are excluded.
- If EnvValue is not empty, only containers that have an environment variable with the specified EnvKey=EnvValue are excluded.
By default, EnvValue is matched as a string, meaning a match occurs only if the EnvValue is identical to the environment variable\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set EnvKey to `NGINX_SERVICE_PORT` and EnvValue to `^(80|6379)$`, containers with service port 80 or 6379 are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its environment variable satisfies any of the key-value pairs. |'."\n" + .'| IncludeK8sLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The whitelist of Kubernetes labels (defined in template.metadata), used to specify the containers to be collected. If you want to set a Kubernetes label whitelist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a Kubernetes label with the specified LabelKey is matched.
- If LabelValue is not empty, only containers that have a Kubernetes label with the specified LabelKey=LabelValue are matched.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the Kubernetes label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `app` and LabelValue to `^(test1|test2)$`, containers with Kubernetes labels app:test1 or app:test2 are matched.
The relationship between multiple whitelist conditions is "OR", meaning a container is matched if its Kubernetes label satisfies any of the whitelist conditions. |'."\n" + .'| ExcludeK8sLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The blacklist of Kubernetes labels (defined in template.metadata), used to exclude containers from collection. If you want to set a Kubernetes label blacklist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a Kubernetes label with the specified LabelKey is excluded.
- If LabelValue is not empty, only containers that have a Kubernetes label with the specified LabelKey=LabelValue are excluded.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the Kubernetes label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `app` and LabelValue to `^(test1|test2)$`, containers with Kubernetes labels app:test1 or app:test2 are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its Kubernetes label satisfies any of the blacklist conditions. |'."\n" + .'| K8sNamespaceRegex | String | No | Empty | ^(default|nginx)$ | Specifies the containers to be collected by namespace name. Regular expressions are supported. For example, if you set this to `^(default|nginx)$`, all containers in the nginx and default namespaces are matched. |'."\n" + .'| K8sPodRegex | String | No | Empty | ^(nginx-log-demo.*)$ | Specifies the containers to be collected by pod name. Regular expressions are supported. For example, if you set this to `^(nginx-log-demo.*)$`, all containers in pods whose names start with nginx-log-demo are matched. |'."\n" + .'| K8sContainerRegex | String | No | Empty | ^(container-test)$ | Specifies the containers to be collected by container name (Kubernetes container names are defined in spec.containers). Regular expressions are supported. For example, if you set this to `^(container-test)$`, all containers named container-test are matched. |'."\n" ."\n" - .'The following table describes the authorization required for this operation. To grant a RAM user or RAM role permission to call this operation, add the required action to the Action element of a RAM policy.'."\n" + .'#### Data processing parameters'."\n" ."\n" - .'| Action | Resource description in an authorization policy |'."\n" - .'| :------------------- | :--------------------------------------------------------------------------------- |'."\n" - .'| `log:UpdateLogStore` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}` |', - 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" - .'| :------------ | :------------ | :------------ | :------------ |'."\n" - .'| 404 | ProjectNotExist | Project does not exist. | Project不存在。 |'."\n" - .'| 404 | LogStoreNotExist | Logstore does not exist. | Logstore不存在。 |'."\n" - .'| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |'."\n" + .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" + .'| -------------------- | --------------------------------------------------------- | ------------ | ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| BeginLineRegex | String | No | Empty | | The regular expression to match the start of a line.
If this configuration item is empty, it indicates single-line mode.
If this expression matches the beginning of a line, that line is treated as a new log. Otherwise, the line is appended to the previous log. |'."\n" + .'| BeginLineCheckLength | Integer | No | Empty | | The length to check for a line start match, in bytes.
The default value is 10 × 1024 bytes.
If the regular expression for the start of a line can be matched within the first N bytes, we recommend setting this parameter to improve line start matching efficiency. |'."\n" + .'| BeginLineTimeoutMs | Integer | No | Empty | | The timeout period for matching the start of a line, in milliseconds.
The default value is 3000 milliseconds.
If no new log appears within 3000 milliseconds, the matching ends, and the last log is uploaded to Simple Log Service. |'."\n" + .'| MaxLogSize | Integer | No | Empty | | The maximum length of a log**,** in bytes. The default value is 0.
The default value is 512 × 1024 bytes.
If the log length exceeds this value, the system stops searching for the start of a line and uploads the log directly. |'."\n" + .'| ExternalK8sLabelTag | Map, where LabelKey and LabelValue are of the String type | No | Empty | | After setting the Kubernetes label (defined in template.metadata) log tag, iLogtail adds Kubernetes label-related fields to the logs.
For example, if you set LabelKey to app and LabelValue to `k8s_label_app`, and a pod has the label `app=serviceA`, iLogtail adds this information to the log, which means the field k8s\\_label\\_app: serviceA is added. If the pod does not have a label named app, the empty field k8s\\_label\\_app: is added. |'."\n" + .'| ExternalEnvTag | Map, where EnvKey and EnvValue are of the String type | No | Empty | | After setting the container environment variable log tag, iLogtail adds container environment variable-related fields to the logs.
For example, if you set EnvKey to `VERSION` and EnvValue to `env_version`, and a container has the environment variable `VERSION=v1.0.0`, this information is added to the log as a tag, which means the field env\\_version: v1.0.0 is added. If the container does not have an environment variable named VERSION, the empty field env\\_version: is added. |'."\n" ."\n" - .'更多信息，请参见[通用错误码](~~29013~~)。', - 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:07.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-12-02T11:55:07.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI offline', - ], - ], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [ - [ - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'log:UpdateLogStore', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - [ - 'conditionKey' => 'log:Encrypted', - 'validationType' => 'always', - ], - ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'LogStore', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}', - ], - ], - ], - ], - ], - ], - 'UpdateLogStoreEncryption' => [ - 'summary' => 'Updates the encryption configuration of a Logstore. You can create encryption configurations for the Logstore and enable or disable the encryption feature.', - 'path' => '/logstores/{logstore}/encryption', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '250787', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The Simple Log Service project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-logstore', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '', - 'description' => 'The request struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'enable' => [ - 'title' => '', - 'description' => 'Specifies whether to enable the encryption feature. After you update the encryption configuration of the Logstore, you can modify only the enable parameter in subsequent update requests. You cannot modify the encryptType or userCmkInfo parameters.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'encryptType' => [ - 'title' => '', - 'description' => 'The encryption algorithm. Valid values: default, m4, sm4\\_ecb, sm4\\_cbc, sm4\\_gcm, aes_ecb, aes_cbc, aes_cfb, aes_ofb, and aes_gcm.'."\n", - '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', - ], - ], - 'userCmkInfo' => [ - 'title' => '', - 'description' => 'Optional. If you use a BYOK key to encrypt logs, you must specify this parameter. If you use the service key of Simple Log Service to encrypt logs, you do not need to specify this parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'keyId' => [ - 'title' => '', - 'description' => 'The ID of the CMK to which the BYOK key belongs. You can create a CMK in KMS. The CMK must be in the same region as the endpoint of Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'f5136b95-2420-ab31-xxxxxxxxx', - ], - 'roleArn' => [ - 'title' => '', - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role.The value is in the acs:ram::12344\\*\\*\\*:role/xxxxx format. To use a BYOK key to encrypt logs, you must create a RAM role and grant the AliyunKMSReadOnlyAccess and AliyunKMSCryptoUserAccess permissions to the RAM role. You must grant the API caller the PassRole permission on the RAM role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'acs:ram::12344***:role/xxxxx', - ], - 'regionId' => [ - 'title' => '', - 'description' => 'The region ID. Example: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - 'required' => false, - 'example' => '', - ], - ], - 'required' => false, - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'ProjectNotExist', - 'errorMessage' => 'The Project does not exist: xxxx.', - 'description' => 'The log entry does not exist.', - ], - [ - 'errorCode' => 'LogStoreNotExist', - 'errorMessage' => 'logstore xxxx does not exist.', - 'description' => 'The Logstore does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateLogStoreEncryption', - 'description' => '## [](#)Limits'."\n" + .'#### Data processing environment variables'."\n" ."\n" - .'If you specify a data encryption method when you configure data encryption settings, you cannot switch to the other method after the configuration. In addition, you cannot change the encryption algorithm or the encryption type. You can only enable or disable the encryption feature by using the enable parameter. If you specify the encryption method by using the service key of Simple Log Service when you configure data encryption settings, you cannot switch to the encryption method by using Bring Your Own Key (BYOK) keys after the configuration.'."\n" + .'| **Environment variable** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" + .'| ------------------------ | -------- | ------------ | ----------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| ALIYUN_LOG_ENV_TAGS | String | No | Empty | | After setting the global environment variable log tag, iLogtail adds fields related to the environment variables of the iLogtail container to the logs. Multiple environment variable names are separated by a VERTICAL LINE (|).
For example, if you set this to node\\_name|node\\_ip, and the iLogtail container exposes the relevant environment variables, this information is added to the log as a tag, which means the fields node\\_ip:172.16.0.1 and node\\_name:worknode are added. |'."\n" ."\n" - .'## [](#)Create encryption configurations'."\n" + .'### MySQL input plug-in'."\n" ."\n" - .'### [](#)Encryption by using service keys'."\n" + .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" + .'| --------------------- | -------- | ------------ | ----------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| Type | string | Yes | / | service_mysql | The type of the plug-in. Set the value to service_mysql. |'."\n" + .'| Address | string | No | 127.0.0.1:3306 | rm-*.mysql.rds.aliyuncs.com | The MySQL address. |'."\n" + .'| User | string | No | root | root | The username for logging on to the MySQL database. |'."\n" + .'| Password | string | No | Empty | | The password for the user to log on to the MySQL database. If you have high security requirements, set the username and password to xxx. After the collection configuration is synchronized to your machine, find the configuration in the `/usr/local/ilogtail/user_log_config.json` file and modify it. For more information, see [Modify a local configuration](~~64955~~).> If you modify this parameter in the console, the local configuration is overwritten after synchronization.> |'."\n" + .'| DataBase | string | No | / | project_database | The name of the database. |'."\n" + .'| DialTimeOutMs | int | No | 5000 | 5000 | The timeout period for connecting to the MySQL database, in ms. |'."\n" + .'| ReadTimeOutMs | int | No | 5000 | 5000 | The timeout period for reading the MySQL query results, in ms. |'."\n" + .'| StateMent | string | No | / | | The SELECT statement. When CheckPoint is set to true, the WHERE condition in the SELECT statement must include the checkpoint column (CheckPointColumn). You can use a question mark (?) as a placeholder that works with the checkpoint column. For example, set CheckPointColumn to id, CheckPointStart to 0, and StateMent to `SELECT * from ... where id > ?`. After each collection, the system saves the ID of the last data entry as a checkpoint. In the next collection, the question mark (?) in the query statement is replaced with the ID corresponding to that checkpoint. |'."\n" + .'| Limit | bool | No | false | true | Specifies whether to use LIMIT for paging.* true: Use LIMIT.
* false (default): Do not use LIMIT.We recommend using LIMIT for paging. If Limit is set to true, the system automatically appends a LIMIT clause to the SELECT statement during SQL queries. |'."\n" + .'| PageSize | int | No | / | 10 | The page size. This must be configured if Limit is set to true. |'."\n" + .'| MaxSyncSize | int | No | 0 | 0 | The maximum number of records to synchronize at a time. The default value is 0, which means no limit. |'."\n" + .'| CheckPoint | bool | No | false | true | Specifies whether to use a checkpoint.* true: Use a checkpoint.
* false (default): Do not use a checkpoint.A checkpoint can be used as the starting point for the next data collection to implement incremental data collection. |'."\n" + .'| CheckPointColumn | string | No | Empty | 1 | The name of the checkpoint column. This must be configured if CheckPoint is set to true. **Warning** The values in this column must be incremental. Otherwise, data may be lost. The maximum value in each query result is used as the input for the next query. |'."\n" + .'| CheckPointColumnType | string | No | Empty | int | The data type of the checkpoint column. Supported types are int and time. The internal storage for the int type is int64. The time type supports MySQL\'s date, datetime, and time types. This must be configured if CheckPoint is set to true. |'."\n" + .'| CheckPointStart | string | No | Empty | | The initial value of the checkpoint column. This must be configured if CheckPoint is set to true. |'."\n" + .'| CheckPointSavePerPage | bool | No | true | true | Specifies whether to save a checkpoint for each page.* true (default): Save a checkpoint for each page.
* false: Save a checkpoint after each synchronization is complete. |'."\n" + .'| IntervalMs | int | No | 60000 | 60000 | The synchronization interval. The default value is 60000, in ms. |'."\n" ."\n" - .'Simple Log Service is fully responsible for data encryption and key management. No additional operations are required. When you create encryption configurations for the Logstore, you must specify the enable and encryptType parameters.'."\n" + .'### HTTP input plug-in'."\n" ."\n" - .'### [](#byok)Encryption by using BYOK keys'."\n" + .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" + .'| ------------------- | -------- | ------------ | ----------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| Type | string | Yes | / | metric_http | The type of the plug-in. Set the value to metric_http. |'."\n" + .'| Address | string | Yes | / | | The list of URLs. **Important** Must start with `http` or `https`. |'."\n" + .'| IntervalMs | int | Yes | / | 10 | The interval for each request, in ms. |'."\n" + .'| Method | string | No | GET | GET | The name of the request method. Must be in uppercase. |'."\n" + .'| Body | string | No | Empty | | The content of the HTTP Body field. |'."\n" + .'| Headers | map | No | Empty | {"key":"value"} | The content of the HTTP Header, for example, `{"key":"value"}`. Replace with the actual value. |'."\n" + .'| PerAddressSleepMs | int | No | 100 | 100 | The interval between requests for each URL in the Addresses list, in ms. |'."\n" + .'| ResponseTimeoutMs | int | No | 5000 | 5000 | The request timeout period, in ms. |'."\n" + .'| IncludeBody | bool | No | false | true | Specifies whether to collect the request Body. The default value is false. If set to true, the request Body content is stored in a key named content. |'."\n" + .'| FollowRedirects | bool | No | false | false | Specifies whether to automatically handle redirection. |'."\n" + .'| InsecureSkipVerify | bool | No | false | false | Specifies whether to skip HTTPS security checks. |'."\n" + .'| ResponseStringMatch | string | No | / | | Performs a regular expression check on the returned Body content. The check result is stored in a key named _response_match_. If it matches, the value is yes. If it does not match, the value is no. |'."\n" ."\n" - .'You must create a customer master key (CMK) in Key Management Service (KMS). Then, Simple Log Service encrypts logs by using the CMK. When you create encryption configurations for the Logstore, you must specify the enable, encryptType, and userCmkInfo parameters.'."\n" + .'### Syslog input plug-in'."\n" ."\n" - .'## [](#)Enable or disable the encryption feature'."\n" - ."\n" - .'After you create encryption configurations for the Logstore, you cannot modify the encryptType or userCmkInfo parameters. However, you can enable and disable the encryption feature by using the enable parameter.'."\n", - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - 'UpdateLogStoreMeteringMode' => [ - 'summary' => 'Changes the billing mode of a Logstore.', - 'path' => '/logstores/{logstore}/meteringmode', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'projectName', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'logstoreName', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The body of the request.'."\n", - 'type' => 'object', - 'properties' => [ - 'meteringMode' => [ - 'title' => '', - 'description' => 'The billing mode. Valid values: ChargeByFunction and ChargeByDataIngest. Default value: ChargeByFunction. The value ChargeByFunction specifies the pay-by-feature billing mode. The value ChargeByDataIngest specifies the pay-by-ingested-data billing mode.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ChargeByFunction', - 'default' => 'ChargeByFunction', - 'enum' => [ - 'ChargeByDataIngest', - 'ChargeByFunction', - ], - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateLogStoreMeteringMode', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [ - [ - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'log:UpdateLogStoreMeteringMode', - 'authLevel' => 'operate', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], - ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], - ], - 'UpdateLogStoreProcessor' => [ - 'summary' => 'Updates the ingest processor for a Logstore.', - 'path' => '/logstores/{logstore}/processor', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '240235', - 'abilityTreeNodes' => [ - 'FEATUREslsTA08U2', - ], - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The name of the project.', - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'logstore', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the logstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-logstore', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.', - 'type' => 'object', - 'properties' => [ - 'processorName' => [ - 'title' => '', - 'description' => 'The name of the ingest processor.', - 'type' => 'string', - 'required' => true, - 'example' => 'parse-nginx-log', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateLogStoreProcessor', - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - 'UpdateLogging' => [ - 'summary' => 'Updates the service log configurations of a project.', - 'path' => '/logging', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '', - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'loggingProject' => [ - 'title' => '', - 'description' => 'The name of the project to which you want to save service logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], - 'loggingDetails' => [ - 'title' => '', - 'description' => 'The configurations of service logs.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'title' => '', - 'description' => 'The type of service logs. Valid values:'."\n" - ."\n" - .'* consumergroup_log: the consumption delay logs of consumer groups.'."\n" - .'* logtail_alarm: the alert logs of Logtail.'."\n" - .'* operation_log: the operation logs.'."\n" - .'* logtail_profile: the collection logs of Logtail.'."\n" - .'* metering: the metering logs.'."\n" - .'* logtail_status: the status logs of Logtail.'."\n" - .'* scheduledsqlalert: the operational logs of Scheduled SQL jobs.'."\n" - .'* etl_alert: the operational logs of data transformation jobs.'."\n", - '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' => '', - 'description' => 'The name of the Logstore to which you want to save service logs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-logstore', - ], - ], - 'required' => false, - 'example' => '', - ], - 'required' => true, - 'example' => '', - ], - ], - 'required' => true, - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateLogging', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [ - [ - 'operationType' => 'update', - 'ramAction' => [ - 'action' => 'log:UpdateLogging', - 'authLevel' => 'resource', - 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], - ], - 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'Project', - 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging', - ], - ], - ], - ], - ], - ], - 'UpdateLogtailPipelineConfig' => [ - 'summary' => 'Updates a Logtail pipeline configuration.', - 'path' => '/pipelineconfigs/{configName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '191814', - 'abilityTreeNodes' => [ - 'FEATUREsls9GTH7Z', - ], - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], - ], - [ - 'name' => 'configName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the Logtail pipeline configuration.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', - 'title' => '', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '', - 'description' => 'The content of the Logtail pipeline configuration.', - 'type' => 'object', - 'properties' => [ - 'configName' => [ - 'description' => 'The name of the configuration.'."\n" - ."\n" - .'>'."\n" - ."\n" - .'The name must be the same as the value of the configName parameter in the request path.'."\n" - ."\n" - .'>', - 'type' => 'string', - 'required' => true, - 'example' => 'test-config', - 'pattern' => '^[0-9a-zA-Z][0-9a-zA-Z-_]{0,126}[0-9a-zA-Z]$', - 'title' => '', - ], - 'logSample' => [ - 'description' => 'A sample log. Multiple logs are supported.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '2022-06-14 11:13:29.796 | DEBUG | __main__::1 - hello world', - ], - 'global' => [ - 'description' => 'The global configuration.', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '', - ], - 'inputs' => [ - 'title' => '', - 'description' => 'The list of input plug-ins.'."\n" - ."\n" - .'>'."\n" - ."\n" - .'Currently, you can configure only one input plug-in.'."\n" - ."\n" - .'>', - 'type' => 'array', - 'items' => [ - 'description' => 'The input plug-in.'."\n" - ."\n" - .'> For the parameters of the file input plug-in, see [File plug-in](~~65064~~). For the parameters of other input plug-ins, see [Processing plug-ins](~~64957~~).', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "input_file",'."\n" - .' "FilePaths": ["/var/log/*.log"]'."\n" - .'}', - ], - 'required' => true, - 'minItems' => 1, - 'example' => '', - ], - 'processors' => [ - 'title' => '', - 'description' => 'The list of processing plug-ins.'."\n" - ."\n" - .'> Processing plug-ins are classified into native processing plug-ins and extension processing plug-ins. For more information, see [Processing plug-ins](~~64957~~).'."\n" - ."\n" - .'>'."\n" - ."\n" - .'> - Native plug-ins can be used only to collect text logs.'."\n" - .'>'."\n" - .'> - You cannot add native plug-ins and extension plug-ins at the same time.'."\n" - .'>'."\n" - .'> - When you use native plug-ins, the following requirements must be met:'."\n" - .'>'."\n" - .'> - The first processing plug-in must be a regular expression-based parsing plug-in, a separator-based parsing plug-in, a JSON-based parsing plug-in, an NGINX-based parsing plug-in, an Apache-based parsing plug-in, or an IIS-based parsing plug-in.'."\n" - .'>'."\n" - .'> - After the first processing plug-in, you can add only one time parsing plug-in, one filter plug-in, and multiple data masking plug-ins.'."\n" - ."\n" - .'>', - 'type' => 'array', - 'items' => [ - 'description' => 'The processing plug-in.'."\n" - ."\n" - .'> For more information, see [Processing plug-ins](~~64957~~).', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "processor_parse_json_native",'."\n" - .' "SourceKey": "content"'."\n" - .'}', - ], - 'required' => false, - 'minItems' => 1, - 'example' => '', - ], - 'aggregators' => [ - 'title' => '', - 'description' => 'The list of aggregator plug-ins.'."\n" - ."\n" - .'>'."\n" - ."\n" - .'This parameter is valid only when you use an extension processing plug-in. You can use a maximum of one aggregator plug-in.'."\n" - ."\n" - .'>', - 'type' => 'array', - 'items' => [ - 'description' => 'The aggregator plug-in.', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '', - ], - 'required' => false, - 'minItems' => 1, - 'example' => '', - ], - 'flushers' => [ - 'title' => '', - 'description' => 'The list of output plug-ins.'."\n" - ."\n" - .'>'."\n" - ."\n" - .'Currently, you can add only one SLS output plug-in.'."\n" - ."\n" - .'>', - 'type' => 'array', - 'items' => [ - 'description' => 'The output plug-in.', - 'type' => 'object', - 'title' => '', - 'required' => false, - 'example' => '{'."\n" - .' "Type": "flusher_sls",'."\n" - .' "Logstore": "test"'."\n" - .'}', - ], - 'required' => true, - 'minItems' => 1, - 'example' => '', - ], - 'task' => [ - 'type' => 'object', - 'description' => '', - 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - 'required' => false, - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - 'example' => 'nginx', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - 'example' => 'application/json', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - 'example' => '0', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - 'example' => 'close', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - 'example' => 'Sun, 27 May 2018 08:25:04 GMT', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - 'example' => '5B0A6B60BB6EE39764D458B5', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateLogtailPipelineConfig', - 'requestParamsDescription' => '## Global configuration'."\n" - ."\n" - .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" - .'| ------------------------- | -------- | ----------------------------------------------- | ----------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| TopicType | string | No | Empty | filepath | The type of the topic. Valid values:* filepath: extracts information from the log file path as the topic. This value is valid only when the input plug-in is input\\_file.
* machine\\_group\\_topic: uses the topic of the machine group to which the configuration is applied.
* custom: uses a custom topic. For more information, see [Log topic](~~60069~~). |'."\n" - .'| TopicFormat | string | Yes, if TopicType is set to filepath or custom. | / | /var/log/(.*).log | The format of the topic. |'."\n" - .'| EnableTimestampNanosecond | bool | No | false | false | Specifies whether to enable nanosecond precision for timestamps. |'."\n" - .'| PipelineMetaTagKey | object | No | Empty | {"HOST_NAME":"__hostname__"} | >This parameter is supported only by LoongCollector 3.0.10 and later.> Controls the tags related to LoongCollector information. The key is the tag parameter name, and the value is the field name of the tag in the log. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. The following tags can be configured:* HOST\\_NAME: the hostname. This tag is added by default. The default value is "\\_\\_hostname\\_\\_".
* AGENT\\_TAG: the custom identifier. This tag is added by default. The default value is "\\_\\_user\\_defined\\_id\\_\\_".
* HOST\\_ID: the host ID. This tag is not added by default. The default value is "\\_\\_host\\_id\\_\\_".
* CLOUD\\_PROVIDER: This tag is not added by default. The default value is "\\_\\_cloud\\_provider\\_\\_". |'."\n" - ."\n" - .'## Input plug-ins'."\n" - ."\n" - .'### File input plug-in'."\n" - ."\n" - .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" - .'| -------------------------------------- | --------- | ---------------------------------------------- | ----------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| Type | string | Yes | / | input_file | The type of the plug-in. Set the value to input_file. |'."\n" - .'| FilePaths | \\[string] | Yes | / | \\["/var/log/*.log"] | The list of paths to the log files to be collected. Currently, only one path is allowed. You can use the asterisk (*) and double asterisk (**) wildcard characters in the path. The double asterisk (**) wildcard character can appear only once and must be used before the filename. |'."\n" - .'| MaxDirSearchDepth | uint | No | 0 | 0 | The maximum depth of the subdirectories that the double asterisk (**) wildcard character can match in a file path. This parameter is valid only when the double asterisk (**) wildcard character is used in the log path. Valid values: 0 to 1000. |'."\n" - .'| ExcludeFilePaths | \\[string] | No | Empty | \\["/home/admin/*.log"] | The blacklist of file paths. The path must be an absolute path. The asterisk (*) wildcard character is supported. |'."\n" - .'| ExcludeFiles | \\[string] | No | Empty | \\["app*.log", "password"] | The blacklist of filenames. The asterisk (*) wildcard character is supported. |'."\n" - .'| ExcludeDirs | \\[string] | No | Empty | \\["/home/admin/dir1", "/home/admin/dir2*"] | The blacklist of directories. The path must be an absolute path. The asterisk (*) wildcard character is supported. |'."\n" - .'| FileEncoding | string | No | utf8 | utf8 | The encoding format of the file. Valid values: utf8 and gbk. |'."\n" - .'| TailSizeKB | uint | No | 1024 | 1024 | The starting collection position of a matched file when the configuration first takes effect, measured from the end of the file. If the file size is smaller than this value, collection starts from the beginning. Valid values: 0 to 10485760 KB. |'."\n" - .'| Multiline | object | No | Empty | / | The multiline aggregation options. |'."\n" - .'| Multiline.Mode | string | No | custom | custom | The multiline aggregation mode. Valid values: custom and JSON. |'."\n" - .'| Multiline.StartPattern | string | Required when Multiline.Mode is set to custom. | Empty | \\d+-\\d+-\\d+.* | The regular expression for the start of a line. |'."\n" - .'| EnableContainerDiscovery | bool | No | false | true | Specifies whether to enable container discovery. This parameter is valid only when Logtail runs in DaemonSet mode and the collected file path is a path within the container. |'."\n" - .'| ContainerFilters | object | No | Empty | / | The container filtering options. The relationship between multiple options is "AND". This parameter is valid only when EnableContainerDiscovery is set to true. |'."\n" - .'| ContainerFilters.K8sNamespaceRegex | string | No | Empty | default | For containers deployed in a Kubernetes environment, specifies the condition for the namespace of the pod to which the container to be collected belongs. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" - .'| ContainerFilters.K8sPodRegex | string | No | Empty | test-pod | For containers deployed in a Kubernetes environment, specifies the condition for the name of the pod to which the container to be collected belongs. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" - .'| ContainerFilters.IncludeK8sLabel | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the label condition for the pod to which the container to be collected belongs. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of a pod label, and the value is the value of the pod label. The following rules apply:* If the value in the map is empty, any pod that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a pod is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a pod is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" - .'| ContainerFilters.ExcludeK8sLabel | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the label condition for the pod to which the container to be excluded from collection belongs. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of a pod label, and the value is the value of the pod label. The following rules apply:* If the value in the map is empty, any pod that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a pod is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a pod is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" - .'| ContainerFilters.K8sContainerRegex | string | No | Empty | test-container | For containers deployed in a Kubernetes environment, specifies the condition for the name of the container to be collected. If you do not add this parameter, all containers are collected. Regular expressions are supported. |'."\n" - .'| ContainerFilters.IncludeEnv | map | No | Empty | / | Specifies the environment variable condition for the container to be collected. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of an environment variable, and the value is the value of the environment variable. The following rules apply:* If the value in the map is empty, any container that has an environment variable with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has an environment variable with the specified key and the variable value matches the regular expression.
- In other cases, a container is matched if it has an environment variable with the specified key and the variable value is the same as the specified value. |'."\n" - .'| ContainerFilters.ExcludeEnv | map | No | Empty | / | Specifies the environment variable condition for the container to be excluded from collection. The relationship between multiple conditions is "OR". If you do not add this parameter, all containers are collected. Regular expressions are supported. The key of the map is the name of an environment variable, and the value is the value of the environment variable. The following rules apply:* If the value in the map is empty, any container that has an environment variable with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has an environment variable with the specified key and the variable value matches the regular expression.
- In other cases, a container is matched if it has an environment variable with the specified key and the variable value is the same as the specified value. |'."\n" - .'| ContainerFilters.IncludeContainerLabel | map | No | Empty | / | Specifies the label condition for the container to be collected. The relationship between multiple conditions is "OR". If you do not add this parameter, the default value is empty, which means all containers are collected. Regular expressions are supported. The key of the map is the name of a container label, and the value is the value of the container label. The following rules apply:* If the value in the map is empty, any container that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a container is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" - .'| ContainerFilters.ExcludeContainerLabel | map | No | Empty | / | Specifies the label condition for the container to be excluded from collection. The relationship between multiple conditions is "OR". If you do not add this parameter, the default value is empty, which means all containers are collected. Regular expressions are supported. The key of the map is the name of a container label, and the value is the value of the container label. The following rules apply:* If the value in the map is empty, any container that has a label with the specified key is matched.
* If the value in the map is not empty:
- If the value starts with `^` and ends with `$`, a container is matched if it has a label with the specified key and the label value matches the regular expression.
- In other cases, a container is matched if it has a label with the specified key and the label value is the same as the specified value. |'."\n" - .'| ExternalK8sLabelTag | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the pod label-related tags to be added to the logs. The key of the map is the name of a pod label, and the value is the corresponding tag name. For example, if you add `app: k8s_label_app` to the map, and a pod has the label `app=serviceA`, this information is added to the log as a tag, which means the field `__tag__:k8s_label_app: serviceA` is added. If the pod does not have the `app` label, the empty field `__tag__:k8s_label_app: `is added. |'."\n" - .'| ExternalEnvTag | map | No | Empty | / | For containers deployed in a Kubernetes environment, specifies the container environment variable-related tags to be added to the logs. The key of the map is the name of an environment variable, and the value is the corresponding tag name. For example, if you add `VERSION: env_version` to the map, and a container has the environment variable `VERSION=v1.0.0`, this information is added to the log as a tag, which means the field `__tag__:env_version: v1.0.0` is added. If the container does not have the `VERSION` environment variable, the empty field `__tag__:env_version: `is added. |'."\n" - .'| CollectingContainersMeta | bool | No | false | true | Specifies whether to enable container metadata preview. |'."\n" - .'| AppendingLogPositionMeta | bool | No | false | false | Specifies whether to add the metadata of the file to which the log belongs to the log. The metadata includes the __tag__:__inode__ field and the __file_offset__ field. |'."\n" - .'| AllowingIncludedByMultiConfigs | bool | No | false | false | Specifies whether to allow the current configuration to collect files that have been matched by other configurations. |'."\n" - .'| Tags | object | No | Empty | {"FileInodeTagKey":"__inode__"} | >This parameter is supported only by LoongCollector 3.0.10 and later.> Controls the tags related to file collection. The key is the tag parameter name, and the value is the field name of the tag in the log. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. The following tags can be configured:* FileInodeTagKey: the file inode. This tag is not added by default. The default value is "\\_\\_inode\\_\\_".
* FilePathTagKey: the file path. This tag is added by default. The default value is "\\_\\_path\\_\\_".The following parameters are valid only when the EnableContainerDiscovery parameter is set to true.* K8sNamespaceTagKey: the namespace of the container where the file is located. This tag is added by default. The default value is "\\_namespace\\_".
* K8sPodNameTagKey: the name of the pod where the file is located. This tag is added by default. The default value is "\\_pod\\_name\\_".
* K8sPodUidTagKey: the UID of the pod where the file is located. This tag is added by default. The default value is "\\_pod\\_uid\\_".
* ContainerNameTagKey: the name of the container where the file is located. This tag is added by default. The default value is "\\_container\\_name\\_".
* ContainerIpTagKey: the IP address of the container where the file is located. This tag is added by default. The default value is "\\_container\\_ip\\_".
* ContainerImageNameTagKey: the image of the container where the file is located. This tag is added by default. The default value is "\\_image\\_name\\_". |'."\n" - .'| FileOffsetKey | string | No | Empty | \\__file_offset__ | >This parameter is supported only by LoongCollector 3.0.10 and later.> The tag for the log\'s position in the file. This tag is not added by default. The default value is __file_offset__. If the value is __default__, the default value is used. If the value is an empty string, the tag is deleted. If the EnableLogPositionMeta parameter exists at the same time as the Tags.FileInodeTagKey or FileOffsetKey parameter, the EnableLogPositionMeta parameter is ignored. |'."\n" - ."\n" - .'### Container stdout (legacy)'."\n" - ."\n" - .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" - .'| ----------------- | --------------------------------------------------------- | ------------ | ----------------- | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| Type | string | Yes | / | service_docker_stdout | The type of the plug-in. Set the value to service_docker_stdout. |'."\n" - .'| Stdout | Boolean | No | true | true | Specifies whether to collect standard output (stdout). |'."\n" - .'| Stderr | Boolean | No | true | true | Specifies whether to collect standard error (stderr). |'."\n" - .'| StartLogMaxOffset | Integer | No | 128 × 1024 | 131072 | The length of historical data to be retrieved during the first collection, in bytes. We recommend a value between 131072 and 1048576. |'."\n" - .'| IncludeLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The whitelist of container labels, used to specify the containers to be collected. The default value is empty, which means the standard output of all containers is collected. If you want to set a container label whitelist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a label with the specified LabelKey is matched.
- If LabelValue is not empty, only containers that have a label with the specified LabelKey=LabelValue are matched.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the container label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `io.kubernetes.container.name` and LabelValue to `^(nginx|cube)$`, containers named nginx or cube are matched.
The relationship between multiple whitelist conditions is "OR", meaning a container is matched if its label satisfies any of the whitelist conditions. |'."\n" - .'| ExcludeLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The blacklist of container labels, used to exclude containers from collection. The default value is empty, which means no containers are excluded. If you want to set a container label blacklist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a label with the specified LabelKey is excluded.
- If LabelValue is not empty, only containers that have a label with the specified LabelKey=LabelValue are excluded.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the container label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `io.kubernetes.container.name` and LabelValue to `^(nginx|cube)$`, containers named nginx or cube are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its label satisfies any of the blacklist conditions. |'."\n" - .'| IncludeEnv | Map, where EnvKey and EnvValue are of the String type | No | Empty | | The whitelist of environment variables, used to specify the containers to be collected. The default value is empty, which means the standard output of all containers is collected. If you want to set an environment variable whitelist, EnvKey is required, and EnvValue is optional.
- If EnvValue is empty, any container that has an environment variable with the specified EnvKey is matched.
- If EnvValue is not empty, only containers that have an environment variable with the specified EnvKey=EnvValue are matched.
By default, EnvValue is matched as a string, meaning a match occurs only if the EnvValue is identical to the environment variable\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set EnvKey to `NGINX_SERVICE_PORT` and EnvValue to \\`^(80 |'."\n" - .'| ExcludeEnv | Map, where EnvKey and EnvValue are of the String type | No | Empty | | The blacklist of environment variables, used to exclude containers from collection. The default value is empty, which means no containers are excluded. If you want to set an environment variable blacklist, EnvKey is required, and EnvValue is optional.
- If EnvValue is empty, the logs of any container that has an environment variable with the specified EnvKey are excluded.
- If EnvValue is not empty, only containers that have an environment variable with the specified EnvKey=EnvValue are excluded.
By default, EnvValue is matched as a string, meaning a match occurs only if the EnvValue is identical to the environment variable\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set EnvKey to `NGINX_SERVICE_PORT` and EnvValue to `^(80|6379)$`, containers with service port 80 or 6379 are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its environment variable satisfies any of the key-value pairs. |'."\n" - .'| IncludeK8sLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The whitelist of Kubernetes labels (defined in template.metadata), used to specify the containers to be collected. If you want to set a Kubernetes label whitelist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a Kubernetes label with the specified LabelKey is matched.
- If LabelValue is not empty, only containers that have a Kubernetes label with the specified LabelKey=LabelValue are matched.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the Kubernetes label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `app` and LabelValue to `^(test1|test2)$`, containers with Kubernetes labels app:test1 or app:test2 are matched.
The relationship between multiple whitelist conditions is "OR", meaning a container is matched if its Kubernetes label satisfies any of the whitelist conditions. |'."\n" - .'| ExcludeK8sLabel | Map, where LabelKey and LabelValue are of the String type | No | Empty | | The blacklist of Kubernetes labels (defined in template.metadata), used to exclude containers from collection. If you want to set a Kubernetes label blacklist, LabelKey is required, and LabelValue is optional.
- If LabelValue is empty, any container that has a Kubernetes label with the specified LabelKey is excluded.
- If LabelValue is not empty, only containers that have a Kubernetes label with the specified LabelKey=LabelValue are excluded.
By default, LabelValue is matched as a string, meaning a match occurs only if the LabelValue is identical to the Kubernetes label\'s value. If the value starts with `^` and ends with `$`, it is a regular expression match. For example, if you set LabelKey to `app` and LabelValue to `^(test1|test2)$`, containers with Kubernetes labels app:test1 or app:test2 are matched.
The relationship between multiple blacklist conditions is "OR", meaning a container is excluded if its Kubernetes label satisfies any of the blacklist conditions. |'."\n" - .'| K8sNamespaceRegex | String | No | Empty | ^(default|nginx)$ | Specifies the containers to be collected by namespace name. Regular expressions are supported. For example, if you set this to `^(default|nginx)$`, all containers in the nginx and default namespaces are matched. |'."\n" - .'| K8sPodRegex | String | No | Empty | ^(nginx-log-demo.*)$ | Specifies the containers to be collected by pod name. Regular expressions are supported. For example, if you set this to `^(nginx-log-demo.*)$`, all containers in pods whose names start with nginx-log-demo are matched. |'."\n" - .'| K8sContainerRegex | String | No | Empty | ^(container-test)$ | Specifies the containers to be collected by container name (Kubernetes container names are defined in spec.containers). Regular expressions are supported. For example, if you set this to `^(container-test)$`, all containers named container-test are matched. |'."\n" - ."\n" - .'#### Data processing parameters'."\n" - ."\n" - .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" - .'| -------------------- | --------------------------------------------------------- | ------------ | ----------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| BeginLineRegex | String | No | Empty | | The regular expression to match the start of a line.
If this configuration item is empty, it indicates single-line mode.
If this expression matches the beginning of a line, that line is treated as a new log. Otherwise, the line is appended to the previous log. |'."\n" - .'| BeginLineCheckLength | Integer | No | Empty | | The length to check for a line start match, in bytes.
The default value is 10 × 1024 bytes.
If the regular expression for the start of a line can be matched within the first N bytes, we recommend setting this parameter to improve line start matching efficiency. |'."\n" - .'| BeginLineTimeoutMs | Integer | No | Empty | | The timeout period for matching the start of a line, in milliseconds.
The default value is 3000 milliseconds.
If no new log appears within 3000 milliseconds, the matching ends, and the last log is uploaded to Simple Log Service. |'."\n" - .'| MaxLogSize | Integer | No | Empty | | The maximum length of a log**,** in bytes. The default value is 0.
The default value is 512 × 1024 bytes.
If the log length exceeds this value, the system stops searching for the start of a line and uploads the log directly. |'."\n" - .'| ExternalK8sLabelTag | Map, where LabelKey and LabelValue are of the String type | No | Empty | | After setting the Kubernetes label (defined in template.metadata) log tag, iLogtail adds Kubernetes label-related fields to the logs.
For example, if you set LabelKey to app and LabelValue to `k8s_label_app`, and a pod has the label `app=serviceA`, iLogtail adds this information to the log, which means the field k8s\\_label\\_app: serviceA is added. If the pod does not have a label named app, the empty field k8s\\_label\\_app: is added. |'."\n" - .'| ExternalEnvTag | Map, where EnvKey and EnvValue are of the String type | No | Empty | | After setting the container environment variable log tag, iLogtail adds container environment variable-related fields to the logs.
For example, if you set EnvKey to `VERSION` and EnvValue to `env_version`, and a container has the environment variable `VERSION=v1.0.0`, this information is added to the log as a tag, which means the field env\\_version: v1.0.0 is added. If the container does not have an environment variable named VERSION, the empty field env\\_version: is added. |'."\n" - ."\n" - .'#### Data processing environment variables'."\n" - ."\n" - .'| **Environment variable** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" - .'| ------------------------ | -------- | ------------ | ----------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| ALIYUN_LOG_ENV_TAGS | String | No | Empty | | After setting the global environment variable log tag, iLogtail adds fields related to the environment variables of the iLogtail container to the logs. Multiple environment variable names are separated by a VERTICAL LINE (|).
For example, if you set this to node\\_name|node\\_ip, and the iLogtail container exposes the relevant environment variables, this information is added to the log as a tag, which means the fields node\\_ip:172.16.0.1 and node\\_name:worknode are added. |'."\n" - ."\n" - .'### MySQL input plug-in'."\n" - ."\n" - .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" - .'| --------------------- | -------- | ------------ | ----------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| Type | string | Yes | / | service_mysql | The type of the plug-in. Set the value to service_mysql. |'."\n" - .'| Address | string | No | 127.0.0.1:3306 | rm-*.mysql.rds.aliyuncs.com | The MySQL address. |'."\n" - .'| User | string | No | root | root | The username for logging on to the MySQL database. |'."\n" - .'| Password | string | No | Empty | | The password for the user to log on to the MySQL database. If you have high security requirements, set the username and password to xxx. After the collection configuration is synchronized to your machine, find the configuration in the `/usr/local/ilogtail/user_log_config.json` file and modify it. For more information, see [Modify a local configuration](~~64955~~).> If you modify this parameter in the console, the local configuration is overwritten after synchronization.> |'."\n" - .'| DataBase | string | No | / | project_database | The name of the database. |'."\n" - .'| DialTimeOutMs | int | No | 5000 | 5000 | The timeout period for connecting to the MySQL database, in ms. |'."\n" - .'| ReadTimeOutMs | int | No | 5000 | 5000 | The timeout period for reading the MySQL query results, in ms. |'."\n" - .'| StateMent | string | No | / | | The SELECT statement. When CheckPoint is set to true, the WHERE condition in the SELECT statement must include the checkpoint column (CheckPointColumn). You can use a question mark (?) as a placeholder that works with the checkpoint column. For example, set CheckPointColumn to id, CheckPointStart to 0, and StateMent to `SELECT * from ... where id > ?`. After each collection, the system saves the ID of the last data entry as a checkpoint. In the next collection, the question mark (?) in the query statement is replaced with the ID corresponding to that checkpoint. |'."\n" - .'| Limit | bool | No | false | true | Specifies whether to use LIMIT for paging.* true: Use LIMIT.
* false (default): Do not use LIMIT.We recommend using LIMIT for paging. If Limit is set to true, the system automatically appends a LIMIT clause to the SELECT statement during SQL queries. |'."\n" - .'| PageSize | int | No | / | 10 | The page size. This must be configured if Limit is set to true. |'."\n" - .'| MaxSyncSize | int | No | 0 | 0 | The maximum number of records to synchronize at a time. The default value is 0, which means no limit. |'."\n" - .'| CheckPoint | bool | No | false | true | Specifies whether to use a checkpoint.* true: Use a checkpoint.
* false (default): Do not use a checkpoint.A checkpoint can be used as the starting point for the next data collection to implement incremental data collection. |'."\n" - .'| CheckPointColumn | string | No | Empty | 1 | The name of the checkpoint column. This must be configured if CheckPoint is set to true. **Warning** The values in this column must be incremental. Otherwise, data may be lost. The maximum value in each query result is used as the input for the next query. |'."\n" - .'| CheckPointColumnType | string | No | Empty | int | The data type of the checkpoint column. Supported types are int and time. The internal storage for the int type is int64. The time type supports MySQL\'s date, datetime, and time types. This must be configured if CheckPoint is set to true. |'."\n" - .'| CheckPointStart | string | No | Empty | | The initial value of the checkpoint column. This must be configured if CheckPoint is set to true. |'."\n" - .'| CheckPointSavePerPage | bool | No | true | true | Specifies whether to save a checkpoint for each page.* true (default): Save a checkpoint for each page.
* false: Save a checkpoint after each synchronization is complete. |'."\n" - .'| IntervalMs | int | No | 60000 | 60000 | The synchronization interval. The default value is 60000, in ms. |'."\n" - ."\n" - .'### HTTP input plug-in'."\n" - ."\n" - .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" - .'| ------------------- | -------- | ------------ | ----------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| Type | string | Yes | / | metric_http | The type of the plug-in. Set the value to metric_http. |'."\n" - .'| Address | string | Yes | / | | The list of URLs. **Important** Must start with `http` or `https`. |'."\n" - .'| IntervalMs | int | Yes | / | 10 | The interval for each request, in ms. |'."\n" - .'| Method | string | No | GET | GET | The name of the request method. Must be in uppercase. |'."\n" - .'| Body | string | No | Empty | | The content of the HTTP Body field. |'."\n" - .'| Headers | map | No | Empty | {"key":"value"} | The content of the HTTP Header, for example, `{"key":"value"}`. Replace with the actual value. |'."\n" - .'| PerAddressSleepMs | int | No | 100 | 100 | The interval between requests for each URL in the Addresses list, in ms. |'."\n" - .'| ResponseTimeoutMs | int | No | 5000 | 5000 | The request timeout period, in ms. |'."\n" - .'| IncludeBody | bool | No | false | true | Specifies whether to collect the request Body. The default value is false. If set to true, the request Body content is stored in a key named content. |'."\n" - .'| FollowRedirects | bool | No | false | false | Specifies whether to automatically handle redirection. |'."\n" - .'| InsecureSkipVerify | bool | No | false | false | Specifies whether to skip HTTPS security checks. |'."\n" - .'| ResponseStringMatch | string | No | / | | Performs a regular expression check on the returned Body content. The check result is stored in a key named _response_match_. If it matches, the value is yes. If it does not match, the value is no. |'."\n" - ."\n" - .'### Syslog input plug-in'."\n" - ."\n" - .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" - .'| ------------------ | -------- | ------------ | -------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" - .'| Type | string | Yes | / | service_syslog | The type of the plug-in. Set the value to service_syslog. |'."\n" - .'| Address | string | No | tcp://127.0.0.1:9999 | | Specifies the protocol, address, and port for Logtail to listen on. Logtail listens and obtains log data based on the Logtail configuration. The format is `[tcp/udp]://[` *ip* `]:[` *port* `]`. If not configured, the default is `tcp://127.0.0.1:9999`, which means it can only receive locally forwarded logs. **Note*** The listening protocol, address, and port number set in the Logtail configuration must be the same as the forwarding rule set in the rsyslog configuration file.
* If the server where Logtail is installed has multiple IP addresses that can receive logs, you can set the address to `0.0.0.0` to listen on all IP addresses of the server. |'."\n" - .'| ParseProtocol | string | No | Empty | rfc3164 | Specifies the protocol used to parse logs. The default is empty, which means no parsing. The options are:* Empty: No parsing.
* rfc3164: Specifies using the RFC3164 protocol to parse logs.
* rfc5424: Specifies using the RFC5424 protocol to parse logs.
auto: Specifies that Logtail automatically selects the appropriate parsing protocol based on the log content. |'."\n" - .'| IgnoreParseFailure | bool | No | true | true | Specifies the action to take after a parsing failure. If not configured, the default is `true`, which means parsing is abandoned, and the returned content field is filled directly. If set to `false`, the log is discarded upon parsing failure. |'."\n" + .'| **Parameter** | **Type** | **Required** | **Default value** | **Example** | **Description** |'."\n" + .'| ------------------ | -------- | ------------ | -------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| Type | string | Yes | / | service_syslog | The type of the plug-in. Set the value to service_syslog. |'."\n" + .'| Address | string | No | tcp://127.0.0.1:9999 | | Specifies the protocol, address, and port for Logtail to listen on. Logtail listens and obtains log data based on the Logtail configuration. The format is `[tcp/udp]://[` *ip* `]:[` *port* `]`. If not configured, the default is `tcp://127.0.0.1:9999`, which means it can only receive locally forwarded logs. **Note*** The listening protocol, address, and port number set in the Logtail configuration must be the same as the forwarding rule set in the rsyslog configuration file.
* If the server where Logtail is installed has multiple IP addresses that can receive logs, you can set the address to `0.0.0.0` to listen on all IP addresses of the server. |'."\n" + .'| ParseProtocol | string | No | Empty | rfc3164 | Specifies the protocol used to parse logs. The default is empty, which means no parsing. The options are:* Empty: No parsing.
* rfc3164: Specifies using the RFC3164 protocol to parse logs.
* rfc5424: Specifies using the RFC5424 protocol to parse logs.
auto: Specifies that Logtail automatically selects the appropriate parsing protocol based on the log content. |'."\n" + .'| IgnoreParseFailure | bool | No | true | true | Specifies the action to take after a parsing failure. If not configured, the default is `true`, which means parsing is abandoned, and the returned content field is filled directly. If set to `false`, the log is discarded upon parsing failure. |'."\n" ."\n" .'### Systemd Journal input plug-in'."\n" ."\n" @@ -41018,17 +24363,10 @@ 'action' => 'log:UpdateLogtailPipelineConfig', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - ], + ['conditionKey' => 'log:TLSVersion'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -41037,49 +24375,28 @@ 'UpdateMachineGroup' => [ 'summary' => 'Modifies the configuration of a machine group.', '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'groupName', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-group', 'title' => ''], ], [ 'name' => 'body', @@ -41087,53 +24404,23 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-machine-group', - ], - 'machineIdentifyType' => [ - 'title' => '', - 'description' => 'The identifier type of the machine group. Valid values:'."\n" - ."\n" - .'* ip: The machine group uses IP addresses as identifiers.'."\n" - .'* userdefined: The machine group uses custom identifiers.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'userdefined', - 'default' => 'ip', - ], - 'groupType' => [ - 'title' => '', - 'description' => 'The type of the machine group. Set the value to an empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '""', - ], + 'groupName' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-machine-group', 'title' => ''], + 'machineIdentifyType' => ['description' => 'The identifier type of the machine group. Valid values:'."\n" + ."\n" + .'- ip: The machine group uses IP addresses as identifiers.'."\n" + ."\n" + .'- userdefined: The machine group uses custom identifiers.', 'type' => 'string', 'required' => true, 'example' => 'userdefined', 'default' => 'ip', 'title' => ''], + 'groupType' => ['description' => 'The type of the machine group. Set the value to an empty string.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '""'], 'groupAttribute' => [ 'title' => '', - 'description' => 'The attribute of the machine group. This parameter is empty by default.'."\n", + 'description' => 'The attribute of the machine group. This parameter is empty by default.', 'type' => 'object', 'properties' => [ - 'groupTopic' => [ - 'title' => '', - 'description' => 'The topic of the machine group. This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testtopic2', - ], - 'externalName' => [ - 'title' => '', - 'description' => 'The identifier of the external management system on which the machine group depends. This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testgroup2', - ], + 'groupTopic' => ['description' => 'The topic of the machine group. This parameter is empty by default.', 'type' => 'string', 'required' => false, 'example' => 'testtopic2', 'title' => ''], + 'externalName' => ['description' => 'The identifier of the external management system on which the machine group depends. This parameter is empty by default.', 'type' => 'string', 'required' => false, 'example' => 'testgroup2', 'title' => ''], ], 'required' => false, 'example' => '', @@ -41142,16 +24429,11 @@ 'title' => '', 'description' => 'The identifiers of the machines in the machine group.'."\n" ."\n" - .'* If you set machineIdentifyType to ip, enter the IP addresses of the machines.'."\n" - .'* If you set machineIdentifyType to userdefined, enter a custom identifier.'."\n", + .'- If you set machineIdentifyType to ip, enter the IP addresses of the machines.'."\n" + ."\n" + .'- If you set machineIdentifyType to userdefined, enter a custom identifier.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The identifier of the machine. Set the value to an IP address or a custom identifier.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.xx', - ], + 'items' => ['description' => 'The identifier of the machine. Set the value to an IP address or a custom identifier.', 'type' => 'string', 'example' => '192.168.xx.xx', 'title' => '', 'required' => false], 'required' => true, 'example' => '[uu_id_1，uu_id_2]', ], @@ -41165,53 +24447,29 @@ 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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateMachineGroup', - 'description' => 'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Log Service endpoint. You must specify a project in Host.', 'extraInfo' => '| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |'."\n" .'| :------------ | :------------ | :------------ | :------------ |'."\n" .'| 400 | InvalidParameter| invalid group resource json | Project不存在。 |'."\n" @@ -41231,18 +24489,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}'], ], ], ], @@ -41251,49 +24501,28 @@ 'UpdateMachineGroupMachine' => [ 'summary' => 'Modifies the machines in a machine group. You can add machine to or remove machines from the machine group.', 'path' => '/machinegroups/{machineGroup}/machines', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + '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' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project', 'title' => ''], ], [ 'name' => 'machineGroup', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the machine group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test-group', - ], + 'schema' => ['description' => 'The name of the machine group.', 'type' => 'string', 'required' => true, 'example' => 'test-group', 'title' => ''], ], [ 'name' => 'body', @@ -41301,15 +24530,9 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => 'The machines to be added or removed.'."\n", + 'description' => 'The machines to be added or removed.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The machine ID. The value can be an IP address or a custom ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.x', - ], + 'items' => ['description' => 'The machine ID. The value can be an IP address or a custom ID.', 'type' => 'string', 'example' => '192.168.xx.x', 'title' => '', 'required' => false], 'required' => true, 'example' => '', ], @@ -41318,16 +24541,13 @@ 'name' => 'action', 'in' => 'query', 'schema' => [ - 'title' => '', - 'description' => 'The operation on the machine. Valid values: add and delete. A value of add specifies to add the machine to the machine group. A value of delete specifies to remove the machine from the machine group.'."\n", + 'description' => 'The operation on the machine. Valid values: add and delete. A value of add specifies to add the machine to the machine group. A value of delete specifies to remove the machine from the machine group.', 'type' => 'string', 'required' => false, 'example' => 'add', 'default' => 'add', - 'enum' => [ - 'add', - 'delete', - ], + 'enum' => ['add', 'delete'], + 'title' => '', ], ], ], @@ -41335,53 +24555,29 @@ 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'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', 'title' => 'UpdateMachineGroupMachine', - 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n", + 'description' => 'Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -41393,390 +24589,197 @@ 'action' => 'log:UpdateMachineGroupMachine', 'authLevel' => 'resource', 'actionConditions' => [ - [ - 'conditionKey' => 'log:TLSVersion', - 'validationType' => 'always', - ], + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], ], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], - ], - ], - ], - ], - ], - 'UpdateMaxComputeExport' => [ - 'summary' => 'Updates a MaxCompute data shipping job.', - 'path' => '/maxcomputeexports/{mcExportName}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '203412', - 'abilityTreeNodes' => [ - 'FEATUREslsQK2IBF', - ], - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], - ], - [ - 'name' => 'mcExportName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the MaxCompute data shipping job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-mc-1234567890-123456', - 'title' => '', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The body parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'displayName' => [ - 'description' => 'The display name of the MaxCompute data shipping job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-mc-job', - 'title' => '', - ], - 'description' => [ - 'description' => 'The description of the MaxCompute data shipping job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '更新MaxCompute投递任务', - 'title' => '', - ], - 'configuration' => [ - 'description' => 'The setting of the MaxCompute data shipping job.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/MaxComputeExportConfiguration', - 'title' => '', - 'example' => '', - ], - ], - 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpdateMaxComputeExport', - 'description' => '* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" - ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" - ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)'."\n", - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], ], - 'UpdateMemory' => [ - 'path' => '/memorystores/{memoryStore}/memories/{memoryId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateMaterializedView' => [ + 'summary' => 'Updates a materialized view.', + 'path' => '/materializedviews/{name}', + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREslsL870A3', - ], + 'abilityTreeCode' => '294422', + 'abilityTreeNodes' => ['FEATUREslsL870A3'], 'autoTest' => true, - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'metadata' => [ - 'type' => 'object', - 'properties' => [], - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'text' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], + 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the project that contains the materialized view.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'memoryStore', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'schema' => ['description' => 'The name of the materialized view to update.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'memoryId', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', - 'description' => '', + 'type' => 'object', + 'properties' => [ + 'originalSql' => ['description' => 'The new SQL query for the materialized view. Updating the query rebuilds the view.', 'type' => 'string', 'title' => '', 'example' => ''], + 'aggIntervalMins' => ['description' => 'The refresh interval of the materialized view, in minutes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'ttl' => ['description' => 'The data retention period (TTL) of the materialized view, in days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => ''], + 'enable' => ['description' => 'Specifies whether to automatically refresh the materialized view.', 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'description' => 'The request body.', 'title' => '', 'example' => '', ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', + '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'], + ], + ], + ], ], - 'summary' => '', + 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '', + 'title' => 'UpdateMaterializedView', ], - 'UpdateMemoryStore' => [ - 'path' => '/memorystores/{memoryStore}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'UpdateMaxComputeExport' => [ + 'summary' => 'Updates a MaxCompute data shipping job.', + '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, + 'abilityTreeCode' => '203412', + 'abilityTreeNodes' => ['FEATUREslsQK2IBF'], ], 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], + ], + [ + 'name' => 'mcExportName', + 'in' => 'path', + 'schema' => ['description' => 'The unique name of the MaxCompute data shipping job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-mc-1234567890-123456', 'title' => ''], + ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ + 'description' => 'The body parameters.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'enableGraph' => [ - 'type' => 'boolean', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'shortTermTtl' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'strategy' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'customInstructions' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'displayName' => ['description' => 'The display name of the MaxCompute data shipping job.', 'type' => 'string', 'required' => true, 'example' => 'my-mc-job', 'title' => ''], + 'description' => ['description' => 'The description of the MaxCompute data shipping job.', 'type' => 'string', 'example' => 'Update MaxCompute delivery task', 'required' => false, 'title' => ''], + 'configuration' => ['description' => 'The setting of the MaxCompute data shipping job.', 'required' => true, '$ref' => '#/components/schemas/MaxComputeExportConfiguration', 'title' => '', 'example' => ''], ], - 'description' => '', - 'title' => '', - 'example' => '', - ], - ], - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'description' => '', + 'required' => false, 'title' => '', 'example' => '', ], ], - [ - 'name' => 'memoryStore', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'description' => '', - 'title' => '', - 'example' => '', + ], + 'responses' => [ + 200 => [ + 'headers' => [ + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], ], ], ], - 'responses' => [], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'summary' => '', + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'UpdateMaxComputeExport', + 'description' => '- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + ."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see [Manage a project](~~48984~~)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => '', + 'translator' => 'manual', ], 'UpdateMetricStore' => [ 'summary' => 'Updates the configuration of an existing Metricstore. A Metricstore is used to store metrics.', 'path' => '/metricstores/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -41785,32 +24788,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '225678', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Metricstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'my_metric_store', - ], + 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'example' => 'my_metric_store', 'title' => ''], ], [ 'name' => 'body', @@ -41821,67 +24810,14 @@ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'ttl' => [ - 'title' => '', - 'description' => 'The data retention period. Unit: days.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], - 'autoSplit' => [ - 'title' => '', - 'description' => 'Specifies whether to enable automatic sharding.', - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - 'example' => 'true', - ], - 'maxSplitShard' => [ - 'title' => '', - 'description' => 'The maximum number of shards for automatic sharding. This parameter is valid only when autoSplit is set to true.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '64', - ], - 'mode' => [ - 'title' => '', - 'description' => 'The type of the Metricstore.', - 'type' => 'string', - 'required' => false, - 'default' => 'standard', - 'example' => 'standard', - ], - 'hot_ttl' => [ - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'description' => 'The retention period of data in the hot storage layer. Unit: days.', - 'example' => '', - ], - 'infrequentAccessTTL' => [ - 'type' => 'integer', - 'format' => 'int32', - 'title' => '', - 'required' => false, - 'description' => 'The retention period for the IA storage class. Unit: days.', - 'example' => '', - ], - 'appendMeta' => [ - 'type' => 'boolean', - 'default' => 'false', - 'description' => '', - 'title' => '', - 'example' => '', - ], - 'shardingPolicy' => [ - '$ref' => '#/components/schemas/ShardingPolicy', - 'description' => '', - 'title' => '', - 'example' => '', - ], + 'ttl' => ['description' => 'The data retention period. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => '', 'required' => false], + 'autoSplit' => ['description' => 'Specifies whether to enable automatic sharding.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => 'true'], + 'maxSplitShard' => ['description' => 'The maximum number of shards for automatic sharding. This parameter is valid only when autoSplit is set to true.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => '', 'required' => false], + 'mode' => ['description' => 'The type of the Metricstore.', 'type' => 'string', 'default' => 'standard', 'title' => '', 'required' => false, 'example' => 'standard'], + 'hot_ttl' => ['description' => 'The retention period of data in the hot storage layer. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => ''], + 'infrequentAccessTTL' => ['description' => 'The retention period for the IA storage class. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => ''], + 'appendMeta' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + 'shardingPolicy' => ['$ref' => '#/components/schemas/ShardingPolicy', 'description' => '', 'title' => '', 'example' => ''], ], 'required' => false, 'example' => '', @@ -41892,62 +24828,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' => 'The specified metricstore xxx does not exist.', - ], + ['errorCode' => 'MetricStoreNotExist', 'errorMessage' => 'The specified metricstore xxx does not exist.', 'description' => 'The specified metricstore xxx does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateMetricStore', 'description' => 'A [Metricstore](~~171723~~) is used to store [metrics](~~174965~~).'."\n" ."\n" @@ -41965,26 +24871,11 @@ ."\n" .'- Metrics are deleted after their retention period expires.', 'changeSet' => [ - [ - 'createdAt' => '2025-12-03T01:37:06.000Z', - 'description' => 'Request parameters changed', - ], - [ - 'createdAt' => '2025-12-02T11:55:05.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:22:02.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => 'OpenAPI offline', - ], - [ - 'createdAt' => '2025-11-24T09:35:52.000Z', - 'description' => 'Request parameters changed', - ], + ['createdAt' => '2025-12-03T01:37:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-12-02T11:55:05.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:22:02.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-02T07:21:18.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-11-24T09:35:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], @@ -41995,20 +24886,14 @@ 'UpdateMetricStoreMeteringMode' => [ 'summary' => 'Updates the billing mode of a specified Metricstore.', '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, @@ -42017,32 +24902,18 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '213244', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The name of the project.', - 'example' => 'projectName', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'projectName', 'title' => ''], ], [ 'name' => 'metricStore', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Metricstore.', - 'type' => 'string', - 'required' => true, - 'example' => 'metricStoreName', - ], + 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'example' => 'metricStoreName', 'title' => ''], ], [ 'name' => 'body', @@ -42053,16 +24924,13 @@ 'type' => 'object', 'properties' => [ 'meteringMode' => [ - 'title' => '', 'description' => 'The billing mode to which you want to switch. Valid values: ChargeByFunction and ChargeByDataIngest. ChargeByFunction specifies the [pay-by-feature](~~48220~~) mode. ChargeByDataIngest specifies the [pay-by-ingested-data](~~2365756~~) mode.', 'type' => 'string', 'required' => true, - 'default' => 'ChargeByFunction', - 'enum' => [ - 'ChargeByDataIngest', - 'ChargeByFunction', - ], 'example' => 'ChargeByFunction', + 'default' => 'ChargeByFunction', + 'enum' => ['ChargeByDataIngest', 'ChargeByFunction'], + 'title' => '', ], ], 'required' => false, @@ -42075,53 +24943,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' => [], @@ -42148,20 +24990,14 @@ 'UpdateMetricStoreProcessor' => [ 'summary' => 'Updates the ingest processor that is associated with a 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, @@ -42170,48 +25006,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '240240', - 'abilityTreeNodes' => [ - 'FEATUREslsA3NLDD', - ], + 'abilityTreeNodes' => ['FEATUREslsA3NLDD'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ - 'name' => 'metricstore', - 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the Metricstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-metricstore', - ], + 'name' => 'metricstore', + 'in' => 'path', + 'schema' => ['description' => 'The name of the Metricstore.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-metricstore'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The request body.'."\n", + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'processorName' => [ - 'title' => '', - 'description' => 'The identifier of the ingest processor.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'filter-metrics', - ], + 'processorName' => ['description' => 'The identifier of the ingest processor.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'filter-metrics'], ], 'required' => false, 'title' => '', @@ -42223,47 +25039,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' => 'UpdateMetricStoreProcessor', 'changeSet' => [], @@ -42275,83 +25071,44 @@ 'UpdateOSSExport' => [ 'summary' => 'Updates an Object Storage Service (OSS) data shipping job.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-oss-1234567890-123456'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-oss-1234567890-123456'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations of the job.'."\n", + 'description' => 'The configurations of the job.', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => 'The display name of the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my-oss-job'."\n", - 'title' => '', - ], - 'description' => [ - 'description' => 'The description of the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '更新OSS投递任务'."\n", - 'title' => '', - ], - 'configuration' => [ - 'description' => 'The configuration details of the job.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/OSSExportConfiguration', - 'title' => '', - 'example' => '', - ], + 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => false, 'example' => 'my-oss-job'."\n", 'title' => ''], + 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Update OSS delivery task', 'required' => false, 'title' => ''], + 'configuration' => ['description' => 'The configuration details of the job.', '$ref' => '#/components/schemas/OSSExportConfiguration', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -42362,48 +25119,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' => 'UpdateOSSExport', 'changeSet' => [], @@ -42411,87 +25148,49 @@ 'flowControlList' => [], ], 'ramActions' => [], + 'translator' => 'manual', ], 'UpdateOSSHDFSExport' => [ 'summary' => 'Updates an OSS-HDFS data shipping job.', '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' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], ], [ 'name' => 'ossExportName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of the job. Make sure that the job exists.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'export-osshdfs-1234567890-123456'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The unique name of the job. Make sure that the job exists.', 'type' => 'string', 'required' => true, 'example' => 'export-osshdfs-1234567890-123456'."\n", 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations of the job.'."\n", + 'description' => 'The configurations of the job.', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => 'The display name of the job.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-oss-hdfs-job'."\n", - 'title' => '', - ], - 'description' => [ - 'description' => 'The description of the job.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '更新OSS-HDFS投递任务'."\n", - 'title' => '', - ], - 'configuration' => [ - 'description' => 'The configuration details of the job.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/OSSExportConfiguration', - 'title' => '', - 'example' => '', - ], + 'displayName' => ['description' => 'The display name of the job.', 'type' => 'string', 'required' => true, 'example' => 'my-oss-hdfs-job'."\n", 'title' => ''], + 'description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'Update OSS-HDFS delivery task', 'required' => false, 'title' => ''], + 'configuration' => ['description' => 'The configuration details of the job.', 'required' => true, '$ref' => '#/components/schemas/OSSExportConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -42502,41 +25201,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'], ], ], ], @@ -42548,57 +25229,37 @@ 'flowControlList' => [], ], 'ramActions' => [], + 'translator' => 'manual', ], 'UpdateOSSIngestion' => [ 'summary' => 'Updates the specified OSS import task.', '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' => 'The name of the project.', - 'type' => 'string', - 'required' => true, - 'example' => 'ali-test-project'."\n", - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-project'."\n", 'title' => ''], ], [ 'name' => 'ossIngestionName', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the OSS import task.', - 'type' => 'string', - 'required' => true, - 'example' => 'ingest-oss-123455', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the OSS import task.', 'type' => 'string', 'required' => true, 'example' => 'ingest-oss-123455', 'title' => ''], ], [ 'name' => 'body', @@ -42608,34 +25269,10 @@ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'description' => 'The description of the OSS import task.', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS导入', - 'title' => '', - ], - 'displayName' => [ - 'description' => 'The display name of the OSS import task.', - 'type' => 'string', - 'required' => true, - 'example' => 'OSS导入', - 'title' => '', - ], - 'schedule' => [ - 'description' => 'The schedule of the task. This parameter is optional. To run the task at a fixed time, such as 08:00 every Monday, use a cron expression.', - '$ref' => '#/components/schemas/Schedule', - 'required' => false, - 'title' => '', - 'example' => '', - ], - 'configuration' => [ - 'description' => 'The configuration of the OSS import task.', - 'required' => true, - '$ref' => '#/components/schemas/OSSIngestionConfiguration', - 'title' => '', - 'example' => '', - ], + 'description' => ['description' => 'The description of the OSS import task.', 'type' => 'string', 'example' => 'OSS import', 'required' => false, 'title' => ''], + 'displayName' => ['description' => 'The display name of the OSS import task.', 'type' => 'string', 'example' => 'OSS import', 'required' => true, 'title' => ''], + 'schedule' => ['description' => 'The schedule of the task. This parameter is optional. To run the task at a fixed time, such as 08:00 every Monday, use a cron expression.', '$ref' => '#/components/schemas/Schedule', 'required' => false, 'title' => '', 'example' => ''], + 'configuration' => ['description' => 'The configuration of the OSS import task.', 'required' => true, '$ref' => '#/components/schemas/OSSIngestionConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -42646,48 +25283,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' => 'UpdateOSSIngestion', 'changeSet' => [], @@ -42695,34 +25312,26 @@ 'flowControlList' => [], ], 'ramActions' => [], + 'translator' => 'manual', ], 'UpdateProject' => [ 'summary' => 'Updates project information.', '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', ], @@ -42735,23 +25344,14 @@ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'description' => [ - 'title' => 'Project description', - 'description' => 'The description of the project. The default value is an empty string.', - 'type' => 'string', - 'required' => true, - 'example' => 'Description of my-project-test', - ], + 'description' => ['title' => 'Project description', 'description' => 'The description of the project. The default value is an empty string.', 'type' => 'string', 'required' => true, 'example' => 'Description of my-project-test'], 'recycleBinEnabled' => [ 'description' => 'Specifies whether to enable the recycle bin.', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'Yes', - 'false' => 'No', - ], - 'title' => '', 'example' => 'true', + 'title' => '', ], ], 'required' => true, @@ -42762,53 +25362,29 @@ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The project name.', - 'example' => 'ali-project-test', - ], + 'schema' => ['description' => 'The project name.', 'type' => 'string', 'required' => true, 'title' => '', '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'], ], ], ], @@ -42832,14 +25408,9 @@ .'| `log:UpdateProject` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}` |', 'requestParamsDescription' => 'Sample request'."\n" ."\n" - .'PUT / HTTP/1.1'."\n" - .'Host:ali-project-test.cn-hangzhou.log.aliyuncs.com'."\n" - .'Content-Type: application/json'."\n" + .'PUT / HTTP/1.1 Host:ali-project-test.cn-hangzhou.log.aliyuncs.com Content-Type: application/json'."\n" ."\n" - .'{'."\n" - .'"description" : "Description of my-project-test",'."\n" - .'"recycleBinEnabled": true'."\n" - .'}', + .'{ "description" : "Description of my-project-test", "recycleBinEnabled": true }', 'responseParamsDescription' => 'Sample response'."\n" ."\n" .'HTTP/1.1 200 OK', @@ -42861,18 +25432,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}'], ], ], ], @@ -42881,93 +25444,42 @@ 'UpdateSavedSearch' => [ 'summary' => 'Updates a saved search.', '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', - ], - 'parameters' => [ - [ - 'name' => 'project', - 'in' => 'host', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my-project', - ], - ], - [ - 'name' => 'savedsearchName', - 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the saved search that you want to update.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'savedsearch-name', - 'title' => '', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'savedsearchName' => [ - 'description' => 'The name of the saved search. The name must be 3 to 63 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'savedsearch-name', - 'title' => '', - ], - 'searchQuery' => [ - 'description' => 'The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the Search statement|Analytic statement format. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time', - 'title' => '', - ], - 'logstore' => [ - 'description' => 'The name of the Logstore to which the saved search belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aliyun-test-logstore', - 'title' => '', - ], - 'topic' => [ - 'description' => 'The topic of the logs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'theme', - 'title' => '', - ], - 'displayName' => [ - 'description' => 'The display name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'displayname', - 'title' => '', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'project', + 'in' => 'host', + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'my-project', 'title' => ''], + ], + [ + 'name' => 'savedsearchName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the saved search that you want to update.', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'savedsearchName' => ['description' => 'The name of the saved search. The name must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'savedsearch-name', 'title' => ''], + 'searchQuery' => ['description' => 'The query statement of the saved search. A query statement consists of a search statement and an analytic statement in the Search statement|Analytic statement format. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).', 'type' => 'string', 'required' => true, 'example' => '*|select date_format(__time__-__time__%60, \'%H:%i:%s\') as time, COUNT(*) as pv group by time', 'title' => ''], + 'logstore' => ['description' => 'The name of the Logstore to which the saved search belongs.', 'type' => 'string', 'required' => true, 'example' => 'aliyun-test-logstore', 'title' => ''], + 'topic' => ['description' => 'The topic of the logs.', 'type' => 'string', 'required' => false, 'example' => 'theme', 'title' => ''], + 'displayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => true, 'example' => 'displayname', 'title' => ''], ], 'required' => false, 'title' => '', @@ -42979,46 +25491,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'], ], ], ], @@ -43027,21 +25515,23 @@ 'title' => 'UpdateSavedSearch', 'description' => '### Usage notes'."\n" ."\n" - .'* Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" - .'* An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" + .'- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.'."\n" + ."\n" + .'- An AccessKey pair is created and obtained. For more information, see [AccessKey pair](~~29009~~).'."\n" ."\n" - .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + .'The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a Resource Access Management (RAM) user to call API operations or perform routine O\\&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see [Create a RAM user and authorize the RAM user to access Simple Log Service](~~47664~~).'."\n" + ."\n" + .'- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" ."\n" - .'* The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see [Manage a project](~~48984~~) and [Manage a Logstore](~~48990~~).'."\n" - .'* Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" + .'- Limits are imposed when you use Simple Log Service to query logs. We recommend that you specify query statements and query time ranges based on the limits. For more information, see [Log search overview](~~43772~~) and [Log analysis overview](~~53608~~).'."\n" ."\n" .'### Authentication resources'."\n" ."\n" .'The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.'."\n" ."\n" - .'|Action|Resource|'."\n" - .'|:---|:---|'."\n" - .'|`log:UpdateSavedSearch`|`acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}`|', + .'| Action | Resource |'."\n" + .'| :---------------------- | :--------------------------------------------------------------------------------------- |'."\n" + .'| `log:UpdateSavedSearch` | `acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}` |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], @@ -43053,18 +25543,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}'], ], ], ], @@ -43073,21 +25555,14 @@ 'UpdateScheduledSQL' => [ 'summary' => 'Updates the specified scheduled SQL task.', '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, @@ -43096,32 +25571,18 @@ 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '209793', - 'abilityTreeNodes' => [ - 'FEATUREslsEPUWT1', - ], + 'abilityTreeNodes' => ['FEATUREslsEPUWT1'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'title' => '', - 'description' => 'The name of the project.', - 'example' => 'ali-test-project', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ali-test-project'], ], [ 'name' => 'scheduledSQLName', 'in' => 'path', - 'schema' => [ - 'description' => 'The unique name of an existing task.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'sql-123456789-123456', - ], + 'schema' => ['description' => 'The unique name of an existing task.', 'type' => 'string', 'required' => true, 'example' => 'sql-123456789-123456', 'title' => ''], ], [ 'name' => 'body', @@ -43131,34 +25592,10 @@ 'description' => 'The configuration of the scheduled SQL task.', 'type' => 'object', 'properties' => [ - 'displayName' => [ - 'description' => 'The display name of the task.', - 'type' => 'string', - 'required' => true, - 'title' => '', - 'example' => 'ali-test-scheduled-sql', - ], - 'description' => [ - 'description' => 'The description of the task.', - 'type' => 'string', - 'required' => false, - 'title' => '', - 'example' => '更新定时SQL任务'."\n", - ], - 'schedule' => [ - 'description' => 'The scheduling configuration of the task.', - 'required' => true, - '$ref' => '#/components/schemas/Schedule', - 'title' => '', - 'example' => '', - ], - 'configuration' => [ - 'description' => 'The configuration of the task.', - 'required' => true, - '$ref' => '#/components/schemas/ScheduledSQLConfiguration', - 'title' => '', - 'example' => '', - ], + 'displayName' => ['description' => 'The display name of the task.', 'type' => 'string', 'required' => true, 'example' => 'ali-test-scheduled-sql', 'title' => ''], + 'description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'Update scheduled SQL task', 'required' => false, 'title' => ''], + 'schedule' => ['description' => 'The scheduling configuration of the task.', 'required' => true, '$ref' => '#/components/schemas/Schedule', 'title' => '', 'example' => ''], + 'configuration' => ['description' => 'The configuration of the task.', 'required' => true, '$ref' => '#/components/schemas/ScheduledSQLConfiguration', 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -43170,45 +25607,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"}]', @@ -43225,34 +25643,24 @@ 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], + 'translator' => 'manual', ], 'UpdateSqlInstance' => [ 'summary' => 'When you use Standard SQL to analyze large amounts of data, a single query may not scan all logs within a specific time range, which can result in incomplete data. Although adding shards improves read and write performance, this improvement applies only to new data. To analyze more data in a single query, enable Dedicated SQL and add more compute resources.', 'path' => '/sqlinstance', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -43261,21 +25669,13 @@ 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '212425', - 'abilityTreeNodes' => [ - 'FEATUREslsMYXSJS', - ], + 'abilityTreeNodes' => ['FEATUREslsMYXSJS'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project in which to enable Dedicated SQL.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project in which to enable Dedicated SQL.', 'type' => 'string', 'required' => true, 'example' => 'test-project', 'title' => ''], ], [ 'name' => 'body', @@ -43285,21 +25685,8 @@ 'description' => 'The request struct.', 'type' => 'object', 'properties' => [ - 'cu' => [ - 'description' => 'The number of Compute Units (CUs). A CU is a compute core that can be used for parallel processing when Dedicated SQL is running.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'title' => '', - 'example' => '2', - ], - 'useAsDefault' => [ - 'description' => 'Specifies whether to enable Dedicated SQL for the project by default. If this parameter is set to true, all query and analysis operations in the project, such as alerts and dashboards, use Dedicated SQL.', - 'type' => 'boolean', - 'required' => true, - 'title' => '', - 'example' => '', - ], + 'cu' => ['description' => 'The number of Compute Units (CUs). A CU is a compute core that can be used for parallel processing when Dedicated SQL is running.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '2'], + 'useAsDefault' => ['description' => 'Specifies whether to enable Dedicated SQL for the project by default. If this parameter is set to true, all query and analysis operations in the project, such as alerts and dashboards, use Dedicated SQL.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', @@ -43311,53 +25698,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' => 'UpdateSqlInstance', 'description' => '**Before you call this operation, make sure that you understand the billing methods and [pricing](~~223777~~) for Dedicated SQL.**', @@ -43373,12 +25734,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}'], ], ], ], @@ -43387,20 +25743,14 @@ 'UpdateStoreView' => [ 'summary' => 'Updates the configurations of a dataset.', 'path' => '/storeviews/{name}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'write', 'deprecated' => false, @@ -43409,39 +25759,25 @@ 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '208677', - 'abilityTreeNodes' => [ - 'FEATUREsls27DZA4', - ], + 'abilityTreeNodes' => ['FEATUREsls27DZA4'], ], 'parameters' => [ [ 'name' => 'project', 'in' => 'host', - 'schema' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'example-project', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the project.', 'type' => 'string', 'required' => true, 'example' => 'example-project', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => 'The name of the dataset.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'my_storeview', - 'title' => '', - ], + 'schema' => ['description' => 'The name of the dataset.', 'type' => 'string', 'required' => true, 'example' => 'my_storeview', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The configurations of the dataset.'."\n", + 'description' => 'The configurations of the dataset.', 'type' => 'object', 'properties' => [ 'storeType' => [ @@ -43449,40 +25785,31 @@ ."\n" .'Valid values:'."\n" ."\n" - .'* metricstore'."\n" + .'- metricstore'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .'* logstore'."\n" + .'- logstore'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n", + .' ', + 'enumValueTitles' => ['metricstore' => 'metricstore', 'logstore' => 'logstore'], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'metricstore' => 'metricstore', - 'logstore' => 'logstore', - ], 'example' => 'logstore', 'title' => '', ], 'stores' => [ - 'description' => 'The Logstores or Metricstores.'."\n", + 'description' => 'The Logstores or Metricstores.', 'type' => 'array', - 'items' => [ - 'description' => 'The Logstore or Metricstore.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/StoreViewStore', - 'title' => '', - 'example' => '', - ], + 'items' => ['description' => 'The Logstore or Metricstore.', 'required' => true, '$ref' => '#/components/schemas/StoreViewStore', 'title' => '', 'example' => ''], 'required' => true, 'title' => '', 'example' => '', @@ -43498,53 +25825,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' => 'UpdateStoreView', 'changeSet' => [], @@ -43559,12 +25860,7 @@ 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ - [ - 'validationType' => 'always', - 'product' => 'SLS', - 'resourceType' => 'All Resource', - 'arn' => '*', - ], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], @@ -43573,20 +25869,14 @@ 'UpsertCollectionPolicy' => [ 'summary' => 'Creates a log collection policy for a cloud service. This way, logs can be automatically collected from the service.', 'path' => '/collectionpolicy', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], + 'consumes' => ['application/json'], 'produces' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, @@ -43595,9 +25885,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192469', - 'abilityTreeNodes' => [ - 'FEATUREsls9NGCVR', - ], + 'abilityTreeNodes' => ['FEATUREsls9NGCVR'], ], 'parameters' => [ [ @@ -43605,92 +25893,45 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => 'The body of the request.'."\n", + 'description' => 'The body of the request.', 'type' => 'object', 'properties' => [ - 'policyName' => [ - 'description' => 'The name must meet the following requirements:'."\n" - ."\n" - .'* The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" - .'* The name must start with a letter.'."\n" - .'* The name must be 3 to 63 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'your_log_policy', - 'maxLength' => 63, - 'minLength' => 3, - 'title' => '', - ], - 'productCode' => [ - 'description' => 'The code of the service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss', - 'title' => '', - ], - 'dataCode' => [ - 'description' => 'The code of the log type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'access_log', - 'title' => '', - ], - 'enabled' => [ - 'description' => 'Specifies whether to enable the policy.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - 'title' => '', - ], + 'policyName' => ['description' => 'The name must meet the following requirements:'."\n" + ."\n" + .'- The name can contain only lowercase letters, digits, hyphens (-), and underscores (\\_).'."\n" + ."\n" + .'- The name must start with a letter.'."\n" + ."\n" + .'- The name must be 3 to 63 characters in length.', 'type' => 'string', 'required' => true, 'maxLength' => 63, 'minLength' => 3, 'example' => 'your_log_policy', 'title' => ''], + 'productCode' => ['description' => 'The code of the service.', 'type' => 'string', 'required' => true, 'example' => 'oss', 'title' => ''], + 'dataCode' => ['description' => 'The code of the log type.', 'type' => 'string', 'required' => true, 'example' => 'access_log', 'title' => ''], + 'enabled' => ['description' => 'Specifies whether to enable the policy.', 'type' => 'boolean', 'required' => true, 'default' => 'false', 'example' => 'true', 'title' => ''], 'policyConfig' => [ - 'description' => 'The configurations of the policy.'."\n", + 'description' => 'The configurations of the policy.', 'type' => 'object', 'properties' => [ 'resourceMode' => [ - 'description' => 'The resource collection mode. Valid values: all, attributeMode, and instanceMode. The value all specifies that logs of all instances within your account are collected to the default logstore. The value attributeMode specifies that logs are collected based on the regions of instances and resource tags. The value instanceMode specifies that logs are collected based on instance IDs.'."\n", + 'description' => 'The resource collection mode. Valid values: all, attributeMode, and instanceMode. The value all specifies that logs of all instances within your account are collected to the default logstore. The value attributeMode specifies that logs are collected based on the regions of instances and resource tags. The value instanceMode specifies that logs are collected based on instance IDs.', 'type' => 'string', 'required' => true, 'example' => 'all', 'default' => 'all', - 'enum' => [ - 'all', - 'instanceMode', - 'attributeMode', - ], - 'title' => '', - ], - 'resourceTags' => [ - 'description' => 'The resource tags. This parameter takes effect only when resourceMode is set to attributeMode. If you leave this parameter empty, resource tag-based filtering is not performed. The system considers that all instances are matched. If you specify a value for this parameter, logs of instances that use the specified resource tags are collected. Logs are collected from an instance only if the resource tags and region of the instance match the specified conditions.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{"tag1":"value1",“tag2":"value2"}', + 'enum' => ['all', 'instanceMode', 'attributeMode'], 'title' => '', ], + 'resourceTags' => ['description' => 'The resource tags. This parameter takes effect only when resourceMode is set to attributeMode. If you leave this parameter empty, resource tag-based filtering is not performed. The system considers that all instances are matched. If you specify a value for this parameter, logs of instances that use the specified resource tags are collected. Logs are collected from an instance only if the resource tags and region of the instance match the specified conditions.', 'type' => 'object', 'required' => false, 'example' => '{"tag1":"value1",“tag2":"value2"}', 'title' => ''], 'regions' => [ - 'description' => 'The regions of the instances. This parameter takes effect only when resourceMode is set to attributeMode. Wildcard characters are supported. If you leave this parameter empty, region-based filtering is not performed. The system considers that all instances are matched. If you specify a value for this parameter, logs of instances that reside in the specified regions are collected. Logs are collected from an instance only if the resource tags and region of the instance match the specified conditions.'."\n", + 'description' => 'The regions of the instances. This parameter takes effect only when resourceMode is set to attributeMode. Wildcard characters are supported. If you leave this parameter empty, region-based filtering is not performed. The system considers that all instances are matched. If you specify a value for this parameter, logs of instances that reside in the specified regions are collected. Logs are collected from an instance only if the resource tags and region of the instance match the specified conditions.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - 'title' => '', - ], + 'items' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'instanceIds' => [ - 'description' => 'The IDs of the instances. This parameter takes effect only when resourceMode is set to instanceMode. Logs are collected only from instances that use the specified IDs.'."\n", + 'description' => 'The IDs of the instances. This parameter takes effect only when resourceMode is set to instanceMode. Logs are collected only from instances that use the specified IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'your-test-bucket1', - 'title' => '', - ], + 'items' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'your-test-bucket1', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -43700,89 +25941,39 @@ 'title' => '', 'example' => '', ], - 'centralizeEnabled' => [ - 'description' => 'Specifies whether to enable centralized storage. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - 'title' => '', - ], + 'centralizeEnabled' => ['description' => 'Specifies whether to enable centralized storage. Default value: false.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], 'centralizeConfig' => [ - 'description' => 'The configurations of centralized storage.'."\n", + 'description' => 'The configurations of centralized storage.', 'type' => 'object', 'properties' => [ - 'destRegion' => [ - 'description' => 'The destination region for centralized storage.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - 'title' => '', - ], - 'destProject' => [ - 'description' => 'The destination project for centralized storage. Make sure that the region of the destination project is consistent with the region specified by destRegion.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'your-sls-project-in-beijing', - 'title' => '', - ], - 'destLogstore' => [ - 'description' => 'The destination logstore for centralized storage. Make sure that the region of the destination logstore is consistent with the region specified by destRegion and the destination logstore belongs to the destination project specified by destProject.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'your-sls-logstore-in-beijing', - 'title' => '', - ], - 'destTTL' => [ - 'description' => 'The data retention period for centralized storage. Unit: days. This parameter takes effect only when you use an existing logstore for centralized storage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'your-sls-logstore-ttl', - 'title' => '', - ], + 'destRegion' => ['description' => 'The destination region for centralized storage.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + 'destProject' => ['description' => 'The destination project for centralized storage. Make sure that the region of the destination project is consistent with the region specified by destRegion.', 'type' => 'string', 'required' => false, 'example' => 'your-sls-project-in-beijing', 'title' => ''], + 'destLogstore' => ['description' => 'The destination logstore for centralized storage. Make sure that the region of the destination logstore is consistent with the region specified by destRegion and the destination logstore belongs to the destination project specified by destProject.', 'type' => 'string', 'required' => false, 'example' => 'your-sls-logstore-in-beijing', 'title' => ''], + 'destTTL' => ['description' => 'The data retention period for centralized storage. Unit: days. This parameter takes effect only when you use an existing logstore for centralized storage.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'your-sls-logstore-ttl', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'dataConfig' => [ - 'description' => 'The data configurations. The configuration is returned only for global logs. For example, if productCode is set to sls, the configuration is returned.'."\n", + 'description' => 'The data configurations. The configuration is returned only for global logs. For example, if productCode is set to sls, the configuration is returned.', 'type' => 'object', 'properties' => [ - 'dataRegion' => [ - 'description' => 'The region for storing the global logs that are collected for the first time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - 'title' => '', - ], + 'dataRegion' => ['description' => 'The region for storing the global logs that are collected for the first time.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'resourceDirectory' => [ - 'description' => 'The configurations of the resource directory. The account must have activated the resource directory and be a management account or a delegated administrator of the resource directory.'."\n", + 'description' => 'The configurations of the resource directory. The account must have activated the resource directory and be a management account or a delegated administrator of the resource directory.', 'type' => 'object', 'properties' => [ - 'accountGroupType' => [ - 'description' => 'The mode of the resource directory. Valid values: all and custom.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'all,custom', - 'title' => '', - ], + 'accountGroupType' => ['description' => 'The mode of the resource directory. Valid values: all and custom.', 'type' => 'string', 'required' => false, 'example' => 'all,custom', 'title' => ''], 'members' => [ - 'description' => 'The members. If accountGroupType is set to custom, the members are returned.'."\n", + 'description' => 'The members. If accountGroupType is set to custom, the members are returned.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '165***********50', - 'title' => '', - ], + 'items' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'required' => false, 'example' => '165***********50', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', @@ -43794,1085 +25985,1749 @@ ], ], 'required' => false, - 'title' => '', - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [ - 'Content-Type' => [ - 'schema' => [ - 'title' => '返回的响应体的内容格式。', - 'type' => 'string', - ], - ], - 'Content-Length' => [ - 'schema' => [ - 'title' => '响应内容长度。', - 'type' => 'string', - ], - ], - 'Date' => [ - 'schema' => [ - 'title' => '返回响应的时间。', - 'type' => 'string', - ], - ], - 'Connection' => [ - 'schema' => [ - 'title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', - 'type' => 'string', - ], - ], - 'x-log-requestid' => [ - 'schema' => [ - 'title' => '服务端产生的标识，该请求的唯一ID。', - 'type' => 'string', - ], - ], - 'Server' => [ - 'schema' => [ - 'title' => '服务器名称。', - 'type' => 'string', - ], - ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', - 'title' => 'UpsertCollectionPolicy', - 'description' => 'You must use the Simple Log Service endpoint for the China (Shanghai) or Singapore region to call the operation.'."\n", - 'responseParamsDescription' => 'For more information about error codes, see [Manage collection rules in the new version of Log Audit Service](~~2835059~~).'."\n", - 'changeSet' => [], - 'flowControl' => [ - 'flowControlList' => [], - ], - 'ramActions' => [], - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'regionName' => 'China (Qingdao)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-qingdao.log.aliyuncs.com', - 'endpoint' => 'cn-qingdao.log.aliyuncs.com', - 'vpc' => 'cn-qingdao-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'regionName' => 'China (Beijing)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-beijing.log.aliyuncs.com', - 'endpoint' => 'cn-beijing.log.aliyuncs.com', - 'vpc' => 'cn-beijing-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'regionName' => 'China (Zhangjiakou)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-zhangjiakou.log.aliyuncs.com', - 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com', - 'vpc' => 'cn-zhangjiakou-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'regionName' => 'China (Hohhot)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-huhehaote.log.aliyuncs.com', - 'endpoint' => 'cn-huhehaote.log.aliyuncs.com', - 'vpc' => 'cn-huhehaote-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'regionName' => 'China (Ulanqab)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-wulanchabu.log.aliyuncs.com', - 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com', - 'vpc' => 'cn-wulanchabu-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'regionName' => 'China (Hangzhou)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-hangzhou.log.aliyuncs.com', - 'endpoint' => 'cn-hangzhou.log.aliyuncs.com', - 'vpc' => 'cn-hangzhou-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'regionName' => 'China (Shanghai)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-shanghai.log.aliyuncs.com', - 'endpoint' => 'cn-shanghai.log.aliyuncs.com', - 'vpc' => 'cn-shanghai-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-nanjing', - 'regionName' => 'China (Nanjing - Local Region)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-nanjing.log.aliyuncs.com', - 'endpoint' => 'cn-nanjing.log.aliyuncs.com', - 'vpc' => 'cn-nanjing-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fuzhou', - 'regionName' => 'China (Fuzhou - Local Region)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-fuzhou.log.aliyuncs.com', - 'endpoint' => 'cn-fuzhou.log.aliyuncs.com', - 'vpc' => 'cn-fuzhou-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'regionName' => 'China (Shenzhen)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-shenzhen.log.aliyuncs.com', - 'endpoint' => 'cn-shenzhen.log.aliyuncs.com', - 'vpc' => 'cn-shenzhen-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'regionName' => 'China (Heyuan)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-heyuan.log.aliyuncs.com', - 'endpoint' => 'cn-heyuan.log.aliyuncs.com', - 'vpc' => 'cn-heyuan-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'regionName' => 'China (Guangzhou)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-guangzhou.log.aliyuncs.com', - 'endpoint' => 'cn-guangzhou.log.aliyuncs.com', - 'vpc' => 'cn-guangzhou-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'regionName' => 'China (Chengdu)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-chengdu.log.aliyuncs.com', - 'endpoint' => 'cn-chengdu.log.aliyuncs.com', - 'vpc' => 'cn-chengdu-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'regionName' => 'China (Hong Kong)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'cn-hongkong.log.aliyuncs.com', - 'endpoint' => 'cn-hongkong.log.aliyuncs.com', - 'vpc' => 'cn-hongkong-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'regionName' => 'Japan (Tokyo)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'ap-northeast-1.log.aliyuncs.com', - 'endpoint' => 'ap-northeast-1.log.aliyuncs.com', - 'vpc' => 'ap-northeast-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'regionName' => 'South Korea (Seoul)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'ap-northeast-2.log.aliyuncs.com', - 'endpoint' => 'ap-northeast-2.log.aliyuncs.com', - 'vpc' => 'ap-northeast-2-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'regionName' => 'Singapore', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'ap-southeast-1.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-1.log.aliyuncs.com', - 'vpc' => 'ap-southeast-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'regionName' => 'Australia (Sydney) Closed', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'ap-southeast-2.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-2.log.aliyuncs.com', - 'vpc' => 'ap-southeast-2-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'regionName' => 'Malaysia (Kuala Lumpur)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'ap-southeast-3.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-3.log.aliyuncs.com', - 'vpc' => 'ap-southeast-3-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'regionName' => 'Indonesia (Jakarta)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'ap-southeast-5.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-5.log.aliyuncs.com', - 'vpc' => 'ap-southeast-5-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'regionName' => 'Philippines (Manila)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'ap-southeast-6.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-6.log.aliyuncs.com', - 'vpc' => 'ap-southeast-6-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'regionName' => 'Thailand (Bangkok)', - 'areaId' => 'asiaPacific', - 'areaName' => 'Asia Pacific', - 'public' => 'ap-southeast-7.log.aliyuncs.com', - 'endpoint' => 'ap-southeast-7.log.aliyuncs.com', - 'vpc' => 'ap-southeast-7-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-southeast-1', - 'regionName' => 'US（Atlanta）', - 'areaId' => 'europeAmerica', - 'areaName' => 'Europe & Americas', - 'public' => 'us-southeast-1.log.aliyuncs.com', - 'endpoint' => 'us-southeast-1.log.aliyuncs.com', - 'vpc' => '', - ], - [ - 'regionId' => 'eu-central-1', - 'regionName' => 'Germany (Frankfurt)', - 'areaId' => 'europeAmerica', - 'areaName' => 'Europe & Americas', - 'public' => 'eu-central-1.log.aliyuncs.com', - 'endpoint' => 'eu-central-1.log.aliyuncs.com', - 'vpc' => 'eu-central-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'regionName' => 'UK (London)', - 'areaId' => 'europeAmerica', - 'areaName' => 'Europe & Americas', - 'public' => 'eu-west-1.log.aliyuncs.com', - 'endpoint' => 'eu-west-1.log.aliyuncs.com', - 'vpc' => 'eu-west-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'regionName' => 'US (Silicon Valley)', - 'areaId' => 'europeAmerica', - 'areaName' => 'Europe & Americas', - 'public' => 'us-west-1.log.aliyuncs.com', - 'endpoint' => 'us-west-1.log.aliyuncs.com', - 'vpc' => 'us-west-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'regionName' => 'US (Virginia)', - 'areaId' => 'europeAmerica', - 'areaName' => 'Europe & Americas', - 'public' => 'us-east-1.log.aliyuncs.com', - 'endpoint' => 'us-east-1.log.aliyuncs.com', - 'vpc' => 'us-east-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'regionName' => 'Saudi Arabia (Riyadh)', - 'areaId' => 'middleEast', - 'areaName' => 'Middle East', - 'public' => 'me-central-1.log.aliyuncs.com', - 'endpoint' => 'me-central-1.log.aliyuncs.com', - 'vpc' => 'me-central-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'regionName' => 'UAE (Dubai)', - 'areaId' => 'middleEast', - 'areaName' => 'Middle East', - 'public' => 'me-east-1.log.aliyuncs.com', - 'endpoint' => 'me-east-1.log.aliyuncs.com', - 'vpc' => 'me-east-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'regionName' => 'India (Mumbai) Closed', - 'areaId' => 'middleEast', - 'areaName' => 'Middle East', - 'public' => 'ap-south-1.log.aliyuncs.com', - 'endpoint' => 'ap-south-1.log.aliyuncs.com', - 'vpc' => 'ap-south-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan-acdr-1', - 'regionName' => 'Heyuan ACDR Auto', - 'areaId' => 'industryCloud', - 'areaName' => 'Industry Cloud', - 'public' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', - 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', - 'vpc' => '', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'regionName' => 'China North 2 Finance (Preview)', - 'areaId' => 'industryCloud', - 'areaName' => 'Industry Cloud', - 'public' => 'cn-beijing-finance-1.log.aliyuncs.com', - 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com', - 'vpc' => 'cn-beijing-finance-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'regionName' => 'China South 1 Finance', - 'areaId' => 'industryCloud', - 'areaName' => 'Industry Cloud', - 'public' => 'cn-shenzhen-finance-1.log.aliyuncs.com', - 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com', - 'vpc' => '', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'regionName' => 'China East 2 Finance', - 'areaId' => 'industryCloud', - 'areaName' => 'Industry Cloud', - 'public' => 'cn-shanghai-finance-1.log.aliyuncs.com', - 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com', - 'vpc' => 'cn-shanghai-finance-1-intranet.log.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'regionName' => 'China East 1 Finance', - 'areaId' => 'industryCloud', - 'areaName' => 'Industry Cloud', - 'public' => 'cn-hangzhou-finance.log.aliyuncs.com', - 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com', - 'vpc' => 'cn-hangzhou-finance-intranet.log.aliyuncs.com', - ], - ], - 'errorCodes' => [ - [ - 'code' => 'AccessDenied', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Unauthorized', - ], - [ - 'code' => 'AlertNotExist', - 'message' => '%s.', - 'http_code' => 404, - 'description' => 'Alert does not exist', - ], - [ - 'code' => 'AlreadyExist', - 'message' => 'App already exist.', - 'http_code' => 400, - 'description' => 'Application already exists', - ], - [ - 'code' => 'AppNotExist', - 'message' => 'The App not exist.', - 'http_code' => 400, - 'description' => 'Application does not exist', - ], - [ - 'code' => 'AuthorizationRequired', - 'message' => 'Authorization Required', - 'http_code' => 401, - 'description' => '', - ], - [ - 'code' => 'ClientError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Internal service exception', - ], - [ - 'code' => 'ConfigServiceNotEnabled', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Configuration service is not enabled', - ], - [ - 'code' => 'CreateError', - 'message' => 'Create app failed.', - 'http_code' => 400, - 'description' => 'Failed to create application', - ], - [ - 'code' => 'CreateFailed', - 'message' => 'Create app failed.', - 'http_code' => 400, - 'description' => 'Failed to create application', - ], - [ - 'code' => 'CreateOrderError', - 'message' => '%s.', - 'http_code' => 200, - 'description' => 'Create Order Error', - ], - [ - 'code' => 'CreateOrderFailed', - 'message' => 'Failed to create an order.', - 'http_code' => 500, - 'description' => '', - ], - [ - 'code' => 'CreateProjectFailed', - 'message' => 'Failed to create the project: %s.', - 'http_code' => 400, - 'description' => 'Failed to create project', - ], - [ - 'code' => 'DashboardError', - 'message' => 'Failed to create or update the dashboard: %s.', - 'http_code' => 400, - 'description' => 'Failed to create or update dashboard', - ], - [ - 'code' => 'DeleteFailed', - 'message' => 'Delete app failed.', - 'http_code' => 400, - 'description' => 'Failed to delete application', - ], - [ - 'code' => 'DescribeUserBusinessStatusFailed', - 'message' => 'Failed to describe user business status.', - 'http_code' => 500, - 'description' => '', - ], - [ - 'code' => 'EntityNotExist.Role', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Role does not exist', - ], - [ - 'code' => 'EtlMetaAlreadyExist', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Meta already exists', - ], - [ - 'code' => 'EventBridgeNotEnabled', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Service not enabled', - ], - [ - 'code' => 'ExceedQuota', - 'message' => 'The %s quota exceed.', - 'http_code' => 400, - 'description' => 'Quota exceed', - ], - [ - 'code' => 'ExceedQuota', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Quota exceed', - ], - [ - 'code' => 'FLOWLOG_INSTANCE_NOT_FOUND', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Invalid Instance', - ], - [ - 'code' => 'GetAlertHistoriesError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Failed to get alert history', - ], - [ - 'code' => 'GetAppFailed', - 'message' => 'Get app failed.', - 'http_code' => 400, - 'description' => 'Failed to get application', - ], - [ - 'code' => 'GetConfigError', - 'message' => 'Failed to get configuration information.', - 'http_code' => 500, - 'description' => '', - ], - [ - 'code' => 'GetProjectFailed', - 'message' => 'Failed to get project.', - 'http_code' => 400, - 'description' => 'Failed to get project', - ], - [ - 'code' => 'GetProjectFailed', - 'message' => 'Failed to get project: %s.', - 'http_code' => 400, - 'description' => 'Failed to get project', - ], - [ - 'code' => 'GetSpecificationsFailed', - 'message' => 'Failed to get specifications of commodity.', - 'http_code' => 500, - 'description' => '', - ], - [ - 'code' => 'GetSpecificationsFailed', - 'message' => '%s.', - 'http_code' => 500, - 'description' => 'Failed to get commodity', - ], - [ - 'code' => 'IncorrectStatus.LoadBalancer', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Incorrect status', - ], - [ - 'code' => 'IndexError', - 'message' => 'Failed to create or update index.', - 'http_code' => 400, - 'description' => 'Failed to create or update index', - ], - [ - 'code' => 'IndexError', - 'message' => 'Failed to create or update index: %s.', - 'http_code' => 400, - 'description' => 'Failed to create or update index', - ], - [ - 'code' => 'InputParaError', - 'message' => 'The specified parameter is invalid.', - 'http_code' => 400, - 'description' => '', - ], - [ - 'code' => 'InputParaError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Input parameter error', - ], - [ - 'code' => 'InternalException', - 'message' => 'Internal service upexpected exception', - 'http_code' => 400, - 'description' => '', - ], - [ - 'code' => 'InternalException', - 'message' => 'Internal service upexpected exception.', - 'http_code' => 400, - 'description' => 'Internal service exception', - ], - [ - 'code' => 'InvalidAppName', - 'message' => 'The appName is invalid.', - 'http_code' => 400, - 'description' => 'Invalid application name', - ], - [ - 'code' => 'InvalidDataType', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Invalid data type', - ], - [ - 'code' => 'InvalidDisplayName', - 'message' => 'Display name length exceeds limit.', - 'http_code' => 400, - 'description' => 'Display name exceeds length', - ], - [ - 'code' => 'InvalidInstance', - 'message' => 'The instance is invalid.', - 'http_code' => 400, - 'description' => 'Invalid Instance', - ], - [ - 'code' => 'InvalidInstance', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Invalid Instance', - ], - [ - 'code' => 'InvalidInstanceId.NotFound', - 'message' => 'The instance does not exist.', - 'http_code' => 400, - 'description' => 'Instance does not exist', - ], - [ - 'code' => 'InvalidLang', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Invalid language', - ], - [ - 'code' => 'InvalidParameter', - 'message' => 'The parameter is invalid: %s', - 'http_code' => 400, - 'description' => 'The specified parameter is invalid.', - ], - [ - 'code' => 'InvalidParameter', - 'message' => 'The parameter is invalid: %s.', - 'http_code' => 400, - 'description' => 'Illegal parameter', - ], - [ - 'code' => 'InvalidRAM', - 'message' => 'Permission denied.', - 'http_code' => 400, - 'description' => 'Authentication not passed', - ], - [ - 'code' => 'InvalidRegion', - 'message' => 'The region is invalid.', - 'http_code' => 400, - 'description' => 'Invalid Region', - ], - [ - 'code' => 'InvalidVpcId.NotFound', - 'message' => 'The vpdId does not exist.', - 'http_code' => 400, - 'description' => 'VpcId does not exist', - ], - [ - 'code' => 'JobAlreadyExist', - 'message' => 'The job already exists.', - 'http_code' => 400, - 'description' => 'Task already exists', - ], - [ - 'code' => 'JobError', - 'message' => 'Failed to create or update the job.', - 'http_code' => 400, - 'description' => 'Job failed', - ], - [ - 'code' => 'JobError', - 'message' => 'Failed to create or update the job: %s.', - 'http_code' => 400, - 'description' => 'Job failed', - ], - [ - 'code' => 'LogstoreError', - 'message' => 'Failed to create or update the logstore.', - 'http_code' => 400, - 'description' => 'Logstore creation or update failed', - ], - [ - 'code' => 'LogstoreError', - 'message' => 'Failed to create or update the logstore: %s.', - 'http_code' => 400, - 'description' => 'Logstore create or update failed', - ], - [ - 'code' => 'LogStoreNotExist', - 'message' => 'logstore xxxx does not exist.', - 'http_code' => 404, - 'description' => 'The Logstore does not exist.', - ], - [ - 'code' => 'LogstoreProductTypeConflict', - 'message' => 'The product type doesn\'t match : %s.', - 'http_code' => 400, - 'description' => 'Logstore type mismatch', - ], - [ - 'code' => 'LogstoreProductTypeConflict', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Logstore type mismatch', - ], - [ - 'code' => 'MetricStoreAlreadyExist', - 'message' => 'The specified metricstore xxx already exists.', - 'http_code' => 400, - 'description' => 'The specified metricstore xxx already exists.', - ], - [ - 'code' => 'MetricStoreNotExist', - 'message' => 'The specified metricstore xxx does not exist.', - 'http_code' => 404, - 'description' => 'The specified metricstore xxx does not exist.', - ], - [ - 'code' => 'ParameterInvalid', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Parameter invalid', - ], - [ - 'code' => 'ParamMissing', - 'message' => 'The app name is required.', - 'http_code' => 400, - 'description' => 'Illegal parameter', - ], - [ - 'code' => 'ParamsIsNull', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Parameter is empty', - ], - [ - 'code' => 'PermissionDenied', - 'message' => 'You are not authorized to activate Log Service.', - 'http_code' => 400, - 'description' => '', - ], - [ - 'code' => 'PermissionDenied', - 'message' => '%s.', - 'http_code' => 401, - 'description' => 'No permission', - ], - [ - 'code' => 'PostBodyInvalid', - 'message' => 'Loggroup contains zero logs.', - 'http_code' => 400, - 'description' => 'There are no logs in the LogGroup.', - ], - [ - 'code' => 'PostBodyInvalid', - 'message' => 'Fail to parse protobuf.', - 'http_code' => 400, - 'description' => 'Protobuffer content is illegal and cannot be parsed.', - ], - [ - 'code' => 'PostBodyTooLarge', - 'message' => 'Body size must little than 10485760.', - 'http_code' => 413, - 'description' => 'Body size must little than 10485760.', - ], - [ - 'code' => 'PostBodyUncompressError', - 'message' => 'Post body uncompressed fail.', - 'http_code' => 400, - 'description' => 'Post body uncompressed fail.', - ], - [ - 'code' => 'ProductDataCollectionNoExist', - 'message' => 'failed to find product data collection for this instance', - 'http_code' => 400, - 'description' => 'The collection configuration for this instance is not found.', - ], - [ - 'code' => 'ProductDataCollectionNoExist', - 'message' => 'Failed to find product data collection for this instance.', - 'http_code' => 400, - 'description' => 'Failed to find product data collection for this instance', - ], - [ - 'code' => 'ProjectExist', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Item already exists', - ], - [ - 'code' => 'ProjectForbidden', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Project is forbidden', - ], - [ - 'code' => 'ProjectNotExist', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Project does not exist', - ], - [ - 'code' => 'ProjectNotExist', - 'message' => 'The Project does not exist: xxxx.', - 'http_code' => 404, - 'description' => 'The log entry does not exist.', - ], - [ - 'code' => 'ProjectRegionInvalid', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Invalid Region', - ], - [ - 'code' => 'RequestError', - 'message' => 'Internal Error.', - 'http_code' => 400, - 'description' => 'Internal service exception', - ], - [ - 'code' => 'ResourceCreating', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Failed to create resource', - ], - [ - 'code' => 'ResourceNotExist', - 'message' => '%s.', - 'http_code' => 404, - 'description' => 'Resource does not exist', - ], - [ - 'code' => 'ResourceRecordNotExist', - 'message' => 'The resource record is not found because CloudLens has not been enabled.', - 'http_code' => 400, - 'description' => 'The resource record is not found because CloudLens has not been enabled.'."\n", - ], - [ - 'code' => 'ResourceRecordNotExist', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Resource record does not exist', - ], - [ - 'code' => 'SavedSearchError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'SavedSearch create or update failed', - ], - [ - 'code' => 'Service.Status.Illeagal', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Illegal service status', - ], - [ - 'code' => 'SetAlertCenterResourceError', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Failed to set alarm resource', - ], - [ - 'code' => 'ShardNotExist', - 'message' => 'shard xxx is not exist.', - 'http_code' => 404, - 'description' => 'Shard does not exist.', + 'responses' => [ + 200 => [ + 'headers' => [ + 'Content-Type' => [ + 'schema' => ['title' => '返回的响应体的内容格式。', 'type' => 'string'], + ], + 'Content-Length' => [ + 'schema' => ['title' => '响应内容长度。', 'type' => 'string'], + ], + 'Date' => [ + 'schema' => ['title' => '返回响应的时间。', 'type' => 'string'], + ], + 'Connection' => [ + 'schema' => ['title' => '是否长链接。取值包括： close：不是长链接，则每个HTTP请求都会重新建立TCP连接。 keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。', 'type' => 'string'], + ], + 'x-log-requestid' => [ + 'schema' => ['title' => '服务端产生的标识，该请求的唯一ID。', 'type' => 'string'], + ], + 'Server' => [ + 'schema' => ['title' => '服务器名称。', 'type' => 'string'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'UpsertCollectionPolicy', + 'description' => 'You must use the Simple Log Service endpoint for the China (Shanghai) or Singapore region to call the operation.', + 'responseParamsDescription' => 'For more information about error codes, see [Manage collection rules in the new version of Log Audit Service](~~2835059~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], + ], + 'endpoints' => [ + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-qingdao.log.aliyuncs.com', 'endpoint' => 'cn-qingdao.log.aliyuncs.com', 'vpc' => 'cn-qingdao-internal.log.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-beijing.log.aliyuncs.com', 'endpoint' => 'cn-beijing.log.aliyuncs.com', 'vpc' => 'cn-beijing-internal.log.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-zhangjiakou.log.aliyuncs.com', 'endpoint' => 'cn-zhangjiakou.log.aliyuncs.com', 'vpc' => 'cn-zhangjiakou-internal.log.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-huhehaote.log.aliyuncs.com', 'endpoint' => 'cn-huhehaote.log.aliyuncs.com', 'vpc' => 'cn-huhehaote-internal.log.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-wulanchabu.log.aliyuncs.com', 'endpoint' => 'cn-wulanchabu.log.aliyuncs.com', 'vpc' => 'cn-wulanchabu-internal.log.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hangzhou.log.aliyuncs.com', 'endpoint' => 'cn-hangzhou.log.aliyuncs.com', 'vpc' => 'cn-hangzhou-internal.log.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shanghai.log.aliyuncs.com', 'endpoint' => 'cn-shanghai.log.aliyuncs.com', 'vpc' => 'cn-shanghai-internal.log.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-nanjing.log.aliyuncs.com', 'endpoint' => 'cn-nanjing.log.aliyuncs.com', 'vpc' => 'cn-nanjing-internal.log.aliyuncs.com'], + ['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-fuzhou.log.aliyuncs.com', 'endpoint' => 'cn-fuzhou.log.aliyuncs.com', 'vpc' => 'cn-fuzhou-internal.log.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shenzhen.log.aliyuncs.com', 'endpoint' => 'cn-shenzhen.log.aliyuncs.com', 'vpc' => 'cn-shenzhen-internal.log.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-heyuan.log.aliyuncs.com', 'endpoint' => 'cn-heyuan.log.aliyuncs.com', 'vpc' => 'cn-heyuan-internal.log.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-guangzhou.log.aliyuncs.com', 'endpoint' => 'cn-guangzhou.log.aliyuncs.com', 'vpc' => 'cn-guangzhou-internal.log.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-chengdu.log.aliyuncs.com', 'endpoint' => 'cn-chengdu.log.aliyuncs.com', 'vpc' => 'cn-chengdu-internal.log.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hongkong.log.aliyuncs.com', 'endpoint' => 'cn-hongkong.log.aliyuncs.com', 'vpc' => 'cn-hongkong-internal.log.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-northeast-1.log.aliyuncs.com', 'endpoint' => 'ap-northeast-1.log.aliyuncs.com', 'vpc' => 'ap-northeast-1-internal.log.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-northeast-2.log.aliyuncs.com', 'endpoint' => 'ap-northeast-2.log.aliyuncs.com', 'vpc' => 'ap-northeast-2-internal.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-1.log.aliyuncs.com', 'endpoint' => 'ap-southeast-1.log.aliyuncs.com', 'vpc' => 'ap-southeast-1-internal.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-2.log.aliyuncs.com', 'endpoint' => 'ap-southeast-2.log.aliyuncs.com', 'vpc' => 'ap-southeast-2-internal.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-3.log.aliyuncs.com', 'endpoint' => 'ap-southeast-3.log.aliyuncs.com', 'vpc' => 'ap-southeast-3-internal.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-5.log.aliyuncs.com', 'endpoint' => 'ap-southeast-5.log.aliyuncs.com', 'vpc' => 'ap-southeast-5-internal.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-6.log.aliyuncs.com', 'endpoint' => 'ap-southeast-6.log.aliyuncs.com', 'vpc' => 'ap-southeast-6-internal.log.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-7.log.aliyuncs.com', 'endpoint' => 'ap-southeast-7.log.aliyuncs.com', 'vpc' => 'ap-southeast-7-internal.log.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-east-1.log.aliyuncs.com', 'endpoint' => 'us-east-1.log.aliyuncs.com', 'vpc' => 'us-east-1-internal.log.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-west-1.log.aliyuncs.com', 'endpoint' => 'us-west-1.log.aliyuncs.com', 'vpc' => 'us-west-1-internal.log.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'eu-west-1.log.aliyuncs.com', 'endpoint' => 'eu-west-1.log.aliyuncs.com', 'vpc' => 'eu-west-1-internal.log.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'eu-central-1.log.aliyuncs.com', 'endpoint' => 'eu-central-1.log.aliyuncs.com', 'vpc' => 'eu-central-1-internal.log.aliyuncs.com'], + ['regionId' => 'us-southeast-1', 'regionName' => 'US（Atlanta）', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-southeast-1.log.aliyuncs.com', 'endpoint' => 'us-southeast-1.log.aliyuncs.com', 'vpc' => 'us-southeast-1-internal.log.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'ap-south-1.log.aliyuncs.com', 'endpoint' => 'ap-south-1.log.aliyuncs.com', 'vpc' => 'ap-south-1-internal.log.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'me-east-1.log.aliyuncs.com', 'endpoint' => 'me-east-1.log.aliyuncs.com', 'vpc' => 'me-east-1-internal.log.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'me-central-1.log.aliyuncs.com', 'endpoint' => 'me-central-1.log.aliyuncs.com', 'vpc' => 'me-central-1-internal.log.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-hangzhou-finance.log.aliyuncs.com', 'endpoint' => 'cn-hangzhou-finance.log.aliyuncs.com', 'vpc' => 'cn-hangzhou-finance-internal.log.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-shanghai-finance-1.log.aliyuncs.com', 'endpoint' => 'cn-shanghai-finance-1.log.aliyuncs.com', 'vpc' => 'cn-shanghai-finance-1-internal.log.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-shenzhen-finance-1.log.aliyuncs.com', 'endpoint' => 'cn-shenzhen-finance-1.log.aliyuncs.com', 'vpc' => 'cn-shenzhen-finance-1-internal.log.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-beijing-finance-1.log.aliyuncs.com', 'endpoint' => 'cn-beijing-finance-1.log.aliyuncs.com', 'vpc' => 'cn-beijing-finance-1-internal.log.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', 'endpoint' => 'cn-heyuan-acdr-1-intranet.log.aliyuncs.com', 'vpc' => 'cn-heyuan-acdr-1-internal.log.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessDenied', 'message' => '%s.', 'http_code' => 400, 'description' => 'Unauthorized'], + ['code' => 'AlertNotExist', 'message' => '%s.', 'http_code' => 404, 'description' => 'Alert does not exist'], + ['code' => 'AlreadyExist', 'message' => 'App already exist.', 'http_code' => 400, 'description' => 'Application already exists'], + ['code' => 'AppNotExist', 'message' => 'The App not exist.', 'http_code' => 400, 'description' => 'Application does not exist'], + ['code' => 'AuthorizationRequired', 'message' => 'Authorization Required', 'http_code' => 401, 'description' => ''], + ['code' => 'ClientError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Internal service exception'], + ['code' => 'ConfigServiceNotEnabled', 'message' => '%s.', 'http_code' => 400, 'description' => 'Configuration service is not enabled'], + ['code' => 'CreateError', 'message' => 'Create app failed.', 'http_code' => 400, 'description' => 'Failed to create application'], + ['code' => 'CreateFailed', 'message' => 'Create app failed.', 'http_code' => 400, 'description' => 'Failed to create application'], + ['code' => 'CreateOrderError', 'message' => '%s.', 'http_code' => 200, 'description' => 'Create Order Error'], + ['code' => 'CreateOrderFailed', 'message' => 'Failed to create an order.', 'http_code' => 500, 'description' => ''], + ['code' => 'CreateProjectFailed', 'message' => 'Failed to create the project: %s.', 'http_code' => 400, 'description' => 'Failed to create project'], + ['code' => 'DashboardError', 'message' => 'Failed to create or update the dashboard: %s.', 'http_code' => 400, 'description' => 'Failed to create or update dashboard'], + ['code' => 'DeleteFailed', 'message' => 'Delete app failed.', 'http_code' => 400, 'description' => 'Failed to delete application'], + ['code' => 'DescribeUserBusinessStatusFailed', 'message' => 'Failed to describe user business status.', 'http_code' => 500, 'description' => ''], + ['code' => 'EntityNotExist.Role', 'message' => '%s.', 'http_code' => 400, 'description' => 'Role does not exist'], + ['code' => 'EtlMetaAlreadyExist', 'message' => '%s.', 'http_code' => 400, 'description' => 'Meta already exists'], + ['code' => 'EventBridgeNotEnabled', 'message' => '%s.', 'http_code' => 400, 'description' => 'Service not enabled'], + ['code' => 'ExceedQuota', 'message' => 'The %s quota exceed.', 'http_code' => 400, 'description' => 'Quota exceed'], + ['code' => 'ExceedQuota', 'message' => '%s.', 'http_code' => 400, 'description' => 'Quota exceed'], + ['code' => 'FLOWLOG_INSTANCE_NOT_FOUND', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid Instance'], + ['code' => 'GetAlertHistoriesError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Failed to get alert history'], + ['code' => 'GetAppFailed', 'message' => 'Get app failed.', 'http_code' => 400, 'description' => 'Failed to get application'], + ['code' => 'GetConfigError', 'message' => 'Failed to get configuration information.', 'http_code' => 500, 'description' => ''], + ['code' => 'GetProjectFailed', 'message' => 'Failed to get project.', 'http_code' => 400, 'description' => 'Failed to get project'], + ['code' => 'GetProjectFailed', 'message' => 'Failed to get project: %s.', 'http_code' => 400, 'description' => 'Failed to get project'], + ['code' => 'GetSpecificationsFailed', 'message' => 'Failed to get specifications of commodity.', 'http_code' => 500, 'description' => ''], + ['code' => 'GetSpecificationsFailed', 'message' => '%s.', 'http_code' => 500, 'description' => 'Failed to get commodity'], + ['code' => 'IncorrectStatus.LoadBalancer', 'message' => '%s.', 'http_code' => 400, 'description' => 'Incorrect status'], + ['code' => 'IndexError', 'message' => 'Failed to create or update index.', 'http_code' => 400, 'description' => 'Failed to create or update index'], + ['code' => 'IndexError', 'message' => 'Failed to create or update index: %s.', 'http_code' => 400, 'description' => 'Failed to create or update index'], + ['code' => 'InputParaError', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InputParaError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Input parameter error'], + ['code' => 'InternalException', 'message' => 'Internal service upexpected exception', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalException', 'message' => 'Internal service upexpected exception.', 'http_code' => 400, 'description' => 'Internal service exception'], + ['code' => 'InvalidAppName', 'message' => 'The appName is invalid.', 'http_code' => 400, 'description' => 'Invalid application name'], + ['code' => 'InvalidDataType', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid data type'], + ['code' => 'InvalidDisplayName', 'message' => 'Display name length exceeds limit.', 'http_code' => 400, 'description' => 'Display name exceeds length'], + ['code' => 'InvalidInstance', 'message' => 'The instance is invalid.', 'http_code' => 400, 'description' => 'Invalid Instance'], + ['code' => 'InvalidInstance', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid Instance'], + ['code' => 'InvalidInstanceId.NotFound', 'message' => 'The instance does not exist.', 'http_code' => 400, 'description' => 'Instance does not exist'], + ['code' => 'InvalidLang', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid language'], + ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid: %s', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], + ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid: %s.', 'http_code' => 400, 'description' => 'Illegal parameter'], + ['code' => 'InvalidRAM', 'message' => 'Permission denied.', 'http_code' => 400, 'description' => 'Authentication not passed'], + ['code' => 'InvalidRegion', 'message' => 'The region is invalid.', 'http_code' => 400, 'description' => 'Invalid Region'], + ['code' => 'InvalidVpcId.NotFound', 'message' => 'The vpdId does not exist.', 'http_code' => 400, 'description' => 'VpcId does not exist'], + ['code' => 'JobAlreadyExist', 'message' => 'The job already exists.', 'http_code' => 400, 'description' => 'Task already exists'], + ['code' => 'JobError', 'message' => 'Failed to create or update the job.', 'http_code' => 400, 'description' => 'Job failed'], + ['code' => 'JobError', 'message' => 'Failed to create or update the job: %s.', 'http_code' => 400, 'description' => 'Job failed'], + ['code' => 'LogstoreError', 'message' => 'Failed to create or update the logstore.', 'http_code' => 400, 'description' => 'Logstore creation or update failed'], + ['code' => 'LogstoreError', 'message' => 'Failed to create or update the logstore: %s.', 'http_code' => 400, 'description' => 'Logstore create or update failed'], + ['code' => 'LogStoreNotExist', 'message' => 'logstore xxxx does not exist.', 'http_code' => 404, 'description' => 'The Logstore does not exist.'], + ['code' => 'LogstoreProductTypeConflict', 'message' => 'The product type doesn\'t match : %s.', 'http_code' => 400, 'description' => 'Logstore type mismatch'], + ['code' => 'LogstoreProductTypeConflict', 'message' => '%s.', 'http_code' => 400, 'description' => 'Logstore type mismatch'], + ['code' => 'MetricStoreAlreadyExist', 'message' => 'The specified metricstore xxx already exists.', 'http_code' => 400, 'description' => 'The specified metricstore xxx already exists.'], + ['code' => 'MetricStoreNotExist', 'message' => 'The specified metricstore xxx does not exist.', 'http_code' => 404, 'description' => 'The specified metricstore xxx does not exist.'], + ['code' => 'ParameterInvalid', 'message' => '%s.', 'http_code' => 400, 'description' => 'Parameter invalid'], + ['code' => 'ParamMissing', 'message' => 'The app name is required.', 'http_code' => 400, 'description' => 'Illegal parameter'], + ['code' => 'ParamsIsNull', 'message' => '%s.', 'http_code' => 400, 'description' => 'Parameter is empty'], + ['code' => 'PermissionDenied', 'message' => 'You are not authorized to activate Log Service.', 'http_code' => 400, 'description' => ''], + ['code' => 'PermissionDenied', 'message' => '%s.', 'http_code' => 401, 'description' => 'No permission'], + ['code' => 'PostBodyInvalid', 'message' => 'Loggroup contains zero logs.', 'http_code' => 400, 'description' => 'There are no logs in the LogGroup.'], + ['code' => 'PostBodyInvalid', 'message' => 'Fail to parse protobuf.', 'http_code' => 400, 'description' => 'Protobuffer content is illegal and cannot be parsed.'], + ['code' => 'PostBodyTooLarge', 'message' => 'Body size must little than 10485760.', 'http_code' => 413, 'description' => 'Body size must little than 10485760.'], + ['code' => 'PostBodyUncompressError', 'message' => 'Post body uncompressed fail.', 'http_code' => 400, 'description' => 'Post body uncompressed fail.'], + ['code' => 'ProductDataCollectionNoExist', 'message' => 'failed to find product data collection for this instance', 'http_code' => 400, 'description' => 'The collection configuration for this instance is not found.'], + ['code' => 'ProductDataCollectionNoExist', 'message' => 'Failed to find product data collection for this instance.', 'http_code' => 400, 'description' => 'Failed to find product data collection for this instance'], + ['code' => 'ProjectExist', 'message' => '%s.', 'http_code' => 400, 'description' => 'Item already exists'], + ['code' => 'ProjectForbidden', 'message' => '%s.', 'http_code' => 400, 'description' => 'Project is forbidden'], + ['code' => 'ProjectNotExist', 'message' => '%s.', 'http_code' => 400, 'description' => 'Project does not exist'], + ['code' => 'ProjectNotExist', 'message' => 'The Project does not exist: xxxx.', 'http_code' => 404, 'description' => 'The log entry does not exist.'], + ['code' => 'ProjectRegionInvalid', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid Region'], + ['code' => 'RequestError', 'message' => 'Internal Error.', 'http_code' => 400, 'description' => 'Internal service exception'], + ['code' => 'ResourceCreating', 'message' => '%s.', 'http_code' => 400, 'description' => 'Failed to create resource'], + ['code' => 'ResourceNotExist', 'message' => '%s.', 'http_code' => 404, 'description' => 'Resource does not exist'], + ['code' => 'ResourceRecordNotExist', 'message' => 'The resource record is not found because CloudLens has not been enabled.', 'http_code' => 400, 'description' => 'The resource record is not found because CloudLens has not been enabled.'."\n"], + ['code' => 'ResourceRecordNotExist', 'message' => '%s.', 'http_code' => 400, 'description' => 'Resource record does not exist'], + ['code' => 'SavedSearchError', 'message' => '%s.', 'http_code' => 400, 'description' => 'SavedSearch create or update failed'], + ['code' => 'Service.Status.Illeagal', 'message' => '%s.', 'http_code' => 400, 'description' => 'Illegal service status'], + ['code' => 'SetAlertCenterResourceError', 'message' => '%s.', 'http_code' => 400, 'description' => 'Failed to set alarm resource'], + ['code' => 'ShardNotExist', 'message' => 'shard xxx is not exist.', 'http_code' => 404, 'description' => 'Shard does not exist.'], + ['code' => 'Unauthorized', 'message' => 'The AccessKeyId is unauthorized.', 'http_code' => null, 'description' => 'The specified AccessKey ID is unauthorized.'], + ['code' => 'UnAuthorized', 'message' => '%s.', 'http_code' => 401, 'description' => 'Unauthorized'], + ['code' => 'Unauthorized', 'message' => 'Unauthorized: %s.', 'http_code' => 401, 'description' => 'Unauthorized'], + ['code' => 'UnRegisterProduct', 'message' => '%s.', 'http_code' => 400, 'description' => 'Cloud product not registered'], + ['code' => 'UpdateFailed', 'message' => 'Update app failed.', 'http_code' => 400, 'description' => 'Failed to update application'], + ['code' => 'VerifyInstanceFailed', 'message' => '%s.', 'http_code' => 400, 'description' => 'Invalid Instance'], + ], + 'changeSet' => [ [ - 'code' => 'Unauthorized', - 'message' => 'The AccessKeyId is unauthorized.', - 'http_code' => null, - 'description' => 'The specified AccessKey ID is unauthorized.', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateMetricStore'], + ['description' => 'Response parameters changed', 'api' => 'GetMetricStore'], + ['description' => 'Request parameters changed', 'api' => 'CreateMetricStore'], + ['description' => 'Request parameters changed', 'api' => 'UpdateLogStore'], + ['description' => 'Request parameters changed', 'api' => 'CreateLogStore'], + ], + 'createdAt' => '2025-12-03T01:37:06.000Z', + 'description' => '', ], [ - 'code' => 'UnAuthorized', - 'message' => '%s.', - 'http_code' => 401, - 'description' => 'Unauthorized', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'UpdateMetricStore'], + ['description' => 'OpenAPI offline', 'api' => 'GetMetricStore'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateLogStore'], + ['description' => 'OpenAPI offline', 'api' => 'CreateMetricStore'], + ['description' => 'OpenAPI offline', 'api' => 'CreateLogStore'], + ['description' => 'OpenAPI offline', 'api' => 'GetMetricStore'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateMetricStore'], + ['description' => 'OpenAPI offline', 'api' => 'CreateMetricStore'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateLogStore'], + ['description' => 'OpenAPI offline', 'api' => 'CreateLogStore'], + ], + 'createdAt' => '2025-12-02T07:21:18.000Z', + 'description' => '', ], [ - 'code' => 'Unauthorized', - 'message' => 'Unauthorized: %s.', - 'http_code' => 401, - 'description' => 'Unauthorized', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateIndexString'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateIndexString'], + ['description' => 'OpenAPI offline', 'api' => 'GetIndexString'], + ], + 'createdAt' => '2025-12-01T08:34:55.000Z', + 'description' => '', ], [ - 'code' => 'UnRegisterProduct', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Cloud product not registered', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateIndexString'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateIndexString'], + ['description' => 'OpenAPI offline', 'api' => 'GetIndexString'], + ], + 'createdAt' => '2025-12-01T08:34:55.000Z', + 'description' => '', ], [ - 'code' => 'UpdateFailed', - 'message' => 'Update app failed.', - 'http_code' => 400, - 'description' => 'Failed to update application', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMetricStore'], + ['description' => 'Request parameters changed', 'api' => 'CreateMetricStore'], + ['description' => 'Request parameters changed', 'api' => 'UpdateMetricStore'], + ], + 'createdAt' => '2025-11-24T09:35:51.000Z', + 'description' => '', ], - [ - 'code' => 'VerifyInstanceFailed', - 'message' => '%s.', - 'http_code' => 400, - 'description' => 'Invalid Instance', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ], ], - 'changeSet' => [ - [ - 'apis' => [ - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateMetricStore', + 'ram' => [ + 'productCode' => 'SLS', + 'productName' => 'Simple Log Service', + 'ramCodes' => ['log'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [ + [ + 'name' => 'log:TLSVersion', + 'schema' => [ + 'type' => 'String', + 'description' => 'Version of TLS', + 'enums' => ['TLSv1', 'TLSv1.1', 'TLSv1.2', 'TLSv1.3'], + ], + ], + [ + 'name' => 'log:Encrypted', + 'schema' => [ + 'type' => 'Boolean', + 'description' => 'Whether to specify encryption configuration when creating or modifying a Logstore', + 'enums' => ['true', 'false'], + ], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'DeleteMachineGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteMachineGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], + ], + ], + ], + [ + 'apiName' => 'ListOSSIngestions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListOSSIngestions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteConsumerGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteConsumerGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], + ], + ], + ], + [ + 'apiName' => 'DeleteSavedSearch', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteSavedSearch', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], + ], + ], + ], + [ + 'apiName' => 'CreateDomain', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateDomain', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], + ], + ], + ], + [ + 'apiName' => 'GetLogging', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetLogging', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], + ], + ], + ], + [ + 'apiName' => 'CreateConsumerGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateConsumerGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], + ], + ], + ], + [ + 'apiName' => 'GetStoreView', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetStoreView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLogStoreMeteringMode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetLogStoreMeteringMode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteIndex', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteIndex', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], + ], + ], + [ + 'apiName' => 'ListOSSHDFSExports', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListOSSHDFSExports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAlert', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateLogStore', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateLogStore', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ['conditionKey' => 'log:Encrypted', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], + ], + ], + [ + 'apiName' => 'ListStoreViews', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListStoreViews', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListMachines', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListMachines', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteProject', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteProject', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}'], + ], + ], + ], + [ + 'apiName' => 'UpdateLogging', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateLogging', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], + ], + ], + ], + [ + 'apiName' => 'ListScheduledSQLs', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:ListScheduledSQLs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCursor', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetCursorOrData', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDashboard', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteDashboard', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLogStore', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateLogStore', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ['conditionKey' => 'log:Encrypted', 'validationType' => 'conditional'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateConsumerGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateConsumerGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], + ], + ], + ], + [ + 'apiName' => 'UpdateIndex', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateIndex', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], + ], + ], + [ + 'apiName' => 'GetAppliedMachineGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetAppliedMachineGroups', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], + ], + ], + ], + [ + 'apiName' => 'ConsumerGroupUpdateCheckPoint', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:ConsumerGroupUpdateCheckPoint', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateLogtailPipelineConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateLogtailPipelineConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteConfig', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetLogStore', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetLogStore', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], + ], + ], + [ + 'apiName' => 'UpdateConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], + ], + ], + ], + [ + 'apiName' => 'ListLogtailPipelineConfig', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListLogtailPipelineConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCursorTime', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetCursorOrData', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDomain', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteDomain', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], + ], + ], + ], + [ + 'apiName' => 'ListConfig', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*'], + ], + ], + ], + [ + 'apiName' => 'GetETL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetETL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSavedSearch', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateSavedSearch', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], + ], + ], + ], + [ + 'apiName' => 'DisableScheduledSQL', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:DisableScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetSqlInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:GetSqlInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'GetSavedSearch', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetSavedSearch', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], + ], + ], + ], + [ + 'apiName' => 'CreateMetricStore', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateMetricStore', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#name}'], + ], + ], + ], + [ + 'apiName' => 'GetDashboard', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetDashboard', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], + ], + ], + ], + [ + 'apiName' => 'EnableAlert', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:EnableAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSqlInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateSqlInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'ListDownloadJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListDownloadJobs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetScheduledSQL', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateStoreView', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateStoreView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListProject', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListProject', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/*'], + ], + ], + ], + [ + 'apiName' => 'CreateStoreView', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateStoreView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetIndex', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetIndex', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], + ], + ], + [ + 'apiName' => 'ListConsumerGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListConsumerGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAlert', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDashboard', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateDashboard', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], + ], + ], + ], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'CreateScheduledSQL', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAlerts', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListAlerts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Alert', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/alert/*'], + ], + ], + ], + [ + 'apiName' => 'GetMachineGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetMachineGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], + ], + ], + ], + [ + 'apiName' => 'CreateLogging', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateLogging', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], + ], + ], + ], + [ + 'apiName' => 'ListMachineGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListMachineGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*'], + ], + ], + ], + [ + 'apiName' => 'DeleteScheduledSQL', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteScheduledSQL', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListShards', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListShards', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateMachineGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateMachineGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], + ], + ], + ], + [ + 'apiName' => 'CreateConfig', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateSavedSearch', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateSavedSearch', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], + ], + ], + ], + [ + 'apiName' => 'UpdateLogStoreMeteringMode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateLogStoreMeteringMode', + 'authLevel' => 'operate', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'DeleteAlert', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], + ], ], - [ - 'description' => 'Response parameters changed', - 'api' => 'GetMetricStore', + ], + [ + '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' => 'Request parameters changed', - 'api' => 'CreateMetricStore', + ], + [ + 'apiName' => 'UpdateScheduledSQL', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'Request parameters changed', - 'api' => 'UpdateLogStore', + ], + [ + 'apiName' => 'GetLogtailPipelineConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetLogtailPipelineConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateLogStore', + ], + [ + '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}'], + ], ], ], - 'createdAt' => '2025-12-03T01:37:06.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'OpenAPI offline', - 'api' => 'UpdateMetricStore', + [ + '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 offline', - 'api' => 'GetMetricStore', + ], + [ + 'apiName' => 'MergeShard', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:MergeShard', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'UpdateLogStore', + ], + [ + 'apiName' => 'GetStoreViewIndex', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetStoreViewIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'CreateMetricStore', + ], + [ + 'apiName' => 'GetProject', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetProject', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'CreateLogStore', + ], + [ + 'apiName' => 'DeleteStoreView', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteStoreView', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'GetMetricStore', + ], + [ + 'apiName' => 'UpdateSqlInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateSqlInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'UpdateMetricStore', + ], + [ + '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 offline', - 'api' => 'CreateMetricStore', + ], + [ + 'apiName' => 'CreateDashboard', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateDashboard', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'UpdateLogStore', + ], + [ + 'apiName' => 'DeleteLogStore', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteLogStore', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'CreateLogStore', + ], + [ + '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}'], + ], ], ], - 'createdAt' => '2025-12-02T07:21:18.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'OpenAPI offline', - 'api' => 'CreateIndexString', + [ + 'apiName' => 'UpdateLogtailPipelineConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateLogtailPipelineConfig', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'UpdateIndexString', + ], + [ + 'apiName' => 'UpdateProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateProject', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'GetIndexString', + ], + [ + 'apiName' => 'ConsumerGroupHeartBeat', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:ConsumerGroupHeartBeat', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'createdAt' => '2025-12-01T08:34:55.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'OpenAPI offline', - 'api' => 'CreateIndexString', + [ + 'apiName' => 'CreateProject', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:CreateProject', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#projectName}'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'UpdateIndexString', + ], + [ + 'apiName' => 'DisableAlert', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:DisableAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'OpenAPI offline', - 'api' => 'GetIndexString', + ], + [ + 'apiName' => 'ListLogStores', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListLogStores', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/*'], + ], ], ], - 'createdAt' => '2025-12-01T08:34:55.000Z', - 'description' => '', - ], - [ - 'apis' => [ - [ - 'description' => 'Response parameters changed', - 'api' => 'GetMetricStore', + [ + 'apiName' => 'UpdateMachineGroupMachine', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:UpdateMachineGroupMachine', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'Request parameters changed', - 'api' => 'CreateMetricStore', + ], + [ + 'apiName' => 'DeleteProjectPolicy', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'log:DeleteProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'description' => 'Request parameters changed', - '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' => '2025-11-24T09:35:51.000Z', - 'description' => '', - ], - ], - 'flowControl' => [ - 'flowControlList' => [ [ - 'threshold' => '-1', - 'countWindow' => 1, - 'regionId' => '*', + 'apiName' => 'EnableScheduledSQL', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'log:EnableScheduledSQL', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - ], - ], - 'ram' => [ - 'productCode' => 'SLS', - 'productName' => 'Simple Log Service', - 'ramCodes' => [ - 'log', - ], - 'ramLevel' => 'SERVICE', - 'ramConditions' => [ [ - 'name' => 'log:TLSVersion', - 'schema' => [ - 'type' => 'String', - 'description' => 'Version of TLS', - 'enums' => [ - 'TLSv1', - 'TLSv1.1', - 'TLSv1.2', - 'TLSv1.3', + 'apiName' => 'PutProjectPolicy', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'log:PutProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ - 'name' => 'log:Encrypted', - 'schema' => [ - 'type' => 'Boolean', - 'description' => 'Whether to specify encryption configuration when creating or modifying a Logstore', - 'enums' => [ - 'true', - 'false', + 'apiName' => 'ApplyConfigToMachineGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:ApplyConfigToGroup', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], + ], + ], + ], + [ + 'apiName' => 'GetProjectPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetProjectPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSavedSearch', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListSavedSearch', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*'], + ], + ], + ], + [ + 'apiName' => 'SplitShard', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'log:SplitShard', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], + ], + ], + ], + [ + 'apiName' => 'ListETLs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListETLs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListOSSExports', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'log:ListOSSExports', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ], + ], + ], + [ + 'apiName' => 'GetAlert', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetAlert', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAppliedConfigs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'log:GetAppliedConfigs', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'log:TLSVersion', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'SLS', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{#MachineGroupName}'], + ['validationType' => 'always', 'resourceType' => 'AzureBlobIngestion', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/azureblobingestion/*'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], + ['validationType' => 'always', 'resourceType' => 'AzureBlobIngestion', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/azureblobingestion/{#azureBlobIngestionName}'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], + ['validationType' => 'always', 'resourceType' => 'MaterializedView', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/materializedview/*'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#logstoreName}/consumergroup/{#ConsumerGroup}'], + ['validationType' => 'always', 'resourceType' => 'ConsumeProcessor', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/consumeprocessor/{#processorName}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/{#SavedSearchName}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/{#DomainName}'], + ['validationType' => 'always', 'resourceType' => 'AgentInstanceConfig', 'arn' => 'acs:log:{#regionId}:{#accountId}:agentinstanceconfig/*'], + ['validationType' => 'always', 'resourceType' => 'IngestProcessor', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/ingestprocessor/{#processorName}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logging'], + ['validationType' => 'always', 'resourceType' => 'Service', 'arn' => 'acs:log::{#AccountId}:service'], + ['validationType' => 'always', 'resourceType' => 'ESIngestion', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/elasticsearchingestion/*'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{l#ogstoreName}/consumergroup/{#ConsumerGroup}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}//dashboard/{#DashboardName}'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}'], + ['validationType' => 'always', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#name}'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:${regionId}:${accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/{#ConsumerGroupName}'], + ['validationType' => 'always', 'resourceType' => 'IngestProcessor', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/ingestprocessor/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => ' acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}'], + ['validationType' => 'always', 'resourceType' => 'CollectionPolicy', 'arn' => 'acs:log::{#accountId}:collectionpolicy/*'], + ['validationType' => 'always', 'resourceType' => 'S3Ingestion', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/s3ingestion/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/*'], + ['validationType' => 'always', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], + ['validationType' => 'always', 'resourceType' => 'MetricStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/metricstore/{#metricstore}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/*'], + ['validationType' => 'always', 'resourceType' => 'CollectionPolicy', 'arn' => 'acs:log::{#accountId}:collectionpolicy/{#policyName}'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}/consumergroup/*'], + ['validationType' => 'always', 'resourceType' => 'Region', 'arn' => 'acs:log:{#regionId}:{#accountId}:*'], + ['validationType' => 'always', 'resourceType' => 'Alert', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/alert/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/*'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#Region}:{#AccountId}:project/{#ProjectName}/logstore/{#LogstoreName}'], + ['validationType' => 'always', 'resourceType' => 'Ticket', 'arn' => 'acs:log::{#accountId}:ticket/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/domain/*'], + ['validationType' => 'always', 'resourceType' => 'AgentInstanceConfig', 'arn' => 'acs:log:{#regionId}:{#accountId}:agentinstanceconfig/{#configType}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => ' acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/{#DashboardName}'], + ['validationType' => 'always', 'resourceType' => 'ConsumeProcessor', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/consumeprocessor/*'], + ['validationType' => 'always', 'resourceType' => 'LogStore', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/machinegroup/{MachineGroup}'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/savedsearch/*'], ], - 'ramActions' => [], - 'resourceTypes' => [], ], ]; -- cgit v1.2.3