diff options
Diffstat (limited to 'data/en_us/elasticsearch')
| -rw-r--r-- | data/en_us/elasticsearch/2017-06-13/api-docs.php | 49503 | ||||
| -rw-r--r-- | data/en_us/elasticsearch/2019-04-22/api-docs.php | 352 |
2 files changed, 24035 insertions, 25820 deletions
diff --git a/data/en_us/elasticsearch/2017-06-13/api-docs.php b/data/en_us/elasticsearch/2017-06-13/api-docs.php index 87273f3..494c4d4 100644 --- a/data/en_us/elasticsearch/2017-06-13/api-docs.php +++ b/data/en_us/elasticsearch/2017-06-13/api-docs.php @@ -1,2255 +1,890 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'ROA', - 'product' => 'elasticsearch', - 'version' => '2017-06-13', - ], + 'info' => ['style' => 'ROA', 'product' => 'elasticsearch', 'version' => '2017-06-13'], 'directories' => [ [ - 'id' => 123900, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 123901, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'CloseManagedIndex', - 'CreateDataStream', - 'CreateILMPolicy', - 'CreateIndexTemplate', - 'DeleteDataStream', - 'DeleteILMPolicy', - 'DeleteIndexTemplate', - 'DescribeILMPolicy', - 'DescribeIndexTemplate', - 'ListDataStreams', - 'ListILMPolicies', - 'ListIndexTemplates', - 'RolloverDataStream', - 'UpdateILMPolicy', - 'UpdateIndexTemplate', - 'CreateComponentIndex', - 'DeleteComponentIndex', - 'DeleteDeprecatedTemplate', - 'DescribeComponentIndex', - 'DescribeDeprecatedTemplate', - 'ListComponentIndices', - 'ListDeprecatedTemplates', - 'UpdateComponentIndex', - ], - ], - 'DeleteInstance', + 'CloseManagedIndex', 'CreateDataStream', 'CreateILMPolicy', 'CreateIndexTemplate', 'DeleteDataStream', 'DeleteILMPolicy', 'DeleteIndexTemplate', 'DescribeILMPolicy', 'DescribeIndexTemplate', 'ListDataStreams', 'ListILMPolicies', 'ListIndexTemplates', 'RolloverDataStream', 'UpdateILMPolicy', 'UpdateIndexTemplate', 'CreateComponentIndex', 'DeleteComponentIndex', 'DeleteDeprecatedTemplate', 'DescribeComponentIndex', 'DescribeDeprecatedTemplate', + 'ListComponentIndices', 'ListDeprecatedTemplates', 'UpdateComponentIndex', + ], + 'type' => 'directory', + 'title' => 'Index management', + ], 'UpdateInstanceChargeType', 'UpdateDescription', 'UpdateReadWritePolicy', 'ModifyElastictask', - 'ModifyInstanceMaintainTime', 'UpdateKibanaWhiteIps', 'UpdateWhiteIps', - 'ListInstance', 'DescribeInstance', - 'DescribeRegions', 'ListAllNode', 'GetElastictask', 'ListInstanceIndices', - 'createInstance', 'EstimatedRestartTime', - 'RestartInstance', - 'RenewInstance', 'ActivateZones', 'DeactivateZones', 'InterruptElasticsearchTask', 'ResumeElasticsearchTask', - 'MigrateToOtherZone', 'CancelDeletion', 'DiagnoseInstance', - 'MoveResourceGroup', 'CapacityPlan', 'GetOpenStoreUsage', 'ListDicts', 'ListShardRecoveries', ], - ], - [ - 'id' => 123955, - 'title' => null, 'type' => 'directory', - 'children' => [ - 'ListTags', - 'ListTagResources', - 'UntagResources', - 'TagResources', - ], + 'title' => 'Instances', ], [ - 'id' => 123960, - 'title' => null, + 'children' => ['DeleteDataTask', 'GetTransferableNodes', 'ListDataTasks', 'GetClusterDataInformation', 'ValidateTransferableNodes', 'TransferNode'], 'type' => 'directory', - 'children' => [ - 'DeleteDataTask', - 'GetTransferableNodes', - 'ListDataTasks', - 'GetClusterDataInformation', - 'ValidateTransferableNodes', - 'TransferNode', - 'CancelTask', - ], + 'title' => 'Data migration', ], [ - 'id' => 123968, - 'title' => null, + 'children' => ['CreateCollector', 'DeleteCollector', 'ModifyDeployMachine', 'UpdateCollector', 'UpdateCollectorName', 'StartCollector', 'StopCollector', 'DescribeCollector', 'ListDefaultCollectorConfigurations', 'ListCollectors', 'RestartCollector', 'ReinstallCollector'], 'type' => 'directory', - 'children' => [ - 'CreateCollector', - 'DeleteCollector', - 'ModifyDeployMachine', - 'UpdateCollector', - 'UpdateCollectorName', - 'StartCollector', - 'StopCollector', - 'DescribeCollector', - 'ListDefaultCollectorConfigurations', - 'ListCollectors', - 'ListNodes', - 'RestartCollector', - 'ReinstallCollector', - ], + 'title' => 'Collectors', ], [ - 'id' => 123982, - 'title' => null, + 'children' => ['GetSuggestShrinkableNodes', 'ValidateShrinkNodes', 'ShrinkNode', 'UpgradeEngineVersion'], 'type' => 'directory', - 'children' => [ - 'UpdateInstance', - 'GetSuggestShrinkableNodes', - 'ValidateShrinkNodes', - 'ShrinkNode', - 'UpgradeEngineVersion', - ], + 'title' => 'Instance upgrade and downgrade', ], [ - 'id' => 123988, - 'title' => null, + 'children' => ['UpdateInstanceSettings', 'UpdateHotIkDicts', 'UpdateSynonymsDicts', 'UpdateDict', 'UpdateAdvancedSetting', 'UpdateExtendConfig', 'UpdateAliwsDict', 'UpdateBlackIps', 'ListAckClusters', 'ListDictInformation', 'ListEcsInstances', 'DescribeAckOperator', 'GetRegionConfiguration', 'ListAckNamespaces', 'InstallAckOperator', 'InstallUserPlugins', 'RecommendTemplates', 'ValidateSlrPermission', 'InitializeOperationRole'], 'type' => 'directory', - 'children' => [ - 'UpdateInstanceSettings', - 'UpdateHotIkDicts', - 'UpdateSynonymsDicts', - 'UpdateDict', - 'UpdateAdvancedSetting', - 'UpdateExtendConfig', - 'UpdateTemplate', - 'UpdateAliwsDict', - 'UpdateBlackIps', - 'DescribeTemplates', - 'ListAckClusters', - 'ListDictInformation', - 'ListEcsInstances', - 'DescribeAckOperator', - 'GetRegionConfiguration', - 'ListAckNamespaces', - 'InstallAckOperator', - 'InstallUserPlugins', - 'RecommendTemplates', - 'ValidateSlrPermission', - 'InitializeOperationRole', - ], + 'title' => 'Cluster configuration', ], [ - 'id' => 124011, - 'title' => null, + 'children' => ['InstallSystemPlugin'], 'type' => 'directory', - 'children' => [ - 'ListPlugins', - 'InstallSystemPlugin', - 'UninstallPlugin', - ], + 'title' => 'Plugin management', ], [ - 'id' => 124015, - 'title' => null, + 'children' => ['GetEmonMonitorData', 'DescribeElasticsearchHealth', 'GetEmonGrafanaAlerts', 'GetEmonGrafanaDashboards', 'PostEmonTryAlarmRule'], 'type' => 'directory', - 'children' => [ - 'GetEmonMonitorData', - 'DescribeElasticsearchHealth', - 'GetEmonGrafanaAlerts', - 'GetEmonGrafanaDashboards', - 'PostEmonTryAlarmRule', - ], + 'title' => 'Cluster monitoring', ], [ - 'id' => 124021, - 'title' => null, + 'children' => ['ListSearchLog'], 'type' => 'directory', - 'children' => [ - 'ListSearchLog', - ], + 'title' => 'Log query', ], [ - 'id' => 124023, - 'title' => null, + 'children' => ['AddConnectableCluster', 'DeleteConnectedCluster', 'UpdatePrivateNetworkWhiteIps', 'UpdatePublicWhiteIps', 'UpdatePublicNetwork', 'UpdateAdminPassword', 'ModifyWhiteIps', 'DescribeConnectableClusters', 'ListConnectedClusters', 'TriggerNetwork', 'OpenHttps', 'CloseHttps', 'CreateVpcEndpoint', 'DeleteVpcEndpoint', 'ListVpcEndpoints'], 'type' => 'directory', - 'children' => [ - 'AddConnectableCluster', - 'DeleteConnectedCluster', - 'UpdatePrivateNetworkWhiteIps', - 'UpdatePublicWhiteIps', - 'UpdatePublicNetwork', - 'UpdateAdminPassword', - 'ModifyWhiteIps', - 'DescribeConnectableClusters', - 'ListConnectedClusters', - 'TriggerNetwork', - 'OpenHttps', - 'CloseHttps', - 'CreateVpcEndpoint', - 'DeleteVpcEndpoint', - 'ListVpcEndpoints', - ], + 'title' => 'Security configuration', ], [ - 'id' => 124039, - 'title' => null, + 'children' => ['AddSnapshotRepo', 'DeleteSnapshotRepo', 'UpdateSnapshotSetting', 'DescribeSnapshotSetting', 'ListSnapshotReposByInstanceId', 'ListAlternativeSnapshotRepos'], 'type' => 'directory', - 'children' => [ - 'CreateSnapshot', - 'AddSnapshotRepo', - 'DeleteSnapshotRepo', - 'UpdateSnapshotSetting', - 'DescribeSnapshotSetting', - 'ListSnapshotReposByInstanceId', - 'ListAlternativeSnapshotRepos', - ], + 'title' => 'Data backup', ], [ - 'id' => 124047, - 'title' => null, + 'children' => ['ListDiagnosisItems', 'UpdateDiagnosisSettings', 'ListDiagnoseReport', 'ListDiagnoseReportIds', 'DescribeDiagnoseReport', 'DescribeDiagnosisSettings', 'ListDiagnoseIndices', 'OpenDiagnosis', 'CloseDiagnosis'], 'type' => 'directory', - 'children' => [ - 'ListDiagnosisItems', - 'UpdateDiagnosisSettings', - 'ListDiagnoseReport', - 'ListDiagnoseReportIds', - 'DescribeDiagnoseReport', - 'DescribeDiagnosisSettings', - 'ListDiagnoseIndices', - 'OpenDiagnosis', - 'CloseDiagnosis', - ], + 'title' => 'Intelligent O&M', ], [ - 'id' => 124056, - 'title' => null, + 'children' => ['UpdateKibanaSettings', 'DescribeKibanaSettings', 'ListKibanaPlugins', 'InstallKibanaSystemPlugin', 'UninstallKibanaPlugin'], 'type' => 'directory', - 'children' => [ - 'UpdateKibanaSettings', - 'DescribeKibanaSettings', - 'ListKibanaPlugins', - 'InstallKibanaSystemPlugin', - 'UninstallKibanaPlugin', - ], + 'title' => 'Kibana', ], [ - 'id' => 124062, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 124063, - 'title' => null, + 'children' => ['DeleteLogstash', 'UpdateLogstash', 'UpdateLogstashDescription', 'UpdateLogstashChargeType', 'ListLogstash', 'DescribeLogstash', 'RenewLogstash', 'RestartLogstash', 'EstimatedLogstashRestartTime'], 'type' => 'directory', - 'children' => [ - 'DeleteLogstash', - 'UpdateLogstash', - 'UpdateLogstashDescription', - 'UpdateLogstashChargeType', - 'ListLogstash', - 'DescribeLogstash', - 'RenewLogstash', - 'RestartLogstash', - 'EstimatedLogstashRestartTime', - ], + 'title' => 'Instance management', ], [ - 'id' => 124073, - 'title' => null, + 'children' => ['UpdateLogstashSettings', 'ListExtendfiles'], 'type' => 'directory', - 'children' => [ - 'UpdateLogstashSettings', - 'ListExtendfiles', - ], + 'title' => 'Cluster configuration', ], [ - 'id' => 124076, - 'title' => null, + 'children' => ['ListLogstashPlugins', 'InstallLogstashSystemPlugin', 'UninstallLogstashPlugin'], 'type' => 'directory', - 'children' => [ - 'ListLogstashPlugins', - 'InstallLogstashSystemPlugin', - 'UninstallLogstashPlugin', - ], + 'title' => 'Plugin management', ], [ - 'id' => 124080, - 'title' => null, + 'children' => ['ListLogstashLog'], 'type' => 'directory', - 'children' => [ - 'ListLogstashLog', - ], + 'title' => 'Log query', ], [ - 'id' => 124082, - 'title' => null, + 'children' => ['UpdateXpackMonitorConfig', 'ListAvailableEsInstanceIds', 'DescribeXpackMonitorConfig', 'ValidateConnection'], 'type' => 'directory', - 'children' => [ - 'UpdateXpackMonitorConfig', - 'ListAvailableEsInstanceIds', - 'DescribeXpackMonitorConfig', - 'ValidateConnection', - ], + 'title' => 'Cluster monitoring', ], [ - 'id' => 124087, - 'title' => null, + 'children' => ['InterruptLogstashTask', 'ResumeLogstashTask'], 'type' => 'directory', - 'children' => [ - 'InterruptLogstashTask', - 'ResumeLogstashTask', - ], + 'title' => 'Change task management', ], [ - 'id' => 124090, - 'title' => null, + 'children' => ['CreatePipelines', 'DeletePipelines', 'UpdatePipelines', 'StopPipelines', 'UpdatePipelineManagementConfig', 'ListPipeline', 'DescribePipeline', 'DescribePipelineManagementConfig', 'RunPipelines'], 'type' => 'directory', - 'children' => [ - 'CreatePipelines', - 'DeletePipelines', - 'UpdatePipelines', - 'StopPipelines', - 'UpdatePipelineManagementConfig', - 'ListPipeline', - 'DescribePipeline', - 'DescribePipelineManagementConfig', - 'RunPipelines', - ], + 'title' => 'Pipeline management', ], 'CreateLogstash', 'UpdateExtendfiles', 'ListPipelineIds', 'CancelLogstashDeletion', ], + 'type' => 'directory', + 'title' => 'Logstash', ], [ - 'id' => 178119, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'TurnOnZone', - 'ListInstanceHistoryEvents', - 'UpdateDynamicSettings', - 'DescribeDynamicSettings', - 'ListActionRecords', - 'DisableKibanaPvlNetwork', - 'UpdateKibanaPvlNetwork', - 'ListKibanaPvlNetwork', - 'EnableKibanaPvlNetwork', - 'TurnOffZone', + 'TurnOnZone', 'ListInstanceHistoryEvents', 'UpdateDynamicSettings', 'DescribeDynamicSettings', 'ListActionRecords', 'DisableKibanaPvlNetwork', 'UpdateKibanaPvlNetwork', 'ListKibanaPvlNetwork', 'EnableKibanaPvlNetwork', 'TurnOffZone', 'CancelTask', 'CreateSnapshot', 'DeleteInstance', 'DescribeRegions', 'DescribeTemplates', 'GetKeystores', 'GrayPublish', 'InitModel', 'ListEventRecords', 'ListInstance', + 'ListNodes', 'ListPlugins', 'ListStatsEventRecords', 'ListTagResources', 'ListTags', 'ListUserPlugin', 'MigrateToOtherZone', 'ModifyInstanceMaintainTime', 'ModifyScheduleExecuteTime', 'MoveResourceGroup', 'PluginAnalysis', 'RemovePlugin', 'RenewInstance', 'RestartInstance', 'TagResources', 'UninstallPlugin', 'UntagResources', 'UpdateFalconSeek', 'UpdateInstance', 'UpdateKeystores', + 'UpdateKibanaSso', 'UpdateTemplate', 'UpgradeInfo', 'createInstance', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'ClientNodeConfiguration' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The client node configuration information.', 'type' => 'object', 'properties' => [ 'diskType' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The storage type of the client node. Only cloud_efficiency (ultra cloud disk) is supported.', 'type' => 'string', 'required' => true, 'example' => 'cloud_ssd', - 'backendName' => 'diskType', - 'enum' => [ - 'cloud_efficiency', - ], - ], - 'amount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '25', - 'minimum' => '2', - 'example' => '3', - 'backendName' => 'amount', + 'enum' => ['cloud_efficiency'], ], + 'amount' => ['title' => '', 'description' => 'The number of client nodes.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '25', 'minimum' => '2', 'example' => '3'], 'spec' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The node specifications of the client node. For more information, see [Specifications](~~271718~~).', 'type' => 'string', 'required' => true, 'example' => 'elasticsearch.sn2ne.large', - 'backendName' => 'spec', 'enum' => [ - 'elasticsearch.sn1ne.large.new', - 'elasticsearch.sn2ne.large.new', - 'elasticsearch.sn1ne.xlarge.new', - 'elasticsearch.sn2ne.xlarge.new', - 'elasticsearch.sn1ne.2xlarge.new', - 'elasticsearch.sn2ne.2xlarge.new', - 'elasticsearch.sn1ne.4xlarge.new', - 'elasticsearch.sn2ne.4xlarge.new', - 'elasticsearch.sn1ne.8xlarge.new', - 'elasticsearch.ic5.large', - 'elasticsearch.sn1ne.large', - 'elasticsearch.sn2ne.large', - 'elasticsearch.r5.large', - 'elasticsearch.ic5.xlarge', - 'elasticsearch.sn1ne.xlarge', - 'elasticsearch.sn2ne.xlarge', - 'elasticsearch.r5.xlarge', - 'elasticsearch.ic5.2xlarge', - 'elasticsearch.sn1ne.2xlarge', - 'elasticsearch.sn2ne.2xlarge', - 'elasticsearch.r5.2xlarge', - 'elasticsearch.ic5.3xlarge', - 'elasticsearch.ic5.4xlarge', - 'elasticsearch.sn1ne.4xlarge', - 'elasticsearch.sn2ne.4xlarge', - 'elasticsearch.sn1ne.8xlarge', + 'elasticsearch.sn1ne.large.new', 'elasticsearch.sn2ne.large.new', 'elasticsearch.sn1ne.xlarge.new', 'elasticsearch.sn2ne.xlarge.new', 'elasticsearch.sn1ne.2xlarge.new', 'elasticsearch.sn2ne.2xlarge.new', 'elasticsearch.sn1ne.4xlarge.new', 'elasticsearch.sn2ne.4xlarge.new', 'elasticsearch.sn1ne.8xlarge.new', 'elasticsearch.ic5.large', 'elasticsearch.sn1ne.large', 'elasticsearch.sn2ne.large', 'elasticsearch.r5.large', 'elasticsearch.ic5.xlarge', 'elasticsearch.sn1ne.xlarge', 'elasticsearch.sn2ne.xlarge', 'elasticsearch.r5.xlarge', 'elasticsearch.ic5.2xlarge', 'elasticsearch.sn1ne.2xlarge', 'elasticsearch.sn2ne.2xlarge', + 'elasticsearch.r5.2xlarge', 'elasticsearch.ic5.3xlarge', 'elasticsearch.ic5.4xlarge', 'elasticsearch.sn1ne.4xlarge', 'elasticsearch.sn2ne.4xlarge', 'elasticsearch.sn1ne.8xlarge', ], ], 'disk' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The storage size of the client node. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '20', 'minimum' => '20', 'example' => '20', - 'backendName' => 'disk', - 'enum' => [ - '20', - ], + 'enum' => ['20'], ], ], 'required' => false, + 'example' => '', ], 'DictInfo' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The dictionary configuration information.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ALI_WS', - 'backendName' => 'type', - ], - 'sourceType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'OSS', - 'backendName' => 'sourceType', - ], - 'fileSize' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - 'backendName' => 'fileSize', - ], - 'name' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'aliws_ext_dict.txt', - 'backendName' => 'name', - ], - ], + 'type' => ['title' => '', 'description' => 'The type of the dictionary file. Valid values:'."\n" + ."\n" + .'- STOP: stopword list'."\n" + .'- MAIN: main dictionary'."\n" + .'- SYNONYMS: synonym dictionary'."\n" + .'- ALI_WS: Alibaba dictionary.', 'type' => 'string', 'example' => 'ALI_WS'], + 'sourceType' => ['title' => '', 'description' => 'The source type of the dictionary file. Valid values:'."\n" + ."\n" + .'- OSS: Object Storage Service (OSS). Ensure that the OSS bucket has public-read permission.'."\n" + .'- ORIGIN: open-source Elasticsearch'."\n" + .'- UPLOAD: uploaded file.', 'type' => 'string', 'example' => 'OSS'], + 'fileSize' => ['title' => '', 'description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602'], + 'name' => ['title' => '', 'description' => 'The name of the dictionary file. Requirements:'."\n" + ."\n" + .'- Main dictionary or stopword list: one word per line, saved as a UTF-8 encoded DIC file. The file name can contain uppercase and lowercase letters, digits, and underscores, and cannot exceed 30 characters in length. Files with duplicate names are not allowed. The main dictionary file and the stopword file cannot share the same name.'."\n" + .'- Synonym dictionary: one synonym expression per line, saved as a UTF-8 encoded TXT file.'."\n" + .'- Alibaba dictionary: the file name must be aliws_ext_dict.txt. The file must be in UTF-8 format. Each line contains one word with no leading or trailing whitespace. Use UNIX or Linux line endings, where each line ends with '."\n" + .'. If the file is generated on a Windows system, use the dos2unix tool on a Linux machine to process the dictionary file before uploading it.', 'type' => 'string', 'example' => 'aliws_ext_dict.txt'], + ], + 'example' => '', ], 'ElasticDataNodeConfiguration' => [ 'title' => '', 'description' => '', - 'visibility' => 'cn', 'type' => 'object', - 'properties' => [ - 'diskType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'cn', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_ssd', - 'backendName' => 'diskType', - 'enum' => [ - 'cloud_essd', - 'cloud_efficiency', - 'cloud_ssd', - ], - ], - 'diskEncryption' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'backendName' => 'diskEncryption', - ], - 'amount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'cn', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '50', - 'minimum' => '2', - 'example' => '3', - 'backendName' => 'amount', - ], - 'spec' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'cn', - 'type' => 'string', - 'required' => true, - 'example' => 'elasticsearch.sn2ne.large', - 'backendName' => 'spec', - 'enum' => [ - 'elasticsearch.sn1ne.large.new', - 'elasticsearch.sn2ne.large.new', - 'elasticsearch.sn1ne.xlarge.new', - 'elasticsearch.sn2ne.xlarge.new', - 'elasticsearch.sn1ne.2xlarge.new', - 'elasticsearch.sn2ne.2xlarge.new', - 'elasticsearch.sn1ne.4xlarge.new', - 'elasticsearch.sn2ne.4xlarge.new', - 'elasticsearch.sn1ne.8xlarge.new', - 'openstore.hybrid.i2.2xlarge', - 'openstore.hybrid.i2g.4xlarge', - 'openstore.i2g.4xlarge', - 'elasticsearch.sn1ne.large', - 'elasticsearch.sn2ne.large', - 'elasticsearch.r5.large', - 'elasticsearch.ic5.xlarge', - 'elasticsearch.sn1ne.xlarge', - 'elasticsearch.sn2ne.xlarge', - 'elasticsearch.r5.xlarge', - 'elasticsearch.ic5.2xlarge', - 'elasticsearch.sn1ne.2xlarge', - 'elasticsearch.sn2ne.2xlarge', - 'elasticsearch.r5.2xlarge', - 'elasticsearch.ic5.3xlarge', - 'elasticsearch.ic5.4xlarge', - 'elasticsearch.sn1ne.4xlarge', - 'elasticsearch.sn2ne.4xlarge', - 'elasticsearch.r6.4xlarge', - 'elasticsearch.sn1ne.8xlarge', - 'elasticsearch.sn2ne.8xlarge', - 'elasticsearch.r6.8xlarge', - 'elasticsearch.c6.13xlarge', - 'elasticsearch.i2g.2xlarge', - 'elasticsearch.i2g.4xlarge', - 'elasticsearch.i2.4xlarge', - 'elasticsearch.i2g.8xlarge', - 'elasticsearch.d1.2xlarge', - 'elasticsearch.d1.4xlarge', - 'elasticsearch.n4.small', - 'elasticsearch.ic5.large', - ], - ], - 'disk' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'cn', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '20480', - 'minimum' => '20', - 'example' => '20', - 'backendName' => 'disk', - ], - 'performanceLevel' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'cn', - 'type' => 'string', - 'required' => false, - 'example' => 'PL1', - 'backendName' => 'performanceLevel', - 'enum' => [ - 'PL0', - 'PL1', - 'PL2', - 'PL3', - ], - ], - ], + 'properties' => [], 'required' => false, + 'example' => '', ], 'Elasticsearch' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The Elasticsearch instance configuration information.', 'type' => 'object', 'properties' => [ - 'masterConfiguration' => [ - 'description' => '', - 'visibility' => 'public', - 'required' => false, - 'backendName' => 'masterConfiguration', - '$ref' => '#/components/schemas/MasterNodeConfiguration', - ], - 'resourceGroupId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzvowej3i****', - 'backendName' => 'resourceGroupId', - ], - 'elasticDataNodeConfiguration' => [ - 'description' => '', - 'visibility' => 'public', - 'required' => false, - 'backendName' => 'elasticDataNodeConfiguration', - '$ref' => '#/components/schemas/ElasticDataNodeConfiguration', - ], - 'dedicateMaster' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'backendName' => 'dedicateMaster', - ], - 'createdAt' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => '2018-07-13T03:58:07.253Z', - 'backendName' => 'createdAt', - ], + 'masterConfiguration' => ['description' => 'The dedicated master node configuration.', 'required' => false, '$ref' => '#/components/schemas/MasterNodeConfiguration', 'title' => '', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzvowej3i****'], + 'elasticDataNodeConfiguration' => ['description' => 'The elastic data node configuration.', 'required' => false, '$ref' => '#/components/schemas/ElasticDataNodeConfiguration', 'title' => '', 'example' => ''], + 'dedicateMaster' => ['title' => '', 'description' => 'Indicates whether the instance contains legacy dedicated master nodes (deprecated).', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'createdAt' => ['title' => '', 'description' => 'The time when the instance was created.', 'type' => 'string', 'required' => false, 'example' => '2018-07-13T03:58:07.253Z'], 'ikHotDicts' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The IK hot dictionary configuration.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/DictInfo', - ], - 'required' => false, - 'backendName' => 'ikHotDicts', - ], - 'port' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['description' => 'IK词典配置。', '$ref' => '#/components/schemas/DictInfo', 'title' => '', 'example' => ''], 'required' => false, - 'example' => '9200', - 'backendName' => 'port', + 'example' => '', ], + 'port' => ['title' => '', 'description' => 'The private network access port of the instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '9200'], 'kibanaPrivateIPWhitelist' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The IP whitelist configuration for private network access to Kibana.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '["192.168.XX.XX"]', - 'extendType' => 'true', - ], - 'required' => false, - 'backendName' => 'kibanaPrivateIPWhitelist', - ], - 'esVersion' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => '6.3.2_with_X-Pack', - 'backendName' => 'esVersion', - ], - 'version' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'required' => false, - 'example' => '6.3.2_with_X-Pack', - 'backendName' => 'version', - ], - 'kibanaConfiguration' => [ - 'description' => '', - 'visibility' => 'public', - 'required' => false, - 'backendName' => 'kibanaConfiguration', - '$ref' => '#/components/schemas/KibanaNodeConfiguration', - ], - 'dataNode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'backendName' => 'dataNode', - ], - 'serviceVpc' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', + 'items' => ['description' => 'Kibana私网地址访问白名单列表。', 'type' => 'string', 'example' => '["192.168.XX.XX"]', 'title' => ''], 'required' => false, - 'example' => 'true', - 'backendName' => 'serviceVpc', + 'example' => '', ], + 'esVersion' => ['title' => '', 'description' => 'The instance version.', 'type' => 'string', 'required' => false, 'example' => '6.3.2_with_X-Pack'], + 'kibanaConfiguration' => ['description' => 'The Kibana node configuration.', 'required' => false, '$ref' => '#/components/schemas/KibanaNodeConfiguration', 'title' => '', 'example' => ''], + 'dataNode' => ['title' => '', 'description' => 'Indicates whether the instance contains data nodes. Valid values:'."\n" + ."\n" + .'- true: The instance contains data nodes.'."\n" + .'- false: The instance does not contain data nodes.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'serviceVpc' => ['title' => '', 'description' => 'Indicates whether the instance is in the Elasticsearch service VPC. Valid values:'."\n" + ."\n" + .'- true: The instance is in the service VPC.'."\n" + .'- false: The instance is not in the service VPC.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'tags' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The instance tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/Tag', - ], - 'required' => false, - 'backendName' => 'tags', - ], - 'haveKibana' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', + 'items' => ['description' => '标签配置。', '$ref' => '#/components/schemas/Tag', 'title' => '', 'example' => ''], 'required' => false, - 'example' => 'true', - 'backendName' => 'haveKibana', + 'example' => '', ], + 'haveKibana' => ['title' => '', 'description' => 'Indicates whether the instance contains Kibana nodes. Valid values:'."\n" + ."\n" + .'- true: The instance contains Kibana nodes.'."\n" + .'- false: The instance does not contain Kibana nodes.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'dictList' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The IK dictionary configuration.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/DictInfo', - ], + 'items' => ['description' => 'IK词典配置信息。', '$ref' => '#/components/schemas/DictInfo', 'title' => '', 'example' => ''], 'required' => false, - 'backendName' => 'dictList', + 'example' => '', ], 'extendConfigs' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The extension parameter settings of the instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'object', - 'example' => '[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]', - 'extendType' => 'true', - ], + 'items' => ['description' => '实例的扩展配置。', 'type' => 'object', 'example' => '[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]', 'title' => ''], 'required' => false, - 'backendName' => 'extendConfigs', - ], - 'status' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'active', - 'backendName' => 'status', - ], - 'instanceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-3h4k3axh33th9****', - 'backendName' => 'instanceId', + 'example' => '', ], + 'status' => ['title' => '', 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- active: Normal.'."\n" + .'- activating: Taking effect.'."\n" + .'- inactive: Frozen.'."\n" + .'- invalid: Expired.', 'type' => 'string', 'required' => false, 'example' => 'active'], + 'instanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-3h4k3axh33th9****'], 'zoneInfos' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The zone information of the instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/ZoneInfo', - ], - 'required' => false, - 'backendName' => 'zoneInfos', - ], - 'kibanaProtocol' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTPS', - 'backendName' => 'kibanaProtocol', - ], - 'enableKibanaPrivateNetwork' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', + 'items' => ['description' => '可用区信息。', '$ref' => '#/components/schemas/ZoneInfo', 'title' => '', 'example' => ''], 'required' => false, - 'example' => 'false', - 'backendName' => 'enableKibanaPrivateNetwork', - ], - 'kibanaDomain' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com', - 'backendName' => 'kibanaDomain', - ], - 'nodeSpec' => [ - 'description' => '', - 'visibility' => 'public', - 'required' => false, - 'backendName' => 'nodeSpec', - '$ref' => '#/components/schemas/NodeSpec', - ], - 'warmNode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'backendName' => 'warmNode', - ], - 'warmNodeConfiguration' => [ - 'description' => '', - 'visibility' => 'public', - 'required' => false, - 'backendName' => 'warmNodeConfiguration', - '$ref' => '#/components/schemas/WarmNodeConfiguration', - ], - 'domain' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com', - 'backendName' => 'domain', - ], - 'haveClientNode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'backendName' => 'haveClientNode', - ], - 'clientNodeConfiguration' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'required' => false, - 'backendName' => 'clientNodeConfiguration', - '$ref' => '#/components/schemas/ClientNodeConfiguration', - ], - 'description' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-abc', - 'backendName' => 'description', - ], - 'endTime' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - 'backendName' => 'endTime', - ], - 'enablePublic' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'backendName' => 'enablePublic', + 'example' => '', ], + 'kibanaProtocol' => ['title' => '', 'description' => 'The access protocol for Kibana. Valid values: HTTP and HTTPS.', 'type' => 'string', 'required' => false, 'example' => 'HTTPS'], + 'enableKibanaPrivateNetwork' => ['title' => '', 'description' => 'Indicates whether private network access to Kibana is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'kibanaDomain' => ['title' => '', 'description' => 'The public network access address of Kibana.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com'], + 'nodeSpec' => ['description' => 'The data node configuration.', 'required' => false, '$ref' => '#/components/schemas/NodeSpec', 'title' => '', 'example' => ''], + 'warmNode' => ['title' => '', 'description' => 'Indicates whether warm data nodes are enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'warmNodeConfiguration' => ['description' => 'The warm data node configuration.', 'required' => false, '$ref' => '#/components/schemas/WarmNodeConfiguration', 'title' => '', 'example' => ''], + 'domain' => ['title' => '', 'description' => 'The private network access address of the Elasticsearch instance.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com'], + 'haveClientNode' => ['title' => '', 'description' => 'Indicates whether client nodes are enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'clientNodeConfiguration' => ['title' => '', 'description' => 'The client node configuration.', 'required' => false, '$ref' => '#/components/schemas/ClientNodeConfiguration', 'example' => ''], + 'description' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-abc'], + 'endTime' => ['title' => '', 'description' => 'The time when the instance expires. For pay-as-you-go instances, the default value is 100 years.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'], + 'enablePublic' => ['title' => '', 'description' => 'Indicates whether the public network address of the instance is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'aliwsDicts' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The Aliws dictionary configuration.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/DictInfo', - ], - 'required' => false, - 'backendName' => 'aliwsDicts', - ], - 'ownerId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'required' => false, - 'example' => '168520994880****', - 'backendName' => 'ownerId', - ], - 'archType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', + 'items' => ['description' => '词典配置信息。', '$ref' => '#/components/schemas/DictInfo', 'title' => '', 'example' => ''], 'required' => false, - 'example' => 'exclusive', - 'backendName' => 'archType', - ], - 'advancedDedicateMaster' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'backendName' => 'advancedDedicateMaster', - ], - 'commodityCode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'required' => false, - 'example' => 'elasticsearch', - 'backendName' => 'commodityCode', - ], - 'paymentType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'prepaid', - 'backendName' => 'paymentType', - ], - 'readWritePolicy' => [ - 'description' => '', - 'visibility' => 'public', - 'required' => false, - 'backendName' => 'readWritePolicy', - '$ref' => '#/components/schemas/ReadWritePolicy', - ], - 'protocol' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'HTTP', - 'backendName' => 'protocol', + 'example' => '', ], + 'advancedDedicateMaster' => ['title' => '', 'description' => 'Indicates whether the new dedicated master node is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'paymentType' => ['title' => '', 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- prepaid: subscription.'."\n" + .'- postpaid: pay-as-you-go.', 'type' => 'string', 'required' => false, 'example' => 'prepaid'], + 'readWritePolicy' => ['description' => 'The high availability configuration of the instance.', 'required' => false, '$ref' => '#/components/schemas/ReadWritePolicy', 'title' => '', 'example' => ''], + 'protocol' => ['title' => '', 'description' => 'The access protocol of the instance. Valid values: HTTP and HTTPS.', 'type' => 'string', 'required' => false, 'example' => 'HTTP'], 'publicIpWhitelist' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The public network access whitelist configuration of the instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '["0.0.0.0/0"]', - 'extendType' => 'true', - ], + 'items' => ['description' => '实例的公网地址访问白名单列表。', 'type' => 'string', 'example' => '["0.0.0.0/0"]', 'title' => ''], 'required' => false, - 'backendName' => 'publicIpWhitelist', - ], - 'kibanaPort' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5601', - 'backendName' => 'kibanaPort', - ], - 'enableKibanaPublicNetwork' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'backendName' => 'enableKibanaPublicNetwork', - ], - 'networkConfig' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'required' => false, - 'backendName' => 'networkConfig', - '$ref' => '#/components/schemas/NetworkConfig', + 'example' => '', ], + 'kibanaPort' => ['title' => '', 'description' => 'The public network access port of Kibana.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5601'], + 'enableKibanaPublicNetwork' => ['title' => '', 'description' => 'Indicates whether public network access to Kibana is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'networkConfig' => ['title' => '', 'description' => 'The network configuration of the instance.', 'required' => false, '$ref' => '#/components/schemas/NetworkConfig', 'example' => ''], 'productType' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The instance edition. Valid values:'."\n" + ."\n" + .'- logEnhancement: Advanced Edition.'."\n" + .'- generalBusiness: general commercial edition.', 'type' => 'string', 'required' => false, 'example' => 'generalBusiness', - 'backendName' => 'productType', - 'enum' => [ - 'generalBusiness', - 'logEnhancement', - 'community', - ], + 'enum' => ['generalBusiness', 'logEnhancement', 'community'], ], 'advancedSetting' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The advanced settings.', 'type' => 'object', 'properties' => [ 'gcName' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'GC垃圾回收器名称。支持CMS和G1。', 'type' => 'string', 'example' => 'CMS', - 'backendName' => 'gcName', - 'enum' => [ - 'CMS', - 'G1', - ], + 'enum' => ['CMS', 'G1'], ], ], 'required' => false, - 'backendName' => 'advancedSetting', - ], - 'nodeAmount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - 'backendName' => 'nodeAmount', - ], - 'updatedAt' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => '2018-07-13T03:58:07.253Z', - 'backendName' => 'updatedAt', - ], - 'enableMetrics' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'backendName' => 'enableMetrics', + 'example' => '', ], + 'nodeAmount' => ['title' => '', 'description' => 'The number of data nodes in the instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], + 'updatedAt' => ['title' => '', 'description' => 'The time when the instance was last updated.', 'type' => 'string', 'required' => false, 'example' => '2018-07-13T03:58:07.253Z'], 'esConfig' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The YML file configuration of the instance.', 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '{"http.cors.allow-credentials":"false"}', - ], - 'backendName' => 'esConfig', + 'additionalProperties' => ['description' => 'YML文件配置。', 'type' => 'string', 'example' => '{"http.cors.allow-credentials":"false"}', 'title' => ''], + 'example' => '', ], 'esIPWhitelist' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The private network access whitelist configuration of the instance (deprecated).', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '["0.0.0.0/0"]', - 'extendType' => 'true', - ], + 'items' => ['description' => '私网访问报名单列表。', 'type' => 'string', 'example' => '["0.0.0.0/0"]', 'title' => ''], 'required' => false, - 'backendName' => 'esIPWhitelist', + 'example' => '', ], 'kibanaIPWhitelist' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The public network access whitelist configuration of Kibana.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '["0.0.0.0/0"]', - 'extendType' => 'true', - ], + 'items' => ['description' => 'Kibana公网地址访问白名单列表。', 'type' => 'string', 'example' => '["0.0.0.0/0"]', 'title' => ''], 'required' => false, - 'backendName' => 'kibanaIPWhitelist', + 'example' => '', ], 'privateNetworkIpWhiteList' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The private network address access whitelist configuration of the instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '["0.0.0.0/0"]', - 'extendType' => 'true', - ], - 'required' => false, - 'backendName' => 'privateNetworkIpWhiteList', - ], - 'vpcInstanceId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', + 'items' => ['description' => '实例的私网地址访问白名单列表。', 'type' => 'string', 'example' => '["0.0.0.0/0"]', 'title' => ''], 'required' => false, - 'example' => 'vpc-bp1uag5jj38c****', - 'backendName' => 'vpcInstanceId', + 'example' => '', ], 'synonymsDicts' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The synonym dictionary configuration of the instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/DictInfo', - ], - 'required' => false, - 'backendName' => 'synonymsDicts', - ], - 'haveElasticDataNode' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'backendName' => 'haveElasticDataNode', - ], - 'zoneCount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'backendName' => 'zoneCount', - ], - 'postpaidServiceStatus' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Private', - 'type' => 'string', - 'required' => false, - 'example' => 'active', - 'backendName' => 'postpaidServiceStatus', - ], - 'kibanaPrivateDomain' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-tl329rbpc0001****-kibana.internal.elasticsearch.aliyuncs.com', - 'backendName' => 'kibanaPrivateDomain', - ], - 'kibanaPrivatePort' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5601', - 'backendName' => 'kibanaPrivatePort', - ], - 'publicDomain' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com', - 'backendName' => 'publicDomain', - ], - 'publicPort' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['description' => '词典配置信息。', '$ref' => '#/components/schemas/DictInfo', 'title' => '', 'example' => ''], 'required' => false, - 'example' => '9200', - 'backendName' => 'publicPort', + 'example' => '', ], + 'haveElasticDataNode' => ['title' => '', 'description' => 'Indicates whether elastic data nodes are enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'zoneCount' => ['title' => '', 'description' => 'The number of zones for the instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'kibanaPrivateDomain' => ['title' => '', 'description' => 'The private network access address of Kibana.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-tl329rbpc0001****-kibana.internal.elasticsearch.aliyuncs.com'], + 'kibanaPrivatePort' => ['title' => '', 'description' => 'The private network access port of Kibana.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5601'], + 'publicDomain' => ['title' => '', 'description' => 'The public network access address of the Elasticsearch instance.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com'], + 'publicPort' => ['title' => '', 'description' => 'The public network access port of the Elasticsearch instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '9200'], ], 'required' => false, + 'example' => '', ], 'KibanaNodeConfiguration' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The Kibana node configuration information.', 'type' => 'object', 'properties' => [ 'amount' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The number of Kibana nodes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '1', 'minimum' => '1', 'example' => '2', - 'backendName' => 'amount', - 'enum' => [ - '1', - ], + 'enum' => ['1'], ], 'spec' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The Kibana node specifications. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'required' => true, 'example' => 'elasticsearch.sn2ne.large', - 'backendName' => 'spec', - 'enum' => [ - 'elasticsearch.sn1ne.large.new', - 'elasticsearch.sn2ne.large.new', - 'elasticsearch.sn2ne.xlarge.new', - 'elasticsearch.sn2ne.2xlarge.new', - 'elasticsearch.sn1ne.large', - 'elasticsearch.n4.small', - 'elasticsearch.sn2ne.large', - 'elasticsearch.sn2ne.xlarge', - 'elasticsearch.sn2ne.2xlarge', - ], - ], - 'disk' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'backendName' => 'disk', + 'enum' => ['elasticsearch.sn1ne.large.new', 'elasticsearch.sn2ne.large.new', 'elasticsearch.sn2ne.xlarge.new', 'elasticsearch.sn2ne.2xlarge.new', 'elasticsearch.sn1ne.large', 'elasticsearch.n4.small', 'elasticsearch.sn2ne.large', 'elasticsearch.sn2ne.xlarge', 'elasticsearch.sn2ne.2xlarge'], ], + 'disk' => ['title' => '', 'description' => 'The storage space of the Kibana node. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20'], ], 'required' => false, + 'example' => '', ], 'Logstash' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The parameter object.', 'type' => 'object', 'properties' => [ 'endpointList' => [ - 'title' => 'EndpointList', - 'description' => '', - 'visibility' => 'public', + 'title' => '', + 'description' => 'The node information.', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'public', + 'description' => 'The object information.', 'type' => 'object', 'properties' => [ - 'host' => [ - 'title' => 'Host', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '172.16.xx.xx', - 'backendName' => 'host', - ], - 'port' => [ - 'title' => 'Port', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9200', - 'backendName' => 'port', - ], - 'zoneId' => [ - 'title' => 'ZoneId', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - 'backendName' => 'zoneId', - ], + 'host' => ['title' => '', 'description' => 'The IP address of the node.', 'type' => 'string', 'example' => '172.16.xx.xx'], + 'port' => ['title' => '', 'description' => 'The access port number of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '9200'], + 'zoneId' => ['title' => '', 'description' => 'The zone ID of the node.', 'type' => 'string', 'example' => 'cn-hangzhou-i'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'endpointList', - ], - 'status' => [ - 'title' => 'Status', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'NORMAL', - 'backendName' => 'status', - ], - 'description' => [ - 'title' => 'Description', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ls-cn-abc', - 'backendName' => 'description', - ], - 'resourceGroupId' => [ - 'title' => 'ResourceGroupId', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'rg-acfm2h5vbzd****', - 'backendName' => 'resourceGroupId', - ], - 'endTime' => [ - 'title' => 'EndTime', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4749897600000', - 'backendName' => 'endTime', - ], - 'instanceId' => [ - 'title' => 'InstanceId', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'ls-cn-n6w1o5jq****', - 'backendName' => 'instanceId', + 'example' => '', ], + 'status' => ['title' => '', 'description' => 'The zone status. Valid values:'."\n" + ."\n" + .'- ISOLATION: offline'."\n" + .'- NORMAL: Normal.', 'type' => 'string', 'example' => 'NORMAL'], + 'description' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'example' => 'ls-cn-abc'], + 'resourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-acfm2h5vbzd****'], + 'endTime' => ['title' => '', 'description' => 'The expiration time of the subscription instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '4749897600000'], + 'instanceId' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'example' => 'ls-cn-n6w1o5jq****'], 'config' => [ - 'title' => 'Config', - 'description' => '', - 'visibility' => 'public', + 'title' => '', + 'description' => 'The instance configuration.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '[]', - ], - 'backendName' => 'config', - ], - 'createdAt' => [ - 'title' => 'CreatedAt', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2018-07-13T03:58:07.253Z', - 'backendName' => 'createdAt', + 'additionalProperties' => ['description' => 'The instance configuration information.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'example' => '', ], + 'createdAt' => ['title' => '', 'description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2018-07-13T03:58:07.253Z'], 'networkConfig' => [ - 'title' => 'NetworkConfig', - 'description' => '', - 'visibility' => 'public', + 'title' => '', + 'description' => 'The network configuration.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => 'Type', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vpc', - 'backendName' => 'type', - ], - 'vpcId' => [ - 'title' => 'VpcId', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vpc-abc', - 'backendName' => 'vpcId', - ], - 'vsArea' => [ - 'title' => 'VsArea', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cn-hangzhou-*', - 'backendName' => 'vsArea', - ], - 'vswitchId' => [ - 'title' => 'VswitchId', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vsw-def', - 'backendName' => 'vswitchId', - ], + 'type' => ['title' => '', 'description' => 'The network type. Currently, only Virtual Private Cloud (VPC) is supported.', 'type' => 'string', 'example' => 'vpc'], + 'vpcId' => ['title' => '', 'description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-abc'], + 'vsArea' => ['title' => '', 'description' => 'The zone in which the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-*'], + 'vswitchId' => ['title' => '', 'description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-def'], ], - 'backendName' => 'networkConfig', + 'example' => '', ], 'zoneInfos' => [ - 'title' => 'ZoneInfos', - 'description' => '', - 'visibility' => 'public', + 'title' => '', + 'description' => 'The zone information.', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'public', + 'description' => 'The zone object information.', 'type' => 'object', 'properties' => [ - 'status' => [ - 'title' => 'Status', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'NORMAL', - 'backendName' => 'status', - ], - 'zoneId' => [ - 'title' => 'ZoneId', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - 'backendName' => 'zoneId', - ], + 'status' => ['title' => '', 'description' => 'The zone status. Valid values:'."\n" + ."\n" + .'- ISOLATION: offline'."\n" + .'- NORMAL: Normal.', 'type' => 'string', 'example' => 'NORMAL'], + 'zoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'zoneInfos', - ], - 'nodeAmount' => [ - 'title' => 'NodeAmount', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - 'backendName' => 'nodeAmount', - ], - 'updatedAt' => [ - 'title' => 'UpdatedAt', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2018-07-18T10:10:04.484Z', - 'backendName' => 'updatedAt', - ], - 'version' => [ - 'title' => 'Version', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '6.7.0_with_X-Pack', - 'backendName' => 'version', - ], - 'dataNode' => [ - 'title' => 'DataNode', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'dataNode', + 'example' => '', ], + 'nodeAmount' => ['title' => '', 'description' => 'The number of nodes in the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'updatedAt' => ['title' => '', 'description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2018-07-18T10:10:04.484Z'], + 'version' => ['title' => '', 'description' => 'The instance version. Valid values:'."\n" + ."\n" + .'- 6.7.0_with_X-Pack'."\n" + .'- 7.4.0_with_X-Pack.', 'type' => 'string', 'example' => '6.7.0_with_X-Pack'], + 'dataNode' => ['title' => '', 'description' => 'Specifies whether to enable data nodes. This parameter must be set to true.', 'type' => 'boolean', 'example' => 'true'], 'nodeSpec' => [ - 'title' => 'NodeSpec', - 'description' => '', - 'visibility' => 'public', + 'title' => '', + 'description' => 'The data node configuration.', 'type' => 'object', 'properties' => [ - 'disk' => [ - 'title' => 'Disk', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - 'backendName' => 'disk', - ], - 'diskType' => [ - 'title' => 'DiskType', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cloud_ssd', - 'backendName' => 'diskType', - ], - 'spec' => [ - 'title' => 'Spec', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'logstash.n4.small', - 'backendName' => 'spec', - ], + 'disk' => ['title' => '', 'description' => 'The disk size of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], + 'diskType' => ['title' => '', 'description' => 'The disk type of the node.', 'type' => 'string', 'example' => 'cloud_ssd'], + 'spec' => ['title' => '', 'description' => 'The node specifications.', 'type' => 'string', 'example' => 'logstash.n4.small'], ], - 'backendName' => 'nodeSpec', - ], - 'paymentType' => [ - 'title' => 'PaymentType', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'postpaid', - 'backendName' => 'paymentType', - ], - 'protocol' => [ - 'title' => 'Protocol', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'HTTP', - 'backendName' => 'protocol', + 'example' => '', ], + 'paymentType' => ['title' => '', 'description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- prepaid: subscription'."\n" + .'- postpaid: pay-as-you-go.', 'type' => 'string', 'example' => 'postpaid'], + 'protocol' => ['title' => '', 'description' => 'The access protocol of the instance.', 'type' => 'string', 'example' => 'HTTP'], 'tags' => [ - 'title' => 'Tags', - 'description' => '', - 'visibility' => 'public', + 'title' => '', + 'description' => 'The instance tags.', 'type' => 'array', 'items' => [ - 'description' => '', - 'visibility' => 'public', + 'description' => 'The tag object.', 'type' => 'object', 'properties' => [ - 'tagKey' => [ - 'title' => 'TagKey', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'env', - 'backendName' => 'tagKey', - ], - 'tagValue' => [ - 'title' => 'TagValue', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'dev', - 'backendName' => 'tagValue', - ], + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'env'], + 'tagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'dev'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'tags', - ], - 'zoneCount' => [ - 'title' => 'ZoneCount', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'zoneCount', + 'example' => '', ], + 'zoneCount' => ['title' => '', 'description' => 'The number of zones for the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], + 'example' => '', ], 'MasterNodeConfiguration' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The configuration information of dedicated master nodes.', 'type' => 'object', 'properties' => [ - 'amount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '3', - 'minimum' => '3', - 'example' => '3', - 'backendName' => 'amount', - ], + 'amount' => ['title' => '', 'description' => 'The number of dedicated master nodes.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '3', 'minimum' => '3', 'example' => '3'], 'spec' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The node specifications of dedicated master nodes. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'required' => true, 'example' => 'elasticsearch.sn2ne.large', - 'backendName' => 'spec', - 'enum' => [ - 'elasticsearch.sn1ne.large.new', - 'elasticsearch.sn2ne.large.new', - 'elasticsearch.sn1ne.xlarge.new', - 'elasticsearch.sn2ne.xlarge.new', - 'elasticsearch.sn1ne.2xlarge.new', - 'elasticsearch.sn2ne.2xlarge.new', - 'elasticsearch.sn1ne.4xlarge.new', - 'elasticsearch.sn2ne.4xlarge.new', - 'elasticsearch.sn1ne.8xlarge.new', - 'elasticsearch.sn2ne.large', - 'elasticsearch.r5.large', - 'elasticsearch.ic5.xlarge', - 'elasticsearch.sn1ne.xlarge', - 'elasticsearch.sn2ne.xlarge', - 'elasticsearch.r5.xlarge', - 'elasticsearch.ic5.2xlarge', - 'elasticsearch.sn1ne.2xlarge', - 'elasticsearch.sn2ne.2xlarge', - 'elasticsearch.r5.2xlarge', - 'elasticsearch.ic5.3xlarge', - ], - ], - 'disk' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '20', - 'minimum' => '20', - 'example' => '20', - 'backendName' => 'disk', + 'enum' => ['elasticsearch.sn1ne.large.new', 'elasticsearch.sn2ne.large.new', 'elasticsearch.sn1ne.xlarge.new', 'elasticsearch.sn2ne.xlarge.new', 'elasticsearch.sn1ne.2xlarge.new', 'elasticsearch.sn2ne.2xlarge.new', 'elasticsearch.sn1ne.4xlarge.new', 'elasticsearch.sn2ne.4xlarge.new', 'elasticsearch.sn1ne.8xlarge.new', 'elasticsearch.sn2ne.large', 'elasticsearch.r5.large', 'elasticsearch.ic5.xlarge', 'elasticsearch.sn1ne.xlarge', 'elasticsearch.sn2ne.xlarge', 'elasticsearch.r5.xlarge', 'elasticsearch.ic5.2xlarge', 'elasticsearch.sn1ne.2xlarge', 'elasticsearch.sn2ne.2xlarge', 'elasticsearch.r5.2xlarge', 'elasticsearch.ic5.3xlarge'], ], + 'disk' => ['title' => '', 'description' => 'The storage space of dedicated master nodes. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '20', 'minimum' => '20', 'example' => '20'], 'diskType' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The storage type of dedicated master nodes. Valid values:'."\n" + .'- cloud_ssd: standard SSD'."\n" + .'- cloud_essd (default): Enterprise SSD (ESSD).', 'type' => 'string', 'required' => true, 'example' => 'cloud_essd', - 'backendName' => 'diskType', - 'enum' => [ - 'cloud_essd', - 'cloud_ssd', - ], + 'enum' => ['cloud_essd', 'cloud_ssd'], ], ], 'required' => false, + 'example' => '', ], 'NetworkConfig' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The network configuration information.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vpc', - 'backendName' => 'type', - ], - 'vpcId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vpc-bp1xk0naij7jx4ph1****', - 'backendName' => 'vpcId', - ], + 'type' => ['title' => '', 'description' => 'The network type. Only Virtual Private Cloud (VPC) is supported.', 'type' => 'string', 'example' => 'vpc'], + 'vpcId' => ['title' => '', 'description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1xk0naij7jx4ph1****'], 'whiteIpGroupList' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The IP whitelist group configuration. You do not need to set this parameter when you call the createInstance operation to create an instance because the setting does not take effect during instance creation. Use a separate API operation to configure whitelists for different roles.', + 'type' => 'array', + 'items' => ['description' => 'IP白名单分组列表。', '$ref' => '#/components/schemas/WhiteIpGroup', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'vswitchId' => ['title' => '', 'description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1ogpdintii5qvyx****'], + 'vsArea' => ['title' => '', 'description' => 'The zone ID of the network.', 'type' => 'string', 'example' => 'cn-hangzhou-e'], + 'loadBalanceType' => ['title' => '', 'description' => 'The load balancing type. Default value: DEFAULT.', 'type' => 'string', 'example' => 'DEFAULT', 'default' => 'DEFAULT'], + 'lbReplica' => ['type' => 'integer', 'description' => '', 'title' => '', 'example' => '', 'format' => 'int32', 'maximum' => '10'], + 'loadBalanceConfig' => [ 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'vswitchId' => ['title' => '', 'description' => 'vswitchId', 'type' => 'string', 'example' => 'vsw-xxxx'], + 'vsArea' => ['title' => '', 'description' => '可用区信息，如: cn-hangzhou-i', 'type' => 'string', 'example' => ''], + ], 'description' => '', - 'visibility' => 'public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/WhiteIpGroup', + 'title' => '', + 'example' => '', ], - 'backendName' => 'whiteIpGroupList', - ], - 'vswitchId' => [ - 'title' => '', 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'vsw-bp1ogpdintii5qvyx****', - 'backendName' => 'vswitchId', - ], - 'vsArea' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cn-hangzhou-e', - 'backendName' => 'vsArea', + 'example' => '', ], ], + 'example' => '', ], 'NodeInfo' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The node information.', 'type' => 'object', 'properties' => [ - 'host' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '172.16.xx.xx', - 'backendName' => 'host', - ], - 'hostName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'es-cn-tl32vdghe0005cd99-data-b-2', - 'backendName' => 'hostName', - ], - 'port' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9200', - 'backendName' => 'port', - ], - 'zoneId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - 'backendName' => 'zoneId', - ], + 'host' => ['title' => '', 'description' => 'The IP address of the node.', 'type' => 'string', 'example' => '172.16.xx.xx'], + 'hostName' => ['title' => '', 'description' => 'The node name. This parameter is supported only for instances of version 7.16 deployed on ACK.', 'type' => 'string', 'example' => 'es-cn-tl32vdghe0005cd99-data-b-2'], + 'port' => ['title' => '', 'description' => 'The port number of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '9200'], + 'zoneId' => ['title' => '', 'description' => 'The zone ID of the node.', 'type' => 'string', 'example' => 'cn-hangzhou-b'], ], + 'example' => '', ], 'NodeSpec' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'Data node configuration information.', 'type' => 'object', 'properties' => [ - 'diskType' => [ + 'disk' => ['title' => '', 'description' => 'Storage space size of data nodes, in GB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20480', 'minimum' => '20', 'example' => '20'], + 'performanceLevel' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Performance level of ESSD cloud disks. Required when the disk type of data nodes is ESSD cloud disk. Supported values: PL1, PL2, PL3.', 'type' => 'string', 'required' => false, - 'example' => 'cloud_ssd', - 'backendName' => 'diskType', - 'enum' => [ - 'cloud_essd', - 'cloud_efficiency', - 'cloud_ssd', - ], + 'example' => 'PL1', + 'enum' => ['PL0', 'PL1', 'PL2', 'PL3', 'CPL0', 'CPL1'], ], - 'spec' => [ + 'diskType' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Storage type of data nodes. Supported values:'."\n" + ."\n" + .'- cloud_ssd: SSD cloud disk'."\n" + .'- cloud_essd: ESSD cloud disk'."\n" + .'- cloud_efficiency: Ultra cloud disk', 'type' => 'string', - 'required' => true, - 'example' => 'elasticsearch.sn2ne.large', - 'backendName' => 'spec', - 'enum' => [ - 'elasticsearch.sn1ne.large.new', - 'elasticsearch.sn2ne.large.new', - 'elasticsearch.sn1ne.xlarge.new', - 'elasticsearch.sn2ne.xlarge.new', - 'elasticsearch.sn1ne.2xlarge.new', - 'elasticsearch.sn2ne.2xlarge.new', - 'elasticsearch.sn1ne.4xlarge.new', - 'elasticsearch.sn2ne.4xlarge.new', - 'elasticsearch.sn1ne.8xlarge.new', - 'openstore.hybrid.i2.2xlarge', - 'openstore.hybrid.i2g.4xlarge', - 'openstore.i2g.4xlarge', - 'elasticsearch.sn1ne.large', - 'elasticsearch.sn2ne.large', - 'elasticsearch.r5.large', - 'elasticsearch.ic5.xlarge', - 'elasticsearch.sn1ne.xlarge', - 'elasticsearch.sn2ne.xlarge', - 'elasticsearch.r5.xlarge', - 'elasticsearch.ic5.2xlarge', - 'elasticsearch.sn1ne.2xlarge', - 'elasticsearch.sn2ne.2xlarge', - 'elasticsearch.r5.2xlarge', - 'elasticsearch.ic5.3xlarge', - 'elasticsearch.ic5.4xlarge', - 'elasticsearch.sn1ne.4xlarge', - 'elasticsearch.sn2ne.4xlarge', - 'elasticsearch.r6.4xlarge', - 'elasticsearch.sn1ne.8xlarge', - 'elasticsearch.sn2ne.8xlarge', - 'elasticsearch.r6.8xlarge', - 'elasticsearch.c6.13xlarge', - 'elasticsearch.i2g.2xlarge', - 'elasticsearch.i2g.4xlarge', - 'elasticsearch.i2.4xlarge', - 'elasticsearch.i2g.8xlarge', - 'elasticsearch.d1.2xlarge', - 'elasticsearch.d1.4xlarge', - 'elasticsearch.n4.small', - 'elasticsearch.ic5.large', - ], - ], - 'disk' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', 'required' => false, - 'maximum' => '20480', - 'minimum' => '20', - 'example' => '20', - 'backendName' => 'disk', + 'example' => 'cloud_ssd', + 'enum' => ['cloud_essd', 'cloud_efficiency', 'cloud_ssd'], ], - 'diskEncryption' => [ + 'diskPreference' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'backendName' => 'diskEncryption', - 'default' => 'false', + 'description' => 'Storage preference.', + 'type' => 'string', + 'example' => '', + 'enum' => ['high_availability', 'high_cost_performance'], ], - 'performanceLevel' => [ + 'diskEncryption' => ['title' => '', 'description' => 'Whether to enable cloud disk encryption for data nodes:'."\n" + ."\n" + .'- true: Enabled'."\n" + .'- false: Disabled', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + 'spec' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'Data node specification. Specification details can be viewed in [Product Specifications](~~271718~~).', 'type' => 'string', - 'required' => false, - 'example' => 'PL1', - 'backendName' => 'performanceLevel', + 'required' => true, + 'example' => 'elasticsearch.sn2ne.large', 'enum' => [ - 'PL0', - 'PL1', - 'PL2', - 'PL3', + 'elasticsearch.sn1ne.large.new', 'elasticsearch.sn2ne.large.new', 'elasticsearch.sn1ne.xlarge.new', 'elasticsearch.sn2ne.xlarge.new', 'elasticsearch.sn1ne.2xlarge.new', 'elasticsearch.sn2ne.2xlarge.new', 'elasticsearch.sn1ne.4xlarge.new', 'elasticsearch.sn2ne.4xlarge.new', 'elasticsearch.sn1ne.8xlarge.new', 'openstore.hybrid.i2.2xlarge', 'openstore.hybrid.i2g.4xlarge', 'openstore.i2g.4xlarge', 'elasticsearch.sn1ne.large', 'elasticsearch.sn2ne.large', 'elasticsearch.r5.large', 'elasticsearch.ic5.xlarge', 'elasticsearch.sn1ne.xlarge', 'elasticsearch.sn2ne.xlarge', 'elasticsearch.r5.xlarge', 'elasticsearch.ic5.2xlarge', + 'elasticsearch.sn1ne.2xlarge', 'elasticsearch.sn2ne.2xlarge', 'elasticsearch.r5.2xlarge', 'elasticsearch.ic5.3xlarge', 'elasticsearch.ic5.4xlarge', 'elasticsearch.sn1ne.4xlarge', 'elasticsearch.sn2ne.4xlarge', 'elasticsearch.r6.4xlarge', 'elasticsearch.sn1ne.8xlarge', 'elasticsearch.sn2ne.8xlarge', 'elasticsearch.r6.8xlarge', 'elasticsearch.c6.13xlarge', 'elasticsearch.i2g.2xlarge', 'elasticsearch.i2g.4xlarge', 'elasticsearch.i2.4xlarge', 'elasticsearch.i2g.8xlarge', 'elasticsearch.d1.2xlarge', 'elasticsearch.d1.4xlarge', 'elasticsearch.n4.small', 'elasticsearch.ic5.large', ], ], ], 'required' => false, + 'example' => '', ], 'PaymentInfo' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The billing details of a subscription instance.', 'type' => 'object', 'properties' => [ - 'duration' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'duration', - ], - 'pricingCycle' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Month', - 'backendName' => 'pricingCycle', - ], - 'isAutoRenew' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'isAutoRenew', - ], - 'autoRenewDuration' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - 'backendName' => 'autoRenewDuration', - ], - ], + 'duration' => ['title' => '', 'description' => 'The subscription duration. This parameter is required. You can specify the duration in months or years.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'pricingCycle' => ['title' => '', 'description' => 'The unit of the subscription duration. This parameter is required. Valid values:'."\n" + ."\n" + .'- Year: year'."\n" + .'- Month: month.', 'type' => 'string', 'example' => 'Month'], + 'isAutoRenew' => ['title' => '', 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + .'- false (default): disabled.', 'type' => 'boolean', 'example' => 'true'], + 'autoRenewDuration' => ['title' => '', 'description' => 'The auto-renewal cycle. Unit: month. This parameter is required when **isAutoRenew** is set to **true**. The valid values are the same as those on the buy page.', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + ], + 'example' => '', ], 'ReadWritePolicy' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The parameter settings for the high-availability feature.', 'type' => 'object', 'properties' => [ - 'writeHa' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'writeHa', - ], - 'autoGeneratePk' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'autoGeneratePk', - ], + 'writeHa' => ['title' => '', 'description' => 'Specifies whether to enable the write high-availability feature. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + .'- false: not enabled.', 'type' => 'boolean', 'example' => 'true'], + 'autoGeneratePk' => ['title' => '', 'description' => 'Specifies whether to automatically generate a document hash primary key when no primary key exists. Valid values:'."\n" + ."\n" + .'- true (default): automatically generates a primary key.'."\n" + .'- false: does not automatically generate a primary key.'."\n" + ."\n" + .'><notice> autoGeneratePk cannot be modified independently. The autoGeneratePk setting takes effect only when writeHa is changed from false to true.'."\n" + .'></notice>.', 'type' => 'boolean', 'example' => 'true'], 'writePolicy' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'Temporarily switches between synchronous and asynchronous high availability. Valid values:'."\n" + ."\n" + .'- sync: temporarily switches from asynchronous write high availability to synchronous write.'."\n" + .'- async: restores asynchronous write high availability after synchronous write is temporarily enabled.'."\n" + ."\n" + .'> This field takes effect only when high availability is enabled, that is, writeHa is set to true. You do not need to pass in the writeHa field when setting this field.', 'type' => 'string', 'example' => 'sync', - 'backendName' => 'writePolicy', - 'enum' => [ - 'sync', - 'async', - ], + 'enum' => ['sync', 'async'], ], ], + 'example' => '', ], 'Tag' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The label information.', 'type' => 'object', 'properties' => [ - 'tagKey' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'env', - 'backendName' => 'tagKey', - ], - 'tagValue' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'dev', - 'backendName' => 'tagValue', - ], + 'tagKey' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'example' => 'env'], + 'tagValue' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'example' => 'dev'], ], + 'example' => '', ], 'WarmNodeConfiguration' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The configuration information of cold data nodes.', 'type' => 'object', 'properties' => [ 'diskType' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The storage type of cold data nodes. Only cloud_efficiency (ultra cloud disk) is supported.', 'type' => 'string', 'required' => false, 'example' => 'cloud_efficiency', - 'backendName' => 'diskType', - 'enum' => [ - 'cloud_efficiency', - ], - ], - 'diskEncryption' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'backendName' => 'diskEncryption', - 'default' => 'false', - ], - 'amount' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '3', - 'backendName' => 'amount', + 'enum' => ['cloud_efficiency'], ], + 'diskEncryption' => ['title' => '', 'description' => 'Specifies whether to enable cloud disk encryption for cold data nodes. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + .'- false: not enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], + 'amount' => ['title' => '', 'description' => 'The number of cold data nodes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '3'], 'spec' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The node specifications of cold data nodes. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'required' => true, 'example' => 'elasticsearch.sn2ne.large', - 'backendName' => 'spec', 'enum' => [ - 'elasticsearch.sn1ne.large.new', - 'elasticsearch.sn2ne.large.new', - 'elasticsearch.sn1ne.xlarge.new', - 'elasticsearch.sn2ne.xlarge.new', - 'elasticsearch.sn1ne.2xlarge.new', - 'elasticsearch.sn2ne.2xlarge.new', - 'elasticsearch.sn1ne.4xlarge.new', - 'elasticsearch.sn2ne.4xlarge.new', - 'elasticsearch.sn1ne.8xlarge.new', - 'elasticsearch.ic5.large', - 'elasticsearch.sn1ne.large', - 'elasticsearch.sn2ne.large', - 'elasticsearch.r5.large', - 'elasticsearch.ic5.xlarge', - 'elasticsearch.sn1ne.xlarge', - 'elasticsearch.sn2ne.xlarge', - 'elasticsearch.r5.xlarge', - 'elasticsearch.ic5.2xlarge', - 'elasticsearch.sn1ne.2xlarge', - 'elasticsearch.sn2ne.2xlarge', - 'elasticsearch.r5.2xlarge', - 'elasticsearch.ic5.3xlarge', - 'elasticsearch.ic5.4xlarge', - 'elasticsearch.sn1ne.4xlarge', - 'elasticsearch.sn2ne.4xlarge', - 'openstore.i2g.4xlarge', - 'elasticsearch.r6.4xlarge', - 'elasticsearch.sn1ne.8xlarge', - 'elasticsearch.sn2ne.8xlarge', - 'elasticsearch.r6.8xlarge', - 'group.c6.large.200', - 'group.c6.large.500', - 'group.c6.large.1t', - 'group.g6.large.1t', - 'group.g6.large.2t', - 'group.g6.xlarge.2t', - 'group.g6.xlarge.4t', - 'group.g6.2xlarge.4t', - 'group.g6.2xlarge.8t', - 'group.c6.4xlarge.8t', - 'group.c6.4xlarge.16t', - 'elasticsearch.d1.2xlarge', - 'elasticsearch.d1.4xlarge', - 'elasticsearch.d2s.5xlarge', + 'elasticsearch.sn1ne.large.new', 'elasticsearch.sn2ne.large.new', 'elasticsearch.sn1ne.xlarge.new', 'elasticsearch.sn2ne.xlarge.new', 'elasticsearch.sn1ne.2xlarge.new', 'elasticsearch.sn2ne.2xlarge.new', 'elasticsearch.sn1ne.4xlarge.new', 'elasticsearch.sn2ne.4xlarge.new', 'elasticsearch.sn1ne.8xlarge.new', 'elasticsearch.ic5.large', 'elasticsearch.sn1ne.large', 'elasticsearch.sn2ne.large', 'elasticsearch.r5.large', 'elasticsearch.ic5.xlarge', 'elasticsearch.sn1ne.xlarge', 'elasticsearch.sn2ne.xlarge', 'elasticsearch.r5.xlarge', 'elasticsearch.ic5.2xlarge', 'elasticsearch.sn1ne.2xlarge', 'elasticsearch.sn2ne.2xlarge', + 'elasticsearch.r5.2xlarge', 'elasticsearch.ic5.3xlarge', 'elasticsearch.ic5.4xlarge', 'elasticsearch.sn1ne.4xlarge', 'elasticsearch.sn2ne.4xlarge', 'openstore.i2g.4xlarge', 'elasticsearch.r6.4xlarge', 'elasticsearch.sn1ne.8xlarge', 'elasticsearch.sn2ne.8xlarge', 'elasticsearch.r6.8xlarge', 'group.c6.large.200', 'group.c6.large.500', 'group.c6.large.1t', 'group.g6.large.1t', 'group.g6.large.2t', 'group.g6.xlarge.2t', 'group.g6.xlarge.4t', 'group.g6.2xlarge.4t', 'group.g6.2xlarge.8t', 'group.c6.4xlarge.8t', + 'group.c6.4xlarge.16t', 'elasticsearch.d1.2xlarge', 'elasticsearch.d1.4xlarge', 'elasticsearch.d2s.5xlarge', ], ], - 'disk' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '20480', - 'minimum' => '500', - 'example' => '500', - 'backendName' => 'disk', - ], + 'disk' => ['title' => '', 'description' => 'The storage space size of cold data nodes, in GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '20480', 'minimum' => '500', 'example' => '500'], 'performanceLevel' => [ 'title' => '', - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The performance level (PL) of the ESSD cloud disk. This parameter is required when the disk type of cold data nodes is a standard SSD. Valid values: PL1, PL2, and PL3.', 'type' => 'string', 'required' => false, 'example' => 'PL1', - 'backendName' => 'performanceLevel', - 'enum' => [ - 'PL0', - 'PL1', - 'PL2', - 'PL3', - ], + 'enum' => ['PL0', 'PL1', 'PL2', 'PL3'], ], ], 'required' => false, + 'example' => '', ], 'WhiteIpGroup' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The IP address whitelist group.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'test_group', - 'backendName' => 'groupName', - ], - 'WhiteIpType' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'PRIVATE_ES', - 'backendName' => 'whiteIpType', - ], + 'groupName' => ['title' => '', 'description' => 'The name of the IP address whitelist group.', 'type' => 'string', 'example' => 'test_group'], + 'WhiteIpType' => ['title' => '', 'description' => 'The type of the IP address whitelist. Valid values:'."\n" + ."\n" + .'- PRIVATE_ES: Elasticsearch private network access whitelist'."\n" + .'- PUBLIC_ES: Elasticsearch public network access whitelist'."\n" + .'- PRIVATE_KIBANA: Kibana private network access whitelist'."\n" + .'- PUBLIC_KIBANA: Kibana public network access whitelist.', 'type' => 'string', 'example' => 'PRIVATE_ES'], 'ips' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The list of IP addresses in the whitelist group.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => '["10.2.xx.xx", "10.3.xx.xx"]', - 'extendType' => 'true', - ], - 'backendName' => 'ips', + 'items' => ['description' => 'The list of IP addresses in the whitelist group.', 'type' => 'string', 'example' => '["10.2.xx.xx", "10.3.xx.xx"]', 'title' => ''], + 'example' => '', ], ], + 'example' => '', ], 'ZoneInfo' => [ 'title' => '', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The zone information.', 'type' => 'object', 'properties' => [ - 'status' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'NORMAL', - 'backendName' => 'status', - ], - 'zoneId' => [ - 'title' => '', - 'description' => '', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - 'backendName' => 'zoneId', - ], + 'status' => ['title' => '', 'description' => 'The zone status. Valid values:'."\n" + ."\n" + .'- ISOLATION: offline'."\n" + .'- NORMAL: Normal.', 'type' => 'string', 'example' => 'NORMAL'], + 'zoneId' => ['title' => '', 'description' => 'The zone ID, which uniquely identifies the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-b'], ], + 'example' => '', ], ], ], 'apis' => [ - 'CloseManagedIndex' => [ - 'summary' => 'Disable Managed Index', - 'path' => '/openapi/instances/{InstanceId}/indices/{Index}/close-managed', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ActivateZones' => [ + 'summary' => 'Resumes an offline zone. This operation is valid only for multi-zone instances.', + 'path' => '/openapi/instances/{InstanceId}/actions/recover-zones', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-m7r24d27d007q****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Used to ensure the idempotency of the request. Generated by the client, it must be unique across different requests and not exceed 64 ASCII characters.', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'Index', - 'in' => 'path', - 'schema' => [ - 'description' => 'Index name. For parameter information, see [ListDataStreams](~~213188~~).', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test-index1', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '空', 'title' => ''], ], ], 'responses' => [ @@ -2257,119 +892,98 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Indicates whether the index\'s cloud management has been successfully closed:'."\n" - ."\n" - .'- true: Success'."\n" - ."\n" - .'- false: Failure', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + .'- true: The zone is resumed.'."\n" + .'- false: The zone failed to be resumed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A5D8E74-565C-43DC-B031-29289FA****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CloseManagedIndex', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'CreateDataStream' => [ - 'summary' => '创建数据流', - 'path' => '/openapi/instances/{InstanceId}/data-streams', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5A5D8E74-565C-43DC-B031-29289FA****\\"\\n}","type":"json"}]', + 'title' => 'Resume an offline zone', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateZones'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ActivateZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'AddConnectableCluster' => [ + 'path' => '/openapi/instances/{InstanceId}/connected-clusters', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082****', - ], + 'schema' => ['description' => 'The current instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF***', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Instance ID of the remote instance. Specifies instance ID of the remote instance with which you want to establish network connectivity. The remote instance must be in the same virtual private cloud (VPC) as the current instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{ "instanceId":"es-cn-09k1rgid9000g****" }', 'title' => ''], ], ], 'responses' => [ @@ -2377,117 +991,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ds-', - ], - ], - ], + 'Result' => ['description' => 'The result. Valid values:'."\n" + ."\n" + .'- true: The configuration succeeded.'."\n" + .'- false: The configuration failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A5D8E74-565C-43DC-B031-29289FA****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": {\\n \\"name\\": \\"ds-\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5A5D8E74-565C-43DC-B031-29289FA****\\"\\n}","type":"json"}]', + 'title' => 'Configure instance network connectivity', + 'summary' => 'Configures network connectivity to establish a connection between different instances.', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateILMPolicy' => [ - 'summary' => '创建索引生命周期策略', - 'path' => '/openapi/instances/{InstanceId}/ilm-policies', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-29T17:13:55.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddConnectableCluster'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:AddConnectableCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'AddSnapshotRepo' => [ + 'path' => '/openapi/instances/{InstanceId}/snapshot-repos', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-m7r23wodb006n****', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The instance ID of the target instance for which you want to configure cross-cluster OSS repository Settings.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The cross-cluster backup information, which specifies the reference instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{'."\n" + .' "repoPath" :"es-cn-4591jumei000u****"'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ @@ -2495,309 +1087,564 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my-policy', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'Result' => ['description' => 'The result. Valid values:'."\n" + ."\n" + .'- true: The reference repository is created.'."\n" + .'- false: The reference repository failed to be created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"my-policy\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateILMPolicy', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Create a reference repository', + 'summary' => 'Creates a reference repository when setting up a cross-cluster OSS repository.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the cross-cluster backup information, which specifies the reference instance.'."\n" + ."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'|------|------|-----------|---------|------|'."\n" + .'| repoPath| String | Yes | es-cn-4591jumei000u**** |The source instance from which you want to restore data. To obtain the parameter information, see [ListAlternativeSnapshotRepos](~~178514~~). After you specify this parameter, Elasticsearch creates a snapshot reference repository for the source instance, from which you can restore data.<br>The source and target instances must meet the following conditions:<br>They are in the same region. They belong to the same account. The version of the source instance is earlier than or equal to the version of the target instance. For more information about the limits, see [Set up a cross-cluster OSS repository](~~131441~~). |'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "repoPath" :"es-cn-4591jumei000u****"'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateIndexTemplate' => [ - 'summary' => '创建索引模版', - 'path' => '/openapi/instances/{InstanceId}/index-templates', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSnapshotRepo'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:AddSnapshotRepo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'CancelDeletion' => [ + 'summary' => 'Recovers a frozen Elasticsearch instance that was released.', + 'path' => '/openapi/instances/{InstanceId}/actions/cancel-deletion', + 'methods' => ['post'], + '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' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-z2q1wk6z00007****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'Indicates whether the instance is recovered. Valid values:'."\n" + ."\n" + .'- true: The instance is recovered.'."\n" + .'- false: The instance failed to be recovered.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D682B6B3-B425-46DA-A5FC-5F5C60553622', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"D682B6B3-B425-46DA-A5FC-5F5C60553622\\"\\n}","type":"json"}]', + 'title' => 'Recover a frozen instance after release', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:47:43.000Z', 'description' => 'Error codes changed'], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelDeletion'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CancelDeletion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'CancelLogstashDeletion' => [ + 'path' => '/openapi/logstashes/{InstanceId}/actions/cancel-deletion', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-m7r1vsi2****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. The client generates this value. The value must be unique among different requests and can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'Indicates whether the instance is successfully resumed. Valid values:'."\n" + ."\n" + .'- true: The instance is successfully resumed.'."\n" + .'- false: The instance failed to be resumed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '23EBF56B-2DC0-4507-8BE5-B87395DB0FEB', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w24n9u900am****', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"23EBF56B-2DC0-4507-8BE5-B87395DB0FEB\\"\\n}","type":"json"}]', + 'title' => 'Resume a frozen instance after release', + 'summary' => 'Resumes a frozen Logstash instance that was frozen after release.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:08.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelLogstashDeletion'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ClientToken', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CancelLogstashDeletion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ], + ], + ], + ], + ], + 'CancelTask' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/cancel-task', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'taskType', + 'in' => 'query', + 'schema' => ['description' => 'The task type. Set this parameter to MigrateData, which indicates a data migration task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MigrateData', 'title' => ''], + ], + [ + 'name' => 'clientToken', 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- true: The task was canceled.'."\n" + .'- false: The task failed to be canceled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'E1136AE9-4E49-4585-9358-6FDD2A6D****', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Cancel a data migration task', + 'summary' => 'Cancels a running data migration task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:08.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CancelTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], + ], + ], + 'CapacityPlan' => [ + 'summary' => 'Recommends optimal cluster capacity planning configurations based on business scenarios, QPS, and log generation volume.', + 'path' => '/openapi/assist/actions/capacity-plan', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request parameters.', 'type' => 'object', 'properties' => [ - 'indexTemplate' => [ - 'title' => '索引模版名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'index-template', - ], - 'indexPatterns' => [ - 'title' => '索引匹配模式正则', - 'description' => '', + 'complexQueryAvailable' => ['description' => 'Specifies whether complex aggregate query is required. Valid values:'."\n" + ."\n" + .'- true: Required.'."\n" + .'- false (default): Not required.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'dataInfo' => [ + 'description' => 'The disk usage information.', 'type' => 'array', 'items' => [ - 'title' => '索引匹配模式正则元素', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '["schema1*","schema2*"]', + 'description' => 'The dataInfo information.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The disk data metric code. Valid values:'."\n" + ."\n" + .'- totalRawData: source data information'."\n" + .'- document: data document information, estimated number of documents'."\n" + .'- dailyIncrement: daily data growth'."\n" + .'- dailyIncrement: daily incremental documents'."\n" + .'- retentionTime: data retention period'."\n" + .'- replica: replica settings.', 'type' => 'string', 'required' => false, 'example' => 'totalRawData', 'title' => ''], + 'size' => ['description' => 'The metric value of disk usage.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'type' => ['description' => 'The disk data type. Valid values:'."\n" + ."\n" + .'- hot: hot data'."\n" + .'- warm: warm data.', 'type' => 'string', 'required' => false, 'example' => 'hot', 'title' => ''], + 'unit' => ['description' => 'The data unit or time unit. Valid values:'."\n" + ."\n" + .'- Data units: MiB, GiB, TB, PB'."\n" + .'- Time units: DAYS, WEEKS, MONTHS, YEARS.', 'type' => 'string', 'required' => false, 'example' => 'MiB', 'title' => ''], + 'totalCount' => ['description' => 'The total number of data entries.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10000', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - 'minItems' => 1, - ], - 'dataStream' => [ - 'title' => '是否同时自动创建数据流', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], - 'priority' => [ - 'title' => '优先级。数组越大，优先级越高。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '30', - 'default' => '0', - ], - 'ilmPolicy' => [ - 'title' => '生命周期策略名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'policy-1', + 'title' => '', + 'example' => '', ], - 'template' => [ - 'title' => '模版设置。详情见：https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html#multiple-component-templates', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'settings' => [ - 'title' => 'settings设置', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"index.number_of_shards\\":\\"1\\"}', - ], - 'mappings' => [ - 'title' => 'mappings设置', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}', - ], - 'aliases' => [ - 'title' => 'aliases设置', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"mydata\\":{}}', + 'metric' => [ + 'description' => 'The metric information, including disk usage, search and write operations, and aggregation requests.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric parameter information.', + 'type' => 'object', + 'properties' => [ + 'code' => ['description' => 'The search or write metric code. Valid values:'."\n" + ."\n" + .'- write: write'."\n" + .'- search: search.', 'type' => 'string', 'required' => false, 'example' => 'write', 'title' => ''], + 'concurrent' => ['description' => 'The number of concurrent connections.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + 'throughput' => ['description' => 'The throughput, in MB/s.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'type' => ['description' => 'The search or write peak type. Valid values:'."\n" + ."\n" + .'- common: normal'."\n" + .'- peak: peak.', 'type' => 'string', 'required' => false, 'example' => 'common', 'title' => ''], + 'peakQps' => ['description' => 'The peak QPS.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'averageQps' => ['description' => 'The average QPS.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'responseTime' => ['description' => 'The expected average response time, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], + 'usageScenario' => ['description' => 'Scenarios. Valid values:'."\n" + ."\n" + .'- general: general-purpose scenario'."\n" + .'- analysisVisualization: data analytics scenario'."\n" + .'- dbAcceleration: database acceleration scenario'."\n" + .'- search: search scenario'."\n" + .'- log: log scenario.', 'type' => 'string', 'required' => false, 'example' => 'general', 'title' => ''], ], 'required' => false, - 'docRequired' => false, - 'example' => '{ "indexTemplate": "index-template", "indexPatterns": [ "schema1*", "schema2*" ], "dataStream": true, "priority": 30, "ilmPolicy": "policy-1", "template": { "settings": "{\\"index.number_of_shards\\":\\"1\\"}", "mappings": "{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}", "aliases": "{\\"mydata\\":{}}" } }', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E91B7129-A669-4D9D-A743-F90A0FF1F5EF', 'title' => ''], 'Result' => [ - 'title' => '索引模版名称', - 'description' => '', - 'type' => 'string', - 'example' => 'index-template', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', + 'description' => 'The result of the request.', + 'type' => 'object', + 'properties' => [ + 'ExtendConfigs' => [ + 'description' => 'The extended configuration information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ExtendConfigs information.', + 'type' => 'object', + 'properties' => [ + 'ConfigType' => ['description' => 'The configuration type. The only valid value is sharedDisk.'."\n" + ."\n" + .'> This extendConfigs property may appear when the planned instance type is Advanced Edition (advanced).', 'type' => 'string', 'example' => 'sharedDisk', 'title' => ''], + 'Disk' => ['description' => 'The disk size, in GiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '2048', 'title' => ''], + 'DiskType' => ['description' => 'The disk type. The only valid value is CPFS_PREMIUM.'."\n" + ."\n" + .'> This extendConfigs property may appear when the planned instance type is Advanced Edition (advanced).', 'type' => 'string', 'example' => 'CPFS_PREMIUM', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'InstanceCategory' => ['description' => 'The edition type. Valid values:'."\n" + ."\n" + .'- advanced: Advanced Edition'."\n" + ."\n" + .'- x-pack: Commercial Edition'."\n" + ."\n" + .'- community: Community Edition.', 'type' => 'string', 'example' => 'advanced', 'title' => ''], + 'NodeConfigurations' => [ + 'description' => 'The node information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The NodeConfigurations information.', + 'type' => 'object', + 'properties' => [ + 'Amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Cpu' => ['description' => 'The number of CPUs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Disk' => ['description' => 'The disk size, in GiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'DiskType' => ['description' => 'The disk type. Valid values:'."\n" + ."\n" + .'- cloud_essd: ESSD'."\n" + ."\n" + .'- cloud_ssd: standard SSD'."\n" + ."\n" + .'- cloud_efficiency: ultra cloud disk'."\n" + ."\n" + .'- local_ssd: local SSD'."\n" + ."\n" + .'- local_efficiency: local ultra disk.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'Memory' => ['description' => 'The memory size of the specifications for the current node role.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'NodeType' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'- WORKER: data node'."\n" + ."\n" + .'- WORKER_WARM: warm node'."\n" + ."\n" + .'- MASTER: dedicated master node'."\n" + ."\n" + .'- KIBANA: Kibana node'."\n" + ."\n" + .'- COORDINATING: client node'."\n" + ."\n" + .'- ELASTIC_WORKER: elastic node.', 'type' => 'string', 'example' => 'WORKER', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OversizedCluster' => ['description' => 'The result calculated based on capacity planning. No default value is available. Valid values:'."\n" + ."\n" + .'- true: The cluster is oversized. The number of data nodes calculated by capacity planning exceeds the threshold of 50.'."\n" + ."\n" + .'- false: The number of data nodes calculated by capacity planning is within 50.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"index-template\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E91B7129-A669-4D9D-A743-F90A0FF1F5EF\\",\\n \\"Result\\": {\\n \\"ExtendConfigs\\": [\\n {\\n \\"ConfigType\\": \\"sharedDisk\\",\\n \\"Disk\\": 2048,\\n \\"DiskType\\": \\"CPFS_PREMIUM\\"\\n }\\n ],\\n \\"InstanceCategory\\": \\"advanced\\",\\n \\"NodeConfigurations\\": [\\n {\\n \\"Amount\\": 10,\\n \\"Cpu\\": 1,\\n \\"Disk\\": 20,\\n \\"DiskType\\": \\"cloud_ssd\\",\\n \\"Memory\\": 2,\\n \\"NodeType\\": \\"WORKER\\"\\n }\\n ],\\n \\"OversizedCluster\\": true\\n }\\n}","type":"json"}]', + 'title' => 'Capacity planning', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDataStream' => [ - 'summary' => '删除数据流', - 'path' => '/openapi/instances/{InstanceId}/data-streams/{DataStream}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CapacityPlan'], + ], ], + 'ramActions' => [], + ], + 'CloseDiagnosis' => [ + 'summary' => 'Disables the intelligent O&M feature for an instance.', + 'path' => '/openapi/diagnosis/instances/{InstanceId}/actions/close-diagnosis', + 'methods' => ['post'], + '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' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-s9dsk3k4k****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'DataStream', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ds-001', - ], + 'name' => 'lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response. Default value: the browser language. Valid values:'."\n" + ."\n" + .'- en: English'."\n" + .'- zh: Simplified Chinese'."\n" + .'- zt: Traditional Chinese'."\n" + .'- es: Spanish'."\n" + .'- fr: French.', 'type' => 'string', 'required' => false, 'example' => 'spanish', 'title' => ''], ], ], 'responses' => [ @@ -2805,66 +1652,76 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'Result' => ['description' => 'Indicates whether the intelligent O&M feature is disabled. Valid values:'."\n" + ."\n" + .'- true: Succeeded.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Disable the intelligent O&M feature for an instance', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteILMPolicy' => [ - 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:42.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-09-13T03:46:42.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseDiagnosis'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CloseDiagnosis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'CloseHttps' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/close-https', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2872,35 +1729,17 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '64235', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'PolicyName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'slm-history-ilm-policy', - ], + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. The client generates this value. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****', 'title' => ''], ], ], 'responses' => [ @@ -2908,106 +1747,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '694FDC20-0FDD-47C4-B921-BFF902FA****', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The HTTPS protocol is disabled.'."\n" + .'- false: The HTTPS protocol failed to be disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"694FDC20-0FDD-47C4-B921-BFF902FA****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteILMPolicy', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC****\\"\\n}","type":"json"}]', + 'title' => 'Disable HTTPS protocol', + 'summary' => 'Disables the HTTPS protocol for a cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteIndexTemplate' => [ - 'summary' => 'Deletes a top index template.', - 'path' => '/openapi/instances/{InstanceId}/index-templates/{IndexTemplate}', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:08.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseHttps'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CloseHttps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'CloseManagedIndex' => [ + 'summary' => 'Disables the cloud managed feature for a specified index in an Indexing Service cluster. This operation is irreversible. After the feature is disabled, it cannot be enabled again.', + 'path' => '/openapi/instances/{InstanceId}/indices/{Index}/close-managed', + 'methods' => ['post'], + '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' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-m7r24d27d007q****', 'title' => ''], ], [ - 'name' => 'IndexTemplate', + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'Index', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'index-name', - ], + 'schema' => ['description' => 'The index name. For more information, see [ListDataStreams](~~213188~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-index1', 'title' => ''], ], ], 'responses' => [ @@ -3015,98 +1856,165 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A0761F7E-0B50-46B9-8CAA-EBB3A420****', - ], + 'Result' => ['description' => 'Indicates whether the cloud managed feature for the index is disabled. Valid values:'."\n" + ."\n" + .'- true: The feature is disabled.'."\n" + ."\n" + .'- false: The feature failed to be disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"A0761F7E-0B50-46B9-8CAA-EBB3A420****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteIndexTemplate', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Disable index hosting', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeILMPolicy' => [ - 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:47:43.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseManagedIndex'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CloseManagedIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], + ], + ], + 'CreateCollector' => [ + 'summary' => 'Creates a collector to collect data from a specified service.', + 'path' => '/openapi/collectors', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082****', - ], + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'PolicyName', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'policy-1', + 'description' => 'The request body parameters. Used to specify the configuration information of the collector to create.', + 'type' => 'object', + 'properties' => [ + 'dryRun' => ['title' => '', 'description' => 'Specifies whether to perform only a dry run without performing the actual request. This parameter is used only when you create or update a collector. Valid values:'."\n" + ."\n" + .'- true: performs only a dry run without creating or updating the collector.'."\n" + .'- false: performs a dry run and sends the request.', 'type' => 'boolean', 'required' => true, 'default' => 'false', 'example' => 'true'], + 'name' => ['title' => '', 'description' => 'The name of the collector. The name must be 1 to 30 characters in length, start with an uppercase or lowercase letter, and can contain letters, digits, underscores (_), or hyphens (-).', 'type' => 'string', 'required' => true, 'example' => 'ct-test'], + 'resType' => [ + 'title' => '', + 'description' => 'The type of the collector. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.', + 'type' => 'string', + 'required' => true, + 'example' => 'fileBeat', + 'enum' => ['fileBeat', 'metricBeat', 'heartBeat', 'auditBeat'], + ], + 'vpcId' => ['title' => '', 'description' => 'The ID of the virtual private cloud (VPC) where the collector resides.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp12nu14urf0upaf*****'], + 'resVersion' => [ + 'title' => '', + 'description' => 'The version of the collector. Valid values:'."\n" + .'- ECS-based deployment: 6.8.5_with_community'."\n" + .'- ACK-based deployment: 6.8.13_with_community.', + 'type' => 'string', + 'required' => true, + 'example' => '6.8.5_with_community', + 'enum' => ['6.8.13_with_community', '6.8.5_with_community'], + ], + 'collectorPaths' => [ + 'title' => '', + 'description' => 'The collection paths of fileBeat. This parameter is required only when the collector is deployed on ECS instances.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The collection paths of fileBeat. This parameter is required only when the collector is deployed on ECS instances.', 'type' => 'string', 'example' => '["/var/log"]', 'required' => false], + 'required' => false, + 'example' => '', + ], + 'configs' => [ + 'title' => '', + 'description' => 'The configuration file information of the collector.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The configuration file information of the collector.', + 'type' => 'object', + 'properties' => [ + 'fileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'filebeat.yml'], + 'content' => ['title' => '', 'description' => 'The file content.', 'type' => 'string', 'required' => true, 'example' => '"filebeat.inputs:xxx"'], + ], + 'required' => true, + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + 'extendConfigs' => [ + 'title' => '', + 'description' => 'The extended configurations of the collector.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The extension configurations of the collector. For details, see the extendConfigs parameter description section below.', 'type' => 'object', 'required' => true, 'example' => '{ "instanceId": "es-cn-nif201ihd0012****", "instanceType": "elasticsearch", "configType": "collectorTargetInstance", "hosts": [ "es-cn-nif201ihd0012****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "*****", "protocol": "HTTP" }, { "type": "ECSInstanceId", "configType": "collectorDeployMachine", "machines": [ { "instanceId": "i-bp11u91xgubypcuz****" } ] } ]'], + 'required' => true, + 'example' => '', + ], + ], + 'required' => false, + 'docRequired' => false, + 'example' => '{ "dryRun": false, "name": "test_beats_1", "resType": "fileBeat", "resVersion": "6.8.5_with_community", "vpcId": "vpc-bp12nu14urf0upaf*****", "collectorPaths": [ "/var/log" ], "configs": [ { "fileName": "filebeat.yml", "content": "filebeat.inputs:xxx" } ] }', + 'title' => '', ], ], ], @@ -3115,276 +2023,241 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FF44681E-FD41-4FDE-B8DF-295DCDD6****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8466BDFB-C513-4B8D-B4E3-5AB256AB****', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ilm-history-ilm-policy', - ], - 'phases' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{"cold":{"minAge":"30d","actions":{"allocate":{"numberOfReplicas":1,"require":{"boxType":"warm"}},"setPriority":{"priority":100}}},"hot":{"minAge":"0s","actions":{"rollover":{"maxAge":"30d","maxDocs":10000,"maxSize":"50gb"},"setPriority":{"priority":1000}}},"delete":{"minAge":"30d","actions":{"delete":{}}}}', - ], + 'resId' => ['description' => 'The ID of the collector that is created.', 'type' => 'string', 'example' => 'ct-cn-4135is2tj194p****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF44681E-FD41-4FDE-B8DF-295DCDD6****\\",\\n \\"Result\\": {\\n \\"name\\": \\"ilm-history-ilm-policy\\",\\n \\"phases\\": {\\n \\"cold\\": {\\n \\"minAge\\": \\"30d\\",\\n \\"actions\\": {\\n \\"allocate\\": {\\n \\"numberOfReplicas\\": 1,\\n \\"require\\": {\\n \\"boxType\\": \\"warm\\"\\n }\\n },\\n \\"setPriority\\": {\\n \\"priority\\": 100\\n }\\n }\\n },\\n \\"hot\\": {\\n \\"minAge\\": \\"0s\\",\\n \\"actions\\": {\\n \\"rollover\\": {\\n \\"maxAge\\": \\"30d\\",\\n \\"maxDocs\\": 10000,\\n \\"maxSize\\": \\"50gb\\"\\n },\\n \\"setPriority\\": {\\n \\"priority\\": 1000\\n }\\n }\\n },\\n \\"delete\\": {\\n \\"minAge\\": \\"30d\\",\\n \\"actions\\": {\\n \\"delete\\": {}\\n }\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeILMPolicy', - 'requestParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeIndexTemplate' => [ - 'path' => '/openapi/instances/{InstanceId}/index-templates/{IndexTemplate}', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8466BDFB-C513-4B8D-B4E3-5AB256AB****\\",\\n \\"Result\\": {\\n \\"resId\\": \\"ct-cn-4135is2tj194p****\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create a collector', + 'requestParamsDescription' => '## extendConfigs parameter description'."\n" + .'The parameters in extendConfigs are described as follows.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- | ---- |'."\n" + .'| extendConfigs| Array | | | The extension configurations of the collector.|'."\n" + .'| └configType | String | Yes | collectorElasticsearchForKibana | The configuration type. Valid values: collectorTargetInstance (collector output), collectorDeployMachine (deployment machine of the collector), and collectorElasticsearchForKibana (Elasticsearch instance information that supports Kibana dashboards).|'."\n" + .'| └type| String | No | ECSInstanceId | The type of machine on which the collector is deployed. Valid values: ECSInstanceId (ECS) and ACKCluster (Container Service for Kubernetes). Required when **configType** is set to **collectorDeployMachine**.|'."\n" + .'| └instanceType| String | No | elasticsearch | The type of instance specified for the collector output. Valid values: elasticsearch and logstash. Required when **configType** is set to **collectorTargetInstance**.|'."\n" + .'| └instanceId | String | Yes | es-cn-nif201ihd0012**** | The ID of the instance associated with the collector. When **configType** is set to **collectorTargetInstance**, this parameter specifies the instance ID of the collector output. When **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**, this parameter specifies the ACK cluster ID.|'."\n" + .'| └machines| Array | No | | The list of ECS instances on which the collector is deployed. Required when **configType** is set to **collectorDeployMachines** and **type** is set to **ECSInstanceId**.|'."\n" + .'| └└instanceId | String | Yes | i-bp11u91xgubypcuz**** | The list of ECS instance IDs.|'."\n" + .'| └groupId | String | | default_ct-cn-5i2l75bz4776**** | The machine group ID. Required when **configType** is set to **collectorDeployMachine**. |'."\n" + .'| └protocol | String | No | HTTP | The transport protocol. The value must be the same as the access protocol of the instance specified for the collector output. Valid values: HTTP and HTTPS. Required when **configType** is set to **collectorTargetInstance**.|'."\n" + .'| └userName| String | No | elastic | The username used to access the instance specified for the collector output. Default value: elastic. Required when **configType** is set to **collectorTargetInstance** or **collectorElasticsearchForKibana**.|'."\n" + .'| └password| String | No | \\***** | The password that corresponds to the username.|'."\n" + .'| └enableMonitoring| Boolean | No | true | Specifies whether to enable Monitoring. Required when **configType** is set to **collectorTargetInstance** and **instanceType** is set to **elasticsearch**. Valid values: true (enabled) and false (disabled).|'."\n" + .'| └hosts| List<String> | No | ["es-cn-nif201i\\*****.elasticsearch.aliyuncs.com:9200"] | The list of access addresses of the instance specified for the collector output. Required when **configType** is set to **collectorTargetInstance**.|'."\n" + .'| └host | String | No | es-cn-nif201ihd0012****-kibana.internal.elasticsearch.aliyuncs.com:5601 | The private endpoint of Kibana after Kibana Dashboard is enabled. Required when **configType** is set to **collectorElasticsearchForKibana**.|'."\n" + .'| └kibanaHost| String | No | https://es-cn-nif201ihd0012****.kibana.elasticsearch.aliyuncs.com:5601 | The public endpoint of Kibana after Kibana Dashboard is enabled. Required when **configType** is set to **collectorElasticsearchForKibana**.|'."\n" + ."\n\n" + .'> └ indicates a child parameter.'."\n" + ."\n" + .'**extendConfigs** includes three configType values: collectorTargetInstance, collectorElasticsearchForKibana, and collectorDeployMachine. The required parameters vary depending on the deployment machine type. The specific combinations are as follows:'."\n" + ."\n" + .'- collectorTargetInstance'."\n" + .' - ECS'."\n" + .' configType, instanceId, instanceType, hosts, userName, password, protocol, enableMonitoring'."\n" + .' - ACK'."\n" + .' configType, instanceId, instanceType, userName, password, protocol, enableMonitoring'."\n" + ."\n" + .'- collectorElasticsearchForKibana'."\n" + .' - ECS'."\n" + .' configType, instanceId, host, kibanaHost, userName, password, protocol'."\n" + .' - ACK'."\n" + .' configType'."\n" + .' '."\n" + .'- collectorDeployMachine'."\n" + .' - ECS'."\n" + .' configType, type, machines, groupId'."\n" + .' - ACK'."\n" + .' configType, type, instanceId.', + 'changeSet' => [ + ['createdAt' => '2022-12-28T07:21:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:47:43.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCollector'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateComponentIndex' => [ + 'summary' => 'Creates an Elasticsearch composable template.', + 'path' => '/openapi/instances/{InstanceId}/component-index/{name}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w24n9u900am****', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-tl329rbpc0001****'], ], [ - 'name' => 'IndexTemplate', + 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'data-stream-default', - ], + 'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'template', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '25DB38F8-82E4-4D16-82BB-FF077C7F****', - ], - 'Result' => [ - 'description' => '', + 'template' => [ + 'description' => 'The composable template information.', 'type' => 'object', 'properties' => [ - 'dataStream' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'indexTemplate' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'data-stream-default', - ], - 'ilmPolicy' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cube_default_ilm_policy', - ], - 'priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'indexPatterns' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ds-*', - ], - ], - 'template' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'settings' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"index.refresh_interval\\":\\"1s\\"}', - ], - 'mappings' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}', - ], - 'aliases' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"mydata\\":{}}', - ], - ], - ], + 'settings' => ['description' => 'The settings configuration of the template.', 'type' => 'object', 'required' => false, 'example' => '{ "index.number_of_replicas": 0 }', 'title' => ''], + 'mappings' => ['description' => 'The mappings configuration of the template.', 'type' => 'object', 'required' => false, 'example' => '{ "properties": { "@timestamp": { "type": "date" } } }', 'title' => ''], + 'aliases' => ['description' => 'The aliases configuration of the template.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + '_meta' => ['description' => 'The metadata, which is used to store information such as remarks.', 'type' => 'object', 'required' => false, 'example' => '{ "description": "set number of shards to one" }', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C20022BA-5382-4339-89FB-30AF48A05431'], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The template was created successfully.'."\n" + .'- false: The template failed to be created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C20022BA-5382-4339-89FB-30AF48A05431\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Create a component', + 'description' => 'For more information, see [Store large volumes of data by using OpenStore](~~317694~~).', + 'changeSet' => [ + ['createdAt' => '2021-12-16T12:46:26.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateComponentIndex'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateComponentIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"25DB38F8-82E4-4D16-82BB-FF077C7F****\\",\\n \\"Result\\": {\\n \\"dataStream\\": true,\\n \\"indexTemplate\\": \\"data-stream-default\\",\\n \\"ilmPolicy\\": \\"cube_default_ilm_policy\\",\\n \\"priority\\": 0,\\n \\"indexPatterns\\": [\\n \\"ds-*\\"\\n ],\\n \\"template\\": {\\n \\"settings\\": \\"{\\\\\\\\\\\\\\"index.refresh_interval\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1s\\\\\\\\\\\\\\"}\\",\\n \\"mappings\\": \\"{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"created_at\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EEE MMM dd HH:mm:ss Z yyyy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"host_name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keyword\\\\\\\\\\\\\\"}}}\\",\\n \\"aliases\\": \\"{\\\\\\\\\\\\\\"mydata\\\\\\\\\\\\\\":{}}\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListDataStreams' => [ - 'summary' => '查询数据流', + 'CreateDataStream' => [ + 'summary' => 'Creates a data stream to manage a set of indexes.', 'path' => '/openapi/instances/{InstanceId}/data-streams', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082****', 'title' => ''], ], [ - 'name' => 'isManaged', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF***', 'title' => ''], ], [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Log1', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -3392,218 +2265,110 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - 'Headers' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + 'Result' => [ + 'description' => 'The name of the created data stream.', 'type' => 'object', 'properties' => [ - 'X-Managed-StorageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '143993923932990', - ], - 'X-Managed-Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'indexTemplateName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'template1', - ], - 'indices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'managedStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'following', - ], - 'size' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15393899', - ], - 'createTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-07-13T03:58:07.253Z', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Log1', - ], - 'health' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Green', - ], - 'isManaged' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my-index-0001', - ], - 'health' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Green', - ], - 'ilmPolicyName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rollver1', - ], - 'totalStorageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1788239393298', - ], - 'managedStorageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1788239393298', - ], - ], + 'name' => ['description' => 'The data stream name.', 'type' => 'string', 'example' => 'ds-', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": {\\n \\"name\\": \\"ds-\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create a data stream', + 'description' => '> The data stream name you create must have a one-to-one correspondence with the index pattern in the index template, and the index template must have the data stream feature enabled. For example, if the index pattern in the index template is ds-\\*, the corresponding data stream name should be ds-.', + 'requestParamsDescription' => 'Specify the following parameters in the RequestBody to define the data stream to be created.'."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'| --- | --- | --- | --- |--- |'."\n" + .'|name|String|Yes|ds-|The data stream name.|.', + 'responseParamsDescription' => '>- If the system returns the **DatastreamUnmatchedIndexTemplateError** message, the data stream does not match any index template. Modify the data stream name, or go to the index template management page to create or modify an index template.- If the system returns the **DatastreamDuplicatedError** message, the data stream already exists. Rename the data stream, or go to the index template management page to create or modify an index template.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-30T17:47:43.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataStream'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateDataStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Headers\\": {\\n \\"X-Managed-StorageSize\\": 143993923932990,\\n \\"X-Managed-Count\\": 100\\n },\\n \\"Result\\": [\\n {\\n \\"indexTemplateName\\": \\"template1\\",\\n \\"indices\\": [\\n {\\n \\"managedStatus\\": \\"following\\",\\n \\"size\\": 15393899,\\n \\"createTime\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"name\\": \\"Log1\\",\\n \\"health\\": \\"Green\\",\\n \\"isManaged\\": false\\n }\\n ],\\n \\"name\\": \\"my-index-0001\\",\\n \\"health\\": \\"Green\\",\\n \\"ilmPolicyName\\": \\"rollver1\\",\\n \\"totalStorageSize\\": 1788239393298,\\n \\"managedStorageSize\\": 1788239393298\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListILMPolicies' => [ + 'CreateILMPolicy' => [ + 'summary' => 'Creates an index lifecycle policy. If a policy with the specified name already exists, the existing policy is replaced and its version is incremented.', 'path' => '/openapi/instances/{InstanceId}/ilm-policies', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-m7r23wodb006n****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-m7r23wodb006n****', 'title' => ''], ], [ - 'name' => 'policyName', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'policy-1', - ], + 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -3611,1691 +2376,1644 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'policy-1', - ], - 'phases' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{"hot":{"minAge":"0ms","actions":{"rollover":{"maxSize":"50gb","maxAge":"30d"},"setPriority":{"priority":100}}},"delete":{"minAge":"3d","actions":{"delete":{}}}}', - ], - ], - ], - ], + 'Result' => ['description' => 'The name of the lifecycle policy that is created.', 'type' => 'string', 'example' => 'my-policy', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n {\\n \\"name\\": \\"policy-1\\",\\n \\"phases\\": {\\n \\"hot\\": {\\n \\"minAge\\": \\"0ms\\",\\n \\"actions\\": {\\n \\"rollover\\": {\\n \\"maxSize\\": \\"50gb\\",\\n \\"maxAge\\": \\"30d\\"\\n },\\n \\"setPriority\\": {\\n \\"priority\\": 100\\n }\\n }\\n },\\n \\"delete\\": {\\n \\"minAge\\": \\"3d\\",\\n \\"actions\\": {\\n \\"delete\\": {}\\n }\\n }\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListILMPolicies', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"my-policy\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Create an index lifecycle policy', + 'requestParamsDescription' => '## RequestBody'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|name|String|my-policy |Yes|The index lifecycle Policy Name.|'."\n" + .'|phases|Map| |No|The content of the index lifecycle policy. For more information, see **Data structure of the phases field**.|'."\n" + ."\n" + .'**Data structure of the phases field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|{key}|Struct| |No|The current lifecycle epoch. The following three epochs are supported: hot (the hot data epoch, in which the index is actively being updated and queried), cold (the cold data epoch, in which the index is no longer updated and is rarely queried. The data still needs to be searchable, but slower query performance is acceptable), and delete (the delete epoch, in which the index is no longer needed and can be safely deleted).|'."\n" + .'|minAge|String|30d|No|The time required for the index to reach the target epoch.|'."\n" + .'|actions|Struct| |No|The policy settings for the current epoch. For more information, see **Data structure of the actions field**.|'."\n" + ."\n" + .'**Data structure of the actions field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|rollver|Struct| |No|The rollover operation for the index in the hot epoch. For more information, see **Data structure of the rollver field**.|'."\n" + .'|setPriority|Struct| |No|The index priority in the hot or cold epoch. For more information, see **Data structure of the setPriority field**.|'."\n" + .'|allocate|Struct| |No|The allocation operation in the cold epoch. For more information, see **Data structure of the allocate field**.|'."\n" + .'|delete|Struct| {} |No|The delete index operation. When the delete epoch is enabled, this parameter is required and must be an empty object.|'."\n" + ."\n" + .'**Data structure of the rollver field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|maxAge|String|30d|No|The time threshold that triggers an index rollover. Specify at least one of maxAge, maxDocs, and maxSize. Unit: d (days) or h (hours).|'."\n" + .'|maxDocs|Integer|10000|No|The document count threshold that triggers an index rollover.|'."\n" + .'|maxSize|String|50gb|No|The index size threshold that triggers an index rollover. Specify at least one of maxAge, maxDocs, and maxSize. Unit: MB or GB.|'."\n" + ."\n" + .'**Data structure of the setPriority field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|priority|Integer|100|No|The default priority of the current node.|'."\n" + ."\n" + .'**Data structure of the allocate field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|numberOfReplicas|Integer|1|No|The number of replicas to allocate. If specified, the default value is 1. This parameter is used together with migrate. When automatic migration is enabled, replica allocation is performed by default.|'."\n" + .'|require |Struct| |No|An optional setting that is available for hot-warm architecture clusters. For more information, see **Data structure of the require field**.|'."\n" + ."\n" + .'**Data structure of the require field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|boxType|String|warm|No|The custom node attribute identifier. This parameter is available for hot-warm architecture clusters and is used to migrate data to warm nodes. Valid values: warm.|', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListIndexTemplates' => [ - 'path' => '/openapi/instances/{InstanceId}/index-templates', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T17:47:42.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateILMPolicy'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateILMPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateIndexTemplate' => [ + 'summary' => 'Creates a cluster index template that can be used for component-based index template settings.', + 'path' => '/openapi/instances/{InstanceId}/index-templates', + 'methods' => ['post'], + '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' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082****', - ], - ], - [ - 'name' => 'indexTemplate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'my-template', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w24n9u900am****', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => 'E1136AE9-4E49-4585-9358-6FDD2A6D****', 'title' => ''], ], [ - 'name' => 'size', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The request body parameters that specify the information about the cluster index template to create.', + 'type' => 'object', + 'properties' => [ + 'indexTemplate' => ['title' => '', 'description' => 'The name of the index template.', 'type' => 'string', 'required' => true, 'example' => 'index-template'], + 'indexPatterns' => [ + 'title' => '', + 'description' => 'The index pattern for matching indexes.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The index pattern for matching indexes.', 'type' => 'string', 'required' => true, 'example' => '["schema1*","schema2*"]'], + 'required' => true, + 'minItems' => 1, + 'example' => '', + ], + 'dataStream' => ['title' => '', 'description' => 'Specifies whether to enable data streams. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + .'- false (default): disabled.', 'type' => 'boolean', 'required' => true, 'example' => 'false'], + 'priority' => ['title' => '', 'description' => 'The priority of the cluster index template.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '0', 'example' => '30', 'default' => '0', 'required' => false], + 'ilmPolicy' => ['title' => '', 'description' => 'The Policy Name of the index lifecycle management (ILM) epoch.', 'type' => 'string', 'example' => 'policy-1', 'required' => false], + 'template' => [ + 'title' => '', + 'description' => 'The template settings. For more information, see [Multiple Component Templates](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html#multiple-component-templates).', + 'type' => 'object', + 'properties' => [ + 'settings' => ['title' => '', 'description' => 'The settings configuration.', 'type' => 'string', 'example' => '{\\"index.number_of_shards\\":\\"1\\"}', 'required' => false], + 'mappings' => ['title' => '', 'description' => 'The mappings configuration.', 'type' => 'string', 'example' => '{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}', 'required' => false], + 'aliases' => ['title' => '', 'description' => 'The aliases configuration.', 'type' => 'string', 'example' => '{\\"mydata\\":{}}', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => '50', + 'docRequired' => false, + 'example' => '{ "indexTemplate": "index-template", "indexPatterns": [ "schema1*", "schema2*" ], "dataStream": true, "priority": 30, "ilmPolicy": "policy-1", "template": { "settings": "{\\"index.number_of_shards\\":\\"1\\"}", "mappings": "{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}", "aliases": "{\\"mydata\\":{}}" } }', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'dataStream' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'indexTemplate' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my-template', - ], - 'ilmPolicy' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my_ilm_policy', - ], - 'priority' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'indexPatterns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'console-*', - ], - ], - 'template' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'settings' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"mydata\\":{}}', - ], - 'mappings' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}', - ], - 'aliases' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\"index.number_of_shards\\":\\"1\\"}', - ], - ], - ], - ], - ], - ], + 'Result' => ['title' => '', 'description' => 'The name of the created cluster index template.', 'type' => 'string', 'example' => 'index-template'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n {\\n \\"dataStream\\": true,\\n \\"indexTemplate\\": \\"my-template\\",\\n \\"ilmPolicy\\": \\"my_ilm_policy\\",\\n \\"priority\\": 100,\\n \\"indexPatterns\\": [\\n \\"console-*\\"\\n ],\\n \\"template\\": {\\n \\"settings\\": \\"{\\\\\\\\\\\\\\"mydata\\\\\\\\\\\\\\":{}}\\",\\n \\"mappings\\": \\"{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"created_at\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EEE MMM dd HH:mm:ss Z yyyy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"host_name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keyword\\\\\\\\\\\\\\"}}}\\",\\n \\"aliases\\": \\"{\\\\\\\\\\\\\\"index.number_of_shards\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"index-template\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Create an index template', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RolloverDataStream' => [ - 'summary' => '滚动数据流，生成新索引', - 'path' => '/openapi/instances/{InstanceId}/data-streams/{DataStream}/rollover', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-12-28T07:21:50.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-30T17:47:42.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIndexTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateIndexTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], ], + ], + 'CreateLogstash' => [ + 'summary' => 'Creates a Logstash instance by calling CreateLogstash.', + 'path' => '/openapi/logstashes', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082****', - ], - ], - [ - 'name' => 'ClientToken', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token that is used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'DataStream', - 'in' => 'path', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'paymentType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- prepaid: subscription.'."\n" + .'- postpaid: pay-as-you-go.', 'type' => 'string', 'required' => false, 'example' => 'prepaid', 'title' => ''], + 'version' => ['description' => 'The instance version. Valid values:'."\n" + ."\n" + .'- 6.7_with_X-Pack'."\n" + .'- 7.4_with_X-Pack.', 'type' => 'string', 'required' => true, 'example' => '6.7_with_X-Pack', 'title' => ''], + 'nodeAmount' => ['description' => 'The number of nodes in the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], + 'nodeSpec' => [ + 'description' => 'The configuration of data nodes.', + 'type' => 'object', + 'properties' => [ + 'disk' => ['description' => 'The disk size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + 'diskType' => ['description' => 'The disk type of the node. Valid values:'."\n" + ."\n" + .'- cloud_ssd'."\n" + .'- cloud_efficiency.', 'type' => 'string', 'required' => false, 'example' => 'cloud_ssd', 'title' => ''], + 'spec' => ['description' => 'The node specifications. For more information about specifications, see [Product specifications](~~271718~~).', 'type' => 'string', 'required' => true, 'example' => 'elasticsearch.ic5.2xlarge', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'networkConfig' => [ + 'description' => 'The network configuration.', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'The network type. Currently, only VPC is supported.', 'type' => 'string', 'required' => false, 'example' => 'vpc', 'title' => ''], + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp16k1dvzxtmagcva****', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1k4ec6s7sjdbudw****', 'title' => ''], + 'vsArea' => ['description' => 'The zone where the instance is deployed.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-i', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'paymentInfo' => [ + 'description' => 'The billing details of the subscription instance. This parameter is required when you create a subscription instance.', + 'type' => 'object', + 'properties' => [ + 'duration' => ['title' => '', 'description' => 'The subscription duration. You can purchase the instance on a monthly or yearly basis. Unit: 1 to 9 months, or 1 to 3 years.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + 'pricingCycle' => ['title' => '', 'description' => 'The unit of the subscription duration. Valid values:'."\n" + ."\n" + .'- Year: year.'."\n" + .'- Month: month.', 'type' => 'string', 'required' => false, 'example' => 'Month'], + 'isAutoRenew' => ['title' => '', 'description' => 'Specifies whether to enable auto-renewal. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'autoRenewDuration' => ['title' => '', 'description' => 'The auto-renewal epoch. Unit: months. This parameter is required when **isAutoRenew** is set to **true**. The valid values are the same as those on the buy page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => ['title' => '', 'description' => 'The name of the instance.', 'type' => 'string', 'required' => false, 'example' => 'ls-cn-abc'], + 'resourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxxkk2p7****'], + ], 'required' => true, 'docRequired' => true, - 'example' => 'ds-001', + 'example' => '7.4.0_with_X-Pack', + 'title' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****', 'title' => ''], + 'Result' => ['description' => 'The returned result.', '$ref' => '#/components/schemas/Logstash', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 400 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****\\",\\n \\"Result\\": {\\n \\"endpointList\\": [\\n {\\n \\"host\\": \\"172.16.xx.xx\\",\\n \\"port\\": 9200,\\n \\"zoneId\\": \\"cn-hangzhou-i\\"\\n }\\n ],\\n \\"status\\": \\"NORMAL\\",\\n \\"description\\": \\"ls-cn-abc\\",\\n \\"resourceGroupId\\": \\"rg-acfm2h5vbzd****\\",\\n \\"endTime\\": 4749897600000,\\n \\"instanceId\\": \\"ls-cn-n6w1o5jq****\\",\\n \\"config\\": {\\n \\"key\\": \\"[]\\"\\n },\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"networkConfig\\": {\\n \\"type\\": \\"vpc\\",\\n \\"vpcId\\": \\"vpc-abc\\",\\n \\"vsArea\\": \\"cn-hangzhou-*\\",\\n \\"vswitchId\\": \\"vsw-def\\"\\n },\\n \\"zoneInfos\\": [\\n {\\n \\"status\\": \\"NORMAL\\",\\n \\"zoneId\\": \\"cn-hangzhou-i\\"\\n }\\n ],\\n \\"nodeAmount\\": 2,\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"version\\": \\"6.7.0_with_X-Pack\\",\\n \\"dataNode\\": true,\\n \\"nodeSpec\\": {\\n \\"disk\\": 50,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"spec\\": \\"logstash.n4.small\\"\\n },\\n \\"paymentType\\": \\"postpaid\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"dev\\"\\n }\\n ],\\n \\"zoneCount\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Create a logstash instance', + 'description' => 'Before calling this operation, note the following:'."\n" + .'- Make sure that you are familiar with the billing method and pricing of Logstash. <props="china"><ph>For more information, see [Billing](~~260882~~).</ph></props>'."\n" + ."\n" + .'- To create an instance, complete real-name verification. <props="china"><ph>For more information, see [Real-name verification](~~37175~~).</ph></props>.', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateILMPolicy' => [ - 'summary' => '修改ES集群索引生命周期策略', - 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}', - 'methods' => [ - 'put', + 'extraInfo' => "\n", + 'changeSet' => [ + ['createdAt' => '2022-12-16T09:44:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-30T06:26:13.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLogstash'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/*'], + ], + ], + ], + ], + ], + 'CreatePipelines' => [ + 'summary' => 'Creates a Logstash pipeline to collect data.', + 'path' => '/openapi/logstashes/{InstanceId}/pipelines', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif24adwc0082w2ka****', - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'trigger', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to save and deploy the pipeline. Valid values:'."\n" + ."\n" + .'- true: Save and deploy.'."\n" + .'- false (default): Save only.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false'], ], [ - 'name' => 'PolicyName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my-policy', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The token can contain up to 64 ASCII characters and must be unique across requests.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The request body parameters that specify the pipeline information. For more information, see [logstash.yml](https://www.elastic.co/guide/en/logstash/6.7/logstash-settings-file.html).', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The request body object.', + 'type' => 'object', + 'properties' => [ + 'pipelineId' => ['title' => '', 'description' => 'The pipeline ID.', 'type' => 'string', 'required' => true, 'example' => 'pipeline-test'], + 'description' => ['title' => '', 'description' => 'The pipeline description.', 'type' => 'string', 'required' => false, 'example' => 'this is a test'], + 'config' => ['title' => '', 'description' => 'The pipeline configuration.', 'type' => 'string', 'required' => true, 'example' => 'input { } filter { } output { }'], + 'workers' => ['title' => '', 'description' => 'The number of worker threads for the pipeline. Default value: the number of CPU cores of the instance.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'default' => '实例的CPU核数。'], + 'batchSize' => ['title' => '', 'description' => 'The batch size of the pipeline. Default value: 125.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '125', 'default' => '125'], + 'batchDelay' => ['title' => '', 'description' => 'The batch delay of the pipeline. Unit: milliseconds. Default value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'default' => '50'], + 'queueType' => [ + 'title' => '', + 'description' => 'The queue type. Valid values:'."\n" + .'- MEMORY: a traditional memory-based queue.'."\n" + .'- PERSISTED: a disk-based ACKed queue (persistent queue).', + 'type' => 'string', + 'required' => false, + 'example' => 'MEMORY', + 'enum' => ['MEMORY', 'PERSISTED'], + ], + 'queueMaxBytes' => ['title' => '', 'description' => 'The total capacity of the queue in bytes. Unit: MB. Default value: 1024.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'default' => '1024'], + 'queueCheckPointWrites' => ['title' => '', 'description' => 'The number of checkpoint writes for the queue. Default value: 1024.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1024', 'default' => '1024'], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my-policy', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'Result' => ['description' => 'Indicates whether the pipeline is created. Valid values:'."\n" + ."\n" + .'- true: The pipeline is created.'."\n" + .'- false: The pipeline failed to be created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Create a logstash pipeline', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipelines'], + ], + ], + 'ramActions' => [ [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:CreatePipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], + ], + 'CreateSnapshot' => [ + 'path' => '/openapi/instances/{InstanceId}/snapshots', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '64224', + 'abilityTreeNodes' => ['FEATUREelasticsearch7ZNWUZ'], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The manual snapshot backup is successful.'."\n" + .'- false: The manual snapshot backup failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"my-policy\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateILMPolicy', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","type":"json"}]', + 'title' => 'Create a cluster index snapshot backup', + 'summary' => 'Calls CreateSnapshot to manually create a snapshot backup of a cluster.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateIndexTemplate' => [ - 'summary' => '修改ES集群索引模版配置', - 'path' => '/openapi/instances/{InstanceId}/index-templates/{IndexTemplate}', - 'methods' => [ - 'put', + 'changeSet' => [ + ['createdAt' => '2024-06-27T03:18:48.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSnapshot'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'CreateVpcEndpoint' => [ + 'summary' => 'Creates a PrivateLink VPC endpoint to connect to an endpoint service created in a user VPC.', + 'path' => '/openapi/instances/{InstanceId}/vpc-endpoints', + 'methods' => ['post'], + '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' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w24n9u900am****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-2r429tctl000d****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], ], [ - 'name' => 'IndexTemplate', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'my-template', - ], + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n" + ."\n" + .'- true: sends a check request without creating an endpoint. The system checks whether the AccessKey pair is valid, whether the Resource Access Management (RAM) user has the required authorization, and whether the required parameters are specified.'."\n" + .'- false (default): triggers the request to create an endpoint.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The endpoint service information.', + 'type' => 'object', + 'properties' => [ + 'serviceId' => ['title' => '', 'description' => 'The ID of the endpoint service that you created. The service VPC endpoint will be associated with this service ID.', 'type' => 'string', 'required' => false, 'example' => 'epsrv-hp3xdsq46ael67lo****'], + 'zoneId' => ['title' => '', 'description' => 'The zone ID of the endpoint service that you created.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i'], + ], 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'my-template', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'serviceId' => ['description' => 'The ID of the user endpoint service associated with the endpoint.', 'type' => 'string', 'example' => 'epsrv-bp1w0p3jdirbfmt6****', 'title' => ''], + 'endpointDomain' => ['description' => 'The endpoint domain name, which is used for connection configuration.', 'type' => 'string', 'example' => 'ep-bp1tah7zbrwmkjef****.epsrv-bp1w0p3jdirbfmt6****.cn-hangzhou.privatelink.aliyuncs.com', 'title' => ''], + 'endpointId' => ['description' => 'The ID of the service VPC endpoint.', 'type' => 'string', 'example' => 'ep-bp1tah7zbrwmkjef****', 'title' => ''], + 'endpointName' => ['description' => 'The name of the service VPC endpoint.', 'type' => 'string', 'example' => 'vpcElasticSearchABC', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": {\\n \\"serviceId\\": \\"epsrv-bp1w0p3jdirbfmt6****\\",\\n \\"endpointDomain\\": \\"ep-bp1tah7zbrwmkjef****.epsrv-bp1w0p3jdirbfmt6****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"endpointId\\": \\"ep-bp1tah7zbrwmkjef****\\",\\n \\"endpointName\\": \\"vpcElasticSearchABC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Create a privateLink VPC endpoint', + 'description' => 'For more information about this API operation, see [Configure private connectivity for an instance](~~279559~~).', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVpcEndpoint'], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateVpcEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"my-template\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'CreateComponentIndex' => [ - 'summary' => '创建Elasticsearch组合模板', - 'path' => '/openapi/instances/{InstanceId}/component-index/{name}', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeactivateZones' => [ + 'summary' => 'Takes part of the zones offline when multiple zones are available, and migrates the nodes in the offline zones to other zones.', + 'path' => '/openapi/instances/{InstanceId}/actions/down-zones', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-tl329rbpc0001****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'template', - ], + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'template' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'settings' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{ "index.number_of_replicas": 0 }', - ], - 'mappings' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{ "properties": { "@timestamp": { "type": "date" } } }', - ], - 'aliases' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - ], - 'required' => false, - ], - '_meta' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{ "description": "set number of shards to one" }', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The zones are taken offline.'."\n" + .'- false: The zones failed to be taken offline.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '4XX' => [ 'schema' => [ - 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'C20022BA-5382-4339-89FB-30AF48A05431', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C20022BA-5382-4339-89FB-30AF48A05431\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'DeleteComponentIndex' => [ - 'summary' => '删除组合索引模板', - 'path' => '/openapi/instances/{InstanceId}/component-index/{name}', - 'methods' => [ - 'delete', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Take part of the zones offline', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also contain a list of zone IDs to take offline. Example:'."\n" + .'`["ap-southeast-1-i","ap-southeast-1-f"]`.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeactivateZones'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeactivateZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'DeleteCollector' => [ + 'summary' => 'Deletes a specified collector.', + 'path' => '/openapi/collectors/{ResId}', + 'methods' => ['delete'], + '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' => 'delete'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ResId', 'in' => 'path', + 'schema' => ['description' => 'The collector ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-92z1h38882dal****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence. Generated by the client. The value must be unique across different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + .'- true: The deletion was successful.'."\n" + .'- false: The deletion failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-tl329rbpc0001****', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'name', - 'in' => 'path', + '4XX' => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'template', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '5XX' => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'DeleteDeprecatedTemplate' => [ - 'summary' => '删除历史索引模板', - 'path' => '/openapi/instances/{InstanceId}/deprecated-templates/{name}', - 'methods' => [ - 'delete', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Delete a collector', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:47:42.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCollector'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + ], + ], + 'DeleteComponentIndex' => [ + 'summary' => 'Deletes a component index template of Elasticsearch.', + 'path' => '/openapi/instances/{InstanceId}/component-index/{name}', + 'methods' => ['delete'], + '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' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-tl329rbpc0001****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-tl329rbpc0001****', 'title' => ''], ], [ 'name' => 'name', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'template', - ], + 'schema' => ['description' => 'The name of the component template.', 'type' => 'string', 'required' => true, 'example' => 'template', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9'], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The deletion was successful.'."\n" + .'- false: The deletion failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'DescribeComponentIndex' => [ - 'summary' => '查看组合索引模板详情', - 'path' => '/openapi/instances/{InstanceId}/component-index/{name}', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Delete a component index template', + 'description' => 'For more information, see [Store massive amounts of data by using OpenStore](~~317694~~).', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-16T12:46:26.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentIndex'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteComponentIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'DeleteConnectedCluster' => [ + 'path' => '/openapi/instances/{InstanceId}/connected-clusters', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-tl329rbpc0001****', - ], + 'schema' => ['description' => 'The instance ID of the current instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'name', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'template', - ], + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'connectedInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID of the remote instance that is connected over the network.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-09k1rgid9000g****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'template' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'aliases' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{}', - ], - 'mappings' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{ "properties": { "@timestamp": { "type": "date" } } }', - ], - 'settings' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{ "index.number_of_replicas": 0 }', - ], - ], - ], - '_meta' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{ "description": "set number of shards to one" }', - ], - ], - ], + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- true: The connected instance is removed.'."\n" + .'- false: The connected instance failed to be removed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": {\\n \\"template\\": {\\n \\"aliases\\": {},\\n \\"mappings\\": {\\n \\"properties\\": {\\n \\"@timestamp\\": {\\n \\"type\\": \\"date\\"\\n }\\n }\\n },\\n \\"settings\\": {\\n \\"index.number_of_replicas\\": 0\\n }\\n },\\n \\"_meta\\": {\\n \\"description\\": \\"set number of shards to one\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'DescribeDeprecatedTemplate' => [ - 'summary' => 'DescribeDeprecatedTemplate', - 'path' => '/openapi/instances/{InstanceId}/deprecated-templates/{name}', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","type":"json"}]', + 'title' => 'Remove a connected instance', + 'summary' => 'Deletes the network connectivity between two instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-29T17:13:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConnectedCluster'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteConnectedCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'DeleteDataStream' => [ + 'summary' => 'Deletes a specified cluster data stream.', + 'path' => '/openapi/instances/{InstanceId}/data-streams/{DataStream}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-tl329rbpc0001****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082****', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'DataStream', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'template', - ], + 'schema' => ['description' => 'The name of the data stream.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ds-001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- true: The data stream was deleted.'."\n" + ."\n" + .'- false: The data stream failed to be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + ], 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'dataStream' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'indexPatterns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["schema1*","schema2*"]', - ], - ], - 'indexTemplate' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'openstore-index-template', - ], - 'order' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'template' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'aliases' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{}"', - ], - 'mappings' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}"', - ], - 'settings' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"index.number_of_shards\\":\\"1\\"}"', - ], - ], - ], - 'version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '70000', - ], - ], - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Delete a data stream', + 'description' => '> - Deleting a data stream also deletes its backing indexes. Proceed with caution.- When an index template has associated data streams, you must delete the data streams associated with the index template before you can delete the index template. On the data stream list page, view the data stream details to find the index template that matches the data stream.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:47:42.000Z', 'description' => 'Error codes changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": {\\n \\"dataStream\\": false,\\n \\"indexPatterns\\": [\\n \\"[\\\\\\"schema1*\\\\\\",\\\\\\"schema2*\\\\\\"]\\"\\n ],\\n \\"indexTemplate\\": \\"openstore-index-template\\",\\n \\"order\\": 100,\\n \\"template\\": {\\n \\"aliases\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"mappings\\": \\"\\\\\\"{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"created_at\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EEE MMM dd HH:mm:ss Z yyyy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"host_name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keyword\\\\\\\\\\\\\\"}}}\\\\\\"\\",\\n \\"settings\\": \\"\\\\\\"{\\\\\\\\\\\\\\"index.number_of_shards\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\\\\\"\\"\\n },\\n \\"version\\": \\"70000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'ListComponentIndices' => [ - 'summary' => 'ES集群组合索引列表', - 'path' => '/openapi/instances/{InstanceId}/component-index', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataStream'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteDataStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'DeleteDataTask' => [ + 'path' => '/openapi/instances/{InstanceId}/data-task', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-tl329rbpc0001****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-oew1oxiro000f****', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'taskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'template', - ], + 'schema' => ['description' => 'The index migration task ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'et_cn_0oyg09o96ib40****', 'title' => ''], ], - [ - 'name' => 'page', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '5', - 'default' => '1', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'size', - 'in' => 'query', + '4XX' => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '5XX' => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Headers' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'composed' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["template1", "template2"]', - ], - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'synthetics-settings', - ], - 'content' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'template' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'settings' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'index' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'lifecycle' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'synthetics', - ], - ], - ], - 'codec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'best_compression', - ], - ], - ], - ], - ], - ], - ], - '_meta' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{ "description": "set number of shards to one" }', - ], - 'version' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], - ], - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"Result\\": [\\n {\\n \\"composed\\": [\\n \\"[\\\\\\"template1\\\\\\", \\\\\\"template2\\\\\\"]\\"\\n ],\\n \\"name\\": \\"synthetics-settings\\",\\n \\"content\\": {\\n \\"template\\": {\\n \\"settings\\": {\\n \\"index\\": {\\n \\"lifecycle\\": {\\n \\"name\\": \\"synthetics\\"\\n },\\n \\"codec\\": \\"best_compression\\"\\n }\\n }\\n },\\n \\"_meta\\": {\\n \\"description\\": \\"set number of shards to one\\"\\n },\\n \\"version\\": 0\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'Query Combined Index List', - ], - 'ListDeprecatedTemplates' => [ - 'summary' => 'ListDeprecatedTemplates', - 'path' => '/openapi/instances/{InstanceId}/deprecated-templates', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","type":"json"}]', + 'title' => 'Delete an index migration task', + 'summary' => 'Deletes an Elasticsearch index migration task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataTask'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteDataTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'DeleteDeprecatedTemplate' => [ + 'summary' => 'Deletes a historical index template.', + 'path' => '/openapi/instances/{InstanceId}/deprecated-templates/{name}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'produces' => [ - 'application/json', - 'application/octet-stream', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-t57p81n7ai89v****', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-tl329rbpc0001****'], ], [ 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'component-openstore-index-template', - ], - ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], + 'in' => 'path', + 'schema' => ['description' => 'The index template name.', 'type' => 'string', 'required' => true, 'example' => 'template', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Headers' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - ], - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'indexPatterns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["schema1*","schema2*"]', - ], - ], - 'template' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'settings' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"index.number_of_shards\\":\\"1\\"}"', - ], - 'mappings' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}"', - ], - 'aliases' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"{}"', - ], - ], - ], - 'dataStream' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'indexTemplate' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'openstore-index-template', - ], - 'version' => [ - 'description' => '', - 'type' => 'string', - 'example' => '70000', - ], - 'order' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], + 'Result' => ['description' => 'The result. Valid values:'."\n" + ."\n" + .'- true: succeeded.'."\n" + .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 5\\n },\\n \\"Result\\": [\\n {\\n \\"indexPatterns\\": [\\n \\"[\\\\\\"schema1*\\\\\\",\\\\\\"schema2*\\\\\\"]\\"\\n ],\\n \\"template\\": {\\n \\"settings\\": \\"\\\\\\"{\\\\\\\\\\\\\\"index.number_of_shards\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"mappings\\": \\"\\\\\\"{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"created_at\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EEE MMM dd HH:mm:ss Z yyyy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"host_name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keyword\\\\\\\\\\\\\\"}}}\\\\\\"\\",\\n \\"aliases\\": \\"\\\\\\"{}\\\\\\"\\"\\n },\\n \\"dataStream\\": false,\\n \\"indexTemplate\\": \\"openstore-index-template\\",\\n \\"version\\": \\"70000\\",\\n \\"order\\": 100\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - ], - 'UpdateComponentIndex' => [ - 'summary' => '修改ES集群动态索引', - 'path' => '/openapi/instances/{InstanceId}/component-index/{name}', - 'methods' => [ - 'put', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Delete a historical index template', + 'description' => 'For more information, see [Store massive amounts of data through OpenStore](~~317694~~).', + 'changeSet' => [ + ['createdAt' => '2022-12-28T07:21:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-16T12:46:26.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDeprecatedTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteDeprecatedTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'DeleteILMPolicy' => [ + 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '64235', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-t57p81n7ai89v****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082****', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'PolicyName', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'component-openstore-index-template', - ], + 'schema' => ['description' => 'The name of the index lifecycle policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'slm-history-ilm-policy', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'template' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'settings' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{ "index.number_of_replicas": 0 }', - ], - 'mappings' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{ "properties": { "@timestamp": { "type": "date" } } }', - ], - 'aliases' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], - ], - 'required' => false, - ], - '_meta' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{ "description": "set number of shards to one" }', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The specified lifecycle policy definition is deleted.'."\n" + ."\n" + .'- false: The specified lifecycle policy definition failed to be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '694FDC20-0FDD-47C4-B921-BFF902FA****', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '4XX' => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"694FDC20-0FDD-47C4-B921-BFF902FA****\\"\\n}","type":"json"}]', + 'title' => 'Delete an index lifecycle policy', + 'summary' => 'Deletes a specified index lifecycle policy.', + 'description' => '> You cannot delete a policy that is currently in use. If the policy is being used to manage any index, the request fails and returns an error.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-09T04:53:07.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteILMPolicy'], + ], + ], + 'ramActions' => [ [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteILMPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'DeleteIndexTemplate' => [ + 'summary' => 'Deletes a specified index template.', + 'path' => '/openapi/instances/{InstanceId}/index-templates/{IndexTemplate}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082****', 'title' => ''], + ], + [ + 'name' => 'IndexTemplate', + 'in' => 'path', + 'schema' => ['description' => 'The name of the index template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'index-name', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Result' => ['description' => 'The result. Valid values:'."\n" + ."\n" + .'- true: The index template was deleted.'."\n" + ."\n" + .'- false: The index template failed to be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A0761F7E-0B50-46B9-8CAA-EBB3A420****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"A0761F7E-0B50-46B9-8CAA-EBB3A420****\\"\\n}","type":"json"}]', + 'title' => 'Delete an index template', + 'description' => '> Before deleting an index template, delete the data streams associated with the index template. Otherwise, the index template cannot be deleted.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIndexTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteIndexTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"requestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', ], 'DeleteInstance' => [ 'path' => '/openapi/instances/{InstanceId}', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5303,40 +4021,25 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-t57p81n7ai89v****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-t57p81n7ai89v****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'deleteType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'protective', - ], + 'schema' => ['description' => 'The release type. Valid values:'."\n" + ."\n" + .'- immediate: The instance is immediately deleted. After deletion, the system permanently clears all data, and the instance no longer appears in the instance list.'."\n" + .'- protective: The instance is frozen for 24 hours before the data is permanently cleared. During this period, the instance still appears in the instance list, and you can choose to [restore the instance](~~202195~~) or [immediately release it](~~202195~~).', 'type' => 'string', 'required' => false, 'example' => 'protective', 'title' => ''], ], ], 'responses' => [ @@ -5344,110 +4047,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '94B03BBA-A132-42C3-8367-0A0C1C45****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94B03BBA-A132-42C3-8367-0A0C1C45****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"94B03BBA-A132-42C3-8367-0A0C1C45****\\"\\n}","errorExample":"{\\n \\"Code\\":\\"InstanceNotFound\\",\\n \\"Message\\":\\"The specified instance does not exist. Check the instance status and try again.\\",\\n \\"RequestId\\":\\"829F38F6-E2D6-4109-90A6-888160BD16C2\\"\\n}"},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteInstance', - 'summary' => 'You can call this operation to release a pay-as-you-go Elasticsearch instance. After the instance is released, the physical resources of the instance is reclaimed. The data of the instance is deleted and cannot be recovered. The disks mounted to the instance nodes and the snapshots are released.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B03BBA-A132-42C3-8367-0A0C1C45****\\"\\n}","type":"json"}]', + 'title' => 'Release a specified pay-as-you-go instance', + 'summary' => 'All physical resources used by the instance are reclaimed, all related data is permanently lost and cannot be recovered, and the cloud disks mounted to the instance nodes along with their corresponding snapshots are released.', + 'description' => 'Before you invoke this operation, note the following:'."\n" + .'Data cannot be recovered after the instance is released. Back up your data before releasing the instance. For more information, see [Snapshot backup and recovery commands](~~65675~~).', 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The response also includes the Result parameter. For more information, see [ListInstance](~~142230~~).', 'extraInfo' => ' ', - ], - 'UpdateInstanceChargeType' => [ - 'summary' => 'null', - 'path' => '/openapi/instances/{InstanceId}/actions/convert-pay-type', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-29T17:13:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], + ], + ], + 'DeleteLogstash' => [ + 'path' => '/openapi/logstashes/{InstanceId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'BearerToken' => [], + 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-0pp1jxvcl000z****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-n6w1o5jq****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value of this parameter must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '付费类型变更，请求体内容', - 'type' => 'object', - 'properties' => [ - 'paymentInfo' => [ - 'title' => '实例转换后的付费信息。', - 'type' => 'object', - 'properties' => [ - 'duration' => [ - 'title' => '付费时长。如果 pricingCycle 为 Year，可选值：1~3；如果 pricingCycle 为 Month，可选值：1~9。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'pricingCycle' => [ - 'title' => '付费周期。可选值：Year、Month。', - 'type' => 'string', - 'example' => 'Month', - ], - ], - ], - 'paymentType' => [ - 'title' => '实例当前的付费类型。prepaid', - 'type' => 'string', - 'example' => 'prepaid', - ], - ], - 'docRequired' => false, - ], + 'name' => 'deleteType', + 'in' => 'query', + 'schema' => ['description' => 'The release type. Valid values:'."\n" + ."\n" + .'- immediate: immediately deletes the instance. After deletion, the system permanently clears all data, and the instance no longer appears in the instance list.'."\n" + .'- protective: freezes the instance for 24 hours before permanently clearing the data. During this period, the instance is still displayed in the instance list. You can choose to [recover the instance](~~202205~~) or [immediately release it](~~160591~~).', 'type' => 'string', 'required' => false, 'example' => 'protective', 'title' => ''], ], ], 'responses' => [ @@ -5455,179 +4123,184 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: conversion successful'."\n" - .'* false: conversion failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94B03BBA-A132-42C3-8367-0A0C1C45****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94B03BBA-A132-42C3-8367-0A0C1C45****\\"\\n}","type":"json"}]', + 'title' => 'Release a logstash instance', + 'summary' => 'Proactively releases a Logstash instance.', + 'description' => 'Before calling this operation, note the following:'."\n" + .'After the instance is released, all physical resources used by the instance are reclaimed, all related data is permanently lost and cannot be recovered, cloud disks mounted to the instance nodes are also released, and the corresponding snapshots are deleted.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The response also includes the Result parameter. For the metric description, see [ListLogstash](~~160534~~).', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-29T17:13:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogstash'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], ], + ], + ], + 'DeletePipelines' => [ + 'path' => '/openapi/logstashes/{InstanceId}/pipelines', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the Logstash instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], [ + 'name' => 'pipelineIds', + 'in' => 'query', + 'schema' => ['description' => 'The pipeline ID.', 'type' => 'string', 'required' => false, 'example' => 'pipeline-test', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Result' => ['description' => 'The returned result:'."\n" + ."\n" + .'- true: The pipelines are deleted.'."\n" + .'- false: The pipelines failed to be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateInstanceChargeType', - 'requestParamsDescription' => '## RequestBody'."\n" - ."\n" - .'You must also specify the following parameters in RequestBody to specify the billing information for the instance after the billing method is converted to subscription. '."\n" - ."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .'| --------- | ---- | -------- | ------- | ----------- |'."\n" - .'| paymentInfo | Array | Yes | | The billing information of the instance after conversion. |'."\n" - .'| └duration | Integer | Yes | 1 | The payment duration of the instance. 1 to 3 if the pricingCycle parameter is set to Year. 1 to 9 if the pricingCycle parameter is set to Month. |'."\n" - .'| └pricingCycle | String | Yes | Year | The billing cycle of the instance. Valid values: Year and Month. |'."\n" - .'| paymentType | String | Yes | prepaid | The billing method of the instance. Only the functions of pay-as-you-go instances can be converted to subscription instances. Therefore, this parameter is set to prepaid. |'."\n" - .'> └ indicates a child parameter. Example:'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "paymentInfo":{ '."\n" - .' "duration":1,'."\n" - .' "pricingCycle":"Month"'."\n" - .' },'."\n" - .' "paymentType":"prepaid"'."\n" - .'}'."\n" - .'```', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'DeletePipelines', + 'summary' => 'Deletes pipelines configured for a Logstash instance.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateDescription' => [ - 'summary' => 'Changes the name of a specified Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/description', - 'methods' => [ - 'patch', - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipelines'], + ], ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:DeletePipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], + ], + 'DeleteSnapshotRepo' => [ + 'path' => '/openapi/instances/{InstanceId}/snapshot-repos', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The return results.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1ptcb30009****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'repoPath', 'in' => 'query', - 'schema' => [ - 'description' => 'The new name of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****', - ], + 'schema' => ['description' => 'The referenced instance ID. To obtain this parameter, see [ListSnapshotReposByInstanceId](~~178513~~).'."\n" + .'.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1rux8i000w****', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyunes_name_test', - ], - ], - 'required' => false, - ], + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], ], 'responses' => [ @@ -5635,151 +4308,173 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FDF34727-1664-44C1-A8DA-3EB72D60****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aliyunes_test_name', - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The reference repository is deleted.'."\n" + .'- false: The reference repository failed to be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'DeleteSnapshotRepo', + 'summary' => 'Deletes a cross-cluster OSS reference repository from an instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSnapshotRepo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteSnapshotRepo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'DeleteVpcEndpoint' => [ + 'summary' => 'Calls DeleteVpcEndpoint to delete a VPC endpoint under a service account.', + 'path' => '/openapi/instances/{InstanceId}/vpc-endpoints/{EndpointId}', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], + 'security' => [ [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-2r429tctl000d****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'Used to ensure the idempotency of the request. This parameter value is generated by the client. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], + ], + [ + 'name' => 'EndpointId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the VPC endpoint that you want to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ep-bp18s6wy9420wdi4****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Result' => ['description' => 'Indicates whether the deletion is successful. Valid values:'."\n" + ."\n" + .'- true: The deletion is successful.'."\n" + ."\n" + .'- false: The deletion failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FDF34727-1664-44C1-A8DA-3EB72D60****\\",\\n \\"Result\\": {\\n \\"description\\": \\"aliyunes_test_name\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateDescription', - 'requestParamsDescription' => "\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","type":"json"}]', + 'title' => 'Delete a VPC endpoint under a service account', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateReadWritePolicy' => [ - 'summary' => '更改ES集群高可用策略', - 'path' => '/openapi/instances/{InstanceId}/actions/update-read-write-policy', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:26.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVpcEndpoint'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteVpcEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], ], + ], + 'DescribeAckOperator' => [ + 'path' => '/openapi/ack-clusters/{ClusterId}/operator', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClusterId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-oew1oxiro000f****', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The ID of the target cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c79acd3fbf462423fb6450e513bb6****', 'title' => ''], ], ], 'responses' => [ @@ -5787,132 +4482,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6615EE8D-FD9D-4FD3-997E-6FEA5B8D82ED', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'version' => ['description' => 'The Operator version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'status' => ['description' => 'The Operator installation status. Valid values:'."\n" + ."\n" + .'- deployed: installed'."\n" + .'- not-deploy: not installed'."\n" + .'- failed: installation failed'."\n" + .'- unknown: unknown status.', 'type' => 'string', 'example' => 'deployed', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateReadWritePolicy', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6615EE8D-FD9D-4FD3-997E-6FEA5B8D82ED\\",\\n \\"Result\\": {\\n \\"version\\": \\"1\\",\\n \\"status\\": \\"deployed\\"\\n }\\n}","type":"json"}]', + 'title' => 'Get ACK operator details', + 'summary' => 'Calls the DescribeAckOperator operation to query the Elasticsearch Operator information installed on a specified Container Service for Kubernetes (ACK) cluster.', + 'description' => '> Before installing a collector on an ACK cluster, you can call this operation to check the installation status of the Elasticsearch Operator on the target cluster.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyElastictask' => [ - 'path' => '/openapi/instances/{InstanceId}/elastic-task', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAckOperator'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeAckOperator', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'ackClusters', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:ackClusters/{#ackClustersId}'], + ], + ], + ], ], + ], + 'DescribeCollector' => [ + 'path' => '/openapi/collectors/{ResId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '64337', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ResId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-6ja1ro4jt000c****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The collector instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-rg31ahn82m0qd****', 'title' => ''], ], ], 'responses' => [ @@ -5920,961 +4595,1087 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'elasticExpansionTask' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'triggerType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'crontab', - ], - 'replicaCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'elasticNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'cronExpression' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0 0 0 ? * MON', - ], - 'targetIndices' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["index"]', - ], + 'resId' => ['description' => 'The collector instance ID.', 'type' => 'string', 'example' => 'ct-cn-rg31ahn82m0qd****', 'title' => ''], + 'gmtUpdateTime' => ['description' => 'The time when the collector was last updated.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'dryRun' => ['description' => 'Specifies whether to perform only a dry run without creating the collector. Valid values:'."\n" + ."\n" + .'- true: Only validates the request without creating the collector.'."\n" + .'- false: Validates the request and creates the collector.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ownerId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '16852099488*****', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the virtual private cloud (VPC) where the collector resides.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtma*****', 'title' => ''], + 'resType' => ['description' => 'The collector type. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.', 'type' => 'string', 'example' => 'fileBeat', 'title' => ''], + 'resVersion' => ['description' => 'The collector version.', 'type' => 'string', 'example' => '6.8.5_with_community', 'title' => ''], + 'gmtCreatedTime' => ['description' => 'The time when the collector was created.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'status' => ['description' => 'The collector status. Valid values:'."\n" + ."\n" + .'- activing: being activated'."\n" + .'- active: activated.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'name' => ['description' => 'The collector name.', 'type' => 'string', 'example' => 'ct-cn-4135is2tj194p****', 'title' => ''], + 'configs' => [ + 'description' => 'The configuration file information of the collector.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The file content.', 'type' => 'string', 'example' => 'fileBeat.inputs:xxx', 'title' => ''], + 'fileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'filebeat.yml', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'elasticShrinkTask' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'triggerType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'crontab', - ], - 'replicaCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'elasticNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'cronExpression' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4 4 4 ? * WED', - ], - 'targetIndices' => [ - 'type' => 'array', - 'items' => [ + 'extendConfigs' => [ + 'description' => 'The extended configurations of the collector.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'successPodsCount' => ['description' => 'The number of pods in the ACK cluster from which data is successfully collected.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'protocol' => ['description' => 'The transport protocol, which must be the same as the access protocol of the instance specified in the collector Output. Valid values: HTTP and HTTPS. This parameter is displayed when **configType** is set to **collectorTargetInstance**.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'userName' => ['description' => 'The username used to access the instance specified in the collector Output. Default value: elastic. This parameter is displayed when **configType** is set to **collectorTargetInstance** or **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'elastic', 'title' => ''], + 'totalPodsCount' => ['description' => 'The total number of pods in the ACK cluster from which data is collected.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'type' => ['description' => 'The type of machine on which the collector is deployed. This parameter is displayed when **configType** is set to **collectorDeployMachine**. Valid values:'."\n" + ."\n" + .'- ECSInstanceId: ECS'."\n" + .'- ACKCluster: Container Kubernetes.', 'type' => 'string', 'example' => 'ECSInstanceId', 'title' => ''], + 'kibanaHost' => ['description' => 'The public network access address of Kibana after Kibana Dashboard is enabled. This parameter is displayed when **configType** is set to **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'enableMonitoring' => ['description' => 'Indicates whether Monitoring is enabled. This parameter is displayed when **configType** is set to **collectorTargetInstance**. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'configType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- collectorTargetInstance: the collector Output'."\n" + .'- collectorDeployMachine: the deployment machine of the collector'."\n" + .'- collectorElasticsearchForKibana: the Elasticsearch instance that supports Kibana Dashboard.', 'type' => 'string', 'example' => 'collectorDeployMachine', 'title' => ''], + 'instanceType' => ['description' => 'The type of instance specified in the collector Output. Valid values: elasticsearch and logstash. This parameter is displayed when **configType** is set to **collectorTargetInstance**.', 'type' => 'string', 'example' => 'elasticsearch', 'title' => ''], + 'groupId' => ['description' => 'The machine group ID. This parameter is displayed when **configType** is set to **collectorDeployMachine**.', 'type' => 'string', 'example' => 'default_ct-cn-5i2l75bz4776****', 'title' => ''], + 'host' => ['description' => 'The private endpoint of Kibana after Kibana Dashboard is enabled. This parameter is displayed when **configType** is set to **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'instanceId' => ['description' => 'The ID of the instance associated with the collector. When **configType** is set to **collectorTargetInstance**, this parameter indicates the instance ID of the collector Output. When **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**, this parameter indicates the ACK (Container Kubernetes) cluster ID.', 'type' => 'string', 'example' => 'es-cn-n6w1o1****', 'title' => ''], + 'machines' => [ + 'description' => 'The list of ECS machines on which the collector is deployed. This parameter is displayed when **configType** is set to **collectorDeployMachines** and **type** is set to **ECSInstanceId**.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'agentStatus' => ['description' => 'The status of the collector on the ECS instance. Valid values:'."\n" + ."\n" + .'- heartOk: The heartbeat is normal.'."\n" + .'- heartLost: The heartbeat is abnormal.'."\n" + .'- uninstalled: Not installed.'."\n" + .'- failed: Installation failed.', 'type' => 'string', 'example' => 'heartOk', 'title' => ''], + 'instanceId' => ['description' => 'The list of ECS instance IDs.', 'type' => 'string', 'example' => 'i-bp1gyhphjaj73jsr****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'hosts' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of access addresses of the instance specified in the collector Output. This parameter is displayed when **configType** is set to **collectorTargetInstance**.', 'type' => 'string', 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', 'title' => ''], 'description' => '', - 'type' => 'string', - 'example' => '["index"] ', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'collectorPaths' => [ + 'type' => 'array', + 'items' => ['description' => 'The Filebeat collection path.', 'type' => 'string', 'example' => '["/var/log"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.', - ], + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": {\\n \\"elasticExpansionTask\\": {\\n \\"triggerType\\": \\"crontab\\",\\n \\"replicaCount\\": 2,\\n \\"elasticNodeCount\\": 2,\\n \\"cronExpression\\": \\"0 0 0 ? * MON\\",\\n \\"targetIndices\\": [\\n \\"[\\\\\\"index\\\\\\"]\\"\\n ]\\n },\\n \\"elasticShrinkTask\\": {\\n \\"triggerType\\": \\"crontab\\",\\n \\"replicaCount\\": 2,\\n \\"elasticNodeCount\\": 2,\\n \\"cronExpression\\": \\"4 4 4 ? * WED\\",\\n \\"targetIndices\\": [\\n \\"[\\\\\\"index\\\\\\"] \\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<ModifyElastictaskResponse>\\n <RequestId>ECF7F13B-A26F-44E6-B77A-5AD5AC32****</RequestId>\\n <Result>\\n <elasticExpansionTask>\\n <TriggerType>crontab</TriggerType>\\n <ReplicaCount>2</ReplicaCount>\\n <CronExpression>0 0 0 ? * MON</CronExpression>\\n <ElasticNodeCount>2</ElasticNodeCount>\\n <TargetIndices>*</TargetIndices>\\n </elasticExpansionTask>\\n </Result>\\n</ModifyElastictaskResponse>","errorExample":""}]', - 'title' => 'ModifyElastictask', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"resId\\": \\"ct-cn-rg31ahn82m0qd****\\",\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"dryRun\\": false,\\n \\"ownerId\\": \\"16852099488*****\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"resType\\": \\"fileBeat\\",\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"status\\": \\"active\\",\\n \\"name\\": \\"ct-cn-4135is2tj194p****\\",\\n \\"configs\\": [\\n {\\n \\"content\\": \\"fileBeat.inputs:xxx\\",\\n \\"fileName\\": \\"filebeat.yml\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n {\\n \\"successPodsCount\\": \\"8\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"userName\\": \\"elastic\\",\\n \\"totalPodsCount\\": \\"10\\",\\n \\"type\\": \\"ECSInstanceId\\",\\n \\"kibanaHost\\": \\"https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"enableMonitoring\\": true,\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"host\\": \\"es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1****\\",\\n \\"machines\\": [\\n {\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"instanceId\\": \\"i-bp1gyhphjaj73jsr****\\"\\n }\\n ],\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve collector instance information', + 'summary' => 'Retrieves the details of a collector instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' **extendConfigs** includes three configType values: collectorTargetInstance, collectorElasticsearchForKibana, and collectorDeployMachine. The returned parameters vary depending on the deployment machine type. The specific combinations are as follows:'."\n" + .'- collectorTargetInstance'."\n" + .' - ECS'."\n" + .' configType, instanceId, instanceType, hosts, userName, password, protocol, enableMonitoring'."\n" + .' - ACK'."\n" + .' configType, instanceId, instanceType, userName, password, protocol, enableMonitoring.'."\n" + ."\n" + .'- collectorElasticsearchForKibana'."\n" + .' - ECS'."\n" + .' configType, instanceId, host, kibanaHost, userName, password, protocol'."\n" + .' - ACK'."\n" + .' configType'."\n" + .' '."\n" + .'- collectorDeployMachine'."\n" + .' - ECS'."\n" + .' configType, type, machines, groupId'."\n" + .' - ACK'."\n" + .' configType, type, instanceId, totalPodsCount, successPodsCount.', 'extraInfo' => ' ', - ], - 'ModifyInstanceMaintainTime' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/modify-maintaintime', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCollector'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + ], + ], + 'DescribeComponentIndex' => [ + 'summary' => 'Queries the details of a composable index template in Elasticsearch.', + 'path' => '/openapi/instances/{InstanceId}/component-index/{name}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-tl329rbpc0001****', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{ "openMaintainTime": true, "maintainStartTime": "03:00Z", "maintainEndTime": "04:00Z" }', - ], + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The name of the composable template.', 'type' => 'string', 'required' => false, 'example' => 'template', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'template' => [ + 'description' => 'The template information.', + 'type' => 'object', + 'properties' => [ + 'aliases' => ['description' => 'The alias configuration of the template.', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'mappings' => ['description' => 'The mappings configuration of the template.', 'type' => 'object', 'example' => '{ "properties": { "@timestamp": { "type": "date" } } }', 'title' => ''], + 'settings' => ['description' => 'The settings configuration of the template.', 'type' => 'object', 'example' => '{ "index.number_of_replicas": 0 }', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + '_meta' => ['description' => 'The metadata, which is used to store information such as remarks.', 'type' => 'object', 'example' => '{ "description": "set number of shards to one" }', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": {\\n \\"template\\": {\\n \\"aliases\\": {},\\n \\"mappings\\": {\\n \\"properties\\": {\\n \\"@timestamp\\": {\\n \\"type\\": \\"date\\"\\n }\\n }\\n },\\n \\"settings\\": {\\n \\"index.number_of_replicas\\": 0\\n }\\n },\\n \\"_meta\\": {\\n \\"description\\": \\"set number of shards to one\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'View composable index template details', + 'description' => 'For more information, see [Use OpenStore to store massive amounts of data](~~317694~~).', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-16T12:46:26.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentIndex'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeComponentIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], - '5XX' => [ + ], + ], + 'DescribeConnectableClusters' => [ + 'path' => '/openapi/instances/{InstanceId}/connectable-clusters', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The current instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + [ + 'name' => 'alreadySetItems', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return instances that are already connected. Valid values:'."\n" + ."\n" + .'- true (default): The returned instance list includes instances that are already connected.'."\n" + .'- false: The returned instance list does not include instances that are already connected.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'networkType' => ['description' => 'The network type of the instance.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'instances' => ['description' => 'The instance ID of instances that can establish private network peering.', 'type' => 'string', 'example' => 'es-cn-xxx', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], - ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating', 'description' => ''], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ModifyInstanceMaintainTime', - 'summary' => 'Enables and modifies the maintenance window of an Elasticsearch cluster.', - 'description' => 'es-cn-n6w1o1x0w001c\\*\\*\\*\\*'."\n", - 'requestParamsDescription' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"networkType\\": \\"vpc\\",\\n \\"instances\\": \\"es-cn-xxx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve private network peering instance list', + 'summary' => 'Retrieves a list of instances that can establish private network peering with the current instance. Instances that are already connected are not included.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateKibanaWhiteIps' => [ - 'summary' => 'Updates an IP address whitelist for access to the Kibana console of a specified Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/kibana-white-ips', - 'methods' => [ - 'patch', - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeConnectableClusters'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeConnectableClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'DescribeDeprecatedTemplate' => [ + 'summary' => 'Queries the details of a historical index template.', + 'path' => '/openapi/instances/{InstanceId}/deprecated-templates/{name}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-tl329rbpc0001****', - ], - ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The update mode. Valid values:'."\n" - ."\n" - .'* Cover: overwrites the IP addresses in the specified IP address whitelist with the IP addresses specified by using the ips parameter. This is the default value.'."\n" - .'* Append: adds the IP addresses specified by using the ips parameter to the specified IP address whitelist.'."\n" - .'* Delete: deletes the IP addresses specified by using the ips parameter from the specified IP address whitelist. At least one IP address must be retained for the whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-tl329rbpc0001****', 'title' => ''], ], [ - 'name' => 'modifyMode', - 'in' => 'query', - 'schema' => [ - 'title' => '修改方式，覆盖/新增/删除，针对设置分组时使用。不设置分组，默认覆盖default分组值', - 'description' => 'The body of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - 'default' => 'Cover', - 'enum' => [ - 'Cover', - 'Append', - 'Delete', - ], - ], + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The index template name.', 'type' => 'string', 'required' => true, 'example' => 'template', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The IP address whitelists of the Kibana node. You cannot configure both the kibanaIPWhitelist and whiteIpGroup parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'kibanaIPWhitelist' => [ - 'title' => 'kibana节点IP访问白名单。不可与分组同时设置。', - 'description' => 'The IP address whitelists. This parameter is available if the whiteIpGroup parameter is left empty. The default IP address whitelist is updated based on the value of this parameter.'."\n" - ."\n" - .'You cannot configure both the kibanaIPWhitelist and whiteIpGroup parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the IP address whitelist that you want to update. You can specify only one whitelist.'."\n" - ."\n" - .'You cannot configure both the kibanaIPWhitelist and whiteIpGroup parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["110.0.XX.XX/8"]', - ], - 'required' => false, - ], - 'whiteIpGroup' => [ - 'title' => 'Kibana 访问白名单分组设置', - 'description' => 'The name of the whitelist. This parameter is required if you configure the whiteIpGroup parameter.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], + 'Result' => [ + 'description' => 'The result information.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'title' => '分组名称', - 'description' => 'The type of the whitelist. Set the value to PUBLIC_KIBANA. This value indicates a public IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_group_name', - ], - 'whiteIpType' => [ - 'title' => '白名单类型，固定设置PUBLIC_KIBANA', - 'description' => 'The IP addresses in the whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC_KIBANA', - ], - 'ips' => [ - 'title' => '分组白名单列表', - 'description' => 'The IP addresses in the whitelist. This parameter is required if you configure the whiteIpGroup parameter.'."\n", + 'dataStream' => ['description' => 'Indicates whether automatic creation of a data stream is enabled. Valid values:'."\n" + ."\n" + .'- true: Automatic creation of a data stream is enabled.'."\n" + .'- false: Automatic creation of a data stream is not enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'indexPatterns' => [ + 'description' => 'The index pattern information.', 'type' => 'array', - 'items' => [ - 'title' => '白名单IP', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["0.0.0.0", "10.2.XX.XX"]', + 'items' => ['description' => 'The index pattern array.', 'type' => 'string', 'example' => '["schema1*","schema2*"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'indexTemplate' => ['description' => 'The index template name.', 'type' => 'string', 'example' => 'openstore-index-template', 'title' => ''], + 'order' => ['description' => 'The priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'template' => [ + 'description' => 'The index template configuration information.', + 'type' => 'object', + 'properties' => [ + 'aliases' => ['description' => 'The alias configuration.', 'type' => 'string', 'example' => '"{}"', 'title' => ''], + 'mappings' => ['description' => 'The mappings configuration of the index template.', 'type' => 'string', 'example' => '"{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}"', 'title' => ''], + 'settings' => ['description' => 'The settings configuration of the index template.', 'type' => 'string', 'example' => '"{\\"index.number_of_shards\\":\\"1\\"}"', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], + 'version' => ['description' => 'The version of the index template.', 'type' => 'string', 'example' => '70000', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": {\\n \\"dataStream\\": false,\\n \\"indexPatterns\\": [\\n \\"[\\\\\\"schema1*\\\\\\",\\\\\\"schema2*\\\\\\"]\\"\\n ],\\n \\"indexTemplate\\": \\"openstore-index-template\\",\\n \\"order\\": 100,\\n \\"template\\": {\\n \\"aliases\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"mappings\\": \\"\\\\\\"{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"created_at\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EEE MMM dd HH:mm:ss Z yyyy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"host_name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keyword\\\\\\\\\\\\\\"}}}\\\\\\"\\",\\n \\"settings\\": \\"\\\\\\"{\\\\\\\\\\\\\\"index.number_of_shards\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\\\\\"\\"\\n },\\n \\"version\\": \\"70000\\"\\n }\\n}","type":"json"}]', + 'title' => 'View historical index template details', + 'changeSet' => [ + ['createdAt' => '2022-12-13T08:50:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-16T12:46:26.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeprecatedTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeDeprecatedTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'DescribeDiagnoseReport' => [ + 'path' => '/openapi/diagnosis/instances/{InstanceId}/reports/{ReportId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchW11LSE'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-mp91kzb8m0009****', 'title' => ''], + ], + [ + 'name' => 'lang', + 'in' => 'query', + 'schema' => ['description' => 'The language of the intelligent diagnostic report. Default value: the browser language. Valid values:'."\n" + ."\n" + .'- en: English'."\n" + .'- zh: Simplified Chinese'."\n" + .'- zt: Traditional Chinese'."\n" + .'- es: Spanish'."\n" + .'- fr: French', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], + ], + [ + 'name' => 'ReportId', + 'in' => 'path', + 'schema' => ['description' => 'The report ID. You can call the [ListDiagnoseReportIds](~~183774~~) API operation to obtain the report ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'scheduled__2020-09-15T00:40:00', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The details of the Elasticsearch cluster.'."\n", - 'type' => 'string', - 'example' => 'E5EF11F1-DBAE-4020-AC24-DFA6C4345CAE', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'The private IP address whitelists for access to the Kibana console of the cluster.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'kibanaPrivateIPWhitelist' => [ - 'description' => 'The private IP address whitelists for access to the Kibana console of the cluster.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The public IP address whitelists for access to the Kibana console of the cluster.'."\n", - 'type' => 'string', - 'example' => '[ "192.168.XX.XX/24" ]', - ], - ], - 'kibanaIPWhitelist' => [ - 'description' => 'The public IP address whitelists for access to the Kibana console of the cluster.'."\n", + 'trigger' => ['description' => 'The method used to trigger the health diagnosis. Valid values: SYSTEM (automatically triggered by the system), INNER (internally triggered), and USER (manually triggered by the user).', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], + 'createTime' => ['description' => 'The timestamp when the report was created. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535745731000', 'title' => ''], + 'reportId' => ['description' => 'The report ID.', 'type' => 'string', 'example' => 'trigger__2020-08-17T17:09:02', 'title' => ''], + 'state' => ['description' => 'The diagnostic status. Valid values: SUCCESS, FAILED, and RUNNING.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'instanceId' => ['description' => 'The ID of the diagnosed instance.', 'type' => 'string', 'example' => 'es-cn-abc', 'title' => ''], + 'health' => ['description' => 'The overall health status of the cluster in the report. Valid values: GREEN, YELLOW, RED, and UNKNOWN.', 'type' => 'string', 'example' => 'YELLOW', 'title' => ''], + 'diagnoseItems' => [ + 'description' => 'The list of diagnostic items in the report.', 'type' => 'array', 'items' => [ - 'description' => 'The network configurations.'."\n", - 'type' => 'string', - 'example' => '["0.0.XX.XX", "10.2.XX.XX", "110.0.XX.XX/9"]', - ], - ], - 'networkConfig' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'object', - 'properties' => [ - 'vpcId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp1jy348ibzulk6hn****', - ], - 'vswitchId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1a0mifpletdd1da****', - ], - 'vsArea' => [ - 'description' => 'The network type.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'type' => [ - 'description' => 'The IP address whitelists.'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'whiteIpGroupList' => [ - 'description' => 'The IP address whitelists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the whitelist.'."\n", + 'type' => 'object', + 'properties' => [ + 'item' => ['description' => 'The name of the diagnostic item.', 'type' => 'string', 'example' => 'IndexAliasUseDiagnostic', 'title' => ''], + 'health' => ['description' => 'The health status of the diagnostic item. Valid values: GREEN, YELLOW, RED, and UNKNOWN.', 'type' => 'string', 'example' => 'YELLOW', 'title' => ''], + 'detail' => [ + 'description' => 'The details of the diagnostic item.', 'type' => 'object', 'properties' => [ - 'groupName' => [ - 'description' => 'The IP addresses in the whitelist.'."\n", - 'type' => 'string', - 'example' => 'test_group_name', - ], - 'ips' => [ - 'description' => 'The IP addresses in the whitelist.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the whitelist.'."\n", - 'type' => 'string', - 'example' => '["0.0.0.0", "10.2.XX.XX"]', - ], - ], - 'whiteIpType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PUBLIC_KIBANA', - ], + 'type' => ['description' => 'The type of the diagnostic result. Valid values: TEXT (text description), CONSOLE_API (console-triggered), and ES_API (API-triggered).', 'type' => 'string', 'example' => 'ES_API', 'title' => ''], + 'name' => ['description' => 'The full name of the diagnostic item.', 'type' => 'string', 'example' => 'Number of Replica Shards', 'title' => ''], + 'desc' => ['description' => 'The description of the diagnostic item.', 'type' => 'string', 'example' => 'Check whether the number of replica shards is optimal and easy to maintain', 'title' => ''], + 'result' => ['description' => 'The diagnostic result.', 'type' => 'string', 'example' => 'You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]', 'title' => ''], + 'suggest' => ['description' => 'The diagnostic suggestion.', 'type' => 'string', 'example' => 'You can call the following function in the Elasticsearch API....', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'items' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'item' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'state' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'desc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'suggest' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'detail' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'diagnosisMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E5EF11F1-DBAE-4020-AC24-DFA6C4345CAE\\",\\n \\"Result\\": {\\n \\"kibanaPrivateIPWhitelist\\": [\\n \\"[ \\\\\\"192.168.XX.XX/24\\\\\\" ]\\"\\n ],\\n \\"kibanaIPWhitelist\\": [\\n \\"[\\\\\\"0.0.XX.XX\\\\\\", \\\\\\"10.2.XX.XX\\\\\\", \\\\\\"110.0.XX.XX/9\\\\\\"]\\"\\n ],\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-bp1jy348ibzulk6hn****\\",\\n \\"vswitchId\\": \\"vsw-bp1a0mifpletdd1da****\\",\\n \\"vsArea\\": \\"cn-hangzhou-h\\",\\n \\"type\\": \\"vpc\\",\\n \\"whiteIpGroupList\\": [\\n {\\n \\"groupName\\": \\"test_group_name\\",\\n \\"ips\\": [\\n \\"[\\\\\\"0.0.0.0\\\\\\", \\\\\\"10.2.XX.XX\\\\\\"]\\"\\n ],\\n \\"whiteIpType\\": \\"PUBLIC_KIBANA\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateKibanaWhiteIps', - 'description' => '* Before you call this operation, you must make sure that the cluster is not in the activating, invalid, or inactive state.'."\n" - ."\n" - .'* You can update an IP address whitelist by using the following parameters:'."\n" - ."\n" - .' * kibanaIPWhitelist'."\n" - .' * modifyMode and whiteIpGroup'."\n" - ."\n" - .'* You cannot specify private IP addresses for public IP address whitelists and cannot specify public IP addresses for private IP address whitelists.', - 'requestParamsDescription' => '> If you want to add an IP address whitelist, you can set the modifyMode parameter only to Cover. If you set this parameter to Delete or Append, you can only update an IP address whitelist.'."\n" - ."\n" - .'* If you set the modifyMode parameter to Cover and leave the ips parameter empty, the system deletes the specified whitelist. If the whitelist specified by using the groupName parameter does not exist, the system creates such a whitelist.'."\n" - .'* If you set the modifyMode parameter to Delete, at least one IP address must be retained for the specified whitelist.'."\n" - .'* If you set the modifyMode parameter to Append, you must make sure that the specified whitelist exists. Otherwise, the system reports the NotFound error.'."\n", - 'responseParamsDescription' => '> Some parameters are displayed in the following sample code but are not provided in the preceding tables. You cannot force your program to obtain these parameters.'."\n", + 'title' => 'View Historical Reports of Intelligent O&M', + 'summary' => 'Calls the DescribeDiagnoseReport operation to view historical reports of intelligent O&M.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateWhiteIps' => [ - 'summary' => 'Updates a private IP address whitelist of an Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/white-ips', - 'methods' => [ - 'patch', - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnoseReport'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeDiagnoseReport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"trigger\\": \\"SYSTEM\\",\\n \\"createTime\\": 1535745731000,\\n \\"reportId\\": \\"trigger__2020-08-17T17:09:02\\",\\n \\"state\\": \\"SUCCESS\\",\\n \\"instanceId\\": \\"es-cn-abc\\",\\n \\"health\\": \\"YELLOW\\",\\n \\"diagnoseItems\\": [\\n {\\n \\"item\\": \\"IndexAliasUseDiagnostic\\",\\n \\"health\\": \\"YELLOW\\",\\n \\"detail\\": {\\n \\"type\\": \\"ES_API\\",\\n \\"name\\": \\"Number of Replica Shards\\",\\n \\"desc\\": \\"Check whether the number of replica shards is optimal and easy to maintain\\",\\n \\"result\\": \\"You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]\\",\\n \\"suggest\\": \\"You can call the following function in the Elasticsearch API....\\"\\n }\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"item\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"state\\": \\"\\",\\n \\"desc\\": \\"\\",\\n \\"suggest\\": \\"\\",\\n \\"detail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"diagnosisMode\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeDiagnosisSettings' => [ + 'path' => '/openapi/diagnosis/instances/{InstanceId}/settings', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchW11LSE'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The request body.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-npk2154oi000b****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-68n1n8b7f000a****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP addresses in the whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ - 'name' => 'modifyMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP addresses in the whitelist. This parameter is available if the whiteIpGroup parameter is left empty. The default IP address whitelist is updated based on the value of this parameter.'."\n" - ."\n" - .'> You cannot configure both the esIPWhitelist and whiteIpGroup parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the IP address whitelist that you want to update. You can specify only one whitelist.'."\n" - ."\n" - .'> You cannot configure both the esIPWhitelist and whiteIpGroup parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'esIPWhitelist' => [ - 'description' => 'The name of the whitelist. This parameter is required if you configure the whiteIpGroup parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP addresses in the whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["10.61.xx.xx", "106.11.xx.xx”]', - ], - 'required' => false, - ], - 'whiteIpGroup' => [ - 'description' => 'The IP addresses in the whitelist. This parameter is required if you configure the whiteIpGroup parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'description' => 'The type of the whitelist. Set the value to **PRIVATE_ES**. This value indicates a private IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_group', - ], - 'ips' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["10.2.xx.xx", "10.3.xx.xx"]', - ], - 'required' => false, - ], - 'whiteIpType' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRIVATE_ES', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The language of the returned results. Default value: en.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The private IP address whitelist. This parameter is deprecated.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The updated whitelist.'."\n", - 'type' => 'string', - 'example' => '8D58B014-BBD7-4D80-B219-00B9D5C6860C', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5E82B8A8-EED7-4557-A6E9-D1AD3E58****', 'title' => ''], 'Result' => [ - 'description' => 'The network configurations.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'esIPWhitelist' => [ - 'description' => 'The list of whitelists.'."\n", + 'updateTime' => ['description' => 'The timestamp when the intelligent O&M scenario was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1588994035385', 'title' => ''], + 'scene' => ['description' => 'The scenario of intelligent O&M.', 'type' => 'string', 'example' => 'Business Search', 'title' => ''], + 'diagnosisMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'dailyScheduleEnabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'authorizationStatus' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'selectedItems' => [ 'type' => 'array', - 'items' => [ - 'description' => 'The information about a whitelist.'."\n", - 'type' => 'string', - 'example' => '["106.11.xx.xx", "10.61.xx.xx"]', - ], - ], - 'networkConfig' => [ - 'description' => 'The name of the whitelist. By default, the default whitelist is included.'."\n", - 'type' => 'object', - 'properties' => [ - 'whiteIpGroupList' => [ - 'description' => 'The IP addresses in the whitelist.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP addresses in the whitelist.'."\n", - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'description' => 'The type of the whitelist. The value of this parameter is fixed as PRIVATE_ES, which indicates a private IP address whitelist.'."\n", - 'type' => 'string', - 'example' => 'test_group', - ], - 'ips' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["10.2.xx.xx", "10.3.xx.xx"]', - ], - ], - 'whiteIpType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PRIVATE_ES', - ], - ], - ], - ], - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'dailyLimit' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'title' => 'Get intelligent O&M scenario settings', + 'summary' => 'Calls the DescribeDiagnosisSettings operation to obtain the scenario settings of intelligent O&M.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisSettings'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeDiagnosisSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 500 => [ + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E82B8A8-EED7-4557-A6E9-D1AD3E58****\\",\\n \\"Result\\": {\\n \\"updateTime\\": 1588994035385,\\n \\"scene\\": \\"Business Search\\",\\n \\"diagnosisMode\\": \\"\\",\\n \\"dailyScheduleEnabled\\": false,\\n \\"authorizationStatus\\": false,\\n \\"selectedItems\\": [\\n \\"\\"\\n ],\\n \\"dailyLimit\\": 0\\n }\\n}","type":"json"}]', + ], + 'DescribeDynamicSettings' => [ + 'summary' => 'Retrieves dynamic metrics of a cluster.', + 'path' => '/openapi/instances/{InstanceId}/dynamic-settings', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ + 'title' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Result' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8D58B014-BBD7-4D80-B219-00B9D5C6860C\\",\\n \\"Result\\": {\\n \\"esIPWhitelist\\": [\\n \\"[\\\\\\"106.11.xx.xx\\\\\\", \\\\\\"10.61.xx.xx\\\\\\"]\\"\\n ],\\n \\"networkConfig\\": {\\n \\"whiteIpGroupList\\": [\\n {\\n \\"groupName\\": \\"test_group\\",\\n \\"ips\\": [\\n \\"[\\\\\\"10.2.xx.xx\\\\\\", \\\\\\"10.3.xx.xx\\\\\\"]\\"\\n ],\\n \\"whiteIpType\\": \\"PRIVATE_ES\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateWhiteIps', - 'description' => '> For more information about the parameters displayed in the following sample code but not provided in the preceding tables, see [ListInstance](~~142230~~). You cannot force your program to obtain these parameters.'."\n", - 'requestParamsDescription' => 'The ID of the cluster.'."\n", - 'responseParamsDescription' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'extraInfo' => ' ', - ], - 'ListInstance' => [ - 'summary' => 'Queries a list of Elasticsearch clusters.', - 'path' => '/openapi/instances', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-30T06:29:10.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDynamicSettings'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeDynamicSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"\\",\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + ], + 'DescribeElasticsearchHealth' => [ + 'summary' => 'Queries the health status of a cluster to check whether it is running properly.', + 'path' => '/openapi/instances/{InstanceId}/elasticsearch-health', + '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' => '64319', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '\\[{"tagKey":"key1","tagValue":"value1"}]'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-tl325wxga000l****', 'title' => ''], ], - [ - 'name' => 'size', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'vpc-bp16k1dvzxtmagcva\\*\\*\\*\\*'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0731F217-2C8A-4D42-8BCD-5C352866E3B7', 'title' => ''], + 'Result' => ['description' => 'The health status of the instance.', 'type' => 'string', 'example' => 'GREEN', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0731F217-2C8A-4D42-8BCD-5C352866E3B7\\",\\n \\"Result\\": \\"GREEN\\"\\n}","type":"json"}]', + 'title' => 'View cluster health status', + 'description' => 'The instance health status. The following three states are supported:'."\n" + ."\n" + .'- GREEN: Primary and replica shards are allocated properly.'."\n" + ."\n" + .'- YELLOW: Primary shards are allocated properly, but replica shards are not allocated properly.'."\n" + ."\n" + .'- RED: Primary shards are not allocated properly.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticsearchHealth'], + ], + ], + 'ramActions' => [ [ - 'name' => 'description', - 'in' => 'query', - 'schema' => [ - 'description' => 'cn-hangzhou-i'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aliyunes_test1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeElasticsearchHealth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], + ], + ], + 'DescribeILMPolicy' => [ + 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'instanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'postpaid'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-v641a0ta3000g****', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'esVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'advanced'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '6.7_with_X-Pack', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082****', 'title' => ''], ], [ - 'name' => 'resourceGroupId', - 'in' => 'query', + 'name' => 'PolicyName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the index lifecycle policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'policy-1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzvowej3i****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FF44681E-FD41-4FDE-B8DF-295DCDD6****', 'title' => ''], + 'Result' => [ + 'description' => 'The details of the specified index lifecycle policy.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the index lifecycle policy.', 'type' => 'string', 'example' => 'ilm-history-ilm-policy', 'title' => ''], + 'phases' => ['description' => 'The content of the index lifecycle policy.', 'type' => 'object', 'example' => '{"cold":{"minAge":"30d","actions":{"allocate":{"numberOfReplicas":1,"require":{"boxType":"warm"}},"setPriority":{"priority":100}}},"hot":{"minAge":"0s","actions":{"rollover":{"maxAge":"30d","maxDocs":10000,"maxSize":"50gb"},"setPriority":{"priority":1000}}},"delete":{"minAge":"30d","actions":{"delete":{}}}}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'tags', - 'in' => 'query', + '4XX' => [ 'schema' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"tagKey":"key1","tagValue":"value1"}]', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'vpcId', - 'in' => 'query', + '5XX' => [ 'schema' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp16k1dvzxtmagcva****', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FF44681E-FD41-4FDE-B8DF-295DCDD6****\\",\\n \\"Result\\": {\\n \\"name\\": \\"ilm-history-ilm-policy\\",\\n \\"phases\\": {\\n \\"cold\\": {\\n \\"minAge\\": \\"30d\\",\\n \\"actions\\": {\\n \\"allocate\\": {\\n \\"numberOfReplicas\\": 1,\\n \\"require\\": {\\n \\"boxType\\": \\"warm\\"\\n }\\n },\\n \\"setPriority\\": {\\n \\"priority\\": 100\\n }\\n }\\n },\\n \\"hot\\": {\\n \\"minAge\\": \\"0s\\",\\n \\"actions\\": {\\n \\"rollover\\": {\\n \\"maxAge\\": \\"30d\\",\\n \\"maxDocs\\": 10000,\\n \\"maxSize\\": \\"50gb\\"\\n },\\n \\"setPriority\\": {\\n \\"priority\\": 1000\\n }\\n }\\n },\\n \\"delete\\": {\\n \\"minAge\\": \\"30d\\",\\n \\"actions\\": {\\n \\"delete\\": {}\\n }\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query index lifecycle details', + 'summary' => 'Queries the details of a specified index lifecycle policy.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '**Data structure of the phases field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|{key}|Struct| |No|The current lifecycle phase. The following three phases are supported:<br>hot: The hot data phase, in which the index is actively being updated and queried.<br>cold: The cold data phase, in which the index is no longer updated and is rarely queried. The information still needs to be searchable, but slower query performance is acceptable.<br>delete: The delete phase, in which the index is no longer needed and can be safely deleted.|'."\n" + .'|minAge|String|30d|No|The time required for the index to reach the target phase.|'."\n" + .'|actions|Struct| |No|The policy settings for the current phase. For more information, see the **Data structure of the actions field** below.|.'."\n" + ."\n" + .'**Data structure of the actions field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|rollover|Struct| |No|The index rollover operation in the hot phase. For more information, see the **Data structure of the rollover field** below.|'."\n" + .'|setPriority|Struct| |No|The index priority in the hot or cold phase. For more information, see the **Data structure of the setPriority field** below.|'."\n" + .'|allocate|Struct| |No|The allocation operation in the cold phase. For more information, see the **Data structure of the allocate field** below.|'."\n" + .'|delete|Struct| {} |No|The delete index operation. When the delete phase is enabled, this parameter is required and must be an empty object.|.'."\n" + ."\n" + .'**Data structure of the rollover field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|maxAge|String|30d|No|The time threshold that triggers an index rollover. Specify at least one of maxAge, maxDocs, and maxSize. Unit: d (days) or h (hours).|'."\n" + .'|maxDocs|Integer|10000|No|The document count threshold that triggers an index rollover.|'."\n" + .'|maxSize|String|50gb|No|The index size threshold that triggers an index rollover. Specify at least one of maxAge, maxDocs, and maxSize. Unit: mb or gb.|.'."\n" + ."\n" + .'**Data structure of the setPriority field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|priority|Integer|100|No|The default priority of the current node.|.'."\n" + ."\n" + .'**Data structure of the allocate field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|numberOfReplicas|Integer|1|No|The number of replicas to allocate. If specified, the default value is 1. This parameter is used together with migrate. When automatic migration is enabled, replica allocation is performed by default.|'."\n" + .'|require |Struct| |No|An optional setting available for hot-warm architecture clusters. For more information, see the **Data structure of the require field** below.|.'."\n" + ."\n" + .'**Data structure of the require field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|boxType|String|warm|No|The custom node attribute identifier, available for hot-warm architecture clusters. This parameter migrates data to warm nodes. Valid values: warm.|.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeILMPolicy'], + ], + ], + 'ramActions' => [ [ - 'name' => 'zoneId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-i', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeILMPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], ], ], + ], + ], + 'DescribeIndexTemplate' => [ + 'path' => '/openapi/instances/{InstanceId}/index-templates/{IndexTemplate}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'paymentType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include dedicated master nodes. Valid values:'."\n" - ."\n" - .'* true: The files contain data that is dumped to the IA storage medium.'."\n" - .'* false: The files do not contain data that is dumped to the IA storage medium.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'postpaid', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'instanceCategory', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of data nodes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'advanced', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w24n9u900am****', 'title' => ''], ], [ - 'name' => 'status', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'IndexTemplate', + 'in' => 'path', + 'schema' => ['description' => 'The name of the index template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'data-stream-default', 'title' => ''], ], ], 'responses' => [ @@ -6882,534 +5683,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The time when the node is created.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Headers' => [ - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* active: normal'."\n" - .'* activating: taking effect'."\n" - .'* inactive: frozen'."\n" - .'* invalid: invalid'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '25DB38F8-82E4-4D16-82BB-FF077C7F****', 'title' => ''], + 'Result' => [ + 'description' => 'The details of the index template.', 'type' => 'object', 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'Specifies whether to include dedicated master nodes (obsolete). Valid values:'."\n" - ."\n" - .'* true: The files contain data that is dumped to the IA storage medium.'."\n" - .'* false: The files do not contain data that is dumped to the IA storage medium.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'dataStream' => ['description' => 'Indicates whether the data stream is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.'."\n" + ."\n" + .'Default value: false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'indexTemplate' => ['description' => 'The name of the index template.', 'type' => 'string', 'example' => 'data-stream-default', 'title' => ''], + 'ilmPolicy' => ['description' => 'The Policy Name of the lifecycle epoch.', 'type' => 'string', 'example' => 'cube_default_ilm_policy', 'title' => ''], + 'priority' => ['description' => 'The priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'indexPatterns' => [ + 'type' => 'array', + 'items' => ['description' => 'The index matching pattern (regular expression).', 'type' => 'string', 'example' => 'ds-*', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - 'Result' => [ - 'description' => 'Indicates whether it is a service VPC.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'advancedDedicateMaster' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* **prepaid**: subscription'."\n" - .'* **postpaid**: pay-as-you-go'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'nodeAmount' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'createdAt' => [ - 'description' => 'The status of the pay-as-you-go service that is overlaid on a subscription instance. Valid values:'."\n" - ."\n" - .'* **active**: normal'."\n" - .'* **closed**: Close'."\n" - .'* **indebt**: Overdue payments are frozen'."\n", - 'type' => 'string', - 'example' => '2018-07-13T03:58:07.253Z', - ], - 'status' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'dedicateMaster' => [ - 'description' => 'The edition of the dedicated KMS instance.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'serviceVpc' => [ - 'description' => 'Specifies whether to deploy the new architecture.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'paymentType' => [ - 'description' => 'The time when the instance was last updated.'."\n", - 'type' => 'string', - 'example' => 'postpaid', - ], - 'resourceGroupId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'rg-aekzvowej3i****', - ], - 'postpaidServiceStatus' => [ - 'description' => 'The tags of the instance. Each tag is a key-value pair.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'description' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'es-cn-abc', - ], - 'esVersion' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => '6.7_with_X-Pack', - ], - 'isNewDeployment' => [ - 'description' => 'The configuration of cluster extension parameters.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'updatedAt' => [ - 'description' => 'Coordination node configuration.'."\n", - 'type' => 'string', - 'example' => '2018-07-18T10:10:04.484Z', - ], - 'instanceId' => [ - 'description' => 'The instance type of the node. For more information, see [Specifications](~~271718~~).'."\n", - 'type' => 'string', - 'example' => 'es-cn-v641a0ta3000g****', - ], - 'tags' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'tagKey' => [ - 'description' => 'The size of the node storage space. Unit: GB.'."\n", - 'type' => 'string', - 'example' => 'env', - ], - 'tagValue' => [ - 'description' => 'The storage type of the node. Only ultra disks (cloud_efficiency) are supported.'."\n", - 'type' => 'string', - 'example' => 'dev', - ], - ], - ], - ], - 'extendConfigs' => [ - 'description' => 'The configurations of elastic data nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '[{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }]', - ], - ], - 'clientNodeConfiguration' => [ - 'description' => 'The instance type of the node. For more information, see [Specifications](~~271718~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.large', - ], - 'amount' => [ - 'description' => 'The size of the node storage space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'disk' => [ - 'description' => 'Specifies whether to enable disk encryption for the node. Valid values:'."\n" - ."\n" - .'* true: enables instant image cache.'."\n" - .'* false: disables reuse of image cache layers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskType' => [ - 'description' => 'The storage type of the node. Valid values:'."\n" - ."\n" - .'* cloud_ssd: SSD.'."\n" - .'* cloud_essd: ESSD.'."\n" - .'* cloud_efficiency: ultra disk'."\n", - 'type' => 'string', - 'example' => 'cloud_efficiency', - ], - 'specInfo' => [ - 'type' => 'string', - ], - ], - ], - 'elasticDataNodeConfiguration' => [ - 'description' => 'The configuration of Kibana nodes.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The instance type of the node. For more information, see [Specifications](~~271718~~).'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.large', - ], - 'amount' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'disk' => [ - 'description' => 'The size of the node storage space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskEncryption' => [ - 'description' => 'The storage type of the node.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'diskType' => [ - 'description' => 'The configuration of dedicated master nodes.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'specInfo' => [ - 'type' => 'string', - ], - ], - ], - 'kibanaConfiguration' => [ - 'description' => 'The instance type of the node. For more information, see [Specifications](~~271718~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'amount' => [ - 'description' => 'The size of the node storage space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'disk' => [ - 'description' => 'The storage type of the node. Only cloud_ssd(SSD cloud disk) is supported.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskType' => [ - 'description' => 'The network configurations.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'specInfo' => [ - 'type' => 'string', - ], - ], - ], - 'masterConfiguration' => [ - 'description' => 'The VPC ID of the cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The zone where the cluster resides.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.large', - ], - 'amount' => [ - 'description' => 'The network type. Only Virtual Private Cloud (VPC) is supported.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'disk' => [ - 'description' => 'The vSwitch ID of the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskType' => [ - 'description' => 'The configuration of data nodes.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'specInfo' => [ - 'type' => 'string', - ], - ], - ], - 'networkConfig' => [ - 'description' => 'The instance type of the node. For more information, see [Specifications](~~271718~~).'."\n", - 'type' => 'object', - 'properties' => [ - 'vpcId' => [ - 'description' => 'The storage space of the node. Unit: GB.'."\n", - 'type' => 'string', - 'example' => 'vpc-abc', - ], - 'vsArea' => [ - 'description' => 'Specifies whether to use disk encryption. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-e', - ], - 'type' => [ - 'description' => 'The storage type of the node. Valid values:'."\n" - ."\n" - .'* cloud_ssd: standard SSD'."\n" - .'* cloud_efficiency: ultra disk'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'vswitchId' => [ - 'description' => 'The performance level of the ESSD. This parameter is required when the diskType parameter is set to cloud_essd. Valid values: PL1, PL2, and PL3.'."\n", - 'type' => 'string', - 'example' => 'vsw-def', - ], - 'whiteIpGroupList' => [ - 'title' => '集群公私网网络白名单分组设置。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'title' => '分组名。', - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], - 'whiteIpType' => [ - 'title' => '网络类型。PRIVATE_ES，ES私网。PUBLIC_KIBANA。Kibana公网。PUBLIC_ES，ES公网。PRIVATE_KIBANA，Kibana私网。', - 'description' => '', - 'type' => 'string', - 'example' => 'PUBLIC_KIBANA', - 'enum' => [ - 'PRIVATE_ES', - 'PUBLIC_KIBANA', - 'PUBLIC_ES', - 'PRIVATE_KIBANA', - ], - ], - 'ips' => [ - 'title' => '网络白名单列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["0.0.0.0", "127.0.XX.XX"]', - ], - ], - ], - ], - ], - ], - ], - 'nodeSpec' => [ - 'description' => 'The VPC ID of the cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'diskEncryption' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'performanceLevel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PL1', - ], - 'specInfo' => [ - 'type' => 'string', - ], - ], - ], - 'vpcInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-bp1uag5jj38c****', - ], - 'kibanaIPWhitelist' => [ - 'title' => '集群Kibana节点公网访问白名单。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '"0.0.0.0/0"', - ], - ], - 'kibanaPrivateIPWhitelist' => [ - 'title' => '集群Kibana节点私网访问白名单。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["192.168.XX.XX"]', - ], - ], - 'publicIpWhitelist' => [ - 'title' => 'Elasticsearch集群公网访问白名单。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[ "0.0.0.0/0" ]', - ], - ], - 'privateNetworkIpWhiteList' => [ - 'title' => 'Elasticsearch集群私网访问白名单。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["192.168.XX.XX/25"]', - ], - ], - 'endTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'archType' => [ - 'type' => 'string', - ], - 'domain' => [ - 'type' => 'string', - ], - 'port' => [ - 'type' => 'string', - ], - 'protocol' => [ - 'type' => 'string', - ], - 'zoneCount' => [ - 'title' => '可用区数目', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'zoneInfos' => [ - 'title' => '可用区信息', - 'type' => 'array', - 'items' => [ - 'title' => '可用区信息', - 'type' => 'object', - 'properties' => [ - 'zoneId' => [ - 'title' => '可用区如cn-hangzhou-i', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'status' => [ - 'title' => '可用区状态 NORMAL: 正常; ISOLATION: 隔离', - 'type' => 'string', - 'example' => 'NORMAL', - ], - ], - ], + 'template' => [ + 'description' => 'The component template.', + 'type' => 'object', + 'properties' => [ + 'settings' => ['description' => 'The settings configuration.', 'type' => 'string', 'example' => '{\\"index.refresh_interval\\":\\"1s\\"}', 'title' => ''], + 'mappings' => ['description' => 'The mappings configuration.', 'type' => 'string', 'example' => '{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}', 'title' => ''], + 'aliases' => ['description' => 'The aliases configuration.', 'type' => 'string', 'example' => '{\\"mydata\\":{}}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => 'Code', - 'description' => 'Code', - 'type' => 'string', - ], - 'Message' => [ - 'title' => 'Message', - 'description' => 'Message', - 'type' => 'string', - ], - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId', - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"Result\\": [\\n {\\n \\"advancedDedicateMaster\\": false,\\n \\"nodeAmount\\": 2,\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"status\\": \\"active\\",\\n \\"dedicateMaster\\": false,\\n \\"serviceVpc\\": true,\\n \\"paymentType\\": \\"postpaid\\",\\n \\"resourceGroupId\\": \\"rg-aekzvowej3i****\\",\\n \\"postpaidServiceStatus\\": \\"active\\",\\n \\"description\\": \\"es-cn-abc\\",\\n \\"esVersion\\": \\"6.7_with_X-Pack\\",\\n \\"isNewDeployment\\": \\"true\\",\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"instanceId\\": \\"es-cn-v641a0ta3000g****\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"dev\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n [\\n {\\n \\"configType\\": \\"aliVersion\\",\\n \\"aliVersion\\": \\"ali1.3.0\\"\\n }\\n ]\\n ],\\n \\"clientNodeConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_efficiency\\",\\n \\"specInfo\\": \\"1C 2G\\"\\n },\\n \\"elasticDataNodeConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"kibanaConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 1,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-abc\\",\\n \\"vsArea\\": \\"cn-hangzhou-e\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-def\\",\\n \\"whiteIpGroupList\\": [\\n {\\n \\"groupName\\": \\"default\\",\\n \\"whiteIpType\\": \\"PUBLIC_KIBANA\\",\\n \\"ips\\": [\\n \\"[\\\\\\"0.0.0.0\\\\\\", \\\\\\"127.0.XX.XX\\\\\\"]\\"\\n ]\\n }\\n ]\\n },\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 50,\\n \\"diskEncryption\\": false,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"performanceLevel\\": \\"PL1\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"vpcInstanceId\\": \\"vpc-bp1uag5jj38c****\\",\\n \\"kibanaIPWhitelist\\": [\\n \\"\\\\\\"0.0.0.0/0\\\\\\"\\"\\n ],\\n \\"kibanaPrivateIPWhitelist\\": [\\n \\"[\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"publicIpWhitelist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"privateNetworkIpWhiteList\\": [\\n \\"[\\\\\\"192.168.XX.XX/25\\\\\\"]\\"\\n ],\\n \\"endTime\\": 1715826092044,\\n \\"archType\\": \\"public\\",\\n \\"domain\\": \\"es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com\\",\\n \\"port\\": \\"9200\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"zoneCount\\": 1,\\n \\"zoneInfos\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"status\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListInstance', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25DB38F8-82E4-4D16-82BB-FF077C7F****\\",\\n \\"Result\\": {\\n \\"dataStream\\": true,\\n \\"indexTemplate\\": \\"data-stream-default\\",\\n \\"ilmPolicy\\": \\"cube_default_ilm_policy\\",\\n \\"priority\\": 0,\\n \\"indexPatterns\\": [\\n \\"ds-*\\"\\n ],\\n \\"template\\": {\\n \\"settings\\": \\"{\\\\\\\\\\\\\\"index.refresh_interval\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1s\\\\\\\\\\\\\\"}\\",\\n \\"mappings\\": \\"{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"created_at\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EEE MMM dd HH:mm:ss Z yyyy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"host_name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keyword\\\\\\\\\\\\\\"}}}\\",\\n \\"aliases\\": \\"{\\\\\\\\\\\\\\"mydata\\\\\\\\\\\\\\":{}}\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'View index template information', + 'summary' => 'Returns information about an index template.', 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIndexTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeIndexTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], ], 'DescribeInstance' => [ - 'summary' => 'The name of the dictionary file.', 'path' => '/openapi/instances/{InstanceId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7422,21 +5798,13 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '64251', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-3h4k3axh33th9****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-3h4k3axh33th9****', 'title' => ''], ], ], 'responses' => [ @@ -7444,876 +5812,552 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'advancedDedicateMaster' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'protocol' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'HTTP', - ], - 'enableKibanaPublicNetwork' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'nodeAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'createdAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-07-13T03:58:07.253Z', - ], - 'enableKibanaPrivateNetwork' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'vpcInstanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-bp1uag5jj38c****', - ], - 'port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'enablePublic' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'dedicateMaster' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'kibanaPort' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5601', - ], - 'esConfig' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{"http.cors.allow-credentials":"false"}', - ], - 'resourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rg-aekzvowej3i****', - ], - 'paymentType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'postpaid', - ], - 'postpaidServiceStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'active', - ], - 'esVersion' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6.3.2_with_X-Pack', - ], - 'haveKibana' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'isNewDeployment' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'warmNode' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'updatedAt' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2018-07-13T03:58:07.253Z', - ], - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-3h4k3axh33th9****', - ], - 'zoneCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'publicDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com', - ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'active', - ], - 'serviceVpc' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'publicPort' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'haveClientNode' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'domain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com', - ], - 'description' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-abc', - ], - 'kibanaDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com', - ], + 'advancedDedicateMaster' => ['description' => 'Indicates whether the instance contains a dedicated master node. Valid values:'."\n" + ."\n" + .'- true: The instance contains a dedicated master node.'."\n" + ."\n" + .'- false: The instance does not contain a dedicated master node.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'protocol' => ['description' => 'The access protocol. Valid values: HTTP and HTTPS.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'enableKibanaPublicNetwork' => ['description' => 'Indicates whether public network access to Kibana is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'nodeAmount' => ['description' => 'The number of data nodes in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'createdAt' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2018-07-13T03:58:07.253Z', 'title' => ''], + 'enableKibanaPrivateNetwork' => ['description' => 'Indicates whether internal-facing access to Kibana is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'vpcInstanceId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1uag5jj38c****', 'title' => ''], + 'port' => ['description' => 'The access port of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'enablePublic' => ['description' => 'Indicates whether the public endpoint of the instance is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'dedicateMaster' => ['description' => 'The dedicated master node (deprecated).', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'kibanaPort' => ['description' => 'The access port of Kibana.', 'type' => 'integer', 'format' => 'int32', 'example' => '5601', 'title' => ''], + 'esConfig' => ['description' => 'The YML file configuration of the instance.', 'type' => 'object', 'example' => '{"http.cors.allow-credentials":"false"}', 'title' => ''], + 'resourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-aekzvowej3i****', 'title' => ''], + 'paymentType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- prepaid: subscription.'."\n" + ."\n" + .'- postpaid: pay-as-you-go.', 'type' => 'string', 'example' => 'postpaid', 'title' => ''], + 'postpaidServiceStatus' => ['description' => 'The status of the pay-as-you-go service that is overlaid on the subscription instance. Valid values:'."\n" + ."\n" + .'- active: Normal.'."\n" + ."\n" + .'- closed: Closed.'."\n" + ."\n" + .'- indebt: Frozen due to overdue payment.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'esVersion' => ['description' => 'The instance version.', 'type' => 'string', 'example' => '6.3.2_with_X-Pack', 'title' => ''], + 'haveKibana' => ['description' => 'Indicates whether the instance contains a Kibana node. Valid values:'."\n" + ."\n" + .'- true: The instance contains a Kibana node.'."\n" + ."\n" + .'- false: The instance does not contain a Kibana node.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'isNewDeployment' => ['description' => 'Indicates whether the instance uses the new deployment architecture.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'warmNode' => ['description' => 'Specifies whether warm data nodes are enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'updatedAt' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2018-07-13T03:58:07.253Z', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-cn-3h4k3axh33th9****', 'title' => ''], + 'zoneCount' => ['description' => 'The number of zones for the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'publicDomain' => ['description' => 'The public endpoint of the instance.', 'type' => 'string', 'example' => 'es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com', 'title' => ''], + 'status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- active: Normal.'."\n" + ."\n" + .'- activating: Taking effect.'."\n" + ."\n" + .'- inactive: Frozen.'."\n" + ."\n" + .'- invalid: Invalid. The cluster does not exist or is inaccessible. In this case, some fields in the response may be missing, such as domain and kibanaDomain.'."\n" + ."\n" + .'- unknown: Unknown. The cluster does not exist or is inaccessible. In this case, some fields in the response may be missing, such as domain and kibanaDomain.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'serviceVpc' => ['description' => 'Indicates whether the instance is a service VPC instance.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'publicPort' => ['description' => 'The public network access port of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'haveClientNode' => ['description' => 'Indicates whether the instance contains client nodes. Valid values:'."\n" + ."\n" + .'- true: The instance contains client nodes.'."\n" + ."\n" + .'- false: The instance does not contain client nodes.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'domain' => ['description' => 'The internal endpoint of the instance.', 'type' => 'string', 'example' => 'es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com', 'title' => ''], + 'description' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'es-cn-abc', 'title' => ''], + 'kibanaDomain' => ['description' => 'The Kibana endpoint.', 'type' => 'string', 'example' => 'es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com', 'title' => ''], 'dictList' => [ - 'description' => '', + 'description' => 'The IK dictionary configuration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'sourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ORIGIN', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM_MAIN.dic', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MAIN', - ], + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'sourceType' => ['description' => 'The source type of the dictionary file. Valid values:'."\n" + ."\n" + .'- OSS: Object Storage Service (OSS). Make sure that the OSS bucket has public read permissions.'."\n" + .'- ORIGIN: Open-source Elasticsearch.'."\n" + .'- UPLOAD: Uploaded file.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], + 'type' => ['description' => 'The type of the dictionary file. Valid values:'."\n" + ."\n" + .'- STOP: Stopword.'."\n" + .'- MAIN: Main dictionary.'."\n" + .'- SYNONYMS: Synonym dictionary.'."\n" + .'- ALI_WS: Alibaba dictionary.', 'type' => 'string', 'example' => 'MAIN', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'synonymsDicts' => [ - 'description' => '', + 'description' => 'The synonym dictionary configuration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'sourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ORIGIN', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM_MAIN.dic', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'STOP', - ], + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'sourceType' => ['description' => 'The source type.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], + 'type' => ['description' => 'The dictionary type. Valid values:'."\n" + ."\n" + .'- STOP: Stopword.'."\n" + ."\n" + .'- MAIN: Main dictionary.'."\n" + ."\n" + .'- SYNONYMS: Synonym dictionary.'."\n" + ."\n" + .'- ALI_WS: Alibaba dictionary.', 'type' => 'string', 'example' => 'STOP', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'zoneInfos' => [ - 'description' => '', + 'description' => 'The zone information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'zoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - ], + 'status' => ['description' => 'The zone status. Valid values:'."\n" + ."\n" + .'- ISOLATION: offline'."\n" + .'- NORMAL: normal.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'zoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'aliwsDicts' => [ - 'description' => '', + 'description' => 'The Alibaba tokenizer dictionary configuration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'sourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OSS', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aliws_ext_dict.txt', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALI_WS', - ], + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'sourceType' => ['description' => 'The source type of the dictionary file. Valid values:'."\n" + ."\n" + .'- OSS: Object Storage Service (OSS). Make sure that the OSS bucket has public read permissions.'."\n" + .'- ORIGIN: Open-source Elasticsearch.'."\n" + .'- UPLOAD: Uploaded file.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'aliws_ext_dict.txt', 'title' => ''], + 'type' => ['description' => 'The type of the dictionary file. Valid values:'."\n" + ."\n" + .'- STOP: Stopword.'."\n" + .'- MAIN: Main dictionary.'."\n" + .'- SYNONYMS: Synonym dictionary.'."\n" + .'- ALI_WS: Alibaba dictionary.', 'type' => 'string', 'example' => 'ALI_WS', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'tags' => [ - 'description' => '', + 'description' => 'The instance tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'tagKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'env', - ], - 'tagValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'esIPWhitelist' => [ - 'description' => '', + 'description' => 'The internal-facing access whitelist (deprecated).', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[ "0.0.0.0/0" ]', - ], + 'items' => ['description' => 'The internal-facing access whitelist (deprecated).', 'type' => 'string', 'example' => '[ "0.0.0.0/0" ]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'extendConfigs' => [ - 'description' => '', + 'description' => 'The extended configuration array of the instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]', - ], + 'items' => ['description' => 'The extended configuration of the instance.', 'type' => 'object', 'example' => '[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'privateNetworkIpWhiteList' => [ - 'description' => '', + 'description' => 'The private endpoint access whitelist of the instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.0.0.0/0', - ], + 'items' => ['description' => 'The private endpoint access whitelist of the instance.', 'type' => 'string', 'example' => '0.0.0.0/0', 'title' => ''], + 'title' => '', + 'example' => '', ], 'publicIpWhitelist' => [ - 'description' => '', + 'description' => 'The public endpoint access whitelist of the instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[ "0.0.0.0/0" ]', - ], + 'items' => ['description' => 'The public endpoint access whitelist of the instance.', 'type' => 'string', 'example' => '[ "0.0.0.0/0" ]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'kibanaPrivateIPWhitelist' => [ - 'description' => '', + 'description' => 'The Kibana private endpoint access whitelist.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["192.168.XX.XX"]', - ], + 'items' => ['description' => 'The Kibana private endpoint access whitelist.', 'type' => 'string', 'example' => '["192.168.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'esIPBlacklist' => [ - 'description' => '', + 'description' => 'The internal-facing access blacklist (deprecated).', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[ "0.0.0.0/0" ]', - ], + 'items' => ['description' => 'The internal-facing access blacklist (deprecated).', 'type' => 'string', 'example' => '[ "0.0.0.0/0" ]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'kibanaIPWhitelist' => [ - 'description' => '', + 'description' => 'The Kibana public endpoint access whitelist.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[ "0.0.0.0/0" ]', - ], + 'items' => ['description' => 'The Kibana public endpoint access whitelist.', 'type' => 'string', 'example' => '[ "0.0.0.0/0" ]', 'title' => ''], + 'title' => '', + 'example' => '', ], 'nodeSpec' => [ - 'description' => '', + 'description' => 'The configuration of data nodes.', 'type' => 'object', 'properties' => [ - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'diskEncryption' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'performanceLevel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PL1', - ], - 'specInfo' => [ - 'type' => 'string', - ], + 'spec' => ['description' => 'The node specifications. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'disk' => ['description' => 'The storage space of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether cloud disk encryption is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'diskType' => ['description' => 'The disk type of the node. Valid values:'."\n" + ."\n" + .'- cloud_ssd: standard SSD'."\n" + .'- cloud_efficiency: ultra disk.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'performanceLevel' => ['description' => 'The performance level (PL) of the ESSD. This parameter is required when diskType is set to cloud_essd. Valid values: PL1, PL2, and PL3.', 'type' => 'string', 'example' => 'PL1', 'title' => ''], + 'specInfo' => ['description' => 'The node specifications description.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'networkConfig' => [ - 'description' => '', + 'description' => 'The network configuration.', 'type' => 'object', 'properties' => [ - 'vpcId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-abc', - ], - 'vsArea' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc', - ], - 'vswitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-abc', - ], + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-abc', 'title' => ''], + 'vsArea' => ['description' => 'The zone where the instance is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], + 'type' => ['description' => 'The network type. Only Virtual Private Cloud (VPC) is supported.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-abc', 'title' => ''], 'whiteIpGroupList' => [ - 'description' => '', + 'description' => 'The whitelist group list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'whiteIpType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PRIVATE_ES', - ], - 'groupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'default', - ], + 'whiteIpType' => ['description' => 'The whitelist type. Valid values:'."\n" + ."\n" + .'- PRIVATE_ES: Elasticsearch private network.'."\n" + ."\n" + .'- PUBLIC_ES: Elasticsearch public network.'."\n" + ."\n" + .'- PRIVATE_KIBANA: Kibana private network.'."\n" + ."\n" + .'- PUBLIC_KIBANA: Kibana public network.', 'type' => 'string', 'example' => 'PRIVATE_ES', 'title' => ''], + 'groupName' => ['description' => 'The name of the whitelist group. The default group is included by default.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'ips' => [ - 'description' => '', + 'description' => 'The IP addresses in the whitelist group.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["0.0.0.0", "127.0.XX.XX"]', - ], + 'items' => ['description' => 'The IP addresses in the whitelist group.', 'type' => 'string', 'example' => '["0.0.0.0", "127.0.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'kibanaConfiguration' => [ - 'description' => '', + 'description' => 'The configuration of the Kibana node.', 'type' => 'object', 'properties' => [ - 'amount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'specInfo' => [ - 'type' => 'string', - ], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'spec' => ['description' => 'The node specifications. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'disk' => ['description' => 'The storage space of a single node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'specInfo' => ['description' => 'The node specifications description.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'masterConfiguration' => [ - 'description' => '', + 'description' => 'The master node configuration.', 'type' => 'object', 'properties' => [ - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'amount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'specInfo' => [ - 'type' => 'string', - ], + 'spec' => ['description' => 'The node specifications. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'disk' => ['description' => 'The storage space of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Only cloud_ssd (standard SSD) is supported.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'specInfo' => ['description' => 'The node specifications description.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'clientNodeConfiguration' => [ - 'description' => '', + 'description' => 'The configuration of client nodes.', 'type' => 'object', 'properties' => [ - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'amount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_efficiency', - ], - 'specInfo' => [ - 'type' => 'string', - ], + 'spec' => ['description' => 'The node specifications. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'disk' => ['description' => 'The storage space of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Only cloud_efficiency (ultra disk) is supported.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], + 'specInfo' => ['description' => 'The node specifications description.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'warmNodeConfiguration' => [ - 'description' => '', + 'description' => 'The configuration of warm data nodes.', 'type' => 'object', 'properties' => [ - 'amount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'diskEncryption' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_efficiency', - ], - 'specInfo' => [ - 'type' => 'string', - ], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'spec' => ['description' => 'The node specifications. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'disk' => ['description' => 'The storage space of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether cloud disk encryption is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Only cloud_efficiency (ultra disk) is supported.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], + 'specInfo' => ['description' => 'The node specifications description.', 'type' => 'string', 'example' => '1C 2G', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'advancedSetting' => [ - 'description' => '', + 'description' => 'The advanced settings.', 'type' => 'object', 'properties' => [ - 'gcName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CMS', - ], + 'gcName' => ['description' => 'The name of the garbage collector. Valid values: CMS and G1.', 'type' => 'string', 'example' => 'CMS', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'elasticDataNodeConfiguration' => [ - 'description' => '', + 'description' => 'The configuration of elastic data nodes.', 'type' => 'object', 'properties' => [ - 'amount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.large', - ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskEncryption' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'specInfo' => [ - 'type' => 'string', - ], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'spec' => ['description' => 'The node specifications. For more information, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.large', 'title' => ''], + 'disk' => ['description' => 'The storage space of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether cloud disk encryption is enabled for the node. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Valid values:'."\n" + ."\n" + .'- cloud_ssd: standard SSD.'."\n" + .'- cloud_essd: ESSD.'."\n" + .'- cloud_efficiency: ultra disk.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'specInfo' => ['description' => 'The node specifications description.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'ikHotDicts' => [ - 'description' => '', + 'description' => 'The IK dictionary hot update configuration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MAIN', - ], - 'sourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OSS', - ], - 'fileSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'deploy_0.dic', - ], + 'type' => ['description' => 'The type of the dictionary to update. Valid values:'."\n" + ."\n" + .'- MAIN: IK main dictionary'."\n" + .'- STOP: IK stopword dictionary.', 'type' => 'string', 'example' => 'MAIN', 'title' => ''], + 'sourceType' => ['description' => 'The source type of the dictionary file. Valid values:'."\n" + ."\n" + .'- OSS: Uses OSS.'."\n" + .'- ORIGIN: Retains the previously uploaded dictionary.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'deploy_0.dic', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'instanceCategory' => [ - 'title' => '版本类型。', - 'description' => '', + 'title' => '', + 'description' => 'The edition of the instance. Valid values:'."\n" + .'- x-pack: Commercial Edition.'."\n" + .'- advanced/IS: Advanced Edition.'."\n" + .'- community: Basic Edition.', 'type' => 'string', 'example' => 'advanced', - 'enum' => [ - 'x-pack', - 'advanced', - 'IS', - 'community', - ], - ], - 'endTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'archType' => [ - 'type' => 'string', - ], - 'kibanaPrivateDomain' => [ - 'type' => 'string', - ], - 'kibanaPrivatePort' => [ - 'type' => 'string', - ], - 'inited' => [ - 'title' => '是否初始化完成', - 'type' => 'boolean', - ], + 'enum' => ['x-pack', 'advanced', 'IS', 'community'], + ], + 'endTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'archType' => ['description' => 'The deployment mode and architecture type. Valid values:'."\n" + .'- exclusive: basic management and control.'."\n" + .'- public: cloud-native management and control.', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'kibanaPrivateDomain' => ['description' => 'The Kibana private endpoint.', 'type' => 'string', 'example' => 'es-cn-x0r3*********.elasticsearch.aliyuncs.com', 'title' => ''], + 'kibanaPrivatePort' => ['description' => 'The Kibana private port.', 'type' => 'string', 'example' => '5601', 'title' => ''], + 'inited' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'endpoints' => [ - 'title' => '对于HP_ALILB 多可用区实例，每个可用区对应的私网域名', + 'title' => '', + 'description' => 'The private endpoints for each zone of an HP_ALILB multi-zone instance.', 'type' => 'array', 'items' => [ 'title' => '', + 'description' => '', 'type' => 'object', 'properties' => [ - 'zoneId' => [ - 'title' => '可用区id', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'endpoint' => [ - 'title' => '可用区私网地址', - 'type' => 'string', - 'example' => 'es-cn-xx-cn-hangzhou-h.elasticsearch.aliyuncs.com', - ], - 'vswitchId' => [ - 'title' => 'vswitchId', - 'type' => 'string', - 'example' => 'vsw-xxx', - ], + 'zoneId' => ['title' => '', 'description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'endpoint' => ['title' => '', 'description' => 'The private endpoint of the zone.', 'type' => 'string', 'example' => 'es-cn-xx-cn-hangzhou-h.elasticsearch.aliyuncs.com'], + 'vswitchId' => ['title' => '', 'description' => 'vswitchId', 'type' => 'string', 'example' => 'vsw-xxx'], ], + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"advancedDedicateMaster\\": true,\\n \\"protocol\\": \\"HTTP\\",\\n \\"enableKibanaPublicNetwork\\": true,\\n \\"nodeAmount\\": 2,\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"enableKibanaPrivateNetwork\\": false,\\n \\"vpcInstanceId\\": \\"vpc-bp1uag5jj38c****\\",\\n \\"port\\": 9200,\\n \\"enablePublic\\": true,\\n \\"dedicateMaster\\": false,\\n \\"kibanaPort\\": 5601,\\n \\"esConfig\\": {\\n \\"http.cors.allow-credentials\\": \\"false\\"\\n },\\n \\"resourceGroupId\\": \\"rg-aekzvowej3i****\\",\\n \\"paymentType\\": \\"postpaid\\",\\n \\"postpaidServiceStatus\\": \\"active\\",\\n \\"esVersion\\": \\"6.3.2_with_X-Pack\\",\\n \\"haveKibana\\": true,\\n \\"isNewDeployment\\": true,\\n \\"warmNode\\": true,\\n \\"updatedAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"instanceId\\": \\"es-cn-3h4k3axh33th9****\\",\\n \\"zoneCount\\": 2,\\n \\"publicDomain\\": \\"es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com\\",\\n \\"status\\": \\"active\\",\\n \\"serviceVpc\\": true,\\n \\"publicPort\\": 9200,\\n \\"haveClientNode\\": true,\\n \\"domain\\": \\"es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com\\",\\n \\"description\\": \\"es-cn-abc\\",\\n \\"kibanaDomain\\": \\"es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com\\",\\n \\"dictList\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ],\\n \\"synonymsDicts\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"STOP\\"\\n }\\n ],\\n \\"zoneInfos\\": [\\n {\\n \\"status\\": \\"NORMAL\\",\\n \\"zoneId\\": \\"cn-hangzhou-b\\"\\n }\\n ],\\n \\"aliwsDicts\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"OSS\\",\\n \\"name\\": \\"aliws_ext_dict.txt\\",\\n \\"type\\": \\"ALI_WS\\"\\n }\\n ],\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"dev\\"\\n }\\n ],\\n \\"esIPWhitelist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"extendConfigs\\": [\\n [\\n {\\n \\"configType\\": \\"aliVersion\\",\\n \\"aliVersion\\": \\"ali1.3.0\\"\\n }\\n ]\\n ],\\n \\"privateNetworkIpWhiteList\\": [\\n \\"0.0.0.0/0\\"\\n ],\\n \\"publicIpWhitelist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"kibanaPrivateIPWhitelist\\": [\\n \\"[\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"esIPBlacklist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"kibanaIPWhitelist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 0,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"performanceLevel\\": \\"PL1\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-abc\\",\\n \\"vsArea\\": \\"cn-hangzhou-b\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-abc\\",\\n \\"whiteIpGroupList\\": [\\n {\\n \\"whiteIpType\\": \\"PRIVATE_ES\\",\\n \\"groupName\\": \\"default\\",\\n \\"ips\\": [\\n \\"[\\\\\\"0.0.0.0\\\\\\", \\\\\\"127.0.XX.XX\\\\\\"]\\"\\n ]\\n }\\n ]\\n },\\n \\"kibanaConfiguration\\": {\\n \\"amount\\": 1,\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 20,\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 3,\\n \\"disk\\": 40,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"clientNodeConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 3,\\n \\"disk\\": 40,\\n \\"diskType\\": \\"cloud_efficiency\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"warmNodeConfiguration\\": {\\n \\"amount\\": 6,\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 500,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_efficiency\\",\\n \\"specInfo\\": \\"1C 2G\\"\\n },\\n \\"advancedSetting\\": {\\n \\"gcName\\": \\"CMS\\"\\n },\\n \\"elasticDataNodeConfiguration\\": {\\n \\"amount\\": 3,\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"disk\\": 20,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"ikHotDicts\\": [\\n {\\n \\"type\\": \\"MAIN\\",\\n \\"sourceType\\": \\"OSS\\",\\n \\"fileSize\\": 6,\\n \\"name\\": \\"deploy_0.dic\\"\\n }\\n ],\\n \\"instanceCategory\\": \\"advanced\\",\\n \\"endTime\\": 0,\\n \\"archType\\": \\"public\\",\\n \\"kibanaPrivateDomain\\": \\"es-cn-x0r3*********.elasticsearch.aliyuncs.com\\",\\n \\"kibanaPrivatePort\\": \\"5601\\",\\n \\"inited\\": true,\\n \\"endpoints\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"endpoint\\": \\"es-cn-xx-cn-hangzhou-h.elasticsearch.aliyuncs.com\\",\\n \\"vswitchId\\": \\"vsw-xxx\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeInstance', + 'title' => 'View instance details', + 'summary' => 'Queries the details of a specified instance.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The edition of the cluster.'."\n", + 'responseParamsDescription' => ' > The following response examples include only the parameters listed in the response elements. Parameters not mentioned are for reference only. Do not rely on these parameters in your code.', 'extraInfo' => ' ', - ], - 'DescribeRegions' => [ - 'path' => '/openapi/regions', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-10-31T03:30:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-05-13T07:08:33.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-10T08:49:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-03T07:33:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-10T04:08:37.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-27T11:53:48.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '64256', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The available status of the region.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1ADFG', - ], - 'Result' => [ - 'description' => 'The endpoint of the region.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'regionId' => [ - 'description' => 'The name of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'status' => [ - 'description' => 'The endpoint of the region that is exposed in the console.'."\n", - 'type' => 'string', - 'example' => 'available', - ], - 'regionEndpoint' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.cn-hangzhou.aliyuncs.com', - ], - 'localName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'China (Hangzhou)', - ], - 'consoleEndpoint' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://elasticsearch-cn-hangzhou.console.aliyun.com', - ], - ], - ], - ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1ADFG\\",\\n \\"Result\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"available\\",\\n \\"regionEndpoint\\": \\"elasticsearch.cn-hangzhou.aliyuncs.com\\",\\n \\"localName\\": \\"China (Hangzhou)\\",\\n \\"consoleEndpoint\\": \\"https://elasticsearch-cn-hangzhou.console.aliyun.com\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeRegions', - 'summary' => 'Get the region information of Alibaba Cloud Elasticsearch.', - 'requestParamsDescription' => 'The list of returned database shards.'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"advancedDedicateMaster\\": true,\\n \\"protocol\\": \\"HTTP\\",\\n \\"enableKibanaPublicNetwork\\": true,\\n \\"nodeAmount\\": 2,\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"enableKibanaPrivateNetwork\\": false,\\n \\"vpcInstanceId\\": \\"vpc-bp1uag5jj38c****\\",\\n \\"port\\": 9200,\\n \\"enablePublic\\": true,\\n \\"dedicateMaster\\": false,\\n \\"kibanaPort\\": 5601,\\n \\"esConfig\\": {\\n \\"http.cors.allow-credentials\\": \\"false\\"\\n },\\n \\"resourceGroupId\\": \\"rg-aekzvowej3i****\\",\\n \\"paymentType\\": \\"postpaid\\",\\n \\"postpaidServiceStatus\\": \\"active\\",\\n \\"esVersion\\": \\"6.3.2_with_X-Pack\\",\\n \\"haveKibana\\": true,\\n \\"isNewDeployment\\": true,\\n \\"warmNode\\": true,\\n \\"updatedAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"instanceId\\": \\"es-cn-3h4k3axh33th9****\\",\\n \\"zoneCount\\": 2,\\n \\"publicDomain\\": \\"es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com\\",\\n \\"status\\": \\"active\\",\\n \\"serviceVpc\\": true,\\n \\"publicPort\\": 9200,\\n \\"haveClientNode\\": true,\\n \\"domain\\": \\"es-cn-3h4k3axh33th9****.elasticsearch.aliyuncs.com\\",\\n \\"description\\": \\"es-cn-abc\\",\\n \\"kibanaDomain\\": \\"es-cn-3h4k3axh33th9****.kibana.elasticsearch.aliyuncs.com\\",\\n \\"dictList\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ],\\n \\"synonymsDicts\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"STOP\\"\\n }\\n ],\\n \\"zoneInfos\\": [\\n {\\n \\"status\\": \\"NORMAL\\",\\n \\"zoneId\\": \\"cn-hangzhou-b\\"\\n }\\n ],\\n \\"aliwsDicts\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"OSS\\",\\n \\"name\\": \\"aliws_ext_dict.txt\\",\\n \\"type\\": \\"ALI_WS\\"\\n }\\n ],\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"dev\\"\\n }\\n ],\\n \\"esIPWhitelist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"extendConfigs\\": [\\n [\\n {\\n \\"configType\\": \\"aliVersion\\",\\n \\"aliVersion\\": \\"ali1.3.0\\"\\n }\\n ]\\n ],\\n \\"privateNetworkIpWhiteList\\": [\\n \\"0.0.0.0/0\\"\\n ],\\n \\"publicIpWhitelist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"kibanaPrivateIPWhitelist\\": [\\n \\"[\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"esIPBlacklist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"kibanaIPWhitelist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 0,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"performanceLevel\\": \\"PL1\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-abc\\",\\n \\"vsArea\\": \\"cn-hangzhou-b\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-abc\\",\\n \\"whiteIpGroupList\\": [\\n {\\n \\"whiteIpType\\": \\"PRIVATE_ES\\",\\n \\"groupName\\": \\"default\\",\\n \\"ips\\": [\\n \\"[\\\\\\"0.0.0.0\\\\\\", \\\\\\"127.0.XX.XX\\\\\\"]\\"\\n ]\\n }\\n ]\\n },\\n \\"kibanaConfiguration\\": {\\n \\"amount\\": 1,\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 20,\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 3,\\n \\"disk\\": 40,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"clientNodeConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 3,\\n \\"disk\\": 40,\\n \\"diskType\\": \\"cloud_efficiency\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"warmNodeConfiguration\\": {\\n \\"amount\\": 6,\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 500,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_efficiency\\",\\n \\"specInfo\\": \\"1C 2G\\"\\n },\\n \\"advancedSetting\\": {\\n \\"gcName\\": \\"CMS\\"\\n },\\n \\"elasticDataNodeConfiguration\\": {\\n \\"amount\\": 3,\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"disk\\": 20,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"ikHotDicts\\": [\\n {\\n \\"type\\": \\"MAIN\\",\\n \\"sourceType\\": \\"OSS\\",\\n \\"fileSize\\": 6,\\n \\"name\\": \\"deploy_0.dic\\"\\n }\\n ],\\n \\"instanceCategory\\": \\"advanced\\",\\n \\"endTime\\": 0,\\n \\"archType\\": \\"public\\",\\n \\"kibanaPrivateDomain\\": \\"es-cn-x0r3*********.elasticsearch.aliyuncs.com\\",\\n \\"kibanaPrivatePort\\": \\"5601\\",\\n \\"inited\\": false,\\n \\"endpoints\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"endpoint\\": \\"es-cn-xx-cn-hangzhou-h.elasticsearch.aliyuncs.com\\",\\n \\"vswitchId\\": \\"vsw-xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ListAllNode' => [ - 'summary' => 'Queries the information of all the nodes in an Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/nodes', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeKibanaSettings' => [ + 'summary' => 'Retrieves the Kibana node configuration of an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/kibana-settings', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The return results.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-tl32cpgwa002l****', - ], - ], - [ - 'name' => 'extended', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Java Virtual Machine (JVM) heap memory usage of the node.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], ], 'responses' => [ @@ -8321,117 +6365,64 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The zone ID of the node.'."\n", - 'type' => 'string', - 'example' => '0D71B597-F3FF-5B56-88D7-74F9D3F7****', - ], - 'Result' => [ - 'description' => 'The CPU utilization.'."\n" - ."\n" - .'> If the **extended** request parameter is set to **true** and the monitoring information of the nodes in the cluster is being synchronized, the value of the cpuPercent parameter is null. In this case, you need to send a request again after 10 seconds to obtain the value of the cpuPercent parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'heapPercent' => [ - 'description' => 'The IP address of the node.'."\n", - 'type' => 'string', - 'example' => '21.6%', - ], - 'zoneId' => [ - 'description' => 'The type of the nodes. Valid values:'."\n" - ."\n" - .'* MASTER: dedicated master node'."\n" - .'* WORKER: hot node'."\n" - .'* WORKER_WARM: warm node'."\n" - .'* COORDINATING: client node'."\n" - .'* KIBANA: Kibana node'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'cpuPercent' => [ - 'description' => 'The disk usage.'."\n", - 'type' => 'string', - 'example' => '4.2%', - ], - 'host' => [ - 'description' => 'The port that is used to connect to the node.'."\n", - 'type' => 'string', - 'example' => '10.15.XX.XX', - ], - 'nodeType' => [ - 'description' => 'The 1-minute load of the node.'."\n", - 'type' => 'string', - 'example' => 'WORKER', - ], - 'diskUsedPercent' => [ - 'description' => 'The health status of the node. Valid values: GREEN, YELLOW, RED, and GRAY.'."\n", - 'type' => 'string', - 'example' => '1.0%', - ], - 'port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'loadOneM' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0.12', - ], - 'health' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'GREEN', - ], - ], - ], - ], + 'Result' => ['description' => 'Some configurable Kibana settings. For more information, see [Kibana settings](https://www.elastic.co/guide/cn/kibana/current/settings.html).', 'type' => 'object', 'example' => '{"map.includeElasticMapsService": "false", "server.ssl.cert": "/home/admin/packages/kibana/config/cert/client.crt", "server.ssl.enabled": "true", "server.ssl.key": "/home/admin/packages/kibana/config/cert/client.key", "xpack.reporting.capture.browser.chromium.disableSandbox": "true"}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6D*****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0D71B597-F3FF-5B56-88D7-74F9D3F7****\\",\\n \\"Result\\": [\\n {\\n \\"heapPercent\\": \\"21.6%\\",\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"cpuPercent\\": \\"4.2%\\",\\n \\"host\\": \\"10.15.XX.XX\\",\\n \\"nodeType\\": \\"WORKER\\",\\n \\"diskUsedPercent\\": \\"1.0%\\",\\n \\"port\\": 9200,\\n \\"loadOneM\\": \\"0.12\\",\\n \\"health\\": \\"GREEN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListAllNode', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'false'."\n", - ], - 'GetElastictask' => [ - 'path' => '/openapi/instances/{InstanceId}/elastic-task', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": {\\n \\"map.includeElasticMapsService\\": \\"false\\",\\n \\"server.ssl.cert\\": \\"/home/admin/packages/kibana/config/cert/client.crt\\",\\n \\"server.ssl.enabled\\": \\"true\\",\\n \\"server.ssl.key\\": \\"/home/admin/packages/kibana/config/cert/client.key\\",\\n \\"xpack.reporting.capture.browser.chromium.disableSandbox\\": \\"true\\"\\n },\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6D*****\\"\\n}","type":"json"}]', + 'title' => 'Get kibana configuration', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeKibanaSettings'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeKibanaSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'DescribeLogstash' => [ + 'path' => '/openapi/logstashes/{InstanceId}', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '64267', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-6ja1ro4jt000c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-s9dsk3k4k****', 'title' => ''], ], ], 'responses' => [ @@ -8439,211 +6430,205 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C9334241-4837-46C2-B24B-9BDC517318DE', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'The details of the instance.', 'type' => 'object', 'properties' => [ - 'elasticExpansionTask' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'triggerType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'crontab', - ], - 'replicaCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'elasticNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', + 'config' => ['description' => 'The instance configuration.', 'type' => 'object', 'example' => '{"slowlog.threshold.warn": "2s","slowlog.threshold.info": "1s","slowlog.threshold.debug": "500ms","slowlog.threshold.trace": "100ms" }', 'title' => ''], + 'paymentType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- prepaid: subscription'."\n" + .'- postpaid: pay-as-you-go.', 'type' => 'string', 'example' => 'prepaid', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-aekzvowej3i****', 'title' => ''], + 'nodeAmount' => ['description' => 'The number of nodes in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'description' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'ls-cn-abc', 'title' => ''], + 'createdAt' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2020-02-06T14:12:03.672Z', 'title' => ''], + 'status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- active: Normal.'."\n" + .'- activating: Taking effect.'."\n" + .'- inactive: Frozen.'."\n" + .'- invalid: Expired.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'vpcInstanceId' => ['description' => 'The ID of the VPC to which the instance belongs.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtmagcva****', 'title' => ''], + 'updatedAt' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2020-02-06T14:22:36.850Z', 'title' => ''], + 'version' => ['description' => 'The version of the instance.', 'type' => 'string', 'example' => '7.4.0_with_X-Pack', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ls-cn-abc', 'title' => ''], + 'endpointList' => [ + 'description' => 'The access information of the nodes.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'zoneId' => ['description' => 'The zone ID of the node.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], + 'port' => ['description' => 'The port number.', 'type' => 'string', 'example' => '9600', 'title' => ''], + 'host' => ['description' => 'The IP address of the node.', 'type' => 'string', 'example' => '172.16.**.**', 'title' => ''], ], - 'cronExpression' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0 0 0 ? * MON', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'The instance labels.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], ], - 'targetIndices' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'index', - ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ZoneInfos' => [ + 'description' => 'The zone information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'status' => ['description' => 'The status of the zone. Valid values:'."\n" + ."\n" + .'- ISOLATION: offline.'."\n" + .'- NORMAL: Normal.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'zoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-b', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'elasticShrinkTask' => [ + 'ExtendConfigs' => [ + 'type' => 'array', + 'items' => ['description' => 'The extension parameter settings of the cluster.', 'type' => 'object', 'example' => '[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]', 'title' => ''], 'description' => '', + 'title' => '', + 'example' => '', + ], + 'nodeSpec' => [ + 'description' => 'The configuration of the node.', 'type' => 'object', 'properties' => [ - 'triggerType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'crontab', - ], - 'replicaCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'elasticNodeCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'cronExpression' => [ - 'description' => '', - 'type' => 'string', - 'example' => '4 4 4 ? * WED', - ], - 'targetIndices' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'index', - ], - ], + 'spec' => ['description' => 'The specification of the node.', 'type' => 'string', 'example' => 'elasticsearch.sn1ne.large', 'title' => ''], + 'disk' => ['description' => 'The disk size of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether cloud disk encryption is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'diskType' => ['description' => 'The disk type of the node.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'networkConfig' => [ + 'description' => 'The network configuration.', + 'type' => 'object', + 'properties' => [ + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtmagcva****', 'title' => ''], + 'vsArea' => ['description' => 'The zone in which the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-*', 'title' => ''], + 'type' => ['description' => 'The network type. Currently, only Virtual Private Cloud (VPC) is supported.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1k4ec6s7sjdbudw****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'endTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.', + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"elasticExpansionTask\\": {\\n \\"triggerType\\": \\"crontab\\",\\n \\"replicaCount\\": 2,\\n \\"elasticNodeCount\\": 2,\\n \\"cronExpression\\": \\"0 0 0 ? * MON\\",\\n \\"targetIndices\\": [\\n \\"index\\"\\n ]\\n },\\n \\"elasticShrinkTask\\": {\\n \\"triggerType\\": \\"crontab\\",\\n \\"replicaCount\\": 2,\\n \\"elasticNodeCount\\": 2,\\n \\"cronExpression\\": \\"4 4 4 ? * WED\\",\\n \\"targetIndices\\": [\\n \\"index\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetElastictask', + 'title' => 'Query logstash instance information', + 'summary' => 'Queries the details of a Logstash instance.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => 'For more parameter descriptions, see [ListLogstash](~~160534~~).', 'extraInfo' => ' ', - ], - 'ListInstanceIndices' => [ - 'summary' => 'Queries the indexes stored on an Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/indices', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogstash'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C9334241-4837-46C2-B24B-9BDC517318DE\\",\\n \\"Result\\": {\\n \\"config\\": {\\n \\"slowlog.threshold.warn\\": \\"2s\\",\\n \\"slowlog.threshold.info\\": \\"1s\\",\\n \\"slowlog.threshold.debug\\": \\"500ms\\",\\n \\"slowlog.threshold.trace\\": \\"100ms\\"\\n },\\n \\"paymentType\\": \\"prepaid\\",\\n \\"ResourceGroupId\\": \\"rg-aekzvowej3i****\\",\\n \\"nodeAmount\\": 2,\\n \\"description\\": \\"ls-cn-abc\\",\\n \\"createdAt\\": \\"2020-02-06T14:12:03.672Z\\",\\n \\"status\\": \\"active\\",\\n \\"vpcInstanceId\\": \\"vpc-bp16k1dvzxtmagcva****\\",\\n \\"updatedAt\\": \\"2020-02-06T14:22:36.850Z\\",\\n \\"version\\": \\"7.4.0_with_X-Pack\\",\\n \\"instanceId\\": \\"ls-cn-abc\\",\\n \\"endpointList\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-b\\",\\n \\"port\\": \\"9600\\",\\n \\"host\\": \\"172.16.**.**\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"dev\\"\\n }\\n ],\\n \\"ZoneInfos\\": [\\n {\\n \\"status\\": \\"NORMAL\\",\\n \\"zoneId\\": \\"cn-hangzhou-b\\"\\n }\\n ],\\n \\"ExtendConfigs\\": [\\n [\\n {\\n \\"configType\\": \\"aliVersion\\",\\n \\"aliVersion\\": \\"ali1.3.0\\"\\n }\\n ]\\n ],\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.sn1ne.large\\",\\n \\"disk\\": 20,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtmagcva****\\",\\n \\"vsArea\\": \\"cn-hangzhou-*\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-bp1k4ec6s7sjdbudw****\\"\\n },\\n \\"endTime\\": 0\\n }\\n}","type":"json"}]', + ], + 'DescribePipeline' => [ + 'path' => '/openapi/logstashes/{InstanceId}/pipelines/{PipelineId}', + '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' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'false'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-tl329rbpc0001****', - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'all', - 'in' => 'query', - 'schema' => [ - 'description' => 'false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => '1'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'log-0001', - ], - ], - [ - 'name' => 'isManaged', - 'in' => 'query', - 'schema' => [ - 'description' => '15'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'isOpenstore', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'The total size of the index in Cloud Hosting. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '15', - ], + 'name' => 'PipelineId', + 'in' => 'path', + 'schema' => ['description' => 'The pipeline ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pipeline_test', 'title' => ''], ], ], 'responses' => [ @@ -8651,417 +6636,453 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The total number of indexes in Cloud Hosting.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - 'Headers' => [ - 'description' => 'The total size of the OpenStore cold stage index for this instance. Unit: bytes.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '829F38F6-E2D6-4109-90A6-888160BD1***', 'title' => ''], + 'Result' => [ + 'description' => 'The returned pipeline information. For more information, see [logstash.yml](https://www.elastic.co/guide/en/logstash/6.7/logstash-settings-file.html).', 'type' => 'object', 'properties' => [ - 'X-Managed-StorageSize' => [ - 'description' => 'The total number of indexes in the OpenStore cold phase.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18093942932', - ], - 'X-Managed-Count' => [ - 'description' => 'The details of the index list.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'X-OSS-StorageSize' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9093942932', - ], - 'X-OSS-Count' => [ - 'description' => 'The time when the index list was queried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'Result' => [ - 'description' => 'The total storage space occupied by the current index. Unit: bytes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'phase' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'warm', - ], - 'managedStatus' => [ - 'description' => 'The current storage lifecycle. Value meaning:'."\n" - ."\n" - .'* warm: warm.'."\n" - .'* cold: the cold phase.'."\n" - .'* hot: hot phase.'."\n" - .'* delete: deletes a stage.'."\n" - ."\n" - .'> If this parameter is empty, the current index is not managed by the lifecycle.'."\n", - 'type' => 'string', - 'example' => 'closing', - ], - 'ilmExplain' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{ "indices": { ".ds-console-2021.08.18-000002": { "index": ".ds-console-2021.08.18-000002", "managed": true, "policy": "console", "lifecycle_date_millis": 1629277498775, "age": "2.64h", "phase": "hot", "phase_time_millis": 1629277450334, "action": "complete", "action_time_millis": 1629278605586, "step": "complete", "step_time_millis": 1629278605586, "phase_execution": { "policy": "console", "phase_definition": { "min_age": "0s", "actions": { "rollover": { "max_size": "1gb", "max_age": "1d", "max_docs": 10000 }, "set_priority": { "priority": 1000 } } }, "version": 1, "modified_date_in_millis": 1629277370953 } } } }', - ], - 'size' => [ - 'description' => 'The running status of the index. The following three statuses are supported:'."\n" - ."\n" - .'* green: healthy.'."\n" - .'* yellow: alerts.'."\n" - .'* red: an exception.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49298589', - ], - 'createTime' => [ - 'description' => 'The name of the Elasticsearch index.'."\n", - 'type' => 'string', - 'example' => '2021-01-11T05:49:41.114Z', - ], - 'name' => [ - 'description' => 'The full lifecycle status of the current index.'."\n", - 'type' => 'string', - 'example' => '.kibana_task_manager_1', - ], - 'health' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'green', - ], - 'isManaged' => [ - 'description' => 'The managed status of the index. The following three statuses are supported:'."\n" - ."\n" - .'* following: Hosting.'."\n" - .'* closing: The instance is being unhosted.'."\n" - .'* closed: unmanaged.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - ], + 'pipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'pipeline_test', 'title' => ''], + 'gmtUpdateTime' => ['description' => 'The time when the pipeline was last updated.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'queueType' => ['description' => 'The queue type. Valid values:'."\n" + ."\n" + .'- MEMORY: a traditional memory-based queue.'."\n" + .'- PERSISTED: a disk-based ACKed queue (persistent queue).', 'type' => 'string', 'example' => 'MEMORY', 'title' => ''], + 'queueCheckPointWrites' => ['description' => 'The number of queue checkpoint writes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], + 'queueMaxBytes' => ['description' => 'The total capacity of the queue, in bytes. Unit: MB.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], + 'config' => ['description' => 'The specific configuration of the pipeline.', 'type' => 'string', 'example' => 'input { } filter { } output { }', 'title' => ''], + 'batchDelay' => ['description' => 'The batch delay of the pipeline. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'workers' => ['description' => 'The number of pipeline worker threads.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'description' => ['description' => 'The pipeline description.', 'type' => 'string', 'example' => 'this is a test', 'title' => ''], + 'gmtCreatedTime' => ['description' => 'The time when the pipeline was created.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'batchSize' => ['description' => 'The batch size of the pipeline.', 'type' => 'integer', 'format' => 'int32', 'example' => '125', 'title' => ''], + 'pipelineStatus' => ['description' => 'The pipeline status. Valid values:'."\n" + ."\n" + .'- NOT_DEPLOYED: not deployed.'."\n" + .'- RUNNING: running.'."\n" + .'- DELETED: deleted. This status is not displayed in the console.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Headers\\": {\\n \\"X-Managed-StorageSize\\": 18093942932,\\n \\"X-Managed-Count\\": 15,\\n \\"X-OSS-StorageSize\\": 9093942932,\\n \\"X-OSS-Count\\": 5\\n },\\n \\"Result\\": [\\n {\\n \\"phase\\": \\"warm\\",\\n \\"managedStatus\\": \\"closing\\",\\n \\"ilmExplain\\": \\"{ \\\\\\"indices\\\\\\": { \\\\\\".ds-console-2021.08.18-000002\\\\\\": { \\\\\\"index\\\\\\": \\\\\\".ds-console-2021.08.18-000002\\\\\\", \\\\\\"managed\\\\\\": true, \\\\\\"policy\\\\\\": \\\\\\"console\\\\\\", \\\\\\"lifecycle_date_millis\\\\\\": 1629277498775, \\\\\\"age\\\\\\": \\\\\\"2.64h\\\\\\", \\\\\\"phase\\\\\\": \\\\\\"hot\\\\\\", \\\\\\"phase_time_millis\\\\\\": 1629277450334, \\\\\\"action\\\\\\": \\\\\\"complete\\\\\\", \\\\\\"action_time_millis\\\\\\": 1629278605586, \\\\\\"step\\\\\\": \\\\\\"complete\\\\\\", \\\\\\"step_time_millis\\\\\\": 1629278605586, \\\\\\"phase_execution\\\\\\": { \\\\\\"policy\\\\\\": \\\\\\"console\\\\\\", \\\\\\"phase_definition\\\\\\": { \\\\\\"min_age\\\\\\": \\\\\\"0s\\\\\\", \\\\\\"actions\\\\\\": { \\\\\\"rollover\\\\\\": { \\\\\\"max_size\\\\\\": \\\\\\"1gb\\\\\\", \\\\\\"max_age\\\\\\": \\\\\\"1d\\\\\\", \\\\\\"max_docs\\\\\\": 10000 }, \\\\\\"set_priority\\\\\\": { \\\\\\"priority\\\\\\": 1000 } } }, \\\\\\"version\\\\\\": 1, \\\\\\"modified_date_in_millis\\\\\\": 1629277370953 } } } }\\",\\n \\"size\\": 49298589,\\n \\"createTime\\": \\"2021-01-11T05:49:41.114Z\\",\\n \\"name\\": \\".kibana_task_manager_1\\",\\n \\"health\\": \\"green\\",\\n \\"isManaged\\": \\"false\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListInstanceIndices', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD1***\\",\\n \\"Result\\": {\\n \\"pipelineId\\": \\"pipeline_test\\",\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"queueType\\": \\"MEMORY\\",\\n \\"queueCheckPointWrites\\": 1024,\\n \\"queueMaxBytes\\": 1024,\\n \\"config\\": \\"input { } filter { } output { }\\",\\n \\"batchDelay\\": 50,\\n \\"workers\\": 2,\\n \\"description\\": \\"this is a test\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"batchSize\\": 125,\\n \\"pipelineStatus\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve logstash pipeline information', + 'summary' => 'Retrieves the pipeline information of a Logstash instance.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => ' > Pipeline parameters that are not configured use system default values and are not included in the response.', 'extraInfo' => ' ', - ], - 'createInstance' => [ - 'summary' => 'Creates an Elasticsearch cluster.', - 'path' => '/openapi/instances', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePipeline'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribePipeline', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'DescribePipelineManagementConfig' => [ + 'summary' => 'Calls DescribePipelineManagementConfig to retrieve the pipeline management configuration of a Logstash instance.', + 'path' => '/openapi/logstashes/{InstanceId}/pipeline-management-config', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], + ], + [ 'name' => 'clientToken', 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value of this parameter must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'endpoints' => ['description' => 'The list of access endpoints for the Elasticsearch instance, in the format of `domain name:port number`.', 'type' => 'string', 'example' => '["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]', 'title' => ''], + 'userName' => ['description' => 'The username used to access the instance.', 'type' => 'string', 'example' => 'elastic', 'title' => ''], + 'pipelineManagementType' => ['description' => 'The pipeline management method. Valid values: Kibana and MULTIPLE_PIPELINE.', 'type' => 'string', 'example' => 'MULTIPLE_PIPELINE', 'title' => ''], + 'esInstanceId' => ['description' => 'The Elasticsearch instance ID.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + 'pipelineIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of pipeline names.', 'type' => 'string', 'example' => '["testKibanaManagement"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"endpoints\\": \\"[\\\\\\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\",\\n \\"userName\\": \\"elastic\\",\\n \\"pipelineManagementType\\": \\"MULTIPLE_PIPELINE\\",\\n \\"esInstanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"pipelineIds\\": [\\n \\"[\\\\\\"testKibanaManagement\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve logstash pipeline management configuration', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:26.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePipelineManagementConfig'], + ], + ], + 'ramActions' => [ [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribePipelineManagementConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], + ], + 'DescribeRegions' => [ + 'path' => '/openapi/regions', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '64256', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'zoneCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'paymentType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'postpaid', - ], - 'paymentInfo' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/PaymentInfo', - ], - 'nodeAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '3', - ], - 'instanceCategory' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'advanced', - ], - 'esAdminPassword' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es_password', - ], - 'esVersion' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '5.5.3_with_X-Pack', - ], - 'nodeSpec' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/NodeSpec', - ], - 'masterConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/MasterNodeConfiguration', - ], - 'warmNodeConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/WarmNodeConfiguration', - ], - 'clientNodeConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ClientNodeConfiguration', - ], - 'elasticDataNodeConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ElasticDataNodeConfiguration', - ], - 'kibanaConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/KibanaNodeConfiguration', - ], - 'networkConfig' => [ - 'description' => '', - 'required' => true, - '$ref' => '#/components/schemas/NetworkConfig', - ], - 'resourceGroupId' => [ - 'title' => '资源组id。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzu7tsu4nem4q', - ], - 'description' => [ - 'title' => '实例名称，', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es', - ], - 'tags' => [ - 'title' => '实例标签组。', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1ADFG', 'title' => ''], + 'Result' => [ + 'description' => 'The list of returned results.', 'type' => 'array', 'items' => [ - 'title' => '实例标签。', 'type' => 'object', 'properties' => [ - 'tagKey' => [ - 'title' => '实例标签键。', - 'type' => 'string', - ], - 'tagValue' => [ - 'title' => '实例标签值。', - 'type' => 'string', - ], + 'regionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'status' => ['description' => 'The availability status of the region.', 'type' => 'string', 'example' => 'available', 'title' => ''], + 'regionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'elasticsearch.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'localName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => 'China (Hangzhou)', 'title' => ''], + 'consoleEndpoint' => ['description' => 'The endpoint of the region exposed in the console.', 'type' => 'string', 'example' => 'https://elasticsearch-cn-hangzhou.console.aliyun.com', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, - 'example' => '{ "description": "xpack-hot-cold", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "x-pack", "nodeSpec": { "spec": "elasticsearch.sn2ne.xlarge", "disk": 20, "diskType": "cloud_ssd" }, "warmNodeConfiguration": { "spec": "elasticsearch.sn1ne.xlarge", "amount": 3, "diskType": "cloud_efficiency", "disk": 500 }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1ADFG\\",\\n \\"Result\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"status\\": \\"available\\",\\n \\"regionEndpoint\\": \\"elasticsearch.cn-hangzhou.aliyuncs.com\\",\\n \\"localName\\": \\"China (Hangzhou)\\",\\n \\"consoleEndpoint\\": \\"https://elasticsearch-cn-hangzhou.console.aliyun.com\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get region information', + 'summary' => 'Retrieves the region information of Alibaba Cloud Elasticsearch.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-15T08:09:27.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-09-15T08:09:27.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DescribeSnapshotSetting' => [ + 'summary' => 'Retrieves the snapshot backup settings and backup cycle of a cluster.', + 'path' => '/openapi/instances/{InstanceId}/snapshot-setting', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '64257', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-0pp1jxvcl000z****', 'title' => ''], + ], + ], 'responses' => [ - 202 => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], 'Result' => [ + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'type' => 'string', - ], + 'Enable' => ['description' => 'Indicates whether automatic backup is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'QuartzRegex' => ['description' => 'The automatic backup time configuration, specified as a Quartz Cron expression.', 'type' => 'string', 'example' => '0 0 01 ? * * *', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.', 'description' => 'The specified cluster does not exist. Check the cluster status and try again.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": {\\n \\"Enable\\": true,\\n \\"QuartzRegex\\": \\"0 0 01 ? * * *\\"\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve snapshot backup settings of a cluster', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSnapshotSetting'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], + ], + ], + 'DescribeTemplates' => [ + 'path' => '/openapi/instances/{InstanceId}/templates', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The template content.', 'type' => 'string', 'example' => '{\\n\\t\\"persistent\\":{\\n\\t\\t\\"search\\":{\\n\\t\\t\\t\\"max_buckets\\":\\"10000\\"\\n\\t\\t}\\n\\t}\\n}', 'title' => ''], + 'templateName' => ['description' => 'The template name. Valid values:'."\n" + .'- staticSettings: elasticsearch.yml configuration'."\n" + .'- ilmPolicy: index lifecycle configuration'."\n" + .'- indexTemplate: index template configuration'."\n" + .'- dynamicSettings: cluster dynamic configuration.', 'type' => 'string', 'example' => 'dynamicSettings', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist', 'description' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<createInstanceResponse>\\n <RequestId>838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3</RequestId>\\n <Result>\\n <instanceId>es-is-0u2ecp69tt****</instanceId>\\n </Result>\\n</createInstanceResponse>","errorExample":""}]', - 'title' => 'createInstance', - 'description' => 'The configurations of warm nodes.'."\n", - 'requestParamsDescription' => 'The configurations of client nodes.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"content\\": \\"{\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"persistent\\\\\\\\\\\\\\":{\\\\\\\\n\\\\\\\\t\\\\\\\\t\\\\\\\\\\\\\\"search\\\\\\\\\\\\\\":{\\\\\\\\n\\\\\\\\t\\\\\\\\t\\\\\\\\t\\\\\\\\\\\\\\"max_buckets\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10000\\\\\\\\\\\\\\"\\\\\\\\n\\\\\\\\t\\\\\\\\t}\\\\\\\\n\\\\\\\\t}\\\\\\\\n}\\",\\n \\"templateName\\": \\"dynamicSettings\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve scenario-specific template configuration of an instance', + 'summary' => 'Retrieves the scenario-specific template configuration and cluster settings of an instance.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'EstimatedRestartTime' => [ - 'path' => '/openapi/instances/{InstanceId}/estimated-time/restart-time', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTemplates'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'DescribeXpackMonitorConfig' => [ + 'path' => '/openapi/logstashes/{InstanceId}/xpack-monitor-config', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9069,39 +7090,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'force', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to forcibly restart the cluster. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], ], 'responses' => [ @@ -9109,164 +7103,180 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'unit' => [ - 'description' => 'The unit.'."\n", - 'type' => 'string', - 'example' => 'second', + 'userName' => ['description' => 'The username used to access the Elasticsearch instance associated with X-Pack monitoring.', 'type' => 'string', 'example' => 'elastic', 'title' => ''], + 'esInstanceId' => ['description' => 'The instance ID of the Elasticsearch instance associated with X-Pack monitoring.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + 'enable' => ['description' => 'Indicates whether X-Pack monitoring is enabled. Valid values:'."\n" + .'- true: enabled.'."\n" + .'- false: not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'endpoints' => [ + 'type' => 'array', + 'items' => ['description' => 'The access endpoints of the Elasticsearch instance associated with X-Pack monitoring.', 'type' => 'string', 'example' => '["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'value' => [ - 'description' => 'The estimated restart time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', + 'pipelineIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The pipelines managed by the Kibana instance associated with X-Pack monitoring.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"unit\\": \\"second\\",\\n \\"value\\": 50\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'EstimatedRestartTime', - 'summary' => 'Queries the estimated time that is required to restart an Elasticsearch cluster.', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You can configure the following parameters in the request body to specify information about the restart. '."\n" - .'| Parameter | Type | Required | Example | Description | '."\n" - .'| ---- | ---- | ---- | ---- | '."\n" - .'| restartType| String | No | instance|The restart type. Valid values: instance and nodeIp. The value instance indicates a cluster restart. The value nodeIp indicates a node restart. Default value: instance. | '."\n" - .'| nodes| List<String\\> | No| \\["127.0.0.1"] |The IP addresses of the nodes that you want to restart. | '."\n" - .'| blueGreenDep| Boolean | No | false |Specifies whether to perform a blue-green restart for the nodes that you want to restart. Default value: false. | '."\n" - .'| batch| Integer | No| 25.0 | The concurrency at which the cluster is forcibly restarted. The default value of this parameter is 1 divided by the total number of nodes in the cluster. | '."\n" - .'| batchUnit| String | No | percent |The unit of the value for the batch parameter. Default value: percent. |'."\n" - ."\n" - .'* If you set the restartType parameter to instance, you do not need to configure the blueGreenDep parameter.'."\n" - ."\n" - .' * If you set the force parameter to true, you must set the batch parameter to a value that is greater than 0 and less than or equal to 100. Otherwise, the system reports the RestartBatchValueError error.'."\n" - .' * If you set the force parameter to false, the default value of the batch parameter is 0. If you set the batch parameter to a value other than 0, the system reports the NormalRestartNotSupportBatch error.'."\n" - ."\n" - .'* If you set the restartType parameter to nodeIp, you do not need to configure the batch parameter.'."\n" - ."\n" - .' * If the nodes parameter is not configured, the system reports a parameter configuration error.'."\n" - .' * If you set the blueGreenDep parameter to true, the system performs a blue-green restart. If you set the blueGreenDep parameter to false, the system performs a normal restart.'."\n" - ."\n" - .'Sample code:'."\n" - ."\n" - .' {'."\n" - .' "restartType":"nodeIp",'."\n" - .' "nodes": ["172.16.xx.xx"],'."\n" - .' "blueGreenDep":true'."\n" - .' }', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"userName\\": \\"elastic\\",\\n \\"esInstanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"enable\\": true,\\n \\"endpoints\\": [\\n \\"[\\\\\\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ],\\n \\"pipelineIds\\": [\\n \\"[]\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Get x-Pack monitoring configuration of an instance', + 'summary' => 'Retrieves the X-Pack monitoring configuration of a Logstash instance.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RestartInstance' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/restart', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeXpackMonitorConfig'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeXpackMonitorConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'DiagnoseInstance' => [ + 'path' => '/openapi/diagnosis/instances/{InstanceId}/actions/diagnose', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchW11LSE'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q8auz0003****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'force', + 'name' => 'lang', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to ignore the status of the instance and forcibly restart the instance.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The language of the report. Default value: browser language. Valid values:'."\n" + ."\n" + .'- en: English'."\n" + .'- zh: Simplified Chinese'."\n" + .'- zt: Traditional Chinese'."\n" + .'- es: Spanish'."\n" + .'- fr: French.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. The maximum length of the token is 64 ASCII characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The diagnostic task information.', + 'type' => 'object', + 'properties' => [ + 'indices' => [ + 'description' => 'The list of indexes to diagnose.', + 'type' => 'array', + 'items' => ['description' => 'The list of indexes to diagnose. If type is set to ALL, indices can be left empty.', 'type' => 'string', 'required' => false, 'example' => '["library"]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'diagnoseItems' => [ + 'description' => 'The diagnostic items.', + 'type' => 'array', + 'items' => ['description' => 'The diagnostic item. For more information, see the response of [ListDiagnosisItems](https://next.api.aliyun.com/document/elasticsearch/2017-06-13/ListDiagnosisItems).', 'type' => 'string', 'required' => false, 'example' => '["ClusterBulkRejectDiagnostic",...]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'type' => ['description' => 'The type of the diagnostic task. Valid values:'."\n" + ."\n" + .'- ALL: Diagnoses all indexes.'."\n" + .'- SELECT: Diagnoses selected indexes.', 'type' => 'string', 'required' => false, 'example' => 'ALL', 'title' => ''], + ], 'required' => false, 'docRequired' => false, + 'example' => '{ "indices":[], "type":"ALL", "diagnoseItems":[ "ClusterBulkRejectDiagnostic", "IndexAliasUseDiagnostic" ] }', + 'title' => '', ], ], ], @@ -9275,522 +7285,470 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => 'The return results.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'nodeAmount' => [ - 'description' => 'The number of data nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'publicDomain' => [ - 'description' => 'The public network access address.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com', - ], - 'createdAt' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => '2020-07-06T10:18:48.662Z', - ], - 'status' => [ - 'description' => 'The state of the cluster.'."\n" - ."\n" - .'Supported: active (normal), activating (initializing), inactive (blocked), and invalid (expired).'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'kibanaPort' => [ - 'description' => 'The public port of the Kibana network.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5601', - ], - 'publicPort' => [ - 'description' => 'The public network port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'paymentType' => [ - 'description' => 'The billing method of the created ECS instance.'."\n" - ."\n" - .'Valid values: prepaid and postpaid.'."\n", - 'type' => 'string', - 'example' => 'postpaid', - ], - 'domain' => [ - 'description' => 'The intranet access address of the instance.', - 'type' => 'string', - 'example' => 'es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com', - ], - 'description' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'es-cn-abc', - ], - 'esVersion' => [ - 'description' => 'The version of the instance.'."\n", - 'type' => 'string', - 'example' => '6.7.0_with_X-Pack', - ], - 'kibanaDomain' => [ - 'description' => 'The public network access address of Kibana.'."\n", - 'type' => 'string', - 'example' => 'es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com', - ], - 'updatedAt' => [ - 'description' => 'The time when the instance was last updated.', - 'type' => 'string', - 'example' => '2018-07-18T10:10:04.484Z', - ], - 'instanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - 'dictList' => [ - 'description' => 'The configuration of the IK dictionaries.'."\n", + 'createTime' => ['description' => 'The timestamp when the diagnostic report was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535745731000', 'title' => ''], + 'reportId' => ['description' => 'The report ID.', 'type' => 'string', 'example' => 'trigger__2020-08-17T17:09:02', 'title' => ''], + 'state' => ['description' => 'The diagnostic status. Valid values: SUCCESS, FAILED, and RUNNING.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID of the diagnosed instance.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + 'items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the Dictionary File. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'type' => [ - 'description' => 'The type of the dictionary. Valid values:'."\n" - ."\n" - .'* STOP: The STOP word.'."\n" - .'* MAIN: MAIN Dictionary'."\n" - .'* SYNONYMS: SYNONYMS'."\n" - .'* ALI_WS: an Alibaba Dictionary.'."\n", - 'type' => 'string', - 'example' => 'MAIN', - ], - 'name' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'example' => 'SYSTEM_MAIN.dic', - ], - 'sourceType' => [ - 'description' => 'The source type. Valid values:'."\n" - ."\n" - .'* OSS: OSS open storage (need to ensure that OSS storage space is public readable.)'."\n" - .'* ORIGIN: Open source Elasticsearch'."\n" - .'* UPLOAD: Uploaded files'."\n", - 'type' => 'string', - 'example' => 'ORIGIN', - ], - ], - ], - ], - 'synonymsDicts' => [ - 'description' => 'The configuration of the synonym dictionaries.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the Dictionary File. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'type' => [ - 'description' => 'The type of the dictionary. Valid values:'."\n" - ."\n" - .'* STOP: The STOP word.'."\n" - .'* MAIN: MAIN Dictionary'."\n" - .'* SYNONYMS: SYNONYMS'."\n" - .'* ALI_WS: an Alibaba Dictionary.'."\n", - 'type' => 'string', - 'example' => 'STOP', - ], - 'name' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'example' => 'SYSTEM_MAIN.dic', - ], - 'sourceType' => [ - 'description' => 'The source type. Valid values:'."\n" - ."\n" - .'* OSS:OSS open storage (the OSS storage space must be publicly readable.)'."\n" - .'* ORIGIN: open-source Elasticsearch'."\n" - .'* UPLOAD'."\n", - 'type' => 'string', - 'example' => 'ORIGIN', - ], - ], - ], - ], - 'kibanaConfiguration' => [ - 'description' => 'The configuration of Kibana nodes.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specification of data nodes.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'amount' => [ - 'description' => 'The number of performance metrics.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'disk' => [ - 'description' => 'The size of the node storage space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskType' => [ - 'description' => 'The storage type of the node.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - ], - ], - 'masterConfiguration' => [ - 'description' => 'The configuration of dedicated master nodes.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The node specifications of the cluster.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.large', - ], - 'amount' => [ - 'description' => 'The number of nodes in the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'disk' => [ - 'description' => 'The size of the node storage space. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskType' => [ - 'description' => 'The storage type of the node. This tool only supports cloud_ssd (cloud SSD) disks.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - ], - ], - 'networkConfig' => [ - 'description' => 'The network configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'vpcId' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtmagcva****', - ], - 'vsArea' => [ - 'description' => 'The zone where the instance is deployed.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'type' => [ - 'description' => 'The network type. Only Virtual Private Cloud (VPC) is supported.'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'vswitchId' => [ - 'description' => 'The ID of the vSwitch associated with the specified VPC.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1k4ec6s7sjdbudw****', - ], - ], - ], - 'nodeSpec' => [ - 'description' => 'The configuration of data nodes.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The specification of data nodes.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'disk' => [ - 'description' => 'The storage space size per data node. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'diskType' => [ - 'description' => 'The storage type of the node. Valid values: cloud_ssd and cloud_efficiency.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', + 'item' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'state' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'suggest' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'desc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'detail' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'diagnosisMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist', + 'title' => 'Diagnose an instance', + 'summary' => 'Calls DiagnoseInstance to immediately diagnose an instance.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:40.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'], + ['createdAt' => '2022-09-13T03:46:40.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 86400, 'regionId' => '*', 'api' => 'DiagnoseInstance'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DiagnoseInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC****\\",\\n \\"Result\\": {\\n \\"nodeAmount\\": 2,\\n \\"publicDomain\\": \\"es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com\\",\\n \\"createdAt\\": \\"2020-07-06T10:18:48.662Z\\",\\n \\"status\\": \\"active\\",\\n \\"kibanaPort\\": 5601,\\n \\"publicPort\\": 9200,\\n \\"paymentType\\": \\"postpaid\\",\\n \\"domain\\": \\"es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com\\",\\n \\"description\\": \\"es-cn-abc\\",\\n \\"esVersion\\": \\"6.7.0_with_X-Pack\\",\\n \\"kibanaDomain\\": \\"es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com\\",\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"dictList\\": {\\n \\"dictList\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"type\\": \\"MAIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"sourceType\\": \\"ORIGIN\\"\\n }\\n ]\\n },\\n \\"synonymsDicts\\": {\\n \\"synonymsDicts\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"type\\": \\"STOP\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"sourceType\\": \\"ORIGIN\\"\\n }\\n ]\\n },\\n \\"kibanaConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 1,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtmagcva****\\",\\n \\"vsArea\\": \\"cn-hangzhou-i\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-bp1k4ec6s7sjdbudw****\\"\\n },\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 50,\\n \\"diskType\\": \\"cloud_ssd\\"\\n }\\n }\\n}","errorExample":"{\\n \\"RequestId\\" : \\"F78BCD23-A133-4E32-A0FD-3D06E014402F\\",\\n \\"Code\\" : \\"InstanceNotFound\\",\\n \\"Message\\" : \\"The specified instance does not exist. Check the instance status and try again.\\"\\n}\\n"},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RestartInstance', - 'summary' => 'You can call this operation to restart a specified Elasticsearch instance.', - 'description' => '> After the instance is restarted, the instance enters the activating state. After the instance is restarted, its status changes to active. Alibaba Cloud Elasticsearch supports restarting a single node. Restarting a node can be divided into normal restart and blue-green restart.', - 'requestParamsDescription' => '## RequestBody'."\n" - ."\n" - .'The following parameters must be specified in RequestBody:'."\n" - ."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .'| --------- | ---- | -------- | ------- | ----------- |'."\n" - .'| restartType | String | No | instance | The restart type. Valid values:'."\n" - ."\n" - .'**instance**(default): Instance restart. '."\n" - ."\n" - .'**nodeIp**: To restart the node, you need to specify the IP address of the node. '."\n" - ."\n" - .'**nodeEcsId**: To restart a node, you need to specify the ID of the ECS instance in the cluster. |'."\n" - .'| nodes | List<String> | No | ["127.0.0.1"] | When selecting a node to restart, specify the IP address or ID of the node to be restarted. |'."\n" - .'| blueGreenDep | Boolean | No | false | Whether to enable blue-green deployment when the node restarts. Default value: **false**. |'."\n" - .'| batchCount | Double | No | 25.0 | Set the concurrency when the instance is forced to restart. |'."\n" - .'| batchUnit | String | No | percent | The unit of the **batchCount**. Default value: **percent**. |'."\n" - .'> - If the **restartType** parameter is not specified or is empty, the default value is **instance**. For **instance** the blueGreenDep parameter is ignored by default, and the following conditions must be met: - When the value of **force** is **true**, the value of **batchCount** must be greater than 0 but less than or equal to 100. Otherwise, a RestartBatchValueError error is returned.'."\n" - .' - When the **force** parameter is set to **false**, **batchCount** is set to 0 by default. If it is set to another value, an error NormalRestartNotSupportBatch.'."\n" - ."\n" - .' is'."\n" - .'- When the value of **restartType ** is **nodeIp**, the ** batchCount ** parameter is ignored. And the following conditions are met: - The error message returned if the **nodes** parameter is null.'."\n" - .' - when the ** bluependep ** is true, the blue-green deployment is enabled when the node is restarted. When this parameter is set to **false**, the system does not enable the blue-green deployment and restarts normally.'."\n" - ."\n" - .'Example:'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "restartType":"nodeIp",'."\n" - .' "nodes":["172.16.xx.xx","172.16.xx.xx"],'."\n" - .' "blueGreenDep":true'."\n" - .'}'."\n" - .'```', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"createTime\\": 1535745731000,\\n \\"reportId\\": \\"trigger__2020-08-17T17:09:02\\",\\n \\"state\\": \\"RUNNING\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"items\\": [\\n {\\n \\"item\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"state\\": \\"\\",\\n \\"suggest\\": \\"\\",\\n \\"desc\\": \\"\\",\\n \\"detail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"diagnosisMode\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'RenewInstance' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/renew', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DisableKibanaPvlNetwork' => [ + 'summary' => 'Disables Kibana private network access.', + 'path' => '/openapi/instances/{InstanceId}/actions/disable-kibana-private', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json', 'application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203888', + 'abilityTreeNodes' => ['FEATUREelasticsearch2PSU4E'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-vo93ngti8000a****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', + 'title' => '', + 'description' => 'response body', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG'], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The operation is successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + 400 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Disable kibana private network access', + 'description' => 'This API operation supports only cloud-native instances. For legacy architecture instances, use the TriggerNetwork method.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableKibanaPvlNetwork'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TriggerNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'EnableKibanaPvlNetwork' => [ + 'summary' => 'Invokes the EnableKibanaPvlNetwork operation to enable private network access for Kibana.', + 'path' => '/openapi/instances/{InstanceId}/actions/enable-kibana-private', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203874', + 'abilityTreeNodes' => ['FEATUREelasticsearch2PSU4E'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-n6w1oxxx****', 'title' => ''], + ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****', - ], + 'schema' => ['title' => '', 'description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'example' => 'xxxxx', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'endpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-27a3mul6l000xxx-kibana-endpoint', 'title' => ''], + 'securityGroups' => [ + 'description' => 'The security groups.', + 'type' => 'array', + 'items' => ['description' => 'The security group name.', 'type' => 'string', 'required' => true, 'example' => 'sg-2sjfaoafee****', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'vSwitchIdsZone' => [ + 'description' => 'The vSwitch and zone information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp194pz9iezj6h1n5****', 'title' => ''], + 'zoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'enumValueTitles' => [], + 'title' => '', + 'example' => '', + ], + 'vpcId' => ['description' => 'The VPC-connected instance ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp19ip2ocyv24w0e2****', 'title' => ''], + ], 'required' => false, - 'docRequired' => false, + 'example' => 'xxxxx', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'Indicates whether private network access for Kibana is created. Valid values:'."\n" + .'- true: The operation is successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0DC92CFE-62AF-51AF-9D5B-F1078D7C451E', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 400 => [ + 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0DC92CFE-62AF-51AF-9D5B-F1078D7C451E\\"\\n}","type":"json"}]', + 'title' => 'EnableKibanaPvlNetwork', + 'description' => '1. This API operation is supported only for cloud-native instances. For legacy architecture instances, use the TriggerNetwork method.'."\n" + .'2. The Kibana specification must be greater than 1 vCPU and 2 GB of memory.', + 'changeSet' => [ + ['createdAt' => '2025-12-03T08:10:54.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableKibanaPvlNetwork'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TriggerNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'EstimatedLogstashRestartTime' => [ + 'path' => '/openapi/logstashes/{InstanceId}/estimated-time/restart-time', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], + ], + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to forcibly restart the instance. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: renewal successfully'."\n" - .'* false: renewal failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'second', 'title' => ''], + 'value' => ['description' => 'The estimated restart time.', 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RenewInstance', - 'summary' => 'Call RenewInstance to renew a subscription instance.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"unit\\": \\"second\\",\\n \\"value\\": 600\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve estimated restart time of a logstash instance', + 'summary' => 'Retrieves the estimated restart time of a Logstash instance.', 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody can also include the following parameters to specify restart configuration.'."\n" ."\n" - .'The following fields are also required in RequestBody to specify the renewal information.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- | ---- |'."\n" + .'| restartType | String | No | instance | The restart type. Valid values: instance (restart the instance, default), nodeIp (restart by node). |'."\n" + .'| nodes | List<String\\> | No | ["127.0.xx.xx"] | The list of IP addresses of target nodes when you restart by node. |'."\n" + .'| blueGreenDep | Boolean | No | false | Specifies whether to perform a blue-green deployment during node restart. Default value: false. |'."\n" + .'| batch | Integer | No | 25.0 | The concurrency for forcibly restarting the instance. Default value: 1/total number of nodes in the instance. |'."\n" + .'| batchUnit | String | No | percent | The unit of batch. Default value: percent. |'."\n" + ."\n\n" + .' * When restartType is set to instance, the blueGreenDep parameter is ignored.'."\n" + .' * If force is set to true, batch must be greater than 0 and less than or equal to 100. Otherwise, the system returns a RestartBatchValueError error.'."\n" + .' * If force is set to false, batch defaults to 0. If you specify another value, the system returns a NormalRestartNotSupportBatch error.'."\n" + .' * When restartType is set to nodeIp, the batch parameter is ignored.'."\n" + .' * If nodeIp is empty, the system returns a parameter error.'."\n" + .' * If blueGreenDep is set to true, a blue-green deployment restart is performed. If blueGreenDep is set to false, a normal restart is performed.'."\n" ."\n" - .'| Field | Type | Required | Example | Description |'."\n" - .'| ----- | ---- | -------- | ------- | ----------- |'."\n" - .'| duration | Integer | Yes | 1 | The renewal duration of the subscription cluster. If pricingCycle is set to Year, the duration is 1 to 3. If pricingCycle is set to Month, the duration is 1 to 9. |'."\n" - .'| pricingCycle | String | Yes | Year | The billing cycle of renewal. Valid values: Year and Month. |'."\n" .'Example:'."\n" ."\n" .'```'."\n" .'{'."\n" - .' "duration":1,'."\n" - .' "pricingCycle":"Year"'."\n" + .' "restartType":"nodeIp",'."\n" + .' "nodes": ["172.16.xx.xx"],'."\n" + .' "blueGreenDep":true'."\n" .'}'."\n" - .'```', + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ActivateZones' => [ - 'summary' => 'Restores nodes in disabled zones. This operation is available only for multi-zone Elasticsearch clusters.', - 'path' => '/openapi/instances/{InstanceId}/actions/recover-zones', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EstimatedLogstashRestartTime'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:EstimatedLogstashRestartTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'EstimatedRestartTime' => [ + 'path' => '/openapi/instances/{InstanceId}/estimated-time/restart-time', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'force', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'Specifies whether to force restart the instance. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'description' => '请求体参数。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '["cn-hangzhou-i","cn-hangzhou-h"]', - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -9798,125 +7756,126 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'Indicates whether the nodes in disabled zones are restored. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5A5D8E74-565C-43DC-B031-29289FA****', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'unit' => ['description' => 'The unit.', 'type' => 'string', 'example' => 'second', 'title' => ''], + 'value' => ['description' => 'The estimated restart time.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5A5D8E74-565C-43DC-B031-29289FA****\\"\\n}","type":"json"}]', - 'title' => 'ActivateZones', - ], - 'DeactivateZones' => [ - 'summary' => 'Disables one or more zones where a multi-zone Elasticsearch cluster resides and migrates the nodes in the disabled zones to other zones.', - 'path' => '/openapi/instances/{InstanceId}/actions/down-zones', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"unit\\": \\"second\\",\\n \\"value\\": 50\\n }\\n}","type":"json"}]', + 'title' => 'Estimated instance restart time', + 'summary' => 'Retrieves the estimated restart time for an instance.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody can also include the following parameters to specify restart configurations.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| restartType| String | No | instance|The restart type. Valid values: instance (restart the instance) and nodeIp (restart by node). Default value: instance.|'."\n" + .'| nodes| List<String\\> | No| ["127.0.0.1"] |The list of IP addresses of target nodes when node restart is selected.|'."\n" + .'| blueGreenDep| Boolean | No | false |Specifies whether to perform a blue-green deployment during node restart. Default value: false.|'."\n" + .'| batch| Integer | No| 25.0 | The concurrency for force restarting the instance. Default value: 1/total number of nodes in the instance.|'."\n" + .'| batchUnit| String | No | percent |The unit of batch. Default value: percent.|'."\n" + ."\n" + .' * When restartType is set to instance, the blueGreenDep parameter is ignored.'."\n" + .' * If force is set to true, batch must be greater than 0 and less than or equal to 100. Otherwise, a RestartBatchValueError error is returned.'."\n" + .' * If force is set to false, batch defaults to 0. If you specify another value, a NormalRestartNotSupportBatch error is returned.'."\n" + .' * When restartType is set to nodeIp, the batch parameter is ignored.'."\n" + .' * If nodeIp is empty, a parameter error is returned.'."\n" + .' * If blueGreenDep is set to true, a blue-green deployment restart is performed. If blueGreenDep is set to false, a normal restart is performed.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "restartType":"nodeIp",'."\n" + .' "nodes": ["172.16.xx.xx"],'."\n" + .' "blueGreenDep":true'."\n" + .'}'."\n" + .'```.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EstimatedRestartTime'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:EstimatedRestartTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'GetClusterDataInformation' => [ + 'summary' => 'Retrieves index migration data information.', + 'path' => '/openapi/cluster/data-information', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'Instance ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'Used to ensure idempotency of the request. The client generates this parameter value and must guarantee its uniqueness across different requests, with a maximum length of 64 ASCII characters.', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -9924,116 +7883,217 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'Return result:'."\n" - ."\n" - .'- true: Zone offline successful'."\n" - .'- false: Zone offline failed', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'connectable' => ['description' => 'Indicates whether the cluster is connectable.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'metaInfo' => [ + 'description' => 'The metadata information of the cluster.', + 'type' => 'object', + 'properties' => [ + 'mapping' => ['description' => 'The mapping configuration of the cluster.', 'type' => 'string', 'example' => '{\\"_doc\\":{\\"properties\\":{\\"user\\":{\\"properties\\":{\\"last\\":{\\"type\\":\\"text\\",...}}}}}}', 'title' => ''], + 'settings' => ['description' => 'The settings configuration of the cluster.', 'type' => 'string', 'example' => '{\\n \\"index\\": {\\n \\"replication\\": {\\n}.....}}', 'title' => ''], + 'typeName' => [ + 'type' => 'array', + 'items' => ['description' => 'The type of the specified index.', 'type' => 'string', 'example' => '["index1-type"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'fields' => [ + 'type' => 'array', + 'items' => ['description' => 'The fields corresponding to the index mapping.', 'type' => 'string', 'example' => '["id","name"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'indices' => [ + 'type' => 'array', + 'items' => ['description' => 'The index list of the cluster.', 'type' => 'string', 'example' => '["index1","index2","index3"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeactivateZones', - 'requestParamsDescription' => '## RequestBody'."\n" - .'The RequestBody also requires a list of IDs for the zones to be offline, as shown in the example below.'."\n" - .'`["cn-hangzhou-i","cn-hangzhou-f"]`'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"connectable\\": true,\\n \\"metaInfo\\": {\\n \\"mapping\\": \\"{\\\\\\\\\\\\\\"_doc\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"last\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",...}}}}}}\\",\\n \\"settings\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"index\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"replication\\\\\\\\\\\\\\": {\\\\\\\\n}.....}}\\",\\n \\"typeName\\": [\\n \\"[\\\\\\"index1-type\\\\\\"]\\"\\n ],\\n \\"fields\\": [\\n \\"[\\\\\\"id\\\\\\",\\\\\\"name\\\\\\"]\\"\\n ],\\n \\"indices\\": [\\n \\"[\\\\\\"index1\\\\\\",\\\\\\"index2\\\\\\",\\\\\\"index3\\\\\\"]\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetClusterDataInformation', + 'requestParamsDescription' => 'No request parameters are required, but you must specify the RequestBody.'."\n" + .'The RequestBody must contain the following parameters to specify cluster information.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| dataSourceType| String | Yes | elasticsearch |The cluster type. Default value: elasticsearch.|'."\n" + .'| endpoint| String | No | http://10.01.xx.xx |The public endpoint of the cluster. This parameter is required when the network environment of the source cluster is the Internet.|'."\n" + .'| instanceId| String | No | es-cn-09k1rnu3g0002**** |The Elasticsearch instance ID. This parameter is required when the network environment of the source cluster is an Alibaba Cloud Elasticsearch cluster.|'."\n" + .'| vpcInstancePort| Integer | No | 9200 |The access port number of the cluster. This parameter is required when the network environment of the source cluster is an Alibaba Cloud Elasticsearch cluster or a self-managed cluster on Alibaba Cloud ECS.|'."\n" + .'| vpcId| String | No | vpc-2ze59tt67m3nzkko9**** |The ID of the virtual private cloud (VPC) where the cluster resides. This parameter is required when the network environment of the source cluster is an Alibaba Cloud Elasticsearch cluster or a self-managed cluster on Alibaba Cloud ECS.|'."\n" + .'| vpcInstanceId| String | No | es-09k1rnu3g0002****-worker |The instance ID or Server Load Balancer (SLB) instance ID of the current cluster. This parameter is required when the network environment of the source cluster is an Alibaba Cloud Elasticsearch cluster.|'."\n" + .'| username| String | No | elastic |The username used to access the cluster.|'."\n" + .'| password| String | No | xxxxxx |The password used to access the cluster.|'."\n" + .'| index| String | No | product |The index name.|'."\n" + .'| type| String | No | default |The index type.|'."\n" + ."\n\n" + .'> - If index is empty, you can verify whether the Elasticsearch cluster is connectable. If the cluster is connectable, the indices field in the returned result is not empty.'."\n" + .'- If index is not empty, you can obtain the settings and mapping information of the specified index.'."\n" + .'- If type is not empty, you can obtain the routing field information of the specified type.'."\n" + ."\n\n" + .'The parameters that you must specify vary based on the network environment of the source cluster:'."\n" + .'- Internet cluster: The required parameters include endpoint. Example:'."\n" + .' '."\n" + .' ```'."\n" + .' {'."\n" + .' "dataSourceType": "elasticsearch",'."\n" + .' "endpoint": "http://es-cn-npk1shyiq000d****.public.elasticsearch.aliyuncs.com:9200",'."\n" + .' "username": "elastic",'."\n" + .' "password": "xxxxxx",'."\n" + .' "index": "default",'."\n" + .' "type": "default"'."\n" + .' }'."\n" + .' ```'."\n" + ."\n" + .'- Self-managed cluster on Alibaba Cloud ECS: The required parameters include vpcInstancePort, vpcId, and vpcIp. Example:'."\n" + .' '."\n" + .' ```'."\n" + .' {'."\n" + .' "dataSourceType": "elasticsearch",'."\n" + .' "vpcId":"vpc-2ze55voww95g82gak****",'."\n" + .' "vpcInstancePort": "9200",'."\n" + .' "vpcIp": "10.12.xx.xx",'."\n" + .' "username" : "elastic",'."\n" + .' "password" : "xxxxxx",'."\n" + .' "index": "product",'."\n" + .' "type" : "default"'."\n" + .' }'."\n" + .' ```'."\n" + .' '."\n" + .'- Alibaba Cloud Elasticsearch cluster: The required parameters include vpcInstancePort, vpcId, vpcInstanceId, and instanceId. Example:'."\n" + .' '."\n" + .' ```'."\n" + .' {'."\n" + .' "dataSourceType" : "elasticsearch",'."\n" + .' "vpcId":"vpc-2ze55voww95g82gak****",'."\n" + .' "vpcInstancePort" : "9200",'."\n" + .' "vpcInstanceId" : "es-cn-09k1rnu3g0002****-worker",'."\n" + .' "instanceId" : "es-cn-oew1oxiro000f****",'."\n" + .' "username" : "elastic",'."\n" + .' "password" : "xxxxxx",'."\n" + .' "index": "product",'."\n" + .' "type" : "default"'."\n" + .' }'."\n" + ."\n" + .' ```'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'InterruptElasticsearchTask' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/interrupt', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:59.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClusterDataInformation'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:GetClusterDataInformation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetElastictask' => [ + 'path' => '/openapi/instances/{InstanceId}/elastic-task', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', + 'abilityTreeCode' => '64267', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-6ja1ro4jt000c****', 'title' => ''], ], ], 'responses' => [ @@ -10041,217 +8101,305 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code. Only displayed if an exception is returned.'."\n", - 'type' => 'string', - 'example' => 'InstanceStatusNotSupportCurrentAction', - ], - 'Message' => [ - 'description' => 'The error message. Only displayed if an exception is returned.'."\n", - 'type' => 'string', - 'example' => 'The cluster is running tasks or in an error status. Try again later.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: interrupted change successfully'."\n" - .'* false: interrupted change failed'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'elasticExpansionTask' => [ + 'description' => 'The elastic scale-out rule.', + 'type' => 'object', + 'properties' => [ + 'triggerType' => ['description' => 'The cause. Currently, only **crontab** is supported, which indicates scheduled triggering.', 'type' => 'string', 'example' => 'crontab', 'title' => ''], + 'replicaCount' => ['description' => 'The number of replicas for the target index.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'elasticNodeCount' => ['description' => 'The number of elastic data nodes during peak hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'cronExpression' => ['description' => 'The trigger cycle, specified as a Quartz Cron expression.', 'type' => 'string', 'example' => '0 0 0 ? * MON', 'title' => ''], + 'targetIndices' => [ + 'type' => 'array', + 'items' => ['description' => 'The name of the target elastic index. Wildcards are supported.', 'type' => 'string', 'example' => 'index', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'elasticShrinkTask' => [ + 'description' => 'The elastic scale-in rule.', + 'type' => 'object', + 'properties' => [ + 'triggerType' => ['description' => 'The cause. Currently, only crontab is supported, which indicates scheduled triggering.', 'type' => 'string', 'example' => 'crontab', 'title' => ''], + 'replicaCount' => ['description' => 'The number of replicas for the target index.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'elasticNodeCount' => ['description' => 'The number of elastic data nodes during off-peak hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'cronExpression' => ['description' => 'The trigger cycle, specified as a Quartz Cron expression.', 'type' => 'string', 'example' => '4 4 4 ? * WED', 'title' => ''], + 'targetIndices' => [ + 'type' => 'array', + 'items' => ['description' => 'The name of the target elastic index. Wildcards are supported.', 'type' => 'string', 'example' => 'index', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], + 404 => [ + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.', 'description' => 'The specified cluster does not exist. Check the cluster status and try again.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"InstanceStatusNotSupportCurrentAction\\",\\n \\"Message\\": \\"The cluster is running tasks or in an error status. Try again later.\\",\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'InterruptElasticsearchTask', - 'summary' => 'Call InterruptElasticsearchTask to interrupt the Alibaba cloud elasticsearch instance in the change. This parameter is valid only for instances in the initializing state. When the instance is interrupted, it enters the suspended state.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"elasticExpansionTask\\": {\\n \\"triggerType\\": \\"crontab\\",\\n \\"replicaCount\\": 2,\\n \\"elasticNodeCount\\": 2,\\n \\"cronExpression\\": \\"0 0 0 ? * MON\\",\\n \\"targetIndices\\": [\\n \\"index\\"\\n ]\\n },\\n \\"elasticShrinkTask\\": {\\n \\"triggerType\\": \\"crontab\\",\\n \\"replicaCount\\": 2,\\n \\"elasticNodeCount\\": 2,\\n \\"cronExpression\\": \\"4 4 4 ? * WED\\",\\n \\"targetIndices\\": [\\n \\"index\\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve cluster elastic scaling rules', + 'summary' => 'Retrieves the elastic scaling rules of a cluster. Elastic nodes must be purchased when the instance is created.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ResumeElasticsearchTask' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/resume', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElastictask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:GetElastictask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'GetEmonGrafanaAlerts' => [ + 'summary' => 'Calls GetEmonGrafanaAlerts to retrieve the Grafana alert list.', + 'path' => '/openapi/emon/projects/{ProjectId}/grafana/proxy/api/alerts', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchEC84H8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ProjectId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The ID of the monitoring alert project, in the format **es-<yourUID>**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-133071096032****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'body', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: resume the interrupted change successfully'."\n" - .'* false: resume the interrupted change successfully failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '08FA74C7-5654-4309-9729-D555AF587B7F', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the Grafana alert list is retrieved. Valid values:'."\n" + ."\n" + .'- true: The alert list is retrieved.'."\n" + .'- false: The alert list failed to be retrieved.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"08FA74C7-5654-4309-9729-D555AF587B7F\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve grafana alert list', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-08-21T02:49:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-28T10:33:01.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmonGrafanaAlerts'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:GetEmonGrafanaAlerts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetEmonGrafanaDashboards' => [ + 'summary' => 'Calls GetEmonGrafanaDashboards to retrieve the list of Grafana dashboards.', + 'path' => '/openapi/emon/projects/{ProjectId}/grafana/proxy/api/search', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchEC84H8'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the monitoring and alerting project, in the format **es-<yourUID>**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-133071096032****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E9D9827-2092-4385-9DA1-FC5A8D1DB3F5', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the Grafana dashboard list is retrieved. Valid values:'."\n" + ."\n" + .'- true: succeeded.'."\n" + .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ResumeElasticsearchTask', - 'summary' => 'Call ResumeElasticsearchTask to resume interrupted change of Elasticsearch instance. After you resume or interrupt a change, the instance enters the activating state.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"1E9D9827-2092-4385-9DA1-FC5A8D1DB3F5\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve grafana dashboard list', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'MigrateToOtherZone' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/migrate-zones', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2025-08-21T02:49:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-28T10:33:01.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmonGrafanaDashboards'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:GetEmonGrafanaDashboards', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:emonProjects/{#ProjectId}'], + ], + ], + ], + ], + ], + 'GetEmonMonitorData' => [ + 'summary' => 'Queries the Grafana metric monitoring data of an Elasticsearch instance.', + 'path' => '/openapi/emon/projects/{ProjectId}/metrics/query', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchEC84H8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ProjectId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'dryRun', - 'in' => 'query', - 'schema' => [ - 'description' => 'Verify whether the zone node can be migrated. true indicates that the data is only verified and the migration task is not executed. false indicates that the migration task is executed after the verification is successful.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The project ID, in the format of `es-<current account ID>`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-185320276651****', 'title' => ''], ], [ 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -10259,264 +8407,201 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'Code' => ['description' => 'The request status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The request result.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2D184B55-FA51-43F7-A1EF-E68A0545****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + .'- true: The request was successful.'."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: migration succeeded'."\n" - .'* false: The migration fails'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'integrity' => ['description' => 'The completeness of time series data points in the metric query result. A value of 1.0 indicates 100% completeness.', 'type' => 'number', 'format' => 'float', 'example' => '1.0', 'title' => ''], + 'summary' => ['description' => 'If the queries contain wildcards, the result includes multiple matched time series datasets. The summary aggregates the values of these time series at each time point based on the aggregator type specified in the query. Currently, only avg is supported as the aggregation method.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'messageWatermark' => ['description' => 'The timestamp when the request reaches the server. This parameter is used for troubleshooting.', 'type' => 'integer', 'format' => 'int64', 'example' => '1522127381471', 'title' => ''], + 'dps' => ['description' => 'The real-time metric monitoring data, in the format of `{timestamp:data}`.', 'type' => 'object', 'example' => ' { "1586249280": 465.1980465119913, "1586249300": 213.45243650423305 }', 'title' => ''], + 'tags' => ['description' => 'The query tags.', 'type' => 'object', 'example' => '{"taskName":"et-xxx","userId":"123456"}', 'title' => ''], + 'metric' => ['description' => 'The metric name.', 'type' => 'string', 'example' => 'elasticbuild.elasticsearch.source.total_doc_count', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'MigrateToOtherZone', - 'summary' => 'Call the MigrateToOtherZone to migrate the nodes in the specified zone to the destination zone.', - 'description' => 'If the specifications in your zone are insufficient, you can upgrade your instance to nodes in another zone. Before calling this interface, you must ensure that:'."\n" - ."\n" - .'* The error message returned because the current account is in a zone that has sufficient resources.'."\n" - ."\n" - .' After migrating nodes with current specifications to another zone, you need to manually [upgrade cluster](~~96650~~) because the cluster will not be upgraded during the migration process. Therefore, select a zone with sufficient resources to avoid cluster upgrade failure. We recommend that you choose new zones that are in lower alphabetical order. For example, for cn-hangzhou-e and cn-hangzhou-h zones, choose cn-hangzhou-h first.'."\n" - ."\n" - .'* The cluster is in the healthy state.'."\n" - ."\n" - .' Can be passed` GET _cat/health?v `command to view the health status of the cluster.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"2D184B55-FA51-43F7-A1EF-E68A0545****\\",\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"integrity\\": 1,\\n \\"summary\\": 10,\\n \\"messageWatermark\\": 1522127381471,\\n \\"dps\\": {\\n \\"1586249280\\": 465.1980465119913,\\n \\"1586249300\\": 213.45243650423305\\n },\\n \\"tags\\": {\\n \\"taskName\\": \\"et-xxx\\",\\n \\"userId\\": \\"123456\\"\\n },\\n \\"metric\\": \\"elasticbuild.elasticsearch.source.total_doc_count\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query grafana metric monitoring data of an instance', 'requestParamsDescription' => '## RequestBody'."\n" ."\n" - .'The following parameters must be specified in RequestBody to specify the zone information for migration. '."\n" - ."\n" .'| Parameter | Type | Required | Example | Description |'."\n" - .'| --------- | ---- | -------- | ------- | ----------- |'."\n" - .'| fromZoneId | String | Yes | cn-hangzhou-i | The zone where the instance is located. |'."\n" - .'| toZoneId | String | Yes | cn-hangzhou-b | The destination zone to which the instance is to be migrated. |'."\n" - .'| toVswitchId | String | Yes | vsw-bp1f7r0ma00pf9h2l**** | The ID of the vSwitch. |'."\n" - .'Example:'."\n" + .'| -------- | -------- | -------- | -------- | -------- |'."\n" + .'|start | Long | Yes | 1522127381471 | The start timestamp for metric monitoring. Unit: milliseconds.|'."\n" + .'|expression | String | No | a+b | The expression for metric data queries.|'."\n" + .'|queries | List | Yes | | The metric query conditions.|'."\n" + .'| └id | String | No | a | If the query conditions in queries use an expression, the queries JSON array describes the metrics involved in the expression. The id is the algebraic symbol for each metric in the expression. The actual metric name is specified in each element of the queries array.|'."\n" + .'| └metric | String | Yes | elasticbuild.elasticsearch.source.total_doc_count | The metric name.|'."\n" + .'| └aggregator | String | Yes | sum | The aggregation method for the metric by tags dimension. The metric is grouped by the specified tags and aggregated using methods such as sum, avg, max, or min.|'."\n" + .'| └downsample | String | Yes | avg | The aggregation method for the metric by time granularity. The time series within the [start,end] window is downsampled in the time dimension. For example, 20s granularity can be aggregated to 1min, 10min, or 1hour granularity. The granularity is automatically adjusted based on the size of the time window.|'."\n" + .'| └tags | Map | Yes | [env,dev] | The metric query tags, in the format of [key,value]. The key must be explicitly specified. The value supports wildcards. Wildcards return multiple time series datasets that meet the conditions.|'."\n" + .'| └granularity | String | Yes | 1m | The time granularity for the metric query. The range is [start,end]. Unit: milliseconds. |'."\n" + .'|limit | String | Yes |"100 "| The maximum size of the result set to return. If this parameter is left empty, all query data is returned. This parameter is typically used when wildcards are used for tag values and the result set is very large.|'."\n" + .'|end | String | Yes | 1522129151000 | The end timestamp for metric monitoring. Unit: milliseconds.|'."\n" + ."\n" + .'> └ indicates a child parameter.'."\n" + ."\n" + .'The following example is provided.'."\n" ."\n" .'```'."\n" .'{'."\n" - .' "fromZoneId": "cn-hangzhou-e",'."\n" - .' "toZoneId": "cn-hangzhou-f",'."\n" - .' "toVswitchId": "vsw-bp16t5hpc689dgkgc****"'."\n" + .' "start": 1522127381471, '."\n" + .' "queries": ['."\n" + .' {'."\n" + .' "metric": "elasticbuild.elasticsearch.source.total_doc_count",'."\n" + .' "aggregator": "sum",'."\n" + .' "downsample": "avg", '."\n" + .' "tags": {'."\n" + .' "taskName": "et-testtsk",'."\n" + .' "userId":"123456" '."\n" + .' }, '."\n" + .' "granularity": "1m" '."\n" + .' }'."\n" + .' ], '."\n" + .' "limit": "", '."\n" + .' "end": 1522129151000'."\n" .'}'."\n" - .'```', - 'responseParamsDescription' => ' ', + .'```.', + 'responseParamsDescription' => 'In the following response example, only the parameters included in the returned data list are guaranteed. Parameters not mentioned are for reference only. Do not rely on obtaining these parameters in your program.', 'extraInfo' => ' ', - ], - 'CancelDeletion' => [ - 'summary' => 'Restores an Elasticsearch cluster that is frozen after it is released.', - 'path' => '/openapi/instances/{InstanceId}/actions/cancel-deletion', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2025-08-21T02:49:07.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmonMonitorData'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:QueryEmonMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'emonProjects', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:emonProjects/{#emonProjectsId}'], + ], + ], + ], ], + ], + 'GetKeystores' => [ + 'summary' => 'Retrieve keystore information ', + 'path' => '/openapi/instances/{InstanceId}/keystores', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json', 'application/xml'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-z2q1wk6z00007****', - ], - ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'Instance ID. ', 'type' => 'string', 'required' => false, 'example' => 'es-cn-tl329rbpc0001****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response ', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'ID of the request ', 'title' => 'ID of the request ', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****'], 'Result' => [ - 'description' => 'Indicates whether the cluster is restored. Valid values:'."\n" - ."\n" - .'* true: The cluster is restored.'."\n" - .'* false: The cluster fails to be restored.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'D682B6B3-B425-46DA-A5FC-5F5C60553622', + 'description' => 'Return Result. ', + 'type' => 'array', + 'items' => ['description' => 'Keystore configuration information ', 'type' => 'string', 'example' => 'xpack.security.authc.realms.active_directory.my_ad.secure_bind_password', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"D682B6B3-B425-46DA-A5FC-5F5C60553622\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CancelDeletion', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DiagnoseInstance' => [ - 'summary' => 'Diagnoses an Elasticsearch cluster.', - 'path' => '/openapi/diagnosis/instances/{InstanceId}/actions/diagnose', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query cluster keystore information ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root>\\n <RequestId>F99407AB-2FA9-489E-A259-40CF6DCC****</RequestId>\\n <Result>xpack.security.authc.realms.active_directory.my_ad.secure_bind_password</Result>\\n</root>","type":"xml"}]', + 'translator' => 'machine', + ], + 'GetOpenStoreUsage' => [ + 'summary' => 'Queries the storage capacity and usage of an OpenStore instance.', + 'path' => '/openapi/instances/{InstanceId}/openstore/usage', + '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' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp when the diagnostic report was generated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'indices' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '["library"]', - ], - 'required' => false, - ], - 'diagnoseItems' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '["ClusterBulkRejectDiagnostic",...]', - ], - 'required' => false, - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ALL', - ], - ], - 'required' => false, - 'docRequired' => false, - 'example' => '{ "indices":[], "type":"ALL", "diagnoseItems":[ "ClusterBulkRejectDiagnostic", "IndexAliasUseDiagnostic" ] }', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-zvp2cqw1f0020****'], ], ], 'responses' => [ @@ -10524,130 +8609,73 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the report.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E1DE2491-804F-4C86-BAB4-548DD70B****'], 'Result' => [ - 'description' => 'The diagnosis status. Valid values: Supported: SUCCESS, FAILED, and RUNNING.'."\n", + 'description' => 'The result of the current request.', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'description' => 'The ID of the diagnostic instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535745731000', - ], - 'reportId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'trigger__2020-08-17T17:09:02', - ], - 'state' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'lastDayUsage' => ['title' => '', 'description' => 'The OpenStore storage usage on the previous day. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '184320'], + 'currentUsage' => ['title' => '', 'description' => 'The current OpenStore storage usage, which is an estimated value based on actual indexes. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '204800'], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1DE2491-804F-4C86-BAB4-548DD70B****\\",\\n \\"Result\\": {\\n \\"lastDayUsage\\": 184320,\\n \\"currentUsage\\": 204800\\n }\\n}","type":"json"}]', + 'title' => 'Query openStore instance usage', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOpenStoreUsage'], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:GetOpenstoreUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"createTime\\": 1535745731000,\\n \\"reportId\\": \\"trigger__2020-08-17T17:09:02\\",\\n \\"state\\": \\"RUNNING\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1x0w001c****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DiagnoseInstance', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'MoveResourceGroup' => [ - 'path' => '/openapi/instances/{InstanceId}/resourcegroup', - 'methods' => [ - 'patch', - 'post', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRegionConfiguration' => [ + 'path' => '/openapi/region', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '64288', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'clientToken', + 'name' => 'zoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The current zone ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-f', 'title' => ''], ], ], 'responses' => [ @@ -10655,975 +8683,804 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6F******', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned region configuration information.', 'type' => 'object', 'properties' => [ - 'nodeAmount' => [ - 'description' => 'The number of data nodes in the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'publicDomain' => [ - 'description' => 'The public endpoint of the cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com', - ], - 'createdAt' => [ - 'description' => 'The time when the cluster was created.'."\n", - 'type' => 'string', - 'example' => '2020-07-06T10:18:48.662Z', - ], - 'status' => [ - 'description' => 'The status of the cluster. Valid values:'."\n" - ."\n" - .'* active: The cluster is normal.'."\n" - .'* activating: The cluster is being activated.'."\n" - .'* Inactive: The cluster is frozen.'."\n" - .'* invalid: The cluster is valid.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'publicPort' => [ - 'description' => 'The port number that is used to access the cluster over the Internet.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'kibanaPort' => [ - 'description' => 'The port number that is used to access the Kibana console of the cluster over the Internet.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5601', - ], - 'paymentType' => [ - 'description' => 'The billing method of the cluster. Valid values:'."\n" - ."\n" - .'* prepaid: subscription'."\n" - .'* postpaid: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'postpaid', - ], - 'domain' => [ - 'description' => 'The internal endpoint of the cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com', - ], - 'description' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-abc', - ], - 'esVersion' => [ - 'description' => 'The version of the cluster.'."\n", - 'type' => 'string', - 'example' => '6.7.0_with_X-Pack', + 'env' => ['description' => 'The environment flag.', 'type' => 'string', 'example' => 'production', 'title' => ''], + 'regionId' => ['description' => 'The current region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'createUrl' => ['description' => 'The URL of the purchase page.', 'type' => 'string', 'example' => 'https://common-buy.aliyun.com/?commodityCode=elasticsearch&orderType=BUY#/buy', 'title' => ''], + 'dataDiskList' => [ + 'description' => 'The allowed values for data node disks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'scaleLimit' => ['description' => 'The maximum continuous value that can be set for the disk size.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''], + 'minSize' => ['description' => 'The minimum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'maxSize' => ['description' => 'The maximum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '5120', 'title' => ''], + 'diskType' => ['description' => 'The disk storage type.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'valueLimitSet' => [ + 'type' => 'array', + 'items' => ['description' => 'The discrete values allowed for the disk size.', 'type' => 'string', 'example' => '[2560,3072,3584,4096,4608,5120]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'kibanaDomain' => [ - 'description' => 'The public endpoint of the Kibana console of the cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com', + 'esVersionsLatestList' => [ + 'description' => 'The list of Elasticsearch versions available for purchase.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The supported major version number.', 'type' => 'string', 'example' => '5.5_with_X-Pack', 'title' => ''], + 'value' => ['description' => 'The full name of the supported minor version.', 'type' => 'string', 'example' => '5.5.3_with_X-Pack', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'updatedAt' => [ - 'description' => 'The time when the cluster was last updated.'."\n", - 'type' => 'string', - 'example' => '2018-07-18T10:10:04.484Z', + 'nodeSpecList' => [ + 'description' => 'The list of data node specifications.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'memorySize' => ['description' => 'The memory size of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => ''], + 'cpuCount' => ['description' => 'The number of CPU cores for this specification.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'diskType' => ['description' => 'The disk storage type.', 'type' => 'string', 'example' => 'local_efficiency', 'title' => ''], + 'spec' => ['description' => 'The specification name.', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.large', 'title' => ''], + 'disk' => ['description' => 'The disk size for this specification.', 'type' => 'integer', 'format' => 'int32', 'example' => '44000', 'title' => ''], + 'specGroupType' => ['description' => 'The storage type. Valid values:'."\n" + ."\n" + .'- common: cloud disk'."\n" + ."\n" + .'- local_efficiency: local SATA disk'."\n" + ."\n" + .'- local_ssd: local SSD disk'."\n" + ."\n\n", 'type' => 'string', 'example' => 'local_efficiency', 'title' => ''], + 'enable' => ['description' => 'Indicates whether the specification is available for purchase.'."\n" + ."\n" + .'- true: available'."\n" + .'- false: unavailable', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'instanceId' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****', + 'clientNodeDiskList' => [ + 'description' => 'The allowed values for coordinating node disks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'scaleLimit' => ['description' => 'The maximum continuous value that can be set for the disk size.', 'type' => 'integer', 'format' => 'int32', 'example' => '18', 'title' => ''], + 'minSize' => ['description' => 'The minimum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'maxSize' => ['description' => 'The maximum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The disk storage type.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'dictList' => [ - 'description' => 'The configurations of IK dictionaries.'."\n", + 'masterDiskList' => [ + 'description' => 'The allowed values for dedicated master node disks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the dictionary file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'sourceType' => [ - 'description' => 'The type of the source of the dictionary file. Valid values:'."\n" - ."\n" - .'* OSS: Object Storage Service (OSS). You must make sure that the access control list (ACL) of the related OSS bucket is public read.'."\n" - .'* ORIGIN: previously uploaded dictionary.'."\n", - 'type' => 'string', - 'example' => 'ORIGIN', - ], - 'name' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'example' => 'SYSTEM_MAIN.dic', - ], - 'type' => [ - 'description' => 'The type of the dictionary. Valid values:'."\n" - ."\n" - .'* STOP: stopword list'."\n" - .'* MAIN: main dictionary'."\n" - .'* SYNONYMS: synonym dictionary'."\n" - .'* ALI_WS: Alibaba Cloud dictionary'."\n", - 'type' => 'string', - 'example' => 'MAIN', - ], + 'scaleLimit' => ['description' => 'The maximum continuous value that can be set for the disk size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'minSize' => ['description' => 'The minimum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'maxSize' => ['description' => 'The maximum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The disk storage type.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'synonymsDicts' => [ - 'description' => 'The configurations of synonym dictionaries.'."\n", + 'supportVersions' => [ + 'description' => 'The supported version configurations.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the dictionary file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'sourceType' => [ - 'description' => 'The type of the source of the dictionary file. Valid values:'."\n" - ."\n" - .'* OSS: Object Storage Service (OSS). You must make sure that the ACL of the related OSS bucket is public read.'."\n" - .'* ORIGIN: previously uploaded dictionary.'."\n", - 'type' => 'string', - 'example' => 'ORIGIN', - ], - 'name' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'example' => 'SYSTEM_MAIN.dic', - ], - 'type' => [ - 'description' => 'The type of the dictionary. Valid values:'."\n" - ."\n" - .'* STOP: stopword list'."\n" - .'* MAIN: main dictionary'."\n" - .'* SYNONYMS: synonym dictionary'."\n" - .'* ALI_WS: Alibaba Cloud dictionary'."\n", - 'type' => 'string', - 'example' => 'STOP', + 'instanceCategory' => ['description' => 'The instance category. Valid values:'."\n" + ."\n" + .'- advanced: Enhanced Edition'."\n" + ."\n" + .'- x-pack: Commercial Edition', 'type' => 'string', 'example' => 'x-pack', 'title' => ''], + 'supportVersionList' => [ + 'description' => 'The supported Elasticsearch version information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The version available on the purchase page.', 'type' => 'string', 'example' => '5.5', 'title' => ''], + 'value' => ['description' => 'The detailed version number.', 'type' => 'string', 'example' => '5.5.3', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'nodeSpec' => [ - 'description' => 'The configurations of data nodes.'."\n", + 'masterSpec' => [ + 'type' => 'array', + 'items' => ['description' => 'The dedicated master node specifications.', 'type' => 'string', 'example' => '["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge" ]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'clientNodeSpec' => [ + 'type' => 'array', + 'items' => ['description' => 'The coordinating node specifications.', 'type' => 'string', 'example' => '["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.4xlarge","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'zones' => [ + 'type' => 'array', + 'items' => ['description' => 'The supported zones.', 'type' => 'string', 'example' => '["cn-hangzhou-b","cn-hangzhou-f"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'instanceSupportNodes' => [ + 'type' => 'array', + 'items' => ['description' => 'The instance node types available in the region.', 'type' => 'string', 'example' => '[ "WORKER", "WORKER_WARM", "COORDINATING", "KIBANA", "MASTER", "ELASTIC_WORKER" ]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'esVersions' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of Elasticsearch versions that can be created.', 'type' => 'string', 'example' => '[ "5.5.3_with_X-Pack"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'node' => [ + 'description' => 'The node configuration.', 'type' => 'object', 'properties' => [ - 'spec' => [ - 'description' => 'The specification category.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'disk' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', + 'maxAmount' => ['description' => 'The maximum number of data nodes allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'minAmount' => ['description' => 'The minimum number of data nodes allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'jvmConfine' => [ + 'description' => 'The JVM validation configuration.', + 'type' => 'object', + 'properties' => [ + 'memory' => ['description' => 'The minimum memory size required to enable JVM garbage collection.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''], + 'supportEsVersions' => [ + 'type' => 'array', + 'items' => ['description' => 'The Elasticsearch versions that support JVM garbage collection.', 'type' => 'string', 'example' => '["6.7.0_with_X-Pack","6.7.0_with_A-Pack","7.4.0_with_X-Pack"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'diskType' => [ - 'description' => 'The storage type.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', + 'supportGcs' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of JVM garbage collectors that can be configured.', 'type' => 'string', 'example' => '["CMS","G1"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'networkConfig' => [ - 'description' => 'The network configurations.'."\n", + 'clientNodeAmountRange' => [ + 'description' => 'The range for the number of coordinating nodes.', 'type' => 'object', 'properties' => [ - 'vpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtmagcva****', - ], - 'vsArea' => [ - 'description' => 'The zone where the cluster resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-i', + 'maxAmount' => ['description' => 'The maximum number of coordinating nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], + 'minAmount' => ['description' => 'The minimum number of coordinating nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'warmNodeProperties' => [ + 'description' => 'The warm node configuration.', + 'type' => 'object', + 'properties' => [ + 'diskList' => [ + 'description' => 'The list of disk configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'scaleLimit' => ['description' => 'The maximum continuous value that can be set for the disk size.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''], + 'minSize' => ['description' => 'The minimum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether disk encryption is supported.'."\n" + ."\n" + .'- true: supported'."\n" + ."\n" + .'- false: not supported', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'maxSize' => ['description' => 'The maximum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '5120', 'title' => ''], + 'diskType' => ['description' => 'The disk storage type.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], + 'valueLimitSet' => [ + 'type' => 'array', + 'items' => ['description' => 'The discrete values allowed for the disk size.', 'type' => 'string', 'example' => '[2560,3072,3584,4096,4608,5120]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'type' => [ - 'description' => 'The network type. Only the VPC is supported.'."\n", - 'type' => 'string', - 'example' => 'vpc', + 'spec' => [ + 'type' => 'array', + 'items' => ['description' => 'The specifications supported by warm nodes.', 'type' => 'string', 'example' => '["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.8xlarge","elasticsearch.ic5.large","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'vswitchId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1k4ec6s7sjdbudw****', + 'amountRange' => [ + 'description' => 'The range for the number of nodes.', + 'type' => 'object', + 'properties' => [ + 'maxAmount' => ['description' => 'The maximum number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'minAmount' => ['description' => 'The minimum number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'kibanaConfiguration' => [ - 'description' => 'The configurations of Kibana nodes.'."\n", + 'kibanaNodeProperties' => [ + 'description' => 'The Kibana node configuration.', 'type' => 'object', 'properties' => [ 'spec' => [ - 'description' => 'The specification category.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'amount' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'disk' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'type' => 'array', + 'items' => ['description' => 'The list of allowed specifications.', 'type' => 'string', 'example' => '["elasticsearch.n4.small","elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn1ne.large"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'diskType' => [ - 'description' => 'The storage type.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', + 'amountRange' => [ + 'description' => 'The allowed range for the number of nodes.', + 'type' => 'object', + 'properties' => [ + 'maxAmount' => ['description' => 'The maximum number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'minAmount' => ['description' => 'The minimum number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'masterConfiguration' => [ - 'description' => 'The configurations of dedicated master nodes.'."\n", + 'elasticNodeProperties' => [ + 'description' => 'The elastic node configuration.', 'type' => 'object', 'properties' => [ - 'spec' => [ - 'description' => 'The specification category.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.large', - ], - 'amount' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'diskList' => [ + 'description' => 'The list of disk configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'scaleLimit' => ['description' => 'The maximum continuous value that can be set for the disk size.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''], + 'minSize' => ['description' => 'The minimum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether disk encryption is supported.'."\n" + ."\n" + .'- true: supported'."\n" + ."\n" + .'- false: not supported', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'maxSize' => ['description' => 'The maximum disk size allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '5120', 'title' => ''], + 'diskType' => ['description' => 'The disk storage type.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'valueLimitSet' => [ + 'type' => 'array', + 'items' => ['description' => 'The discrete values allowed for the disk size.', 'type' => 'string', 'example' => '[2560,3072,3584,4096,4608,5120]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'disk' => [ - 'description' => 'The storage capacity. Unit: GB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'spec' => [ + 'type' => 'array', + 'items' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => '["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.8xlarge","elasticsearch.ic5.large","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'diskType' => [ - 'description' => 'The storage type.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', + 'amountRange' => [ + 'description' => 'The range for the number of elastic nodes.', + 'type' => 'object', + 'properties' => [ + 'maxAmount' => ['description' => 'The maximum number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], + 'minAmount' => ['description' => 'The minimum number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'logstashZones' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"nodeAmount\\": 2,\\n \\"publicDomain\\": \\"es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com\\",\\n \\"createdAt\\": \\"2020-07-06T10:18:48.662Z\\",\\n \\"status\\": \\"active\\",\\n \\"publicPort\\": 9200,\\n \\"kibanaPort\\": 5601,\\n \\"paymentType\\": \\"postpaid\\",\\n \\"domain\\": \\"es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com\\",\\n \\"description\\": \\"es-cn-abc\\",\\n \\"esVersion\\": \\"6.7.0_with_X-Pack\\",\\n \\"kibanaDomain\\": \\"es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com\\",\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"dictList\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ],\\n \\"synonymsDicts\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"STOP\\"\\n }\\n ],\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 50,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtmagcva****\\",\\n \\"vsArea\\": \\"cn-hangzhou-i\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-bp1k4ec6s7sjdbudw****\\"\\n },\\n \\"kibanaConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 1,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n","errorExample":""}]', - 'title' => 'MoveResourceGroup', - 'summary' => 'Migrates an Elasticsearch cluster to a specified resource group.', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify the information about the resource group to which the cluster is migrated. '."\n" - .'| Parameter | Type | Required | Example | Description | '."\n" - .'| ---- | ---- | ---- | ---- | '."\n" - .'|resourceGroupId| String | Yes | rg-acfm2h5vbzd\\*\\*\\*\\* |The ID of the destination resource group. You can obtain the ID from the [Resource Group](https://resourcemanager.console.aliyun.com/resource-groups) page. |', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6F******\\",\\n \\"Result\\": {\\n \\"env\\": \\"production\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"createUrl\\": \\"https://common-buy.aliyun.com/?commodityCode=elasticsearch&orderType=BUY#/buy\\",\\n \\"dataDiskList\\": [\\n {\\n \\"scaleLimit\\": 2048,\\n \\"minSize\\": 20,\\n \\"maxSize\\": 5120,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"valueLimitSet\\": [\\n \\"[2560,3072,3584,4096,4608,5120]\\"\\n ]\\n }\\n ],\\n \\"esVersionsLatestList\\": [\\n {\\n \\"key\\": \\"5.5_with_X-Pack\\",\\n \\"value\\": \\"5.5.3_with_X-Pack\\"\\n }\\n ],\\n \\"nodeSpecList\\": [\\n {\\n \\"memorySize\\": 64,\\n \\"cpuCount\\": 16,\\n \\"diskType\\": \\"local_efficiency\\",\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"disk\\": 44000,\\n \\"specGroupType\\": \\"local_efficiency\\",\\n \\"enable\\": true\\n }\\n ],\\n \\"clientNodeDiskList\\": [\\n {\\n \\"scaleLimit\\": 18,\\n \\"minSize\\": 20,\\n \\"maxSize\\": 20,\\n \\"diskType\\": \\"cloud_efficiency\\"\\n }\\n ],\\n \\"masterDiskList\\": [\\n {\\n \\"scaleLimit\\": 20,\\n \\"minSize\\": 20,\\n \\"maxSize\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n }\\n ],\\n \\"supportVersions\\": [\\n {\\n \\"instanceCategory\\": \\"x-pack\\",\\n \\"supportVersionList\\": [\\n {\\n \\"key\\": \\"5.5\\",\\n \\"value\\": \\"5.5.3\\"\\n }\\n ]\\n }\\n ],\\n \\"masterSpec\\": [\\n \\"[\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.4xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.4xlarge\\\\\\",\\\\\\"elasticsearch.r5.large\\\\\\",\\\\\\"elasticsearch.r5.xlarge\\\\\\",\\\\\\"elasticsearch.r5.2xlarge\\\\\\" ]\\"\\n ],\\n \\"clientNodeSpec\\": [\\n \\"[\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.4xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.4xlarge\\\\\\",\\\\\\"elasticsearch.ic5.xlarge\\\\\\",\\\\\\"elasticsearch.ic5.2xlarge\\\\\\",\\\\\\"elasticsearch.ic5.3xlarge\\\\\\",\\\\\\"elasticsearch.ic5.4xlarge\\\\\\",\\\\\\"elasticsearch.r5.large\\\\\\",\\\\\\"elasticsearch.r5.xlarge\\\\\\",\\\\\\"elasticsearch.r5.2xlarge\\\\\\"]\\"\\n ],\\n \\"zones\\": [\\n \\"[\\\\\\"cn-hangzhou-b\\\\\\",\\\\\\"cn-hangzhou-f\\\\\\"]\\"\\n ],\\n \\"instanceSupportNodes\\": [\\n \\"[ \\\\\\"WORKER\\\\\\", \\\\\\"WORKER_WARM\\\\\\", \\\\\\"COORDINATING\\\\\\", \\\\\\"KIBANA\\\\\\", \\\\\\"MASTER\\\\\\", \\\\\\"ELASTIC_WORKER\\\\\\" ]\\"\\n ],\\n \\"esVersions\\": [\\n \\"[ \\\\\\"5.5.3_with_X-Pack\\\\\\"]\\"\\n ],\\n \\"node\\": {\\n \\"maxAmount\\": 50,\\n \\"minAmount\\": 2\\n },\\n \\"jvmConfine\\": {\\n \\"memory\\": 32,\\n \\"supportEsVersions\\": [\\n \\"[\\\\\\"6.7.0_with_X-Pack\\\\\\",\\\\\\"6.7.0_with_A-Pack\\\\\\",\\\\\\"7.4.0_with_X-Pack\\\\\\"]\\"\\n ],\\n \\"supportGcs\\": [\\n \\"[\\\\\\"CMS\\\\\\",\\\\\\"G1\\\\\\"]\\"\\n ]\\n },\\n \\"clientNodeAmountRange\\": {\\n \\"maxAmount\\": 25,\\n \\"minAmount\\": 2\\n },\\n \\"warmNodeProperties\\": {\\n \\"diskList\\": [\\n {\\n \\"scaleLimit\\": 2048,\\n \\"minSize\\": 500,\\n \\"diskEncryption\\": true,\\n \\"maxSize\\": 5120,\\n \\"diskType\\": \\"cloud_efficiency\\",\\n \\"valueLimitSet\\": [\\n \\"[2560,3072,3584,4096,4608,5120]\\"\\n ]\\n }\\n ],\\n \\"spec\\": [\\n \\"[\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.4xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.8xlarge\\\\\\",\\\\\\"elasticsearch.ic5.large\\\\\\",\\\\\\"elasticsearch.ic5.xlarge\\\\\\",\\\\\\"elasticsearch.ic5.2xlarge\\\\\\",\\\\\\"elasticsearch.ic5.3xlarge\\\\\\",\\\\\\"elasticsearch.ic5.4xlarge\\\\\\",\\\\\\"elasticsearch.r5.large\\\\\\",\\\\\\"elasticsearch.r5.xlarge\\\\\\",\\\\\\"elasticsearch.r5.2xlarge\\\\\\"]\\"\\n ],\\n \\"amountRange\\": {\\n \\"maxAmount\\": 50,\\n \\"minAmount\\": 2\\n }\\n },\\n \\"kibanaNodeProperties\\": {\\n \\"spec\\": [\\n \\"[\\\\\\"elasticsearch.n4.small\\\\\\",\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.large\\\\\\"]\\"\\n ],\\n \\"amountRange\\": {\\n \\"maxAmount\\": 20,\\n \\"minAmount\\": 1\\n }\\n },\\n \\"elasticNodeProperties\\": {\\n \\"diskList\\": [\\n {\\n \\"scaleLimit\\": 2048,\\n \\"minSize\\": 500,\\n \\"diskEncryption\\": true,\\n \\"maxSize\\": 5120,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"valueLimitSet\\": [\\n \\"[2560,3072,3584,4096,4608,5120]\\"\\n ]\\n }\\n ],\\n \\"spec\\": [\\n \\"[\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.4xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.8xlarge\\\\\\",\\\\\\"elasticsearch.ic5.large\\\\\\",\\\\\\"elasticsearch.ic5.xlarge\\\\\\",\\\\\\"elasticsearch.ic5.2xlarge\\\\\\",\\\\\\"elasticsearch.ic5.3xlarge\\\\\\",\\\\\\"elasticsearch.ic5.4xlarge\\\\\\",\\\\\\"elasticsearch.r5.large\\\\\\",\\\\\\"elasticsearch.r5.xlarge\\\\\\",\\\\\\"elasticsearch.r5.2xlarge\\\\\\"]\\"\\n ],\\n \\"amountRange\\": {\\n \\"maxAmount\\": 25,\\n \\"minAmount\\": 2\\n }\\n },\\n \\"logstashZones\\": [\\n \\"\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Get region information', + 'summary' => 'Retrieves the current region information.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '> The example values above are for reference only. Refer to the actual return values of the API. ', 'extraInfo' => ' ', - ], - 'CapacityPlan' => [ - 'summary' => 'Capacity Planning', - 'path' => '/openapi/assist/actions/capacity-plan', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-12-06T07:56:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-16T05:54:40.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRegionConfiguration'], + ], ], + 'ramActions' => [], + ], + 'GetSuggestShrinkableNodes' => [ + 'summary' => 'Retrieves the nodes that can be removed based on the specified node type and quantity.', + 'path' => '/openapi/instances/{InstanceId}/suggest-shrinkable-nodes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'Anonymous' => [], + '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' => 'body', - 'in' => 'body', + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'nodeType', + 'in' => 'query', + 'schema' => ['description' => 'The type of nodes to scale in. **WORKER** indicates hot nodes. **WORKER_WARM** indicates warm nodes.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WORKER', 'title' => ''], + ], + [ + 'name' => 'count', + 'in' => 'query', + 'schema' => ['description' => 'The expected number of removable nodes to retrieve.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ignoreStatus', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to ignore the instance status. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Request parameter information.', 'type' => 'object', 'properties' => [ - 'complexQueryAvailable' => [ - 'description' => 'Indicates whether there is a need for complex aggregation queries. Options:'."\n" - ."\n" - .'- true: Yes'."\n" - .'- false (default): No', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'dataInfo' => [ - 'description' => 'Disk usage status.', - 'type' => 'array', - 'items' => [ - 'description' => 'Information about dataInfo.', - 'type' => 'object', - 'properties' => [ - 'code' => [ - 'description' => 'Disk data metric code. Options:'."\n" - ."\n" - .'- totalRawData: Raw data information'."\n" - .'- document: Data document information, estimated document count'."\n" - .'- dailyIncrement: Daily data growth'."\n" - .'- dailyIncrementDoc: Daily incremental document count'."\n" - .'- retentionTime: Data retention period'."\n" - .'- replica: Replica settings', - 'type' => 'string', - 'required' => false, - 'example' => 'totalRawData', - ], - 'size' => [ - 'description' => 'Disk usage metric value.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'type' => [ - 'description' => 'Disk data type. Options:'."\n" - ."\n" - .'- hot: Hot data'."\n" - .'- warm: Cold data', - 'type' => 'string', - 'required' => false, - 'example' => 'hot', - ], - 'unit' => [ - 'description' => 'Data or time unit. Options:'."\n" - ."\n" - .'- Data units: MiB, GiB, TB, PB'."\n" - .'- Time units: DAYS, WEEKS, MONTHS, YEARS', - 'type' => 'string', - 'required' => false, - 'example' => 'MiB', - ], - 'totalCount' => [ - 'description' => 'Total number of data entries.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10000', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'metric' => [ - 'description' => 'Metrics information including disk usage, search and write operations, aggregation requests, etc.', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + 'Result' => [ + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ - 'description' => 'Information about metric parameters.', 'type' => 'object', 'properties' => [ - 'code' => [ - 'description' => 'Search or write metric code. Options:'."\n" - ."\n" - .'- write: Write'."\n" - .'- search: Search', - 'type' => 'string', - 'required' => false, - 'example' => 'write', - ], - 'concurrent' => [ - 'description' => 'Concurrent number.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - 'throughput' => [ - 'description' => 'Throughput, unit: MB/S.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'type' => [ - 'description' => 'Search/write peak type. Options:'."\n" - ."\n" - .'- common: Regular'."\n" - .'- peak: Peak', - 'type' => 'string', - 'required' => false, - 'example' => 'common', - ], - 'peakQps' => [ - 'description' => 'Peak QPS.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'averageQps' => [ - 'description' => 'Average QPS.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'responseTime' => [ - 'description' => 'Expected average response time, unit: milliseconds.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], + 'port' => ['description' => 'The access port number of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'host' => ['description' => 'The IP address of the node.', 'type' => 'string', 'example' => '192.168.**.**', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'usageScenario' => [ - 'description' => 'Usage scenarios, options:'."\n" - ."\n" - .'- general: General scenario'."\n" - .'- analysisVisualization: Data analysis scenario'."\n" - .'- dbAcceleration: Database acceleration scenario'."\n" - .'- search: Search scenario'."\n" - .'- log: Log scenario', - 'type' => 'string', - 'required' => false, - 'example' => 'general', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n {\\n \\"port\\": 9200,\\n \\"host\\": \\"192.168.**.**\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get removable nodes', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' The Result parameter also contains the following parameters.'."\n" + .'| Name | Type | Example | Description |'."\n" + .'| ---- | ---- |---- |---- |'."\n" + .'| nodeType | String | WORKER | The node type. Valid values: MASTER (dedicated master node), WORKER (hot node), WORKER_WARM (warm node), COORDINATING (client node), and KIBANA (Kibana node). |'."\n" + .'| zoneId | String | ap-southeast-1-b | The zone ID of the node.|.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSuggestShrinkableNodes'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'GetTransferableNodes' => [ + 'summary' => 'Retrieves the nodes available for data migration based on the specified node type and count.', + 'path' => '/openapi/instances/{InstanceId}/transferable-nodes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'nodeType', + 'in' => 'query', + 'schema' => ['description' => 'The type of node for data migration. **WORKER** indicates a hot node. **WORKER_WARM** indicates a warm node.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WORKER', 'title' => ''], + ], + [ + 'name' => 'count', + 'in' => 'query', + 'schema' => ['description' => 'The expected number of nodes to retrieve for data migration.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Return information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'ID of the current request.', - 'type' => 'string', - 'example' => 'E91B7129-A669-4D9D-A743-F90A0FF1F5EF', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], 'Result' => [ - 'description' => 'Returned result of the request.', - 'type' => 'object', - 'properties' => [ - 'ExtendConfigs' => [ - 'description' => 'Extended configuration information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Information about ExtendConfigs.', - 'type' => 'object', - 'properties' => [ - 'ConfigType' => [ - 'description' => 'Configuration type, with a single value: sharedDisk.'."\n" - ."\n" - .'> This extendConfigs attribute may appear when the planned instance type is Advanced.'."\n", - 'type' => 'string', - 'example' => 'sharedDisk', - ], - 'Disk' => [ - 'description' => 'Disk size, in GiB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2048', - ], - 'DiskType' => [ - 'description' => 'Disk type, with a single value: CPFS_PREMIUM.'."\n" - ."\n" - .'> This extendConfigs attribute may appear when the planned instance type is Advanced.', - 'type' => 'string', - 'example' => 'CPFS_PREMIUM', - ], - ], - ], - ], - 'InstanceCategory' => [ - 'description' => 'Edition type, with values meaning as follows:'."\n" - ."\n" - .'- advanced: Enhanced Edition'."\n" - ."\n" - .'- x-pack: Commercial Edition'."\n" - ."\n" - .'- community: Community Edition', - 'type' => 'string', - 'example' => 'advanced', - ], - 'NodeConfigurations' => [ - 'description' => 'Node information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Information about NodeConfigurations.', - 'type' => 'object', - 'properties' => [ - 'Amount' => [ - 'description' => 'Number of nodes.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Cpu' => [ - 'description' => 'Number of CPUs.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Disk' => [ - 'description' => 'Disk size, in GiB.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'DiskType' => [ - 'description' => 'Disk type, with meanings as follows:'."\n" - ."\n" - .'- cloud_essd: ESSD Cloud Disk'."\n" - ."\n" - .'- cloud_ssd: SSD Cloud Disk'."\n" - ."\n" - .'- cloud_efficiency: Efficient Cloud Disk'."\n" - ."\n" - .'- local_ssd: Local SSD Disk'."\n" - ."\n" - .'- local_efficiency: Local Efficient Disk', - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'Memory' => [ - 'description' => 'Specified memory size for the current node role.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'NodeType' => [ - 'description' => 'Node type, with supported types as follows:'."\n" - ."\n" - .'- WORKER: Data Node'."\n" - ."\n" - .'- WORKER_WARM: Cold Data Node'."\n" - ."\n" - .'- MASTER: Dedicated Master Node'."\n" - ."\n" - .'- KIBANA: Kibana Node'."\n" - ."\n" - .'- COORDINATING: Coordinator Node'."\n" - ."\n" - .'- ELASTIC_WORKER: Elastic Node', - 'type' => 'string', - 'example' => 'WORKER', - ], - ], - ], - ], - 'OversizedCluster' => [ - 'description' => 'Based on the capacity planning calculation, there is no default value. The meanings of the values are as follows:'."\n" - ."\n" - .'- true: Represents an oversized cluster, indicating that the number of data nodes calculated by the capacity planning exceeds the threshold of 50.'."\n" - ."\n" - .'- false: The number of data nodes calculated by the capacity planning is within 50.', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'port' => ['description' => 'The access port of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'host' => ['description' => 'The IP address of the node.', 'type' => 'string', 'example' => '192.168.**.**', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E91B7129-A669-4D9D-A743-F90A0FF1F5EF\\",\\n \\"Result\\": {\\n \\"ExtendConfigs\\": [\\n {\\n \\"ConfigType\\": \\"sharedDisk\\",\\n \\"Disk\\": 2048,\\n \\"DiskType\\": \\"CPFS_PREMIUM\\"\\n }\\n ],\\n \\"InstanceCategory\\": \\"advanced\\",\\n \\"NodeConfigurations\\": [\\n {\\n \\"Amount\\": 10,\\n \\"Cpu\\": 1,\\n \\"Disk\\": 20,\\n \\"DiskType\\": \\"cloud_ssd\\",\\n \\"Memory\\": 2,\\n \\"NodeType\\": \\"WORKER\\"\\n }\\n ],\\n \\"OversizedCluster\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'Capacity Planning', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n {\\n \\"port\\": 9200,\\n \\"host\\": \\"192.168.**.**\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetTransferableNodes', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => 'The Result also contains the following parameters.'."\n" + .'| Name | Type |Example |Description |'."\n" + .'| ------ | ------ |------ |------ |'."\n" + .'| nodeType | String |WORKER |The node type. Valid values: MASTER (dedicated master node), WORKER (hot node), WORKER_WARM (warm node), COORDINATING (client node), and KIBANA (Kibana node).|'."\n" + .'| zoneId | String |ap-southeast-1b |The zone ID of the node.|.', 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'GetOpenStoreUsage' => [ - 'summary' => 'View the storage capacity and usage of the OpensStore instance.', - 'path' => '/openapi/instances/{InstanceId}/openstore/usage', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTransferableNodes'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'GrayPublish' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/grayPublish', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '159981', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'es-cn-zvp2cqw1f0020\\*\\*\\*\\*'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-zvp2cqw1f0020****', - 'title' => '实例id', - ], + 'schema' => ['description' => 'Elasticsearch instance ID (Required)', 'type' => 'string', 'required' => false, 'example' => 'es-cn-0pp1jxvcl000z****', 'title' => ''], + ], + [ + 'name' => 'X-Request-ChangeId', + 'in' => 'query', + 'schema' => ['description' => 'Change ID', 'type' => 'string', 'required' => false, 'example' => 'ea8d33aa4371c3499d0***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E1DE2491-804F-4C86-BAB4-548DD70B****', - 'title' => 'Id of the request', - ], - 'Result' => [ - 'description' => 'The current request result.'."\n", - 'type' => 'object', - 'properties' => [ - 'lastDayUsage' => [ - 'description' => 'The storage capacity of OpenStore yesterday. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '184320', - 'title' => '昨日使用容量', - ], - 'currentUsage' => [ - 'description' => 'The current OpenStore storage capacity (estimated value based on actual indexes). Unit: Byte.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '204800', - 'title' => '当前使用量', - ], - ], - ], + 'RequestId' => ['description' => 'Id of the request', 'title' => 'Id of the request', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC4****'], + 'Result' => ['description' => 'Return Result.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], - 'title' => 'Schema of Response', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E1DE2491-804F-4C86-BAB4-548DD70B****\\",\\n \\"Result\\": {\\n \\"currentUsage\\": 204800,\\n \\"lastDayUsage\\": 184320\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetOpenStoreUsage', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDicts' => [ - 'summary' => 'Queries the details of a specified type of dictionary.', - 'path' => '/openapi/instances/{InstanceId}/dicts', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Continue Phased Release for Restart', + 'summary' => 'Continue restarting the remaining edge zones of the Elasticsearch instance after the phased release is completed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC4****\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'InitModel' => [ + 'path' => '/openapi/instances/{InstanceId}/initModel', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeCode' => '240472', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'analyzerType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the dictionary. Valid values:'."\n" - ."\n" - .'* IK: IK dictionary after a standard update'."\n" - .'* IK_HOT: IK dictionary after a rolling update'."\n" - .'* SYNONYMS: synonym dictionary'."\n" - .'* ALIWS: Alibaba Cloud dictionary'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'IK', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SYSTEM_MAIN.dic', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-0ju29ifnc0005****', - ], + 'schema' => ['description' => 'Instance ID. ', 'type' => 'string', 'required' => true, 'example' => 'es-cn-jjw4k***', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'Request body. ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", + 'api_key' => ['description' => 'API key for the AI Search Open Platform ', 'type' => 'string', 'required' => true, 'example' => 'os-xfdddf*', 'title' => ''], + 'host' => ['description' => 'Service registration endpoint of the AI Search Open Platform ', 'type' => 'string', 'required' => true, 'example' => '****.platform-cn-hangzhou-vpc.opensearch.aliyuncs.com', 'title' => ''], + 'workspace' => ['description' => 'Workspace. ', 'type' => 'string', 'required' => true, 'example' => 'default', 'title' => ''], + 'http_schema' => [ + 'description' => 'HTTP protocol type ', 'type' => 'string', - 'example' => '2937F832-F39E-41EF-89BA-B528342A2A3A', - ], - 'Headers' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], + 'required' => true, + 'enum' => ['http', 'https'], + 'example' => 'https', + 'title' => '', ], - 'Result' => [ - 'description' => 'The returned result.'."\n", + 'models' => [ + 'description' => 'Specify the models to initialize. If empty, all built-in models will be initialized. ', + 'title' => 'Specify the models to initialize. If empty, all built-in models will be initialized. ', 'type' => 'array', 'items' => [ + 'description' => 'Model object ', 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the dictionary file. Unit: byte.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'sourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'example' => 'ORIGIN', - ], - 'downloadUrl' => [ - 'description' => 'The link that is used to download the dictionary over the Internet. The link is valid for 90s.'."\n", - 'type' => 'string', - 'example' => 'http://test_bucket.oss-cn-hangzhou.aliyuncs.com/AliyunEs/test.dic?Expires=162573****&OSSAccessKeyId=LTAI*****V9&Signature=PNPO********BBGsJDO4V3VfU4sE%3D', - ], - 'name' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'example' => 'SYSTEM_MAIN.dic', - ], - 'type' => [ - 'description' => 'The type of the IK dictionary. Valid values:'."\n" - ."\n" - .'* MAIN: main dictionary'."\n" - .'* STOP: stopword list'."\n", - 'type' => 'string', - 'example' => 'MAIN', - ], + 'serviceId' => ['description' => 'Service ID of the Search Open Platform ', 'type' => 'string', 'required' => false, 'example' => 'ops-text-embedding-**', 'title' => ''], + 'modelType' => ['description' => 'Model category '."\n" + .'- a. Text embedding: text_embedding '."\n" + .'- b. Reranking: rerank '."\n" + .'- c. Document segmentation: doc_split '."\n" + .'- d. Large Language Model (LLM) service: completion '."\n" + .'- e. Query analysis: query_analyze '."\n" + .'- f. Document content parsing: doc_analyze '."\n" + .'- g. Image content parsing: img_analyze ', 'type' => 'string', 'required' => false, 'example' => 'text_embedding', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - '5XX' => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'description' => 'Schema of Response ', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'ID of the request ', 'title' => 'ID of the request ', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC4****'], + 'Result' => ['description' => 'Return Result ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], - ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Register AI Search Open Platform model ', + 'summary' => 'Initialize AI model ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2937F832-F39E-41EF-89BA-B528342A2A3A\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 1\\n },\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"downloadUrl\\": \\"http://test_bucket.oss-cn-hangzhou.aliyuncs.com/AliyunEs/test.dic?Expires=162573****&OSSAccessKeyId=LTAI*****V9&Signature=PNPO********BBGsJDO4V3VfU4sE%3D\\",\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"type\\": \\"MAIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListDicts', - 'requestParamsDescription' => '> The name of each dictionary file for each type of Elasticsearch analyzer is unique.'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC4****\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ListShardRecoveries' => [ - 'path' => '/openapi/instances/{InstanceId}/cat-recovery', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InitializeOperationRole' => [ + 'summary' => 'Calls the InitializeOperationRole operation to create a service-linked role.', + 'path' => '/openapi/user/slr', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-7mz293m9a003j****', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value of this parameter must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'activeOnly', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return information about data restoration of shards. Valid values:'."\n" - ."\n" - .'* true: returns information about data restoration of shards that are being restored.'."\n" - .'* false: returns information about data restoration of all shards.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -11631,184 +9488,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'index' => [ - 'description' => 'The name of the index.'."\n", - 'type' => 'string', - 'example' => 'my-index-000001', - ], - 'sourceHost' => [ - 'description' => 'The IP address of the source node.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'sourceNode' => [ - 'description' => 'The name of the source node.'."\n", - 'type' => 'string', - 'example' => '2Kni3dJ', - ], - 'filesTotal' => [ - 'description' => 'The total number of files.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '79', - ], - 'bytesPercent' => [ - 'description' => 'The data restoration progress.'."\n", - 'type' => 'string', - 'example' => '80%', - ], - 'translogOps' => [ - 'description' => 'The number of translog operations to be restored.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12086', - ], - 'translogOpsPercent' => [ - 'description' => 'The restoration progress of translog operations.'."\n", - 'type' => 'string', - 'example' => '80%', - ], - 'bytesTotal' => [ - 'description' => 'The total amount of data that is restored.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12086', - ], - 'targetHost' => [ - 'description' => 'The IP address of the destination node.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'targetNode' => [ - 'description' => 'The name of the destination node.'."\n", - 'type' => 'string', - 'example' => 'YVVKLmW', - ], - 'filesPercent' => [ - 'description' => 'The file execution progress.'."\n", - 'type' => 'string', - 'example' => '80.0%', - ], - 'stage' => [ - 'description' => 'The data restoration status. Valid values:'."\n" - ."\n" - .'* done: Data restoration is complete.'."\n" - .'* finalize: Data is being cleared.'."\n" - .'* index: Index metadata is being read, and bytes are being copied from source to destination.'."\n" - .'* init: Data restoration is not started.'."\n" - .'* start: Data restoration is started.'."\n" - .'* translog: Translogs are being redone.'."\n", - 'type' => 'string', - 'example' => 'done', - ], - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The service-linked role is created.'."\n" + .'- false: The service-linked role failed to be created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '29101430-4797-4D1D-96C3-9FCBCCA8F845', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": [\\n {\\n \\"index\\": \\"my-index-000001\\",\\n \\"sourceHost\\": \\"192.168.XX.XX\\",\\n \\"sourceNode\\": \\"2Kni3dJ\\",\\n \\"filesTotal\\": 79,\\n \\"bytesPercent\\": \\"80%\\",\\n \\"translogOps\\": 12086,\\n \\"translogOpsPercent\\": \\"80%\\",\\n \\"bytesTotal\\": 12086,\\n \\"targetHost\\": \\"192.168.XX.XX\\",\\n \\"targetNode\\": \\"YVVKLmW\\",\\n \\"filesPercent\\": \\"80.0%\\",\\n \\"stage\\": \\"done\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListShardRecoveries', - 'summary' => 'Queries the information about shards that are being restored or shards that are restored. By default, this operation returns only the information about shards that are being restored after you call this operation.', - 'description' => '> The restoration of a shard is a process of synchronizing data from a primary shard to a replica shard. After the restoration is complete, the replica shard is available for data searches.'."\n", - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"29101430-4797-4D1D-96C3-9FCBCCA8F845\\"\\n}","type":"json"}]', + 'title' => 'Create a service-linked role', + 'description' => '> Before you use a collector to collect logs from different data sources or perform elastic scaling tasks for a cluster (applicable only to the China site), you must create a service-linked role.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody also requires the following parameter to specify the name of the service-linked role to create.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'|--------|-------|--------------|-----------|--------|'."\n" + .'| rolename | String | Yes | AliyunServiceRoleForElasticsearchCollector | The name of the service-linked role. Valid values: AliyunServiceRoleForElasticsearchOps (the role for performing elastic scaling tasks for a cluster, applicable only to the China site) and AliyunServiceRoleForElasticsearchCollector (the role for creating and managing Beats collectors).|.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListTags' => [ - 'summary' => 'All tags created by the user in the current region.', - 'path' => '/openapi/tags/all-tags', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T17:28:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitializeOperationRole'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InitializeOperationRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'InstallAckOperator' => [ + 'summary' => 'Installs the ACK Operator on a specified Container Service cluster.', + 'path' => '/openapi/ack-clusters/{ClusterId}/operator', + 'methods' => ['post'], + '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' => 'none'], 'parameters' => [ [ - 'name' => 'pageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The return results.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '20', - ], + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => ['description' => 'The ID of the target cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c79acd3fbf462423fb6450e513bb6****', 'title' => ''], ], [ - 'name' => 'resourceType', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag value of the ENI.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'INSTANCE', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -11816,613 +9595,457 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TagValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dev', - ], - 'TagKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'env', - ], - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The installation was successful.'."\n" + .'- false: The installation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EFA88951-7A6F-4A8E-AB8F-2BB7132BA751', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"TagValue\\": \\"dev\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListTags', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"EFA88951-7A6F-4A8E-AB8F-2BB7132BA751\\"\\n}","type":"json"}]', + 'title' => 'Install ACK operator', + 'description' => '> Before installing a collector on an ACK cluster, call this operation to install the Elasticsearch Operator on the target cluster.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListTagResources' => [ - 'summary' => 'Queries the tags that are added to one or more resources.', - 'path' => '/openapi/tags', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T17:28:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallAckOperator'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallAckOperator', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'ackClusters', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:ackClusters/{#ackClustersId}'], + ], + ], + ], + ], + ], + 'InstallKibanaSystemPlugin' => [ + 'path' => '/openapi/instances/{InstanceId}/kibana-plugins/system/actions/install', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Page', - 'in' => 'query', - 'schema' => [ - 'description' => '1d2db86sca4384811e0b5e8707e\\*\\*\\*\\*\\*\\*'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => true, - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Size', - 'in' => 'query', - 'schema' => [ - 'description' => '\\["es-cn-aaa","es-cn-bbb"]'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => true, - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '\\[{"key":"env","value","dev"},{"key":"dev", "value":"IT"}]'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCE', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1d2db86sca4384811e0b5e8707e******', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w00******', 'title' => ''], ], [ - 'name' => 'ResourceIds', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["es-cn-aaa","es-cn-bbb"]', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'Tags', - 'in' => 'query', - 'schema' => [ - 'description' => 'The header of the response. This parameter is empty and is for reference only. You cannot force this parameter to be relied on in the program.'."\n" - ."\n" - .'> The return examples does not contain this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"key":"env","value","dev"},{"key":"dev", "value":"IT"}]', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of resources to query.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'A list of resources that have tags.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6D****** ', - ], - 'Headers' => [ - 'description' => 'The labels of the resource.'."\n", - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'TagResources' => [ - 'description' => 'The type of the resource. Fixed to `ALIYUN::ELASTICSEARCH::INSTANCE`.'."\n", - 'type' => 'object', - 'properties' => [ - 'TagResource' => [ - 'description' => 'Indicates the ID of a resource.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TagValue' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'dev', - ], - 'ResourceType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ALIYUN::ELASTICSEARCH::INSTANCE', - ], - 'ResourceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-oew1q8bev0002****', - ], - 'TagKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'env', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****', 'title' => ''], + 'Result' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of plug-ins to be installed.', 'type' => 'string', 'example' => '["bsearch_querybuilder"] ', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6D******\\\\t\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"dev\\",\\n \\"ResourceType\\": \\"ALIYUN::ELASTICSEARCH::INSTANCE\\",\\n \\"ResourceId\\": \\"es-cn-oew1q8bev0002****\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListTagResources', - 'requestParamsDescription' => '10'."\n", + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"bsearch_querybuilder\\\\\\"]\\\\t\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Install kibana preset plug-ins', + 'summary' => 'Installs preset plug-ins for Kibana. The Kibana instance must have specifications of 2 vCPUs and 4 GB of memory or higher.', + 'requestParamsDescription' => '## RequestBody'."\n" + ."\n" + .'The RequestBody must also contain the plug-in names in the format `["pluginname1","pluginname2",…,"plugin_namen"]`, for example, `["bsearch_label","bsearch_querybuilder"]`.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UntagResources' => [ - 'summary' => 'Deletes a user resource tag relationship.', - 'path' => '/openapi/tags', - 'methods' => [ - 'delete', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallKibanaSystemPlugin'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallKibanaSystemPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'InstallLogstashSystemPlugin' => [ + 'path' => '/openapi/logstashes/{InstanceId}/plugins/system/actions/install', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ResourceIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource list that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '["es-cn-09k1rocex0006****","es-cn-oew1rgiev0009****"]', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource. Fixed to **INSTANCE** .'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'INSTANCE', - ], - ], - [ - 'name' => 'TagKeys', - 'in' => 'query', - 'schema' => [ - 'description' => 'The list of tags that you want to delete. The list can contain up to 20 subitems.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["tagKey1","tagKey2"]', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'All', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to delete all parts. Default value: **false** . This parameter is valid only when **TagKeys** is not specified.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. This parameter value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC4****', 'title' => ''], 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: deleted'."\n" - .'* false: Failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6D******', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => ['description' => 'The list of successfully installed plugins.', 'type' => 'string', 'example' => '["logstash-input-datahub", "logstash-input-maxcompute"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC4****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"logstash-input-datahub\\\\\\", \\\\\\"logstash-input-maxcompute\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Install logstash system plugins', + 'summary' => 'Installs system plugins for a specified Logstash instance.', + 'description' => 'Before calling this operation, note the following:'."\n" + .'The plugins to be installed must be included in the Alibaba Cloud Logstash [default system plugin list](~~139626~~). External open source plugins are not supported.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the names of the plugins to be installed, in the format `["pluginName1","pluginName2",...,"pluginNamen"]`. Example:'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' "logstash-input-datahub",'."\n" + .' "logstash-input-maxcompute"'."\n" + .']'."\n" + .'```.', + 'responseParamsDescription' => 'The returned data also includes the **Headers** parameter, which indicates the response header information.', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallLogstashSystemPlugin'], + ], + ], + 'ramActions' => [ [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallSystemPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], ], ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + ], + 'InstallSystemPlugin' => [ + 'path' => '/openapi/instances/{InstanceId}/plugins/system/actions/install', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], - 500 => [ + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to guarantee the idempotence of the request. The value of this parameter must be unique among different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + 'Result' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of plug-ins to be installed.', 'type' => 'string', 'example' => '["aliyun-sql"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6D******\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UntagResources', - 'description' => 'When you call this operation, take note of the following items:'."\n" - ."\n" - .'* You can only delete user tags.'."\n" - ."\n" - .'> User labels are manually added to instances by users. A system Tag is a tag that Alibaba Cloud services add to instances. System labels are divided into visible labels and invisible labels.'."\n" - ."\n" - .'* If you delete a resource tag relationship that is not associated with any resources, you must delete the tags.', - 'requestParamsDescription' => '* **All=true** you call this operation with when TagKeys is empty and all resource tag relationships under the Resource are deleted. For resources without tags, the interface is not processed and success is returned.'."\n" - .'* When **TagKeys** is null and **All=false**, the API is not processed and success is returned.'."\n" - .'* **TagKeys** is not empty. **All** is ignored when this operation is called, whether it is true or false.'."\n" - .'* **After the TagKeys **specified** are **are, you can call this operation to delete the specified tags from resources. If the specified tag does not exist on a resource, the specified tag is not processed.'."\n" - .'* If the requested resource does not exist, the system returns **InvalidResourceId.NotFound** when you call this operation.'."\n", + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"aliyun-sql\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Install elasticsearch system plug-ins', + 'summary' => 'Installs system plug-ins on an Elasticsearch instance.', + 'requestParamsDescription' => '## RequestBody'."\n" + .' '."\n" + .'The RequestBody must contain the names of the plug-ins to be installed, in the format `["plugin_name1","plugin_name2",...,"plugin_namen"]`. Example: `["aliyun-sql","codec-compression"]`.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'TagResources' => [ - 'summary' => 'Adds tags to clusters.', - 'path' => '/openapi/tags', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallSystemPlugin'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallSystemPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'InstallUserPlugins' => [ + 'summary' => 'Installs custom plugins that have been uploaded to the Elasticsearch console.', + 'path' => '/openapi/instances/{InstanceId}/plugins/user/actions/install', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-i7m27ausp001l****', 'title' => ''], + ], + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceIds' => [ - 'title' => '实例ID列表。', - 'description' => 'A tag.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '实例ID', - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '["es-cn-aaa","es-cn-bbb"]', - ], - 'required' => true, - 'maxItems' => 50, - 'minItems' => 1, - ], - 'Tags' => [ - 'title' => '所关联的标签列表。', - 'description' => 'The value of the tag.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '标签元素', - 'description' => 'The resource type. Set the value to INSTANCE.'."\n", - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '标签Key', - 'description' => 'The returned object.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env', - ], - 'value' => [ - 'title' => '标签Value', - 'description' => 'Indicates whether tags are added to the clusters. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'IT', - ], - ], - 'required' => true, - ], - 'required' => true, - 'maxItems' => 20, - 'minItems' => 1, - ], - 'ResourceType' => [ - 'title' => '资源类型，固定为INSTANCE。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'INSTANCE', - 'enum' => [ - 'INSTANCE', - ], - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The list of custom plugins to install.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[ {"name": "pluginName1.zip"}, {"name": "pluginName2.zip"} ]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****', 'title' => ''], 'Result' => [ - 'title' => '返回结果，true 标签关联资源成功。', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'title' => '请求ID。', + 'type' => 'array', + 'items' => ['description' => 'The list of plugins requested for installation. If the installation fails, the system returns the corresponding error code. Refer to the error code to troubleshoot the issue.', 'type' => 'string', 'example' => '["pluginName1.zip", "pluginName2.zip"]', 'title' => ''], 'description' => '', - 'type' => 'string', - 'example' => '3D8795D9-8FF5-46B2-86E6-E3B407*******', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"3D8795D9-8FF5-46B2-86E6-E3B407*******\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'TagResources', - 'requestParamsDescription' => 'The resource IDs.'."\n", + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"pluginName1.zip\\\\\\", \\\\\\"pluginName2.zip\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'InstallUserPlugins', + 'description' => '> The custom plugin installation feature is being upgraded internally and is temporarily unavailable. If you urgently need this feature, submit a ticket to contact us.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the list of custom plugins.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| RequestBody | Array | | | |'."\n" + .'| └ name | String | Yes | pluginName1.zip | The custom plugin that has been uploaded to the Elasticsearch console. |'."\n" + ."\n" + .'└ indicates a child parameter.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {"name": "pluginName1.zip"},'."\n" + .' {"name": "pluginName2.zip"}'."\n" + .']'."\n" + ."\n" + .'```.', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDataTask' => [ - 'path' => '/openapi/instances/{InstanceId}/data-task', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2025-06-12T08:42:15.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallUserPlugins'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallUserPlugins', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'InterruptElasticsearchTask' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/interrupt', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-oew1oxiro000f****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'taskId', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the index migration task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'et_cn_0oyg09o96ib40****', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], ], 'responses' => [ @@ -12430,95 +10053,135 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'Code' => ['description' => 'The error code. This parameter is returned only when an exception occurs.', 'type' => 'string', 'example' => 'InstanceStatusNotSupportCurrentAction', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned only when an exception occurs.', 'type' => 'string', 'example' => 'The cluster is running tasks or in an error status. Try again later.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The change is interrupted.'."\n" + .'- false: The change failed to be interrupted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"InstanceStatusNotSupportCurrentAction\\",\\n \\"Message\\": \\"The cluster is running tasks or in an error status. Try again later.\\",\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Interrupt an instance change', + 'summary' => 'Interrupts an instance change task. This operation is valid only for instances in the Effecting state. After the interruption, the instance enters the suspended state.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterruptElasticsearchTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InterruptElasticsearchTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - '5XX' => [ + ], + ], + 'InterruptLogstashTask' => [ + 'path' => '/openapi/logstashes/{InstanceId}/actions/interrupt', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-4591f1y6****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['description' => 'The error code. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => '.', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => '.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0FA05123-745C-42FD-A69B-AFF48EF9****', 'title' => ''], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The task is suspended.'."\n" + .'- false: The task failed to be suspended.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], - ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteDataTask', - 'summary' => 'You can call this operation to delete an index migration task.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\".\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"0FA05123-745C-42FD-A69B-AFF48EF9****\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Suspend an instance change task', + 'summary' => 'After the interruption, the instance enters the suspended state.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetTransferableNodes' => [ - 'summary' => 'Call GetTransferableNodes to specify the type and number of nodes to obtain the nodes that can be migrated.', - 'path' => '/openapi/instances/{InstanceId}/transferable-nodes', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterruptLogstashTask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InterruptLogstashTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'ListAckClusters' => [ + 'path' => '/openapi/ack-clusters', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12526,43 +10189,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. (Deprecated).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'nodeType', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of nodes.**WORKER**represents a hot node,**WORKER_WARM** represents a warm node.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WORKER', - ], + 'schema' => ['description' => 'The number of records per page. (Deprecated).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '15', 'title' => ''], ], [ - 'name' => 'count', + 'name' => 'vpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of nodes to be migrated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the VPC where the ACK cluster resides.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp12nu14urf0upaf4****', 'title' => ''], ], ], 'responses' => [ @@ -12570,70 +10212,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F93EAA49-284F-4FCE-9E67-FA23FB4BB512', 'title' => ''], 'Result' => [ - 'description' => 'The return results.'."\n", + 'description' => 'The list of ACK clusters returned by the current request.', 'type' => 'array', 'items' => [ + 'description' => 'The information about a single ACK cluster.', 'type' => 'object', 'properties' => [ - 'port' => [ - 'description' => 'The access port of the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'host' => [ - 'description' => 'The IP address of the node.'."\n", - 'type' => 'string', - 'example' => '192.168.**.**', - ], + 'clusterType' => ['description' => 'The cluster type. Only ManagedKubernetes is supported, which indicates a managed Kubernetes cluster.', 'type' => 'string', 'example' => 'ManagedKubernetes', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the VPC where the cluster resides.', 'type' => 'string', 'example' => 'vpc-bp12nu14urf0upaf4****', 'title' => ''], + 'name' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'clusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'c5ea2c2d9a3cf499481292f60425d****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n {\\n \\"port\\": 9200,\\n \\"host\\": \\"192.168.**.**\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetTransferableNodes', - 'requestParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDataTasks' => [ - 'path' => '/openapi/instances/{InstanceId}/data-task', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F93EAA49-284F-4FCE-9E67-FA23FB4BB512\\",\\n \\"Result\\": [\\n {\\n \\"clusterType\\": \\"ManagedKubernetes\\",\\n \\"vpcId\\": \\"vpc-bp12nu14urf0upaf4****\\",\\n \\"name\\": \\"test\\",\\n \\"clusterId\\": \\"c5ea2c2d9a3cf499481292f60425d****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve ACK cluster list', + 'summary' => 'Retrieves the list of Container Service for Kubernetes (ACK) clusters.', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAckClusters'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'elasticsearch:ListAckClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListAckNamespaces' => [ + 'path' => '/openapi/ack-clusters/{ClusterId}/namespaces', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. (Deprecated).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of records per page. (Deprecated).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ClusterId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-oew1oxiro000f****', - ], + 'schema' => ['description' => 'The ID of the target cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c79acd3fbf462423fb6450e513bb6****', 'title' => ''], ], ], 'responses' => [ @@ -12641,216 +10322,147 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '95789100-A329-473B-9D14-9E0B7DB4BD5A', 'title' => ''], 'Result' => [ - 'description' => 'The return results.'."\n", + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'createTime' => [ - 'description' => 'The time when the site monitoring task was created.'."\n", - 'type' => 'string', - 'example' => '2020-07-30 06:32:18', - ], - 'taskId' => [ - 'description' => 'The ID of the task.'."\n", - 'type' => 'string', - 'example' => 'et_cn_mfv1233r47272****', - ], - 'status' => [ - 'description' => 'The status of the task.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'sinkCluster' => [ - 'description' => 'The information of the target cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'index' => [ - 'description' => 'The target index.'."\n", - 'type' => 'string', - 'example' => 'product_info', - ], - 'type' => [ - 'description' => 'The type of the destination index.'."\n", - 'type' => 'string', - 'example' => '_doc', - ], - 'endpoint' => [ - 'description' => 'The public network access address of the target cluster.'."\n", - 'type' => 'string', - 'example' => 'http://192.168.xx.xx:4101', - ], - 'vpcId' => [ - 'description' => 'The ID of the VPC to which the cluster belongs.'."\n", - 'type' => 'string', - 'example' => 'vpc-2ze55voww95g82gak****', - ], - 'vpcInstancePort' => [ - 'description' => 'The access port number of the cluster.'."\n", - 'type' => 'string', - 'example' => '9200', - ], - 'vpcInstanceId' => [ - 'description' => 'The instance ID or Server Load Balancer (SLB) ID of the current cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-09k1rnu3g0002****-worker', - ], - 'dataSourceType' => [ - 'description' => 'The type of the target cluster. Default value: elasticsearch.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - 'sourceCluster' => [ - 'description' => 'The information about the source cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'index' => [ - 'description' => 'The index whose data you want to migrate.'."\n", - 'type' => 'string', - 'example' => 'product_info', - ], - 'settings' => [ - 'description' => 'The Settings of the cluster.'."\n", - 'type' => 'string', - 'example' => '{\\n \\"index\\": {\\n \\"replication\\": {\\n}.....}}', - ], - 'mapping' => [ - 'description' => 'The Mapping configuration of the cluster.'."\n", - 'type' => 'string', - 'example' => '{\\"_doc\\":{\\"properties\\":{\\"user\\":{\\"properties\\":{\\"last\\":{\\"type\\":\\"text\\",...}}}}}}', - ], - 'type' => [ - 'description' => 'The type of the destination index.'."\n", - 'type' => 'string', - 'example' => '_doc', - ], - 'routing' => [ - 'description' => 'The routing field to index the table. It is set to the primary key by default.'."\n", - 'type' => 'string', - 'example' => '_id', - ], - 'dataSourceType' => [ - 'description' => 'The type of the source cluster. Default value: elasticsearch.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], + 'namespace' => ['description' => 'The namespace of the cluster.', 'type' => 'string', 'example' => 'logging', 'title' => ''], + 'status' => ['description' => 'The namespace status.', 'type' => 'string', 'example' => 'Active', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95789100-A329-473B-9D14-9E0B7DB4BD5A\\",\\n \\"Result\\": [\\n {\\n \\"namespace\\": \\"logging\\",\\n \\"status\\": \\"Active\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List ACK namespaces', + 'summary' => 'Queries all namespaces in a specified Container Service for Kubernetes (ACK) cluster.', + 'description' => 'This operation is deprecated and will be taken offline soon.', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAckNamespaces'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListAckNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'ackClusters', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:ackClusters/{#ackClustersId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"createTime\\": \\"2020-07-30 06:32:18\\",\\n \\"taskId\\": \\"et_cn_mfv1233r47272****\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"sinkCluster\\": {\\n \\"index\\": \\"product_info\\",\\n \\"type\\": \\"_doc\\",\\n \\"endpoint\\": \\"http://192.168.xx.xx:4101\\",\\n \\"vpcId\\": \\"vpc-2ze55voww95g82gak****\\",\\n \\"vpcInstancePort\\": \\"9200\\",\\n \\"vpcInstanceId\\": \\"es-cn-09k1rnu3g0002****-worker\\",\\n \\"dataSourceType\\": \\"1\\"\\n },\\n \\"sourceCluster\\": {\\n \\"index\\": \\"product_info\\",\\n \\"settings\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"index\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"replication\\\\\\\\\\\\\\": {\\\\\\\\n}.....}}\\",\\n \\"mapping\\": \\"{\\\\\\\\\\\\\\"_doc\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"last\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",...}}}}}}\\",\\n \\"type\\": \\"_doc\\",\\n \\"routing\\": \\"_id\\",\\n \\"dataSourceType\\": \\"1\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListDataTasks', - 'summary' => 'Call ListDataTasks to obtain the information of a data migration task.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetClusterDataInformation' => [ - 'summary' => 'Call GetClusterDataInformation to obtain the data information about the cluster.', - 'path' => '/openapi/cluster/data-information', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListActionRecords' => [ + 'summary' => 'Release notes Release notes details.', + 'path' => '/openapi/instances/{InstanceId}/action-records', + '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' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'A short description of struct.', 'type' => 'string', 'example' => ''], + ], + [ + 'name' => 'requestId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'userId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'actionNames', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'filter', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -12858,911 +10470,1153 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Result' => [ - 'description' => 'The return results.'."\n", - 'type' => 'object', - 'properties' => [ - 'connectable' => [ - 'description' => 'Whether it is connectable.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'metaInfo' => [ - 'description' => 'The metadata of the cluster.'."\n", - 'type' => 'object', - 'properties' => [ - 'mapping' => [ - 'description' => 'The Mapping configuration of the cluster.'."\n", - 'type' => 'string', - 'example' => '{\\"_doc\\":{\\"properties\\":{\\"user\\":{\\"properties\\":{\\"last\\":{\\"type\\":\\"text\\",...}}}}}}', - ], - 'settings' => [ - 'description' => 'The Settings of the cluster.'."\n", - 'type' => 'string', - 'example' => '{\\n \\"index\\": {\\n \\"replication\\": {\\n}.....}}', - ], - 'typeName' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["index1-type"]', - ], - 'description' => 'Specifies the type of the index.'."\n", - ], - 'fields' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["id","name"]', - ], - 'description' => 'The fields in the Mapping for the index.'."\n", - ], - 'indices' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["index1","index2","index3"]', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'actionName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'actionParams' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'actionResultAccessList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'endTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'instanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'process' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'recordDiff' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'recordIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'startTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'stateType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'statusInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'subState' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'nodeCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'completeNodeCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'exception' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'latencyMills' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'process' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'startTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'endTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'stateType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'subStatusInfo' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'subState' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'nodeCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'completeNodeCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'exception' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'latencyMills' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'process' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'startTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'endTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'stateType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], ], - 'description' => 'The index list of the cluster.'."\n", + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'userId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'userType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ownerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'userInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'metaNow' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'metaOld' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + ], + 'changeSet' => [ + ['createdAt' => '2025-03-18T02:02:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-30T06:29:10.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListActionRecords'], ], + ], + 'ramActions' => [ [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListActionRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], ], ], ], - 404 => [ + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Result\\": [\\n {\\n \\"actionName\\": \\"\\",\\n \\"actionParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"actionResultAccessList\\": [\\n \\"\\"\\n ],\\n \\"endTime\\": 0,\\n \\"instanceId\\": \\"\\",\\n \\"process\\": \\"\\",\\n \\"recordDiff\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"recordIds\\": [\\n \\"\\"\\n ],\\n \\"requestId\\": \\"\\",\\n \\"startTime\\": 0,\\n \\"stateType\\": \\"\\",\\n \\"statusInfo\\": [\\n {\\n \\"subState\\": \\"\\",\\n \\"nodeCount\\": 0,\\n \\"completeNodeCount\\": 0,\\n \\"exception\\": \\"\\",\\n \\"latencyMills\\": 0,\\n \\"process\\": \\"\\",\\n \\"startTime\\": 0,\\n \\"endTime\\": 0,\\n \\"stateType\\": \\"\\",\\n \\"subStatusInfo\\": [\\n {\\n \\"subState\\": \\"\\",\\n \\"nodeCount\\": 0,\\n \\"completeNodeCount\\": 0,\\n \\"exception\\": \\"\\",\\n \\"latencyMills\\": 0,\\n \\"process\\": \\"\\",\\n \\"startTime\\": 0,\\n \\"endTime\\": 0,\\n \\"stateType\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"userId\\": \\"\\",\\n \\"userType\\": \\"\\",\\n \\"ownerId\\": \\"\\",\\n \\"userInfo\\": \\"\\",\\n \\"metaNow\\": \\"\\",\\n \\"metaOld\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '', + ], + 'ListAllNode' => [ + 'summary' => 'Retrieves information about all nodes in an Elasticsearch cluster.', + 'path' => '/openapi/instances/{InstanceId}/nodes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-tl32cpgwa002l****', 'title' => ''], + ], + [ + 'name' => 'extended', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return monitoring information for the nodes. Valid values:'."\n" + ."\n" + .'- true (default): Returns monitoring information.'."\n" + ."\n" + .'- false: Does not return monitoring information.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0D71B597-F3FF-5B56-88D7-74F9D3F7****', 'title' => ''], + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'heapPercent' => ['description' => 'The JVM memory usage.', 'type' => 'string', 'example' => '21.6%', 'title' => ''], + 'zoneId' => ['description' => 'The zone where the node resides.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'cpuPercent' => ['description' => 'The CPU usage.'."\n" + .'> When **extended** is set to **true** and the monitoring information of the node is being synchronized, the parameter value returns null. In this case, wait 10 seconds and send the request again to retrieve the value.', 'type' => 'string', 'example' => '4.2%', 'title' => ''], + 'host' => ['description' => 'The IP address of the node.', 'type' => 'string', 'example' => '10.15.XX.XX', 'title' => ''], + 'nodeType' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'- MASTER: dedicated master node'."\n" + .'- WORKER: hot node'."\n" + .'- WORKER_WARM: warm node'."\n" + .'- COORDINATING: client node'."\n" + .'- KIBANA: Kibana node.', 'type' => 'string', 'example' => 'WORKER', 'title' => ''], + 'diskUsedPercent' => ['description' => 'The disk usage.', 'type' => 'string', 'example' => '1.0%', 'title' => ''], + 'port' => ['description' => 'The access port of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'loadOneM' => ['description' => 'The one-minute load average.', 'type' => 'string', 'example' => '0.12', 'title' => ''], + 'health' => ['description' => 'The health status of the node. Valid values: GREEN, YELLOW, RED, and GRAY.', 'type' => 'string', 'example' => 'GREEN', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D71B597-F3FF-5B56-88D7-74F9D3F7****\\",\\n \\"Result\\": [\\n {\\n \\"heapPercent\\": \\"21.6%\\",\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"cpuPercent\\": \\"4.2%\\",\\n \\"host\\": \\"10.15.XX.XX\\",\\n \\"nodeType\\": \\"WORKER\\",\\n \\"diskUsedPercent\\": \\"1.0%\\",\\n \\"port\\": 9200,\\n \\"loadOneM\\": \\"0.12\\",\\n \\"health\\": \\"GREEN\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Elasticsearch instance node information', + 'requestParamsDescription' => ' ', + 'extraInfo' => '## FAQ'."\n" + .'Q: When I call the ListAllNode API, the returned results are incomplete. In some cases, metric information such as diskUsedPercent, cpuPercent, and heapPercent is not returned. How do I handle this?'."\n" + .'A: Unlike the Elasticsearch Client API, OpenAPI cannot guarantee real-time retrieval of all metric statuses of a cluster. For example, when the cluster is under high load or is unstable, some metric information may not be returned. In this case, use the Elasticsearch Client API to retrieve the metric information of the Elasticsearch cluster. For more information, see [Access an Alibaba Cloud Elasticsearch cluster by using a client](~~69194~~).', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-16T12:37:25.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAllNode'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"connectable\\": true,\\n \\"metaInfo\\": {\\n \\"mapping\\": \\"{\\\\\\\\\\\\\\"_doc\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"last\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",...}}}}}}\\",\\n \\"settings\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"index\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"replication\\\\\\\\\\\\\\": {\\\\\\\\n}.....}}\\",\\n \\"typeName\\": [\\n \\"[\\\\\\"index1-type\\\\\\"]\\"\\n ],\\n \\"fields\\": [\\n \\"[\\\\\\"id\\\\\\",\\\\\\"name\\\\\\"]\\"\\n ],\\n \\"indices\\": [\\n \\"[\\\\\\"index1\\\\\\",\\\\\\"index2\\\\\\",\\\\\\"index3\\\\\\"]\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetClusterDataInformation', - 'requestParamsDescription' => 'The request parameters is empty, but the RequestBody parameter is required.'."\n" - ."\n" - .'You must specify the cluster information by setting the following parameters in RequestBody:'."\n" - ."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .'| --------- | ---- | -------- | ------- | ----------- |'."\n" - .'| dataSourceType | String | Yes | elasticsearch | The type of the cluster. Default value: elasticsearch. |'."\n" - .'| endpoint | String | No | http://10.01.xx.xx | The public domain name of the cluster. This parameter must be specified when the network environment of the source cluster is a public network. |'."\n" - .'| instanceId | String | No | es-cn-09k1rnu3g0002**** | The ID of the Elasticsearch instance. This parameter is required when the network environment of the source cluster is an Alibaba Cloud Elasticsearch cluster. |'."\n" - .'| vpcInstancePort | Integer | No | 9200 | The access port number of the cluster. The source cluster network environment is required when the Alibaba Cloud Elasticsearch cluster or Alibaba Cloud ECS Service User-created cluster is used. |'."\n" - .'| vpcId | String | No | vpc-2ze59tt67m3nzkko9**** | The ID of the VPC to which the cluster belongs. The source cluster network environment is required when the Alibaba Cloud Elasticsearch cluster or Alibaba Cloud ECS Service User-created cluster is used. |'."\n" - .'| vpcInstanceId | String | No | es-09k1rnu3g0002****-worker | The instance ID or Server Load Balancer (SLB) ID of the current cluster. This parameter is required when the network environment of the source cluster is an Alibaba Cloud Elasticsearch cluster. |'."\n" - .'| username | String | No | elastic | The username that is used to connect to the cluster. |'."\n" - .'| password | String | No | xxxxxx | The password that is used to connect to the cluster. |'."\n" - .'| index | String | No | product | The name of the destination index. |'."\n" - .'| type | String | No | default | The type of the destination index. |'."\n" - .'> - If the index is empty, you can check whether the Elasticsearch cluster can be connected. If the connectivity is available, the indices field in the returned results is not null.'."\n" - .'- If the index is not empty, you can get the information about the settings and mappings under the current index.'."\n" - .'- If the type is not empty, you can obtain the routing field of the current type.'."\n" - ."\n" - .'The parameters vary depending on the network environment of the source cluster.'."\n" - ."\n" - .'- Public network cluster: enter one or more parameters, including endpoint. Example:```'."\n" - .'{'."\n" - .' "dataSourceType": "elasticsearch",'."\n" - .' "endpoint": "http://es-cn-npk1shyiq000d****.public.elasticsearch.aliyuncs.com:9200",'."\n" - .' "username": "elastic",'."\n" - .' "password": "xxxxxx",'."\n" - .' "index": "default",'."\n" - .' "type": "default"'."\n" - .' }'."\n" - .'```'."\n" - .'- Alibaba Cloud ECS Service self-built cluster: Enter the following parameters: vpcInstancePort, vpcId, and vpcIp. For example:```'."\n" - .'{'."\n" - .' "dataSourceType": "elasticsearch",'."\n" - .' "vpcId":"vpc-2ze55voww95g82gak****",'."\n" - .' "vpcInstancePort": "9200",'."\n" - .' "vpcIp": "10.12.xx.xx",'."\n" - .' "username" : "elastic",'."\n" - .' "password" : "xxxxxx",'."\n" - .' "index": "product",'."\n" - .' "type" : "default"'."\n" - .' }'."\n" - .'```'."\n" - .'- Alibaba Cloud Elasticsearch cluster: specify the parameters: vpcInstancePort, vpcId, vpcInstanceId, and instanceId. The sample code is as follows:```'."\n" - .'{'."\n" - .' "dataSourceType" : "elasticsearch",'."\n" - .' "vpcId":"vpc-2ze55voww95g82gak****",'."\n" - .' "vpcInstancePort" : "9200",'."\n" - .' "vpcInstanceId" : "es-cn-09k1rnu3g0002****-worker",'."\n" - .' "instanceId" : "es-cn-oew1oxiro000f****",'."\n" - .' "username" : "elastic",'."\n" - .' "password" : "xxxxxx",'."\n" - .' "index": "product",'."\n" - .' "type" : "default"'."\n" - .' }'."\n" - .'```', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ValidateTransferableNodes' => [ - 'summary' => 'Checks whether the data on specific nodes in a specified Elasticsearch cluster can be migrated.', - 'path' => '/openapi/instances/{InstanceId}/validate-transfer-nodes', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAlternativeSnapshotRepos' => [ + 'summary' => 'Retrieves the OSS reference repositories that can be added to the current instance.', + 'path' => '/openapi/instances/{InstanceId}/alternative-snapshot-repos', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-0pp1jxvcl000z****', 'title' => ''], ], [ - 'name' => 'nodeType', + 'name' => 'alreadySetItems', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WORKER', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'host' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '172.16.xx.xx', - ], - 'port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9200', - ], - 'zoneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai-c', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to return the OSS reference repositories that have already been added. Valid values:'."\n" + ."\n" + .'- true (default): Returns the already added repositories.'."\n" + .'- false: Does not return the already added repositories.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'repoPath' => ['description' => 'The repository address.', 'type' => 'string', 'example' => 'RepoPath', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-cn-6ja1ro4jt000c****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"repoPath\\": \\"RepoPath\\",\\n \\"instanceId\\": \\"es-cn-6ja1ro4jt000c****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'OSS reference repositories available for an instance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlternativeSnapshotRepos'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListAlternativeSnapshotRepos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'ListAvailableEsInstanceIds' => [ + 'path' => '/openapi/logstashes/{InstanceId}/available-elasticsearch-for-centralized-management', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'endpoint' => ['description' => 'The public network access address of the Elasticsearch instance.', 'type' => 'string', 'example' => 'http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200', 'title' => ''], + 'description' => ['description' => 'The name of the Elasticsearch instance.', 'type' => 'string', 'example' => 'instanceName', 'title' => ''], + 'kibanaEndpoint' => ['description' => 'The public network access address of Kibana.', 'type' => 'string', 'example' => 'https://es-cn-n6w1o1x0w001c****.kibana.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'esInstanceId' => ['description' => 'The Elasticsearch instance ID.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ValidateTransferableNodes', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"endpoint\\": \\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\\",\\n \\"description\\": \\"instanceName\\",\\n \\"kibanaEndpoint\\": \\"https://es-cn-n6w1o1x0w001c****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"esInstanceId\\": \\"es-cn-n6w1o1x0w001c****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve available instances', + 'summary' => 'Retrieves a list of available Elasticsearch instances when configuring X-Pack monitoring for a Logstash instance.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'TransferNode' => [ - 'summary' => 'Runs a data migration task for node scaling operations.', - 'path' => '/openapi/instances/{InstanceId}/actions/transfer', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvailableEsInstanceIds'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListAvailableEsInstanceIds', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], + ], + 'ListCollectors' => [ + 'summary' => 'Retrieves a list of collectors.', + 'path' => '/openapi/collectors', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'name' => 'resId', + 'in' => 'query', + 'schema' => ['description' => 'The collector ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ct-cn-77uqof2s7rg5c****', 'title' => ''], ], [ - 'name' => 'nodeType', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WORKER', - ], + 'schema' => ['description' => 'The collector name.', 'type' => 'string', 'required' => false, 'example' => 'collectorName1', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The instance ID associated with the collector.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-nif1q8auz0003****', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'host' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.xx', - ], - 'port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9200', - ], - 'zoneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai-c', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the returned results. Default value: 1. Minimum value: 1. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of results per page. Default value: 20. Minimum value: 1. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'sourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of machine on which the collector is deployed. If this parameter is not specified, all types are returned. Valid values:'."\n" + ."\n" + .'- ECS: ECS instance'."\n" + ."\n" + .'- ACK: Container Kubernetes cluster.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of returned records.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'configs' => [ + 'description' => 'The configuration file information of the collector.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'fields.yml', 'title' => ''], + 'content' => ['description' => 'The file content.', 'type' => 'string', 'example' => '- key: log\\n title: Log file content\\n description: >\\n Contains log file lines.\\n ....', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'dryRun' => ['description' => 'Indicates whether the collector is validated only without being created. Valid values:'."\n" + ."\n" + .'- true: Only validates without creating.'."\n" + .'- false: Validates and creates.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'resType' => ['description' => 'The collector type. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.', 'type' => 'string', 'example' => 'fileBeat', 'title' => ''], + 'ownerId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '168520994880****', 'title' => ''], + 'resId' => ['description' => 'The collector instance ID.', 'type' => 'string', 'example' => 'ct-cn-0v3xj86085dvq****', 'title' => ''], + 'collectorPaths' => [ + 'type' => 'array', + 'items' => ['description' => 'The collection path of Filebeat.', 'type' => 'string', 'example' => '["/var/log"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'gmtUpdateTime' => ['description' => 'The time when the collector was last updated.', 'type' => 'string', 'example' => '2020-08-18T09:40:43.000+0000', 'title' => ''], + 'extendConfigs' => [ + 'description' => 'The extended configuration information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'enableMonitoring' => ['description' => 'Indicates whether Monitoring is enabled. This parameter is displayed when **configType** is **collectorTargetInstance** and **instanceType** is **elasticsearch**. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + ."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'hosts' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of access addresses for the instance specified in the collector Output. This parameter is displayed when **configType** is **collectorTargetInstance**.', 'type' => 'string', 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'instanceType' => ['description' => 'The type of instance specified in the collector Output. Valid values: elasticsearch, logstash. This parameter is displayed when **configType** is **collectorTargetInstance**.', 'type' => 'string', 'example' => 'elasticsearch', 'title' => ''], + 'groupId' => ['description' => 'The machine group ID. This parameter is displayed when **configType** is **collectorDeployMachine**.', 'type' => 'string', 'example' => 'default_ct-cn-5i2l75bz4776****', 'title' => ''], + 'userName' => ['description' => 'The username used to access the instance specified in the collector Output. Default value: elastic. This parameter is displayed when **configType** is **collectorTargetInstance** or **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'elastic', 'title' => ''], + 'type' => ['description' => 'The type of machine on which the collector is deployed. This parameter is displayed when **configType** is **collectorDeployMachine**. Valid values:'."\n" + ."\n" + .'- ECSInstanceId: ECS'."\n" + ."\n" + .'- ACKCluster: Container Kubernetes.', 'type' => 'string', 'example' => 'ECSInstanceId', 'title' => ''], + 'configType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- collectorTargetInstance: the collector Output'."\n" + .'- collectorDeployMachine: the deployment machine of the collector'."\n" + .'- collectorElasticsearchForKibana: the Elasticsearch instance that supports Kibana dashboards.', 'type' => 'string', 'example' => 'collectorDeployMachine', 'title' => ''], + 'protocol' => ['description' => 'The transmission protocol, which must be consistent with the access protocol of the instance specified in the collector Output. Valid values: HTTP, HTTPS. This parameter is displayed when **configType** is **collectorTargetInstance**.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'instanceId' => ['description' => 'The ID of the instance associated with the collector. When **configType** is **collectorTargetInstance**, this is the instance ID of the collector Output. When **configType** is **collectorDeployMachines** and **type** is **ACKCluster**, this is the ACK (Container Kubernetes) cluster ID.', 'type' => 'string', 'example' => 'es-cn-nif1z89fz003i****', 'title' => ''], + 'host' => ['description' => 'The internal-facing access address of Kibana over the private network after Kibana Dashboard is enabled. This parameter is displayed when **configType** is **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'kibanaHost' => ['description' => 'The public network access address of Kibana after Kibana Dashboard is enabled. This parameter is displayed when **configType** is **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'totalPodsCount' => ['description' => 'The total number of Pod nodes collected in the ACK cluster. This parameter is displayed when **configType** is **collectorDeployMachines** and **type** is **ACKCluster**.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'successPodsCount' => ['description' => 'The number of Pod nodes successfully collected in the ACK cluster. This parameter is displayed when **configType** is **collectorDeployMachines** and **type** is **ACKCluster**.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'machines' => [ + 'description' => 'The list of ECS machines on which the collector is deployed. This parameter is displayed when **configType** is **collectorDeployMachines** and **type** is **ECSInstanceId**.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The list of ECS machine IDs.', 'type' => 'string', 'example' => 'i-bp13y63575oypr9d****', 'title' => ''], + 'agentStatus' => ['description' => 'The status of each collector on the ECS instance. Valid values:'."\n" + ."\n" + .'- heartOk: The heartbeat is normal.'."\n" + .'- heartLost: The heartbeat is abnormal.'."\n" + .'- uninstalled: Not installed.'."\n" + .'- failed: Installation failed.', 'type' => 'string', 'example' => 'heartOk', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'resVersion' => ['description' => 'The collector version.', 'type' => 'string', 'example' => '6.8.5_with_community', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the VPC where the collector resides.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtma*****', 'title' => ''], + 'name' => ['description' => 'The collector name.', 'type' => 'string', 'example' => 'FileBeat001', 'title' => ''], + 'gmtCreatedTime' => ['description' => 'The time when the collector was created.', 'type' => 'string', 'example' => '2020-08-18T02:06:12.000+0000', 'title' => ''], + 'status' => ['description' => 'The collector status. Valid values:'."\n" + ."\n" + .'- activing: Taking effect.'."\n" + ."\n" + .'- active: Active.', 'type' => 'string', 'example' => 'active', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'TransferNode', - 'requestParamsDescription' => "\n", - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 5\\n },\\n \\"Result\\": [\\n {\\n \\"configs\\": [\\n {\\n \\"fileName\\": \\"fields.yml\\",\\n \\"content\\": \\"- key: log\\\\\\\\n title: Log file content\\\\\\\\n description: >\\\\\\\\n Contains log file lines.\\\\\\\\n ....\\"\\n }\\n ],\\n \\"dryRun\\": false,\\n \\"resType\\": \\"fileBeat\\",\\n \\"ownerId\\": \\"168520994880****\\",\\n \\"resId\\": \\"ct-cn-0v3xj86085dvq****\\",\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ],\\n \\"gmtUpdateTime\\": \\"2020-08-18T09:40:43.000+0000\\",\\n \\"extendConfigs\\": [\\n {\\n \\"enableMonitoring\\": true,\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ],\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"userName\\": \\"elastic\\",\\n \\"type\\": \\"ECSInstanceId\\",\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"instanceId\\": \\"es-cn-nif1z89fz003i****\\",\\n \\"host\\": \\"es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601\\",\\n \\"kibanaHost\\": \\"https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"totalPodsCount\\": \\"10\\",\\n \\"successPodsCount\\": \\"8\\",\\n \\"machines\\": [\\n {\\n \\"instanceId\\": \\"i-bp13y63575oypr9d****\\",\\n \\"agentStatus\\": \\"heartOk\\"\\n }\\n ]\\n }\\n ],\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"name\\": \\"FileBeat001\\",\\n \\"gmtCreatedTime\\": \\"2020-08-18T02:06:12.000+0000\\",\\n \\"status\\": \\"active\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List collector information', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' **extendConfigs** includes three configType values: collectorTargetInstance, collectorElasticsearchForKibana, and collectorDeployMachine. The returned parameters vary depending on the deployment machine type. The specific combinations are as follows:'."\n" + .'- collectorTargetInstance'."\n" + .' - ECS'."\n" + .' configType, instanceId, instanceType, hosts, userName, password, protocol, enableMonitoring'."\n" + .' - ACK'."\n" + .' configType, instanceId, instanceType, userName, password, protocol, enableMonitoring.'."\n" + ."\n" + .'- collectorElasticsearchForKibana'."\n" + .' - ECS'."\n" + .' configType, instanceId, host, kibanaHost, userName, password, protocol'."\n" + .' - ACK'."\n" + .' configType'."\n" + .' '."\n" + .'- collectorDeployMachine'."\n" + .' - ECS'."\n" + .' configType, type, machines, groupId'."\n" + .' - ACK'."\n" + .' configType, type, instanceId, totalPodsCount, successPodsCount.', 'extraInfo' => ' ', - ], - 'CancelTask' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/cancel-task', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCollectors'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListCollectors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListComponentIndices' => [ + 'summary' => 'Retrieves the list of composable templates for an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/component-index', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-tl329rbpc0001****', 'title' => ''], ], [ - 'name' => 'taskType', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data migration task. Set the value to MigrateData.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MigrateData', - ], + 'schema' => ['description' => 'The name of the composable template.', 'type' => 'string', 'required' => false, 'example' => 'template', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The page number for paging. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'example' => '5', 'default' => '1', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page for paging. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'example' => '10', 'default' => '10', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: the task was cancelled successfully'."\n" - .'* false: the task was cancelled successfully failed'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', + 'Result' => [ + 'description' => 'The details of the returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned object information.', + 'type' => 'object', + 'properties' => [ + 'composed' => [ + 'description' => 'The information about the index templates that reference this composable template.', + 'type' => 'array', + 'items' => ['description' => 'The array of index template names that reference this composable template.', 'type' => 'string', 'example' => '["template1", "template2"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The name of the composable template.', 'type' => 'string', 'example' => 'synthetics-settings', 'title' => ''], + 'content' => [ + 'description' => 'The content of the composable template.', + 'type' => 'object', + 'properties' => [ + 'template' => [ + 'description' => 'The composable template object.', + 'type' => 'object', + 'properties' => [ + 'settings' => [ + 'description' => 'The settings configuration of the template.', + 'type' => 'object', + 'properties' => [ + 'index' => [ + 'description' => 'The index information.', + 'type' => 'object', + 'properties' => [ + 'lifecycle' => [ + 'description' => 'The index lifecycle configuration.', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the lifecycle policy.', 'type' => 'string', 'example' => 'synthetics', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'codec' => ['description' => 'The index compression method. Valid values:'."\n" + ."\n" + .'- LZ4: the default compression algorithm of Elasticsearch. It provides fast compression and decompression but a relatively lower compression ratio.'."\n" + .'- best_compression: uses the best_compression algorithm for compression, which provides a higher compression ratio.', 'type' => 'string', 'example' => 'best_compression', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + '_meta' => ['description' => 'The metadata, which is used to store information such as remarks.', 'type' => 'object', 'example' => '{ "description": "set number of shards to one" }', 'title' => ''], + 'version' => ['description' => 'The version of the composable template.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"Result\\": [\\n {\\n \\"composed\\": [\\n \\"[\\\\\\"template1\\\\\\", \\\\\\"template2\\\\\\"]\\"\\n ],\\n \\"name\\": \\"synthetics-settings\\",\\n \\"content\\": {\\n \\"template\\": {\\n \\"settings\\": {\\n \\"index\\": {\\n \\"lifecycle\\": {\\n \\"name\\": \\"synthetics\\"\\n },\\n \\"codec\\": \\"best_compression\\"\\n }\\n }\\n },\\n \\"_meta\\": {\\n \\"description\\": \\"set number of shards to one\\"\\n },\\n \\"version\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List composable index templates', + 'description' => 'For more information, see [Store massive amounts of data through OpenStore](~~317694~~).', + 'changeSet' => [ + ['createdAt' => '2022-09-15T08:09:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-15T08:09:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-10T09:28:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-16T12:46:26.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListComponentIndices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListComponentIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CancelTask', - 'summary' => 'Call CancelTask to cancel a data migration task.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'CreateCollector' => [ - 'summary' => '创建收集器', - 'path' => '/openapi/collectors', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListConnectedClusters' => [ + 'summary' => 'Retrieves a list of instances that have established private network peering with the current instance.', + 'path' => '/openapi/instances/{InstanceId}/connected-clusters', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the created crawer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The current instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-0pp1jxvcl000z****', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'dryRun' => [ - 'title' => '创建是否校验。true:只校验不创建，false：校验并创建', - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - 'default' => 'false', - ], - 'name' => [ - 'title' => '采集器实例名称，自定义', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ct-test', - ], - 'resType' => [ - 'title' => '采集器类型。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'fileBeat', - 'enum' => [ - 'fileBeat', - 'metricBeat', - 'heartBeat', - 'auditBeat', - ], - ], - 'vpcId' => [ - 'title' => '采集器所属专有网络ID。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp12nu14urf0upaf*****', - ], - 'resVersion' => [ - 'title' => '采集器版本', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '6.8.5_with_community', - 'enum' => [ - '6.8.13_with_community', - '6.8.5_with_community', - ], - ], - 'collectorPaths' => [ - 'title' => 'filebeat的采集路径，只有ECS机器上的使用', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'filebeat的采集路径元素', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '["/var/log"]', - ], - 'required' => false, - ], - 'configs' => [ - 'title' => '配置文件信息', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '配置文件信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'fileName' => [ - 'title' => '文件路径名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'filebeat.yml', - ], - 'content' => [ - 'title' => '文件内容。详见：https://help.aliyun.com/document_detail/146447.html', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], + 'Result' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'networkType' => ['description' => 'The network type of the instance.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'instances' => ['description' => 'The instance IDs of remote instances that have established private network peering with the current instance.', 'type' => 'string', 'example' => 'es-cn-09k1rocex0006****', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '"filebeat.inputs:xxx"', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => true, ], - 'required' => true, - ], - 'extendConfigs' => [ - 'title' => '采集器Output实例配置', 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '采集器Output设置，详见数据结构：CollectorDeployMachine、CollectorKibanaInstance、CollectorTargetInstance', - 'description' => '', - 'type' => 'object', - 'required' => true, - 'example' => '{ "instanceId": "es-cn-nif201ihd0012****", "instanceType": "elasticsearch", "configType": "collectorTargetInstance", "hosts": [ "es-cn-nif201ihd0012****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "*****", "protocol": "HTTP" }, { "type": "ECSInstanceId", "configType": "collectorDeployMachine", "machines": [ { "instanceId": "i-bp11u91xgubypcuz****" } ] } ]', - ], - 'required' => true, + 'title' => '', + 'example' => '', ], ], - 'required' => false, - 'docRequired' => false, - 'example' => '{ "dryRun": false, "name": "test_beats_1", "resType": "fileBeat", "resVersion": "6.8.5_with_community", "vpcId": "vpc-bp12nu14urf0upaf*****", "collectorPaths": [ "/var/log" ], "configs": [ { "fileName": "filebeat.yml", "content": "filebeat.inputs:xxx" } ] }', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"Result\\": [\\n {\\n \\"networkType\\": \\"vpc\\",\\n \\"instances\\": \\"es-cn-09k1rocex0006****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Retrieve instances with private network peering to the current instance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnectedClusters'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListConnectedClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'ListDataStreams' => [ + 'summary' => 'Retrieves the list of index data streams in an Elasticsearch cluster.', + 'path' => '/openapi/instances/{InstanceId}/data-streams', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082****', 'title' => ''], + ], + [ + 'name' => 'isManaged', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display only managed indexes. Valid values:'."\n" + ."\n" + .'- true: displays only managed indexes.'."\n" + ."\n" + .'- false (default): displays all indexes.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'The data stream name.', 'type' => 'string', 'required' => false, 'example' => 'Log1', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8466BDFB-C513-4B8D-B4E3-5AB256AB****', - ], - 'Result' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', 'type' => 'object', 'properties' => [ - 'resId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ct-cn-4135is2tj194p****', + 'X-Managed-StorageSize' => ['description' => 'The total storage size of indexes. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '143993923932990', 'title' => ''], + 'X-Managed-Count' => ['description' => 'The total number of data streams.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Result' => [ + 'description' => 'The details of the returned data streams.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'indexTemplateName' => ['description' => 'The index template name.', 'type' => 'string', 'example' => 'template1', 'title' => ''], + 'indices' => [ + 'description' => 'The index information under the current data stream.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'managedStatus' => ['description' => 'The managed status of the index. Valid values:'."\n" + .'- following: managed.'."\n" + ."\n" + .'- closing: being unmanaged.'."\n" + ."\n" + .'- closed: not managed.', 'type' => 'string', 'example' => 'following', 'title' => ''], + 'size' => ['description' => 'The total storage space occupied by the current index. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '15393899', 'title' => ''], + 'createTime' => ['description' => 'The time when the data stream list was queried.', 'type' => 'string', 'example' => '2018-07-13T03:58:07.253Z', 'title' => ''], + 'name' => ['description' => 'The data stream name.', 'type' => 'string', 'example' => 'Log1', 'title' => ''], + 'health' => ['description' => 'The index status. Valid values:'."\n" + ."\n" + .'- Green: healthy.'."\n" + ."\n" + .'- Yellow: warning.'."\n" + ."\n" + .'- Red: abnormal.', 'type' => 'string', 'example' => 'Green', 'title' => ''], + 'isManaged' => ['description' => 'This field is deprecated and can be ignored.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'The index name.', 'type' => 'string', 'example' => 'my-index-0001', 'title' => ''], + 'health' => ['description' => 'The data stream status. Valid values:'."\n" + ."\n" + .'- Green: healthy.'."\n" + ."\n" + .'- Yellow: warning.'."\n" + ."\n" + .'- Red: abnormal.', 'type' => 'string', 'example' => 'Green', 'title' => ''], + 'ilmPolicyName' => ['description' => 'The index lifecycle policy name.', 'type' => 'string', 'example' => 'rollver1', 'title' => ''], + 'totalStorageSize' => ['description' => 'The total storage space occupied by all indexes under the current data stream. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1788239393298', 'title' => ''], + 'managedStorageSize' => ['description' => 'The total storage space occupied by managed indexes under the current data stream. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1788239393298', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8466BDFB-C513-4B8D-B4E3-5AB256AB****\\",\\n \\"Result\\": {\\n \\"resId\\": \\"ct-cn-4135is2tj194p****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateCollector', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Headers\\": {\\n \\"X-Managed-StorageSize\\": 143993923932990,\\n \\"X-Managed-Count\\": 100\\n },\\n \\"Result\\": [\\n {\\n \\"indexTemplateName\\": \\"template1\\",\\n \\"indices\\": [\\n {\\n \\"managedStatus\\": \\"following\\",\\n \\"size\\": 15393899,\\n \\"createTime\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"name\\": \\"Log1\\",\\n \\"health\\": \\"Green\\",\\n \\"isManaged\\": false\\n }\\n ],\\n \\"name\\": \\"my-index-0001\\",\\n \\"health\\": \\"Green\\",\\n \\"ilmPolicyName\\": \\"rollver1\\",\\n \\"totalStorageSize\\": 1788239393298,\\n \\"managedStorageSize\\": 1788239393298\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List data streams of an elasticsearch cluster', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteCollector' => [ - 'summary' => 'Deletes a shipper.', - 'path' => '/openapi/collectors/{ResId}', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataStreams'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDataStreams', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], + ], + ], + 'ListDataTasks' => [ + 'path' => '/openapi/instances/{InstanceId}/data-task', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ResId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-92z1h38882dal****', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-oew1oxiro000f****', 'title' => ''], ], ], 'responses' => [ @@ -13770,70 +11624,129 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => 'Indicates whether the shipper is deleted. Valid values:'."\n" - ."\n" - .'* true: The shipper is deleted.'."\n" - .'* false: The shipper fails to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'createTime' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2020-07-30 06:32:18', 'title' => ''], + 'taskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'et_cn_mfv1233r47272****', 'title' => ''], + 'status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'sinkCluster' => [ + 'description' => 'The destination cluster information.', + 'type' => 'object', + 'properties' => [ + 'index' => ['description' => 'The destination index.', 'type' => 'string', 'example' => 'product_info', 'title' => ''], + 'type' => ['description' => 'The index type.', 'type' => 'string', 'example' => '_doc', 'title' => ''], + 'endpoint' => ['description' => 'The public network access address of the destination cluster.', 'type' => 'string', 'example' => 'http://192.168.xx.xx:4101', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the virtual private cloud (VPC) where the cluster resides.', 'type' => 'string', 'example' => 'vpc-2ze55voww95g82gak****', 'title' => ''], + 'vpcInstancePort' => ['description' => 'The port number used to access the cluster.', 'type' => 'string', 'example' => '9200', 'title' => ''], + 'vpcInstanceId' => ['description' => 'The instance ID of the current cluster or the load balancing SLB (Server Load Balancer) instance ID.', 'type' => 'string', 'example' => 'es-cn-09k1rnu3g0002****-worker', 'title' => ''], + 'dataSourceType' => ['description' => 'The destination cluster type. Default value: elasticsearch.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'sourceCluster' => [ + 'description' => 'The source cluster information.', + 'type' => 'object', + 'properties' => [ + 'index' => ['description' => 'The index to be migrated.', 'type' => 'string', 'example' => 'product_info', 'title' => ''], + 'settings' => ['description' => 'The Settings configuration of the cluster.', 'type' => 'string', 'example' => '{\\n \\"index\\": {\\n \\"replication\\": {\\n}.....}}', 'title' => ''], + 'mapping' => ['description' => 'The Mapping configuration of the cluster.', 'type' => 'string', 'example' => '{\\"_doc\\":{\\"properties\\":{\\"user\\":{\\"properties\\":{\\"last\\":{\\"type\\":\\"text\\",...}}}}}}', 'title' => ''], + 'type' => ['description' => 'The index type.', 'type' => 'string', 'example' => '_doc', 'title' => ''], + 'routing' => ['description' => 'The routing field of the index. The primary key field is used by default.', 'type' => 'string', 'example' => '_id', 'title' => ''], + 'dataSourceType' => ['description' => 'The source cluster type. Default value: elasticsearch.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteCollector', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"createTime\\": \\"2020-07-30 06:32:18\\",\\n \\"taskId\\": \\"et_cn_mfv1233r47272****\\",\\n \\"status\\": \\"SUCCESS\\",\\n \\"sinkCluster\\": {\\n \\"index\\": \\"product_info\\",\\n \\"type\\": \\"_doc\\",\\n \\"endpoint\\": \\"http://192.168.xx.xx:4101\\",\\n \\"vpcId\\": \\"vpc-2ze55voww95g82gak****\\",\\n \\"vpcInstancePort\\": \\"9200\\",\\n \\"vpcInstanceId\\": \\"es-cn-09k1rnu3g0002****-worker\\",\\n \\"dataSourceType\\": \\"1\\"\\n },\\n \\"sourceCluster\\": {\\n \\"index\\": \\"product_info\\",\\n \\"settings\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"index\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"replication\\\\\\\\\\\\\\": {\\\\\\\\n}.....}}\\",\\n \\"mapping\\": \\"{\\\\\\\\\\\\\\"_doc\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"last\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",...}}}}}}\\",\\n \\"type\\": \\"_doc\\",\\n \\"routing\\": \\"_id\\",\\n \\"dataSourceType\\": \\"1\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List elasticsearch data migration tasks', + 'summary' => 'Retrieves a list of data migration tasks between different Elasticsearch clusters.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyDeployMachine' => [ - 'path' => '/openapi/collectors/{ResId}/actions/modify-deploy-machines', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataTasks'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDataTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'ListDefaultCollectorConfigurations' => [ + 'path' => '/openapi/beats/default-configurations', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13841,39 +11754,33 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ResId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The shipper ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-xb1i7q79u65nk****', - ], + 'name' => 'resType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the collector. Valid values:'."\n" + ."\n" + .'- fileBeat'."\n" + .'- metricBeat'."\n" + .'- heartBeat'."\n" + .'- auditBeat.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'fileBeat', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'resVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The version of the collector. The available versions vary based on the type of machine on which the collector is deployed. Valid values:'."\n" + ."\n" + .'- ECS: 6.8.5_with_community'."\n" + .'- ACK: 6.8.13_with_community.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6.8.5_with_community', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'sourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of machine on which the collector is deployed. If you do not specify this parameter, all types are returned. Valid values:'."\n" + ."\n" + .'- ECS: Elastic Compute Service (ECS) instance'."\n" + .'- ACK: Container Service for Kubernetes (ACK) cluster.', 'type' => 'string', 'required' => false, 'example' => 'ECS', 'title' => ''], ], ], 'responses' => [ @@ -13881,503 +11788,412 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5', 'title' => ''], 'Result' => [ - 'description' => 'Indicates whether the ECS instances are changed. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C37CE536-6C0F-4778-9B59-6D94C7F7EB63', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The content of the configuration file.', 'type' => 'string', 'example' => '- key: log\\n title: Log file content\\n description: >\\n Contains log file lines.\\n fields:\\n ......', 'title' => ''], + 'fileName' => ['description' => 'The name of the configuration file.', 'type' => 'string', 'example' => 'fields.yml', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"C37CE536-6C0F-4778-9B59-6D94C7F7EB63\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ModifyDeployMachine', - 'summary' => 'Changes the Elastic Compute Service (ECS) instances on which a shipper is installed.', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify information about the ECS instances on which you want to install the shipper. | Parameter | Type | Required | Example | Description | | ---- | ---- | ---- | ---- | | machines| List | Yes | |The information about the ECS instances. | | └instanceId | String | Yes | i-bp11u91xgubypcuz\\*\\*\\*\\* |The instance ID. | | type| String | Yes | ECSInstanceId |The type of the machine on which you want to install the shipper. Set the value to ECSInstanceId. | | configType| String | Yes |collectorDeployMachine |The configuration type. Set the value to collectorDeployMachine. |'."\n", + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5\\",\\n \\"Result\\": [\\n {\\n \\"content\\": \\"- key: log\\\\\\\\n title: Log file content\\\\\\\\n description: >\\\\\\\\n Contains log file lines.\\\\\\\\n fields:\\\\\\\\n ......\\",\\n \\"fileName\\": \\"fields.yml\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List default collector configurations', + 'summary' => 'Invokes the ListDefaultCollectorConfigurations operation to retrieve the default configuration file of a collector.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateCollector' => [ - 'path' => '/openapi/collectors/{ResId}', - 'methods' => [ - 'put', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDefaultCollectorConfigurations'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDefaultCollectorConfigurations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListDeprecatedTemplates' => [ + 'summary' => 'Queries the list of historical index templates.', + 'path' => '/openapi/instances/{InstanceId}/deprecated-templates', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'produces' => ['application/json', 'application/octet-stream'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'ResId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The shipper ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-77uqof2s7rg5c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-t57p81n7ai89v****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The index template name.', 'type' => 'string', 'required' => false, 'example' => 'component-openstore-index-template', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number Settings for a paged query. Paging is used to retrieve results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page Settings for a paged query. Paging is used to retrieve results.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', 'type' => 'object', 'properties' => [ - 'resId' => [ - 'description' => 'The shipper ID.'."\n", - 'type' => 'string', - 'example' => 'ct-cn-0v3xj86085dvq****', - ], - 'gmtUpdateTime' => [ - 'description' => 'The time when the shipper was updated.'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'dryRun' => [ - 'description' => 'Indicates whether the shipper is checked and updated. Valid values:'."\n" - ."\n" - .'* true: The shipper is only checked.'."\n" - .'* false: The shipper is checked and updated.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ownerId' => [ - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'example' => '16852099488*****', - ], - 'vpcId' => [ - 'description' => 'The ID of the VPC in which the shipper resides.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtma*****', - ], - 'resType' => [ - 'description' => 'The type of the shipper. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.'."\n", - 'type' => 'string', - 'example' => 'fileBeat', - ], - 'resVersion' => [ - 'description' => 'The version of the shipper.'."\n", - 'type' => 'string', - 'example' => '6.8.5_with_community', - ], - 'gmtCreatedTime' => [ - 'description' => 'The time when the shipper was created.'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'status' => [ - 'description' => 'The status of the shipper. Valid values:'."\n" - ."\n" - .'* activing: The shipper is being initialized.'."\n" - .'* active: The shipper is in effect.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'name' => [ - 'description' => 'The name of the shipper.'."\n", - 'type' => 'string', - 'example' => 'ct-test', - ], - 'configs' => [ - 'description' => 'The information about the configuration file for the shipper.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'description' => 'The content of the configuration file.'."\n", - 'type' => 'string', - 'example' => 'filebeat.inputs:xxx', - ], - 'fileName' => [ - 'description' => 'The name of the configuration file.'."\n", - 'type' => 'string', - 'example' => 'filebeat.yml', - ], - ], + 'X-Total-Count' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The object information.', + 'type' => 'object', + 'properties' => [ + 'indexPatterns' => [ + 'description' => 'The index template information.', + 'type' => 'array', + 'items' => ['description' => 'The index pattern list.', 'type' => 'string', 'example' => '["schema1*","schema2*"]', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - 'extendConfigs' => [ - 'description' => 'The extended parameters that are configured for the shipper.'."\n", - 'type' => 'array', - 'items' => [ + 'template' => [ + 'description' => 'The index template configuration.', 'type' => 'object', 'properties' => [ - 'successPodsCount' => [ - 'description' => 'The number of pods from which logs are successfully collected in the ACK cluster. This parameter is returned only when **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**.'."\n", - 'type' => 'string', - 'example' => '8', - ], - 'protocol' => [ - 'description' => 'The transfer protocol that is used. It is the same as the protocol over which you can access the output of the shipper. Valid values: HTTP and HTTPS. This parameter is returned only when **configType** is set to **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'userName' => [ - 'description' => 'The username that is used to access the output of the shipper. Default value: elastic. This parameter is returned only when **configType** is set to **collectorTargetInstance** or **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'elastic', - ], - 'totalPodsCount' => [ - 'description' => 'The number of pods from which logs needed to be collected in the ACK cluster. This parameter is returned only when **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'type' => [ - 'description' => 'The type of the machine on which the shipper is installed. This parameter is returned only when **configType** is set to **collectorDeployMachine**. Valid values:'."\n" - ."\n" - .'* ECSInstanceId'."\n" - .'* ACKCluster'."\n", - 'type' => 'string', - 'example' => 'ECSInstanceId', - ], - 'kibanaHost' => [ - 'description' => 'The address that is used to access Kibana over the Internet after you enable Kibana Dashboard. This parameter is returned only when **configType** is set to **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601', - ], - 'enableMonitoring' => [ - 'description' => 'Indicates whether Kibana Monitoring is enabled. This parameter is returned only when **configType** is set to **collectorTargetInstance** and **instanceType** is set to **elasticsearch**. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'configType' => [ - 'description' => 'The type of the configuration items. Valid values:'."\n" - ."\n" - .'* collectorTargetInstance: indicates the information about the output of the shipper.'."\n" - .'* collectorDeployMachine: indicates the information about the machine on which the shipper is installed.'."\n" - .'* collectorElasticsearchForKibana: indicates the information about the Elasticsearch cluster for which Kibana Dashboard is enabled.'."\n", - 'type' => 'string', - 'example' => 'collectorDeployMachine', - ], - 'instanceType' => [ - 'description' => 'The type of the output of the shipper. Valid values: elasticsearch and logstash. This parameter is returned only when **configType** is set to **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch', - ], - 'groupId' => [ - 'description' => 'The machine group ID. This parameter is returned only when **configType** is set to **collectorDeployMachine**.'."\n", - 'type' => 'string', - 'example' => 'default_ct-cn-5i2l75bz4776****', - ], - 'host' => [ - 'description' => 'The address that is used to access Kibana over an internal network after you enable Kibana Dashboard. This parameter is returned only when **configType** is set to **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601', - ], - 'instanceId' => [ - 'description' => 'The ID of the object that is associated with the shipper. If **configType** is set to **collectorTargetInstance**, the value of this parameter is the ID of the output of the shipper. If **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**, the value of this parameter is the ID of an ACK cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-nif1z89fz003i****', - ], - 'machines' => [ - 'description' => 'This parameter is returned only when configType is set to collectorDeployMachine.'."\n" - ."\n" - .'This parameter indicates the information about the ECS instances or ACK clusters on which the shipper is installed.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'agentStatus' => [ - 'description' => 'The installation status of the shipper on an ECS instance. Valid values:'."\n" - ."\n" - .'* heartOk'."\n" - .'* heartLost'."\n" - .'* uninstalled'."\n" - .'* failed'."\n", - 'type' => 'string', - 'example' => 'heartOk', - ], - 'instanceId' => [ - 'description' => 'The ID of the ECS instance on which the shipper is installed.'."\n", - 'type' => 'string', - 'example' => 'i-bp13y63575oypr9d****', - ], - ], - ], - ], - 'hosts' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', - ], - ], + 'settings' => ['description' => 'The settings configuration of the template.', 'type' => 'string', 'example' => '"{\\"index.number_of_shards\\":\\"1\\"}"', 'title' => ''], + 'mappings' => ['description' => 'The mappings configuration of the template.', 'type' => 'string', 'example' => '"{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}"', 'title' => ''], + 'aliases' => ['description' => 'The alias configuration of the template.', 'type' => 'string', 'example' => '"{}"', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'collectorPaths' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["/var/log"]', - ], - ], + 'dataStream' => ['description' => 'Indicates whether the template matches a data stream. Valid values:'."\n" + ."\n" + .'- true: matched'."\n" + .'- false: not matched.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'indexTemplate' => ['description' => 'The index template name.', 'type' => 'string', 'example' => 'openstore-index-template', 'title' => ''], + 'version' => ['description' => 'The version of the index template.', 'type' => 'string', 'example' => '70000', 'title' => ''], + 'order' => ['description' => 'The priority.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 5\\n },\\n \\"Result\\": [\\n {\\n \\"indexPatterns\\": [\\n \\"[\\\\\\"schema1*\\\\\\",\\\\\\"schema2*\\\\\\"]\\"\\n ],\\n \\"template\\": {\\n \\"settings\\": \\"\\\\\\"{\\\\\\\\\\\\\\"index.number_of_shards\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"mappings\\": \\"\\\\\\"{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"created_at\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EEE MMM dd HH:mm:ss Z yyyy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"host_name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keyword\\\\\\\\\\\\\\"}}}\\\\\\"\\",\\n \\"aliases\\": \\"\\\\\\"{}\\\\\\"\\"\\n },\\n \\"dataStream\\": false,\\n \\"indexTemplate\\": \\"openstore-index-template\\",\\n \\"version\\": \\"70000\\",\\n \\"order\\": 100\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List historical index templates', + 'description' => 'For more information, see [Use OpenStore to store large volumes of data](~~317694~~).', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-16T12:46:26.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeprecatedTemplates'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDeprecatedTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], + ], + ], + 'ListDiagnoseIndices' => [ + 'path' => '/openapi/diagnosis/instances/{InstanceId}/indices', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + [ + 'name' => 'lang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Default value: the browser language. Valid values:'."\n" + ."\n" + .'- en: English'."\n" + .'- zh: Simplified Chinese'."\n" + .'- zt: Traditional Chinese'."\n" + .'- es: Spanish'."\n" + .'- fr: French.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F05ED12E-140A-4ACB-B059-3A508A69F2E1', 'title' => ''], + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => ['description' => 'The list of diagnostic indexes.', 'type' => 'string', 'example' => '["my_index_aliws", "aliyun-index-test","filebeat-6.7.0-2020.11.15", "filebeat-6.7.0-2020.12.27"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"resId\\": \\"ct-cn-0v3xj86085dvq****\\",\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"dryRun\\": false,\\n \\"ownerId\\": \\"16852099488*****\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"resType\\": \\"fileBeat\\",\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"status\\": \\"active\\",\\n \\"name\\": \\"ct-test\\",\\n \\"configs\\": [\\n {\\n \\"content\\": \\"filebeat.inputs:xxx\\",\\n \\"fileName\\": \\"filebeat.yml\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n {\\n \\"successPodsCount\\": \\"8\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"userName\\": \\"elastic\\",\\n \\"totalPodsCount\\": \\"10\\",\\n \\"type\\": \\"ECSInstanceId\\",\\n \\"kibanaHost\\": \\"https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"enableMonitoring\\": true,\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"host\\": \\"es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601\\",\\n \\"instanceId\\": \\"es-cn-nif1z89fz003i****\\",\\n \\"machines\\": [\\n {\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"instanceId\\": \\"i-bp13y63575oypr9d****\\"\\n }\\n ],\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateCollector', - 'summary' => 'Updates the configurations of a shipper.', - 'requestParamsDescription' => '## Parameters required in the request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify information about the shipper whose configurations you want to update.'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|dryRun|boolean|Yes|false|Specifies whether to check and update the shipper. Valid values: true and false. The value true indicates that the shipper will be only checked. The value false indicates that the shipper will be checked and updated.|'."\n" - .'|name|String|Yes|ct-test|The name of the shipper.|'."\n" - .'|status|String|Yes|activing|The status of the shipper. Valid values: activing and active. The value activing indicates that the shipper is being initialized. The value active indicates that the shipper is in effect.|'."\n" - .'|resType|String|Yes|fileBeat|The type of the shipper. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.|'."\n" - .'|vpcId|String|Yes|vpc-bp16k1dvzxtma\\*\\*\\*\\*\\*|The ID of the virtual private cloud (VPC) in which the shipper resides.|'."\n" - .'|resVersion|String|Yes|6.8.5\\_with\\_community|The version of the shipper.|'."\n" - .'|ownerId|String|Yes|16852099488\\*\\*\\*\\*\\*|The account ID.|'."\n" - .'|gmtCreatedTime|Date|Yes|2020-06-20T07:26:47.000+0000|The time when the shipper was created.|'."\n" - .'|gmtUpdateTime|Date|Yes|2020-06-20T07:26:47.000+0000|The time when the shipper was updated.|'."\n" - .'|collectorPaths|List|No|\\["/var/log"\\]|The collection path of the shipper.|'."\n" - .'|configs|List|Yes||The information about the configuration file for the shipper.|'."\n" - .'|└fileName|String|Yes|filebeat.yml|The name of the configuration file.|'."\n" - .'|└content|String|Yes|"filebeat.inputs:xxx"|The content of the configuration file.|'."\n" - .'|extendConfigs|Array|Yes||The extended configurations of the shipper.|'."\n" - .'|└configType|String|Yes|collectorElasticsearchForKibana|The type of the configuration items. Valid values: collectorTargetInstance, collectorDeployMachine, and collectorElasticsearchForKibana. The value collectorTargetInstance indicates the information about the output of the shipper. The value collectorDeployMachine indicates the information about the machine on which the shipper is installed. The value collectorElasticsearchForKibana indicates the information about the Elasticsearch cluster for which Kibana Dashboard is enabled.|'."\n" - .'|└type|String|Yes|ECSInstanceId|The type of the machine on which the shipper is installed. Valid values: ECSInstanceId and ACKCluster. This parameter is required only when **configType** is set to **collectorDeployMachine**.|'."\n" - .'|└machines|Array|No||The information about the ECS instances on which the shipper is installed. This parameter is required only when **configType** is set to **collectorDeployMachines** and **type** is set to **ECSInstanceId**.|'."\n" - .'|└└instanceId|String|No|i-bp13y63575oypr9d\\*\\*\\*\\*|The IDs of the ECS instances on which the shipper is installed.|'."\n" - .'|└└agentStatus|String|No|failed|The installation status of the shipper on an ECS instance. Valid values: heartOk, heartLost, uninstalled, and failed.|'."\n" - .'|└groupId|String||default\\_ct-cn-5i2l75bz4776\\*\\*\\*\\*|The machine group ID. This parameter is required only when **configType** is set to **collectorDeployMachine**.|'."\n" - .'|└instanceId|String|Yes|es-cn-nif1z89fz003i\\*\\*\\*\\*|The ID of the object that is associated with the shipper. If you set **configType** to **collectorTargetInstance**, set instanceId to the ID of the output of the shipper. If you set **configType** to **collectorDeployMachines** and **type** to **ACKCluster**, set instanceId to the ID of an ACK cluster.|'."\n" - .'|└protocol|String|Yes|HTTP|The transfer protocol that you want to use. It must be the same as the protocol over which you can access the output of the shipper. Valid values: HTTP and HTTPS. This parameter is required only when **configType** is set to **collectorTargetInstance**.|'."\n" - .'|└userName|String|Yes|elastic|The username that can be used to access the output of the shipper. Default value: elastic. This parameter is required only when **configType** is set to **collectorTargetInstance** or **collectorElasticsearchForKibana**.|'."\n" - .'|└enableMonitoring|Boolean|Yes|true|Specifies whether to enable Kibana Monitoring. This parameter is required only when **configType** is set to **collectorTargetInstance** and **instanceType** is set to **elasticsearch**. Valid values: true and false.|'."\n" - .'|└hosts|List|No|\\["es-cn-n6w1o1x\\*\\*\\*\\*\\*.elasticsearch.aliyuncs.com:9200"\\]|The access addresses of the output of the shipper. This parameter is required only when **configType** is set to **collectorTargetInstance**.|'."\n" - .'|└instanceType|String|Yes|elasticsearch|The type of the output of the shipper. Valid values: elasticsearch and logstash. This parameter is required only when **configType** is set to **collectorTargetInstance**.|'."\n" - .'|└host|String|No|es-cn-n6w1o1x0w001c\\*\\*\\*\\*-kibana.internal.elasticsearch.aliyuncs.com:5601|The address that is used to access Kibana over an internal network after you enable Kibana Dashboard. This parameter is required only when **configType** is set to **collectorElasticsearchForKibana**.|'."\n" - .'|└kibanaHost|String|No|[https://es-cn-nif1z89fz003i\\*\\*\\*\\*.kibana.elasticsearch.aliyuncs.com:5601](https://es-cn-nif1z89fz003i\\*\\*\\*\\*.kibana.elasticsearch.aliyuncs.com:5601)|The address that is used to access Kibana over the Internet after you enable Kibana Dashboard. This parameter is required only when **configType** is set to **collectorElasticsearchForKibana**.|'."\n" - ."\n\n" - .'**Note**└ indicates a child parameter.'."\n" - ."\n" - .'### Description for special parameters'."\n" - ."\n" - .'The configType parameter in **extendConfigs** has three values: collectorTargetInstance, collectorElasticsearchForKibana, and collectorDeployMachine. The parameters that you need to configure vary based on the value of the configType parameter.'."\n" - ."\n" - .'* collectorTargetInstance'."\n" - ."\n" - .' * ECS configType, instanceId, instanceType, hosts, userName, password, protocol, and enableMonitoring'."\n" - .' * ACK configType, instanceId, instanceType, userName, password, protocol, and enableMonitoring'."\n" - ."\n" - .'* collectorElasticsearchForKibana'."\n" - ."\n" - .' * ECS configType, instanceId, host, kibanaHost, userName, password, and protocol'."\n" - .' * ACK configType'."\n" - ."\n" - .'* collectorDeployMachine'."\n" - ."\n" - .' * ECS configType, type, machines, and groupId'."\n" - .' * ACK configType, type, instanceId, totalPodsCount, and successPodsCount', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F05ED12E-140A-4ACB-B059-3A508A69F2E1\\",\\n \\"Result\\": [\\n \\"[\\\\\\"my_index_aliws\\\\\\", \\\\\\"aliyun-index-test\\\\\\",\\\\\\"filebeat-6.7.0-2020.11.15\\\\\\", \\\\\\"filebeat-6.7.0-2020.12.27\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve diagnostic indexes from the intelligent O&M module', + 'summary' => 'Retrieves the diagnostic indexes from the intelligent O&M module for a specified instance.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateCollectorName' => [ - 'summary' => 'Changes the name of a shipper.', - 'path' => '/openapi/collectors/{ResId}/actions/rename', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseIndices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDiagnoseIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'ListDiagnoseReport' => [ + 'path' => '/openapi/diagnosis/instances/{InstanceId}/reports', + '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' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'ResId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-77uqof2s7rg5c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1qu7ei000p****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The language of the reports to retrieve. Default value: the browser language. Valid values:'."\n" + ."\n" + .'- en: English'."\n" + .'- zh: Simplified Chinese'."\n" + .'- zt: Traditional Chinese'."\n" + .'- es: Spanish'."\n" + .'- fr: French.', 'type' => 'string', 'required' => false, 'example' => 'es', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'startTime', + 'in' => 'query', + 'schema' => ['description' => 'The start timestamp of the query. Unit: milliseconds.'."\n" + ."\n" + .'- Minimum value: 1000000000000'."\n" + .'- Maximum value: 2000000000000.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2000000000000', 'minimum' => '1000000000000', 'example' => '1594569600000', 'title' => ''], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp of the query. Unit: milliseconds.'."\n" + .'- Minimum value: 1000000000000'."\n" + .'- Maximum value: 2000000000000.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2000000000000', 'minimum' => '1000000000000', 'example' => '1595174399999', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1. Minimum value: 1. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of reports per page. Default value: 10. Minimum value: 1. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'detail', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display the details of diagnostic items.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'trigger', + 'in' => 'query', + 'schema' => ['description' => 'The trigger method of the health diagnostics. Valid values:'."\n" + ."\n" + .'- SYSTEM (default): automatically triggered by the system'."\n" + .'- INNER: internally triggered'."\n" + .'- USER: manually triggered by the user.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', 'title' => ''], ], ], 'responses' => [ @@ -14385,269 +12201,161 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', 'type' => 'object', 'properties' => [ - 'resId' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'example' => 'ct-cn-77uqof2s7rg5c****', - ], - 'gmtUpdateTime' => [ - 'description' => 'The time when the shipper was updated.'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'dryRun' => [ - 'description' => 'Indicates whether a dry run is performed. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ownerId' => [ - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'example' => '16852099488*****', - ], - 'vpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC) where the shipper resides.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtma*****', - ], - 'resType' => [ - 'description' => 'The type of the shipper. Valid values: fileBeat, metricBeat, heartBeat, and audiBeat.'."\n", - 'type' => 'string', - 'example' => 'fileBeat', - ], - 'resVersion' => [ - 'description' => 'The version of the shipper. The version of a shipper depends on the type of the machine on which the shipper is deployed.'."\n" + 'X-Total-Count' => ['description' => 'The total number of records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'trigger' => ['description' => 'The trigger method of the health diagnostics. Valid values:'."\n" ."\n" - .'* Elastic Compute Service (ECS) instance: 6.8.5\\_with_community'."\n" - .'* Container Service for Kubernetes (ACK) cluster: 6.8.13\\_with_community'."\n", - 'type' => 'string', - 'example' => '6.8.5_with_community', - ], - 'gmtCreatedTime' => [ - 'description' => 'The time when the shipper was created.'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'status' => [ - 'description' => 'The status of the shipper. Valid values: activating and active.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'name' => [ - 'description' => 'The name of the shipper.'."\n", - 'type' => 'string', - 'example' => 'ct-test', - ], - 'configs' => [ - 'description' => 'The information about the configuration file of the shipper.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'description' => 'The content of the file.'."\n", - 'type' => 'string', - 'example' => '- key: log\\n title: Log file content\\n description: >\\n Contains log file lines.\\n ....', - ], - 'fileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'fields.yml', - ], - ], - ], - ], - 'extendConfigs' => [ - 'description' => 'The extended configurations of the shipper.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'successPodsCount' => [ - 'description' => 'The number of pods from which data is successfully collected in the ACK cluster. This parameter is returned if the value of **configType** is **collectorDeployMachine** and the value of **type** is **ACKCluster**.'."\n", - 'type' => 'string', - 'example' => '8', - ], - 'protocol' => [ - 'description' => 'The transmission protocol. Valid values: **HTTP** and **HTTPS**.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'userName' => [ - 'description' => 'The username that is used to access the resource specified in the output configuration part of the shipper. The default value is elastic. This parameter is returned if the value of **configType** is **collectorTargetInstance** or **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'elastic', - ], - 'totalPodsCount' => [ - 'description' => 'The total number of pods from which data is collected in the ACK cluster. This parameter is returned if the value of **configType** is **collectorDeployMachine** and the value of **type** is **ACKCluster**.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'type' => [ - 'description' => 'The type of the machine on which the shipper is deployed. This parameter is returned if the value of **configType** is **collectorDeployMachine**. Valid values:'."\n" - ."\n" - .'* ECSInstanceId'."\n" - .'* ACKCluster'."\n", - 'type' => 'string', - 'example' => 'ECSInstanceId', - ], - 'kibanaHost' => [ - 'description' => 'The public endpoint of Kibana after you enable the Kibana dashboard. This parameter is returned if the value of **configType** is **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'https://es-cn-4591jumei000u****.kibana.elasticsearch.aliyuncs.com:5601', - ], - 'enableMonitoring' => [ - 'description' => 'Indicates whether monitoring is enabled. This parameter is returned if the value of **configType** is **collectorTargetInstance** and the value of **instanceType** is **elasticsearch**. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'configType' => [ - 'description' => 'The configuration type. Valid values:'."\n" - ."\n" - .'* collectorTargetInstance'."\n" - .'* collectorDeployMachine'."\n" - .'* collectorElasticsearchForKibana'."\n", - 'type' => 'string', - 'example' => 'collectorDeployMachine', - ], - 'instanceType' => [ - 'description' => 'The type of the cluster specified in the output configuration part of the shipper. Valid values: elasticsearch and logstash. This parameter is returned if the value of **configType** is **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch', - ], - 'groupId' => [ - 'description' => 'The ID of the machine group. This parameter is returned if the value of **configType** is **collectorDeployMachine**.'."\n", - 'type' => 'string', - 'example' => 'default_ct-cn-5i2l75bz4776****', - ], - 'host' => [ - 'description' => 'The private endpoint of Kibana after you enable the Kibana dashboard. This parameter is returned if the value of **configType** is **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'es-cn-4591jumei000u****-kibana.internal.elasticsearch.aliyuncs.com:5601', - ], - 'instanceId' => [ - 'description' => 'The ID of the resource that is associated with the shipper. If the value of **configType** is **collectorTargetInstance**, the value of this parameter is the ID of the resource specified in the output configuration part of the shipper. If the value of **configType** is **collectorDeployMachine** and the value of **type** is **ACKCluster**, the value of this parameter is the ID of the ACK cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1****', - ], - 'machines' => [ - 'description' => 'The information about the ECS instances on which the shipper is deployed. This parameter is returned if the value of **configType** is **collectorDeployMachine** and the value of **type** is **ECSInstanceId**.'."\n", - 'type' => 'array', - 'items' => [ + .'- SYSTEM: automatically triggered by the system'."\n" + .'- INNER: internally triggered'."\n" + .'- USER: manually triggered by the user.', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'createTime' => ['description' => 'The timestamp when the report was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1535745731000', 'title' => ''], + 'reportId' => ['description' => 'The report ID.', 'type' => 'string', 'example' => 'trigger__2020-08-17T17:09:02f', 'title' => ''], + 'state' => ['description' => 'The diagnostic status. Valid values: SUCCESS, FAILED, and RUNNING.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID of the diagnosed instance.', 'type' => 'string', 'example' => 'es-cn-abc', 'title' => ''], + 'health' => ['description' => 'The overall health status of the cluster in the report. Valid values: GREEN, YELLOW, RED, and UNKNOWN.', 'type' => 'string', 'example' => 'YELLOW', 'title' => ''], + 'diagnoseItems' => [ + 'description' => 'The list of diagnostic items in the report.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'item' => ['description' => 'The name of the diagnostic item.', 'type' => 'string', 'example' => 'IndexAliasUseDiagnostic', 'title' => ''], + 'health' => ['description' => 'The health status of the diagnostic item. Valid values: GREEN, YELLOW, RED, and UNKNOWN.', 'type' => 'string', 'example' => 'YELLOW', 'title' => ''], + 'detail' => [ + 'description' => 'The details of the diagnostic item.', 'type' => 'object', 'properties' => [ - 'agentStatus' => [ - 'description' => 'The status of the shipper on the ECS instance. Valid values: **heartOk**, **heartLost**, **uninstalled**, and **failed**.'."\n", - 'type' => 'string', - 'example' => 'heartOk', - ], - 'instanceId' => [ - 'description' => 'The IDs of the ECS instances.'."\n", - 'type' => 'string', - 'example' => 'c1b9fde5172b84f82b9928e825a7b8988', - ], + 'type' => ['description' => 'The type of the diagnostic result. Valid values:'."\n" + ."\n" + .'- TEXT: text description'."\n" + .'- CONSOLE_API: console-triggered'."\n" + .'- ES_API: API-triggered.', 'type' => 'string', 'example' => 'ES_API', 'title' => ''], + 'name' => ['description' => 'The full name of the diagnostic item.', 'type' => 'string', 'example' => 'Number of Replica Shards', 'title' => ''], + 'desc' => ['description' => 'The description of the diagnostic item.', 'type' => 'string', 'example' => 'Check whether the number of replica shards is optimal and easy to maintain', 'title' => ''], + 'result' => ['description' => 'The diagnostic result.', 'type' => 'string', 'example' => 'You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]', 'title' => ''], + 'suggest' => ['description' => 'The diagnostic suggestion.', 'type' => 'string', 'example' => 'You can call the following function in the Elasticsearch API....', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'hosts' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', - ], - ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - 'collectorPaths' => [ - 'type' => 'array', 'items' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'item' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'state' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'desc' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'suggest' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'detail' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'string', - 'example' => '["/var/log"]', + 'title' => '', + 'example' => '', ], + 'diagnosisMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"resId\\": \\"ct-cn-77uqof2s7rg5c****\\",\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"dryRun\\": false,\\n \\"ownerId\\": \\"16852099488*****\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"resType\\": \\"fileBeat\\",\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"status\\": \\"active\\",\\n \\"name\\": \\"ct-test\\",\\n \\"configs\\": [\\n {\\n \\"content\\": \\"- key: log\\\\\\\\n title: Log file content\\\\\\\\n description: >\\\\\\\\n Contains log file lines.\\\\\\\\n ....\\",\\n \\"fileName\\": \\"fields.yml\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n {\\n \\"successPodsCount\\": \\"8\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"userName\\": \\"elastic\\",\\n \\"totalPodsCount\\": \\"10\\",\\n \\"type\\": \\"ECSInstanceId\\",\\n \\"kibanaHost\\": \\"https://es-cn-4591jumei000u****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"enableMonitoring\\": true,\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"host\\": \\"es-cn-4591jumei000u****-kibana.internal.elasticsearch.aliyuncs.com:5601\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1****\\",\\n \\"machines\\": [\\n {\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"instanceId\\": \\"c1b9fde5172b84f82b9928e825a7b8988\\"\\n }\\n ],\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateCollectorName', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameter in the request body to specify the new name of the shipper. '."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .' | ---- | ---- | ---- | ---- | '."\n" - .'| name| String | Yes |collectorName1 |The new name of the shipper. |'."\n" - ."\n" - .'Sample code:'."\n" - ."\n" - .' {'."\n" - .' "name": "collectorName1"'."\n" - .' }', + 'title' => 'List intelligent O&M historical reports', + 'summary' => 'Calls ListDiagnoseReport to retrieve historical reports of intelligent O&M.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StartCollector' => [ - 'summary' => 'Starts a collector to collect data.', - 'path' => '/openapi/collectors/{ResId}/actions/start', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T03:46:42.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseReport'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDiagnoseReport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 15\\n },\\n \\"Result\\": [\\n {\\n \\"trigger\\": \\"USER\\",\\n \\"createTime\\": 1535745731000,\\n \\"reportId\\": \\"trigger__2020-08-17T17:09:02f\\",\\n \\"state\\": \\"SUCCESS\\",\\n \\"instanceId\\": \\"es-cn-abc\\",\\n \\"health\\": \\"YELLOW\\",\\n \\"diagnoseItems\\": [\\n {\\n \\"item\\": \\"IndexAliasUseDiagnostic\\",\\n \\"health\\": \\"YELLOW\\",\\n \\"detail\\": {\\n \\"type\\": \\"ES_API\\",\\n \\"name\\": \\"Number of Replica Shards\\",\\n \\"desc\\": \\"Check whether the number of replica shards is optimal and easy to maintain\\",\\n \\"result\\": \\"You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]\\",\\n \\"suggest\\": \\"You can call the following function in the Elasticsearch API....\\"\\n }\\n }\\n ],\\n \\"items\\": [\\n {\\n \\"item\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"state\\": \\"\\",\\n \\"desc\\": \\"\\",\\n \\"suggest\\": \\"\\",\\n \\"detail\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"diagnosisMode\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListDiagnoseReportIds' => [ + 'summary' => 'Retrieves all IDs of Intelligent O&M Center historical reports.', + 'path' => '/openapi/diagnosis/instances/{InstanceId}/report-ids', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14656,29 +12364,55 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'ResId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the collector.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-77uqof2s7rg5c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1qu7ei000p****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must ensure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The language of the reports to retrieve. Default value: the browser language. Valid values:'."\n" + .'- en: English'."\n" + .'- zh: Simplified Chinese'."\n" + .'- zt: Traditional Chinese'."\n" + .'- es: Spanish'."\n" + .'- fr: French.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], + ], + [ + 'name' => 'startTime', + 'in' => 'query', + 'schema' => ['description' => 'The start timestamp of the query.'."\n" + .'Minimum value: 1000000000000 ms'."\n" + .'Maximum value: 2000000000000 ms.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2000000000000', 'minimum' => '1000000000000', 'example' => '1595088000000', 'title' => ''], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp of the query.'."\n" + .'Minimum value: 1000000000000 ms'."\n" + .'Maximum value: 2000000000000 ms.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2000000000000', 'minimum' => '1000000000000', 'example' => '1595174399999', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1. Minimum value: 1. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of report IDs per page. Default value: 10. Minimum value: 1. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'trigger', + 'in' => 'query', + 'schema' => ['description' => 'The trigger method of the health diagnostics. Valid values: SYSTEM (automatically triggered by the system), INNER (internally triggered), and USER (manually triggered by the user).', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', 'title' => ''], ], ], 'responses' => [ @@ -14686,173 +12420,175 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => ['description' => 'The returned results.', 'type' => 'string', 'example' => '["scheduled__2020-09-13T00:40:00"]', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'StartCollector', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"scheduled__2020-09-13T00:40:00\\\\\\"]\\"\\n ],\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'List intelligent O&M center historical report iDs', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StopCollector' => [ - 'summary' => 'Stops a shipper.', - 'path' => '/openapi/collectors/{ResId}/actions/stop', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseReportIds'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDiagnoseReportIds', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'ListDiagnosisItems' => [ + 'summary' => 'Lists the intelligent diagnostic items for an Elasticsearch instance.', + 'path' => '/openapi/diagnosis/items', + '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' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163553', + 'abilityTreeNodes' => ['FEATUREelasticsearchMWTZRB', 'FEATUREelasticsearchEC84H8'], ], 'parameters' => [ [ - 'name' => 'ResId', - 'in' => 'path', + 'name' => 'lang', + 'in' => 'query', 'schema' => [ - 'description' => 'The shipper ID.'."\n", + 'description' => 'The language of the request. Default value: the browser language. Valid values:'."\n" + ."\n" + .'- en: English'."\n" + .'- zh: Simplified Chinese'."\n" + .'- zt: Traditional Chinese'."\n" + .'- es: Spanish'."\n" + .'- fr: French.', + 'enumValueTitles' => ['en' => 'English.', 'zt' => 'Traditional Chinese.', 'fr' => 'French.', 'zh' => 'Simplified Chinese.', 'es' => 'Spanish.'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-77uqof2s7rg5c****', + 'required' => false, + 'example' => 'en', + 'title' => '', ], ], [ - 'name' => 'ClientToken', + 'name' => 'instanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result object.', + 'type' => 'object', + 'properties' => [ + 'key' => ['title' => '', 'description' => 'The diagnostic item identifier.', 'type' => 'string', 'example' => 'ClusterBulkRejectDiagnostic'], + 'name' => ['title' => '', 'description' => 'The diagnostic item name.', 'type' => 'string', 'example' => '索引写入BulkReject诊断'], + 'description' => ['title' => '', 'description' => 'The diagnostic item description.', 'type' => 'string', 'example' => '诊断集群写数据是否有堆积当集群的数据写入存在堆积时，会造成BulkReject异常，可能会导致数据丢失，且会造成系统资源消耗严重'], + 'esApiRequired' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'List intelligent diagnostic items', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnosisItems'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'StopCollector', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": [\\n {\\n \\"key\\": \\"ClusterBulkRejectDiagnostic\\",\\n \\"name\\": \\"索引写入BulkReject诊断\\",\\n \\"description\\": \\"诊断集群写数据是否有堆积当集群的数据写入存在堆积时，会造成BulkReject异常，可能会导致数据丢失，且会造成系统资源消耗严重\\",\\n \\"esApiRequired\\": false\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeCollector' => [ - 'path' => '/openapi/collectors/{ResId}', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListDictInformation' => [ + 'path' => '/openapi/instances/{InstanceId}/dict/_info', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14860,20 +12596,27 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ResId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-rg31ahn82m0qd****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + [ + 'name' => 'bucketName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the OSS bucket where the dictionary file is stored.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'search-cloud-test-cn-****', 'title' => ''], + ], + [ + 'name' => 'key', + 'in' => 'query', + 'schema' => ['description' => 'The storage path of the dictionary file in the OSS bucket.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oss/dic_0.dic', 'title' => ''], + ], + [ + 'name' => 'analyzerType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the OSS dictionary to be added. Valid values: IK_HOT, IK, SYNONYMS, and ALIWS. Default value: IK.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ALIWS', 'title' => ''], ], ], 'responses' => [ @@ -14881,304 +12624,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7C4334EA-D22B-48BD-AE28-08EE68******', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'resId' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'example' => 'ct-cn-rg31ahn82m0qd****', - ], - 'gmtUpdateTime' => [ - 'description' => 'The time when the shipper was updated.'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'dryRun' => [ - 'description' => 'Indicates whether a dry run is performed. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ownerId' => [ - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'example' => '16852099488*****', - ], - 'vpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC) where the shipper resides.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtma*****', - ], - 'resType' => [ - 'description' => 'The type of the shipper. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.'."\n", - 'type' => 'string', - 'example' => 'fileBeat', - ], - 'resVersion' => [ - 'description' => 'The version of the shipper.'."\n", - 'type' => 'string', - 'example' => '6.8.5_with_community', - ], - 'gmtCreatedTime' => [ - 'description' => 'The time when the shipper was created.'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'status' => [ - 'description' => 'The status of the shipper. Valid values:'."\n" - ."\n" - .'* activating'."\n" - .'* active'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'name' => [ - 'description' => 'The name of the shipper.'."\n", - 'type' => 'string', - 'example' => 'ct-cn-4135is2tj194p****', - ], - 'configs' => [ - 'description' => 'The information about the configuration file of the shipper.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'description' => 'The content of the file.'."\n", - 'type' => 'string', - 'example' => 'fileBeat.inputs:xxx', - ], - 'fileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'filebeat.yml', - ], - ], - ], - ], - 'extendConfigs' => [ - 'description' => 'The extended configurations of the shipper.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'successPodsCount' => [ - 'description' => 'The number of pods from which data is succcessfully collected in the Container Service for Kubernetes (ACK) cluster.'."\n", - 'type' => 'string', - 'example' => '8', - ], - 'protocol' => [ - 'description' => 'The transmission protocol, which must be the same as the access protocol of the resource specified in the output configuration part of the shipper. Valid values: HTTP and HTTPS. This parameter is returned if the value of **configType** is **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'userName' => [ - 'description' => 'The username that is used to access the resource specified in the output configuration part of the shipper. The default value is elastic. This parameter is returned if the value of **configType** is **collectorTargetInstance** or **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'elastic', - ], - 'totalPodsCount' => [ - 'description' => 'The total number of pods from which data is collected in the ACK cluster.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'type' => [ - 'description' => 'The type of the machine on which the shipper is deployed. This parameter is returned if the value of **configType** is **collectorDeployMachine**. Valid values:'."\n" - ."\n" - .'* ECSInstanceId'."\n" - .'* ACKCluster'."\n", - 'type' => 'string', - 'example' => 'ECSInstanceId', - ], - 'kibanaHost' => [ - 'description' => 'The public endpoint of Kibana after you enable the Kibana dashboard. This parameter is returned if the value of **configType** is **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601', - ], - 'enableMonitoring' => [ - 'description' => 'Indicates whether monitoring is enabled. This parameter is returned if the value of **configType** is **collectorTargetInstance**. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'configType' => [ - 'description' => 'The configuration type. Valid values:'."\n" - ."\n" - .'* collectorTargetInstance'."\n" - .'* collectorDeployMachine'."\n" - .'* collectorElasticsearchForKibana'."\n", - 'type' => 'string', - 'example' => 'collectorDeployMachine', - ], - 'instanceType' => [ - 'description' => 'The type of the cluster specified in the output configuration part of the shipper. Valid values: elasticsearch and logstash. This parameter is returned if the value of **configType** is **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch', - ], - 'groupId' => [ - 'description' => 'The ID of the machine group. This parameter is returned if the value of **configType** is **collectorDeployMachine**.'."\n", - 'type' => 'string', - 'example' => 'default_ct-cn-5i2l75bz4776****', - ], - 'host' => [ - 'description' => 'The private endpoint of Kibana after you enable the Kibana dashboard. This parameter is returned if the value of **configType** is **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601', - ], - 'instanceId' => [ - 'description' => 'The ID of the resource that is associated with the shipper. If the value of **configType** is **collectorTargetInstance**, the value of this parameter is the ID of the resource specified in the output configuration part of the shipper. If the value of **configType** is **collectorDeployMachines** and the value of **type** is **ACKCluster**, the value of this parameter is the ID of the ACK cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1****', - ], - 'machines' => [ - 'description' => 'The information about the Elastic Compute Service (ECS) instances on which the shipper is deployed. This parameter is returned if the value of **configType** is **collectorDeployMachines** and the value of **type** is **ECSInstanceId**.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'agentStatus' => [ - 'description' => 'The status of the shipper on the ECS instance. Valid values:'."\n" - ."\n" - .'* heartOk: The heartbeat is normal.'."\n" - .'* heartLost: The heartbeat is abnormal.'."\n" - .'* uninstalled: The shipper is not installed.'."\n" - .'* failed: The shipper fails to be installed.'."\n", - 'type' => 'string', - 'example' => 'heartOk', - ], - 'instanceId' => [ - 'description' => 'The IDs of the ECS instances.'."\n", - 'type' => 'string', - 'example' => 'i-bp1gyhphjaj73jsr****', - ], - ], - ], - ], - 'hosts' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', - ], - ], - ], - ], - ], - 'collectorPaths' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["/var/log"]', + 'type' => ['description' => 'The dictionary type. Valid values:'."\n" + ."\n" + .'- MAIN: primary tokenization dictionary'."\n" + ."\n" + .'- STOP: stopword dictionary.', 'type' => 'string', 'example' => 'STOP', 'title' => ''], + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2202301', 'title' => ''], + 'ossObject' => [ + 'description' => 'The details of the OSS file.', + 'type' => 'object', + 'properties' => [ + 'key' => ['description' => 'The storage path of the dictionary file in the OSS bucket.', 'type' => 'string', 'example' => 'oss/dict_0*.dic', 'title' => ''], + 'bucketName' => ['description' => 'The name of the OSS bucket where the file is stored.', 'type' => 'string', 'example' => 'es-osstest*', 'title' => ''], + 'etag' => ['description' => 'The MD5 checksum (ETag) of the OSS file, in uppercase.', 'type' => 'string', 'example' => '2ABAB5E70BBF631145647F6BE533****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"resId\\": \\"ct-cn-rg31ahn82m0qd****\\",\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"dryRun\\": false,\\n \\"ownerId\\": \\"16852099488*****\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"resType\\": \\"fileBeat\\",\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"status\\": \\"active\\",\\n \\"name\\": \\"ct-cn-4135is2tj194p****\\",\\n \\"configs\\": [\\n {\\n \\"content\\": \\"fileBeat.inputs:xxx\\",\\n \\"fileName\\": \\"filebeat.yml\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n {\\n \\"successPodsCount\\": \\"8\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"userName\\": \\"elastic\\",\\n \\"totalPodsCount\\": \\"10\\",\\n \\"type\\": \\"ECSInstanceId\\",\\n \\"kibanaHost\\": \\"https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"enableMonitoring\\": true,\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"host\\": \\"es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1****\\",\\n \\"machines\\": [\\n {\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"instanceId\\": \\"i-bp1gyhphjaj73jsr****\\"\\n }\\n ],\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeCollector', - 'summary' => 'Queries the detailed information of a shipper.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C4334EA-D22B-48BD-AE28-08EE68******\\",\\n \\"Result\\": {\\n \\"type\\": \\"STOP\\",\\n \\"fileSize\\": 2202301,\\n \\"ossObject\\": {\\n \\"key\\": \\"oss/dict_0*.dic\\",\\n \\"bucketName\\": \\"es-osstest*\\",\\n \\"etag\\": \\"2ABAB5E70BBF631145647F6BE533****\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query dictionary information', + 'summary' => 'Queries the information of a specified dictionary.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The parameters returned in **extendConfigs** vary based on the value of configType. Valid values of configType include collectorTargetInstance, collectorElasticsearchForKibana, and collectorDeployMachine.'."\n" - ."\n" - .'* collectorTargetInstance'."\n" - ."\n" - .' * ECS configType, instanceId, instanceType, hosts, userName, password, protocol, and enableMonitoring'."\n" - .' * ACK configType, instanceId, instanceType, userName, password, protocol, and enableMonitoring'."\n" - ."\n" - .'* collectorElasticsearchForKibana'."\n" - ."\n" - .' * ECS configType, instanceId, host, kibanaHost, userName, password, and protocol'."\n" - .' * ACK configType'."\n" - ."\n" - .'* collectorDeployMachine'."\n" - ."\n" - .' * ECS configType, type, machines, and groupId'."\n" - .' * ACK configType, type, instanceId, totalPodsCount, and successPodsCount'."\n", + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListDefaultCollectorConfigurations' => [ - 'path' => '/openapi/beats/default-configurations', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDictInformation'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'ListDicts' => [ + 'summary' => 'Queries the details of the dictionary list for a specified type.', + 'path' => '/openapi/instances/{InstanceId}/dicts', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15188,50 +12736,33 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'resType', + 'name' => 'analyzerType', 'in' => 'query', - 'schema' => [ - 'description' => 'The shipper type. Valid values:'."\n" - ."\n" - .'* fileBeat'."\n" - .'* metricBeat'."\n" - .'* heartBeat'."\n" - .'* auditBeat'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'fileBeat', - ], + 'schema' => ['description' => 'The dictionary type. Valid values:'."\n" + ."\n" + .'- IK: IK cold update dictionary.'."\n" + ."\n" + .'- IK_HOT: IK hot update dictionary.'."\n" + ."\n" + .'- SYNONYMS: Synonym dictionary.'."\n" + ."\n" + .'- ALIWS: Alibaba dictionary.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'IK', 'title' => ''], ], [ - 'name' => 'resVersion', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The shipper version. The shipper version varies based on the type of the machine on which the shipper is deployed. Valid values:'."\n" - ."\n" - .'* ECS: 6.8.5\\_with_community'."\n" - .'* ACK: 6.8.13\\_with_community'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '6.8.5_with_community', - ], + 'schema' => ['description' => 'The name of the file to filter.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], ], [ - 'name' => 'sourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the machine on which the shipper is deployed. If you do not configure this parameter, the default configuration files of shippers deployed on all types of machines are returned. Valid values:'."\n" - ."\n" - .'* ECS: ECS instance'."\n" - .'* ACK: ACK cluster'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-0ju29ifnc0005****', 'title' => ''], ], ], 'responses' => [ @@ -15239,109 +12770,115 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2937F832-F39E-41EF-89BA-B528342A2A3A', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The request result.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => 'The content of the configuration file.'."\n", - 'type' => 'string', - 'example' => '- key: log\\n title: Log file content\\n description: >\\n Contains log file lines.\\n fields:\\n ......', - ], - 'fileName' => [ - 'description' => 'The name of the configuration file.'."\n", - 'type' => 'string', - 'example' => 'fields.yml', - ], + 'fileSize' => ['description' => 'The size of the dictionary file, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'sourceType' => ['description' => 'A fixed value.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], + 'downloadUrl' => ['description' => 'The publicly accessible download URL. The URL is valid for 90 seconds.', 'type' => 'string', 'example' => 'http://test_bucket.oss-cn-hangzhou.aliyuncs.com/AliyunEs/test.dic?Expires=162573****&OSSAccessKeyId=LTAI*****V9&Signature=PNPO********BBGsJDO4V3VfU4sE%3D', 'title' => ''], + 'name' => ['description' => 'The file name of the dictionary file.', 'type' => 'string', 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], + 'type' => ['description' => 'The type of the IK dictionary. Valid values:'."\n" + ."\n" + .'- MAIN: main tokenization dictionary.'."\n" + ."\n" + .'- STOP: stopword dictionary.', 'type' => 'string', 'example' => 'MAIN', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5\\",\\n \\"Result\\": [\\n {\\n \\"content\\": \\"- key: log\\\\\\\\n title: Log file content\\\\\\\\n description: >\\\\\\\\n Contains log file lines.\\\\\\\\n fields:\\\\\\\\n ......\\",\\n \\"fileName\\": \\"fields.yml\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListDefaultCollectorConfigurations', - 'summary' => 'Queries the default configuration files of shippers.', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2937F832-F39E-41EF-89BA-B528342A2A3A\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 1\\n },\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"downloadUrl\\": \\"http://test_bucket.oss-cn-hangzhou.aliyuncs.com/AliyunEs/test.dic?Expires=162573****&OSSAccessKeyId=LTAI*****V9&Signature=PNPO********BBGsJDO4V3VfU4sE%3D\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'View dictionary list details', + 'requestParamsDescription' => ' > The dictionary name under each elasticsearchAnalyzer is unique. Even the IK main tokenization dictionary and the stopword dictionary do not have dictionary files with the same name.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListCollectors' => [ - 'summary' => 'Queries a list of shippers.', - 'path' => '/openapi/collectors', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDicts'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDicts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], ], + ], + 'ListEcsInstances' => [ + 'summary' => 'Retrieves the list of ECS instances under the current user\'s VPC and vSwitch.', + 'path' => '/openapi/ecs', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15353,80 +12890,41 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'resId', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ct-cn-77uqof2s7rg5c****', - ], + 'schema' => ['description' => 'The page number of the returned results. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the shipper.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'collectorName1', - ], + 'schema' => ['description' => 'The number of results per page. Default value: 10. Maximum value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'instanceId', + 'name' => 'ecsInstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource with which the shipper is associated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-nif1q8auz0003****', - ], + 'schema' => ['description' => 'The list of ECS instance IDs. The value can be a JSON array that consists of up to 100 instance IDs. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '["i-bp13y63575oypr9d****","i-bp1gyhphjaj73jsr****"]', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'ecsInstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Valid values: 1 to 200. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the ECS instance.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'tags', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values: 1 to 500. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'Instance tags of the ECS instance. The following fields must be included:'."\n" + ."\n" + .'- tagKey: instance tag key.'."\n" + .'- tagValue: instance tag value.', 'type' => 'string', 'required' => false, 'example' => '[{ "tagKey":"a","tagValue":"b"}]', 'title' => ''], ], [ - 'name' => 'sourceType', + 'name' => 'vpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the machine on which the shipper is deployed. If you leave this parameter empty, shippers deployed on all types of machines are returned. Valid values:'."\n" - ."\n" - .'* ECS'."\n" - .'* ACK'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ECS', - ], + 'schema' => ['description' => 'The ID of the VPC where the ECS instance resides.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp16k1dvzxtmagcva****', 'title' => ''], ], ], 'responses' => [ @@ -15434,636 +12932,542 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Headers' => [ - 'description' => 'The header of the response.'."\n", + 'description' => 'The response headers.', 'type' => 'object', 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], + 'X-Total-Count' => ['description' => 'The total number of returned records.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'configs' => [ - 'description' => 'The information about the configuration file of the shipper.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'fileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'fields.yml', - ], - 'content' => [ - 'description' => 'The content of the file.'."\n", - 'type' => 'string', - 'example' => '- key: log\\n title: Log file content\\n description: >\\n Contains log file lines.\\n ....', - ], - ], - ], - ], - 'dryRun' => [ - 'description' => 'Indicates whether a dry run is performed. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'resType' => [ - 'description' => 'The type of the shipper. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.'."\n", - 'type' => 'string', - 'example' => 'fileBeat', - ], - 'ownerId' => [ - 'description' => 'The account ID.'."\n", - 'type' => 'string', - 'example' => '168520994880****', - ], - 'resId' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'example' => 'ct-cn-0v3xj86085dvq****', - ], - 'collectorPaths' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["/var/log"]', - ], - ], - 'gmtUpdateTime' => [ - 'description' => 'The time when the shipper was updated.'."\n", - 'type' => 'string', - 'example' => '2020-08-18T09:40:43.000+0000', - ], - 'extendConfigs' => [ - 'description' => 'The extended configurations of the shipper.'."\n", + 'ecsInstanceId' => ['description' => 'The ECS instance ID.', 'type' => 'string', 'example' => 'i-bp14ncqge8wy3l3d****', 'title' => ''], + 'collectors' => [ + 'description' => 'The list of collectors deployed on the ECS instance.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'enableMonitoring' => [ - 'description' => 'Indicates whether monitoring is enabled. This parameter is returned if the value of **configType** is **collectorTargetInstance** and the value of **instanceType** is **elasticsearch**. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'hosts' => [ + 'configs' => [ + 'description' => 'The configuration file information of the collector.', 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'fields.yml', 'title' => ''], + 'content' => ['description' => 'The file content.', 'type' => 'string', 'example' => '- key: log\\n title: Log file content\\n description: >\\n Contains log file lines.\\n ....', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'instanceType' => [ - 'description' => 'The type of the cluster specified in the output configuration part of the shipper. Valid values: elasticsearch and logstash. This parameter is returned if the value of **configType** is **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch', - ], - 'groupId' => [ - 'description' => 'The ID of the machine group. This parameter is returned if the value of **configType** is **collectorDeployMachine**.'."\n", - 'type' => 'string', - 'example' => 'default_ct-cn-5i2l75bz4776****', - ], - 'userName' => [ - 'description' => 'The username that is used to access the resource specified in the output configuration part of the shipper. The default value is elastic. This parameter is returned if the value of **configType** is **collectorTargetInstance** or **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'elastic', - ], - 'type' => [ - 'description' => 'The type of the machine on which the shipper is deployed. This parameter is returned if the value of **configType** is **collectorDeployMachine**. Valid values:'."\n" - ."\n" - .'* ECSInstanceId'."\n" - .'* ACKCluster'."\n", - 'type' => 'string', - 'example' => 'ECSInstanceId', - ], - 'configType' => [ - 'description' => 'The configuration type. Valid values:'."\n" - ."\n" - .'* collectorTargetInstance'."\n" - .'* collectorDeployMachine'."\n" - .'* collectorElasticsearchForKibana'."\n", - 'type' => 'string', - 'example' => 'collectorDeployMachine', - ], - 'protocol' => [ - 'description' => 'The transmission protocol, which must be the same as the access protocol of the resource specified in the output configuration part of the shipper. Valid values: HTTP and HTTPS. This parameter is returned if the value of **configType** is **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'instanceId' => [ - 'description' => 'The ID of the resource with which the shipper is associated. If the value of **configType** is **collectorTargetInstance**, the value of this parameter is the ID of the resource specified in the output configuration part of the shipper. If the value of **configType** is **collectorDeployMachine** and the value of **type** is **ACKCluster**, the value of this parameter is the ID of the ACK cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-nif1z89fz003i****', - ], - 'host' => [ - 'description' => 'The internal endpoint of Kibana after you enable the Kibana dashboard. This parameter is returned if the value of **configType** is **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601', - ], - 'kibanaHost' => [ - 'description' => 'The public endpoint of Kibana after you enable the Kibana dashboard. This parameter is returned if the value of **configType** is **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601', - ], - 'totalPodsCount' => [ - 'description' => 'The total number of pods from which data is collected in the ACK cluster. This parameter is returned if the value of **configType** is **collectorDeployMachine** and the value of **type** is **ACKCluster**.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'successPodsCount' => [ - 'description' => 'The number of pods from which data is successfully collected in the ACK cluster. This parameter is returned if the value of **configType** is **collectorDeployMachine** and the value of **type** is **ACKCluster**.'."\n", - 'type' => 'string', - 'example' => '8', + 'dryRun' => ['description' => 'Indicates whether the collector is only validated without being created. Valid values:'."\n" + ."\n" + .'- true: Only validates without creating.'."\n" + .'- false: Validates and creates.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'resType' => ['description' => 'The collector type. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.', 'type' => 'string', 'example' => 'fileBeat', 'title' => ''], + 'ownerId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '16852***488*****', 'title' => ''], + 'resId' => ['description' => 'The collector instance ID.', 'type' => 'string', 'example' => 'ct-cn-0v3xj86085dvq****', 'title' => ''], + 'collectorPaths' => [ + 'type' => 'array', + 'items' => ['description' => 'The collection path of Filebeat.', 'type' => 'string', 'example' => '["/var/log"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'machines' => [ - 'description' => 'The information about the ECS instances on which the shipper is deployed. This parameter is returned if the value of **configType** is **collectorDeployMachine** and the value of **type** is **ECSInstanceId**.'."\n", + 'gmtUpdateTime' => ['description' => 'The time when the collector was last updated.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'extendConfigs' => [ + 'description' => 'The extended configuration information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => 'The IDs of the ECS instances.'."\n", - 'type' => 'string', - 'example' => 'i-bp13y63575oypr9d****', + 'protocol' => ['description' => 'The transmission protocol, which must be consistent with the access protocol of the instance specified by the collector Output. Valid values: HTTP and HTTPS. This parameter is displayed when configType is set to collectorTargetInstance.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'enableMonitoring' => ['description' => 'Indicates whether Monitoring is enabled. This parameter is displayed when configType is set to collectorTargetInstance and instanceType is set to elasticsearch. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'instanceId' => ['description' => 'The ID of the instance associated with the collector. When configType is set to collectorTargetInstance, this is the instance ID of the collector Output. When configType is set to collectorDeployMachines and type is set to ACKCluster, this is the ACK (Container Service for Kubernetes) cluster ID.', 'type' => 'string', 'example' => 'es-cn-nif1z89fz003i****', 'title' => ''], + 'hosts' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of access addresses of the instance specified by the collector Output. This parameter is displayed when configType is set to collectorTargetInstance.', 'type' => 'string', 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'agentStatus' => [ - 'description' => 'The status of the shipper on the ECS instance. Valid values:'."\n" - ."\n" - .'* heartOk'."\n" - .'* heartLost'."\n" - .'* uninstalled'."\n" - .'* failed'."\n", - 'type' => 'string', - 'example' => 'heartOk', + 'groupId' => ['description' => 'The machine group ID. This parameter is displayed when configType is set to collectorDeployMachine.', 'type' => 'string', 'example' => 'default_ct-cn-5i2l75bz4776****', 'title' => ''], + 'instanceType' => ['description' => 'The type of the instance specified by the collector Output. Valid values: elasticsearch and logstash. This parameter is displayed when configType is set to collectorTargetInstance.', 'type' => 'string', 'example' => 'elasticsearch', 'title' => ''], + 'machines' => [ + 'description' => 'The list of ECS machines on which the collector is deployed. This parameter is displayed when configType is set to collectorDeployMachines and type is set to ECSInstanceId.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The list of ECS machine IDs.', 'type' => 'string', 'example' => 'i-bp13y63575oypr9d****', 'title' => ''], + 'agentStatus' => ['description' => 'The status of each collector on the ECS instance. Valid values:'."\n" + ."\n" + .'- heartOk: The heartbeat is normal.'."\n" + .'- heartLost: The heartbeat is abnormal.'."\n" + .'- uninstalled: Not installed.'."\n" + .'- failed: Installation failed.', 'type' => 'string', 'example' => 'heartOk', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'configType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- collectorTargetInstance: the collector Output.'."\n" + .'- collectorDeployMachine: the deployment machine of the collector.'."\n" + .'- collectorElasticsearchForKibana: the Elasticsearch instance information that supports Kibana dashboards.', 'type' => 'string', 'example' => 'collectorDeployMachine', 'title' => ''], + 'userName' => ['description' => 'The username used to access the instance specified by the collector Output. Default value: elastic. This parameter is displayed when configType is set to collectorTargetInstance or collectorElasticsearchForKibana.', 'type' => 'string', 'example' => 'elastic', 'title' => ''], + 'type' => ['description' => 'The type of machine on which the collector is deployed. This parameter is displayed when configType is set to collectorDeployMachine. Valid values:'."\n" + ."\n" + .'- ECSInstanceId: ECS'."\n" + .'- ACKCluster: Container Service for Kubernetes.', 'type' => 'string', 'example' => 'ECSInstanceId', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'resVersion' => ['description' => 'The collector version. When the machine type for collector deployment is ECS, only **6.8.5_with_community** is supported.', 'type' => 'string', 'example' => '6.8.5_with_community', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the VPC where the collector resides.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtm******', 'title' => ''], + 'name' => ['description' => 'The collector name.', 'type' => 'string', 'example' => 'ct-testAbc', 'title' => ''], + 'gmtCreatedTime' => ['description' => 'The time when the collector was created.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'status' => ['description' => 'The collector status. Valid values:'."\n" + ."\n" + .'- activing: Taking effect.'."\n" + .'- active: Active.', 'type' => 'string', 'example' => 'activing', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'resVersion' => [ - 'description' => 'The version of the shipper.'."\n", - 'type' => 'string', - 'example' => '6.8.5_with_community', - ], - 'vpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC) where the shipper resides.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtma*****', - ], - 'name' => [ - 'description' => 'The name of the shipper.'."\n", - 'type' => 'string', - 'example' => 'FileBeat001', - ], - 'gmtCreatedTime' => [ - 'description' => 'The time when the shipper was created.'."\n", - 'type' => 'string', - 'example' => '2020-08-18T02:06:12.000+0000', - ], - 'status' => [ - 'description' => 'The status of the shipper. Valid values:'."\n" - ."\n" - .'* activating'."\n" - .'* active'."\n", - 'type' => 'string', - 'example' => 'active', + 'cloudAssistantStatus' => ['description' => 'The installation status of Cloud Assistant. Valid values:'."\n" + ."\n" + .'- true: Installed.'."\n" + .'- false: Not installed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ecsInstanceName' => ['description' => 'The name of the ECS instance.', 'type' => 'string', 'example' => 'ecsTestName', 'title' => ''], + 'osType' => ['description' => 'The operating system type of the ECS instance. Valid values:'."\n" + ."\n" + .'- windows: Windows operating system.'."\n" + .'- linux: Linux operating system.', 'type' => 'string', 'example' => 'linux', 'title' => ''], + 'ipAddress' => [ + 'description' => 'The IP address information of the ECS instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'host' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '172.16.xx.xx', 'title' => ''], + 'ipType' => ['description' => 'The IP address type. Valid values:'."\n" + ."\n" + .'- public: public IP address.'."\n" + .'- private: private network address.', 'type' => 'string', 'example' => 'private', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'tags' => ['description' => 'The tag information of the ECS instance.', 'type' => 'string', 'example' => '[ { "tagKey": "a", "tagValue": "b" } ]', 'title' => ''], + 'status' => ['description' => 'The status of the ECS instance. Valid values:'."\n" + ."\n" + .'- running: Running.'."\n" + .'- starting: Starting.'."\n" + .'- stopping: Stopping.'."\n" + .'- stopped: Stopped.', 'type' => 'string', 'example' => 'running', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 5\\n },\\n \\"Result\\": [\\n {\\n \\"resId\\": \\"ct-cn-0v3xj86085dvq****\\",\\n \\"gmtUpdateTime\\": \\"2020-08-18T09:40:43.000+0000\\",\\n \\"dryRun\\": false,\\n \\"ownerId\\": \\"168520994880****\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"resType\\": \\"fileBeat\\",\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"gmtCreatedTime\\": \\"2020-08-18T02:06:12.000+0000\\",\\n \\"status\\": \\"active\\",\\n \\"name\\": \\"FileBeat001\\",\\n \\"configs\\": [\\n {\\n \\"content\\": \\"- key: log\\\\\\\\n title: Log file content\\\\\\\\n description: >\\\\\\\\n Contains log file lines.\\\\\\\\n ....\\",\\n \\"fileName\\": \\"fields.yml\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n {\\n \\"successPodsCount\\": \\"8\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"userName\\": \\"elastic\\",\\n \\"totalPodsCount\\": \\"10\\",\\n \\"type\\": \\"ECSInstanceId\\",\\n \\"kibanaHost\\": \\"https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"enableMonitoring\\": true,\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"host\\": \\"es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601\\",\\n \\"instanceId\\": \\"es-cn-nif1z89fz003i****\\",\\n \\"machines\\": [\\n {\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"instanceId\\": \\"i-bp13y63575oypr9d****\\"\\n }\\n ],\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListCollectors', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 11\\n },\\n \\"Result\\": [\\n {\\n \\"ecsInstanceId\\": \\"i-bp14ncqge8wy3l3d****\\",\\n \\"collectors\\": [\\n {\\n \\"configs\\": [\\n {\\n \\"fileName\\": \\"fields.yml\\",\\n \\"content\\": \\"- key: log\\\\\\\\n title: Log file content\\\\\\\\n description: >\\\\\\\\n Contains log file lines.\\\\\\\\n ....\\"\\n }\\n ],\\n \\"dryRun\\": false,\\n \\"resType\\": \\"fileBeat\\",\\n \\"ownerId\\": \\"16852***488*****\\",\\n \\"resId\\": \\"ct-cn-0v3xj86085dvq****\\",\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ],\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"extendConfigs\\": [\\n {\\n \\"protocol\\": \\"HTTP\\",\\n \\"enableMonitoring\\": true,\\n \\"instanceId\\": \\"es-cn-nif1z89fz003i****\\",\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ],\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"machines\\": [\\n {\\n \\"instanceId\\": \\"i-bp13y63575oypr9d****\\",\\n \\"agentStatus\\": \\"heartOk\\"\\n }\\n ],\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"userName\\": \\"elastic\\",\\n \\"type\\": \\"ECSInstanceId\\"\\n }\\n ],\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtm******\\",\\n \\"name\\": \\"ct-testAbc\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"status\\": \\"activing\\"\\n }\\n ],\\n \\"cloudAssistantStatus\\": \\"true\\",\\n \\"ecsInstanceName\\": \\"ecsTestName\\",\\n \\"osType\\": \\"linux\\",\\n \\"ipAddress\\": [\\n {\\n \\"host\\": \\"172.16.xx.xx\\",\\n \\"ipType\\": \\"private\\"\\n }\\n ],\\n \\"tags\\": \\"[ { \\\\\\"tagKey\\\\\\": \\\\\\"a\\\\\\", \\\\\\"tagValue\\\\\\": \\\\\\"b\\\\\\" } ]\\",\\n \\"status\\": \\"running\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve ECS instance list', + 'description' => '><notice> Before calling this operation, create the AliyunElasticsearchAccessingOOSRole and AliyunOOSAccessingECS4ESRole service-linked roles. These roles allow the Elasticsearch service account to obtain ECS access permissions of the Alibaba Cloud account. For more information, see [Collect ECS service logs](~~146446~~).'."\n" + .'></notice>.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The parameters returned in **extendConfigs** vary based on the value of configType. Valid values of configType include collectorTargetInstance, collectorElasticsearchForKibana, and collectorDeployMachine.'."\n" - ."\n" - .'* collectorTargetInstance'."\n" - ."\n" - .' * ECS configType, instanceId, instanceType, hosts, userName ,password, protocol, and enableMonitoring'."\n" - .' * ACK configType, instanceId, instanceType, userName, password, protocol, and enableMonitoring'."\n" - ."\n" - .'* collectorElasticsearchForKibana'."\n" - ."\n" - .' * ECS configType, instanceId, host, kibanaHost, userName, password, and protocol'."\n" - .' * ACK configType'."\n" - ."\n" - .'* collectorDeployMachine'."\n" - ."\n" - .' * ECS configType, type, machines, and groupId'."\n" - .' * ACK configType, type, instanceId, totalPodsCount, and successPodsCount'."\n", + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListNodes' => [ - 'summary' => 'The list of historical reports of Intelligent Maintenance.', - 'path' => '/openapi/collectors/{ResId}/nodes', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEcsInstances'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListCollectors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListEventRecords' => [ + 'path' => '/openapi/{eventType}/listEventRecords', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '251506', + 'abilityTreeNodes' => ['FEATUREelasticsearchGHNE3U'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'page', - 'in' => 'query', + 'name' => 'eventType', + 'in' => 'path', 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'enumValueTitles' => ['UserOperator' => 'Cluster Change ', 'HealthCheck' => 'Cluster Health ', 'SystemUpdate' => 'System Change '], + 'description' => 'Event type. ', + 'title' => 'A short description of struct ', + 'type' => 'string', 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', + 'example' => 'UserOperator', ], ], [ - 'name' => 'size', + 'name' => 'termType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'Object type used for filtering. This parameter is optional. If empty, event records of all types are returned. ', 'type' => 'string', 'required' => false, 'example' => 'InstanceId', 'title' => ''], ], [ - 'name' => 'ecsInstanceIds', + 'name' => 'termContent', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the ECS instances.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp1ei8ysh7orb6eq****', - ], + 'schema' => ['description' => 'Object content used for filtering. This parameter is optional. If empty, event records for all instances are returned. Note: The value passed must correspond to the selected filter type. ', 'type' => 'string', 'required' => false, 'example' => '**', 'title' => ''], ], [ - 'name' => 'ecsInstanceName', + 'name' => 'beginTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the ECS instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Start time for event query. ', 'type' => 'string', 'required' => false, 'example' => '1746516590000', 'title' => ''], ], [ - 'name' => 'tags', + 'name' => 'endTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The tags of the ECS instance. You must configure tagKey and tagValue.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"tagKey":"abc","tagValue":"xyz"}]', - ], + 'schema' => ['description' => 'End time for event query. ', 'type' => 'string', 'required' => false, 'example' => '1746775790000', 'title' => ''], ], [ - 'name' => 'ResId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-l871nd0u73c45****', - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'Page number for paged query. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'Number of entries per page for paged query. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Return ', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E1FD7642-7C40-4FF2-9C0F-21F1A1746F70', - ], - 'Headers' => [ - 'description' => 'The header of the response.'."\n", + 'RequestId' => ['description' => 'Request ID ', 'title' => 'Id of the request ', 'type' => 'string', 'example' => '7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****'], + 'Result' => [ + 'description' => 'Return Result ', 'type' => 'object', 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'total' => ['description' => 'Total number of records ', 'type' => 'string', 'example' => '4', 'title' => ''], + 'result' => [ + 'description' => 'Content ', + 'type' => 'array', + 'items' => [ + 'description' => 'details ', + 'type' => 'object', + 'properties' => [ + 'displayName' => ['description' => 'Management event display name ', 'type' => 'string', 'example' => 'Instance.SpecModify', 'title' => ''], + 'type' => ['description' => 'Event type ', 'type' => 'string', 'example' => 'UserOperator', 'title' => ''], + 'level' => ['description' => 'event level ', 'type' => 'string', 'example' => 'Info', 'title' => ''], + 'status' => ['description' => 'Event status ', 'type' => 'string', 'example' => 'Executed', 'title' => ''], + 'source' => ['description' => 'Event occurrence source ', 'type' => 'string', 'example' => 'webConsole', 'title' => ''], + 'showContent' => [ + 'description' => 'Management event content ', + 'type' => 'object', + 'properties' => [ + 'actionSuggest' => [ + 'description' => 'Operation suggestion ', + 'type' => 'object', + 'properties' => [ + 'suggestType' => ['description' => 'Operation suggestion type ', 'type' => 'string', 'example' => 'promptText', 'title' => ''], + 'suggestActions' => [ + 'description' => 'Operation suggestion ', + 'type' => 'array', + 'items' => ['description' => 'Operation suggestion action ', 'type' => 'string', 'example' => '“”', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'suggestText' => ['description' => 'Operation suggestion text ', 'type' => 'string', 'example' => '“”', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'instanceId' => ['description' => 'Instance ID of the occurrence', 'type' => 'string', 'example' => 'es-cn-a5cb2dece****', 'title' => ''], + 'desc' => ['description' => 'Description of the management event', 'type' => 'string', 'example' => 'Instance.SpecModify', 'title' => ''], + 'eventStatus' => ['description' => 'Management event status', 'type' => 'string', 'example' => 'Executed', 'title' => ''], + 'eventTime' => ['description' => 'Time of occurrence', 'type' => 'string', 'example' => '2025-05-08 18:31:01', 'title' => ''], + 'executeStartTime' => ['description' => 'Start Time of O&M execution for the management event', 'type' => 'string', 'example' => '2025-05-08 18:31:00', 'title' => ''], + 'executeFinishTime' => ['description' => 'End Time of O&M execution for the management event', 'type' => 'string', 'example' => '2025-05-08 18:41:01', 'title' => ''], + 'opsChangeId' => ['description' => 'Execution ID of the cluster Change', 'type' => 'string', 'example' => 'f183728022a1c769e97b4*****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'mustOps' => ['description' => 'is O&M processing required ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'scheduleExecuteTime' => ['description' => 'scheduled running time ', 'type' => 'string', 'example' => '2025-05-08 18:41:01', 'title' => ''], + 'scheduleFinishTime' => ['description' => 'scheduled end time ', 'type' => 'string', 'example' => '2025-05-08 18:41:01', 'title' => ''], + 'autoAlarm' => ['description' => 'Is auto-alarm enabled', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'product' => ['description' => 'product type of the management event ', 'type' => 'string', 'example' => 'elasticsearch', 'title' => ''], + 'dryRun' => ['description' => 'is Preview ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve Event List ', + 'summary' => 'Obtain Event List ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****\\",\\n \\"Result\\": {\\n \\"total\\": \\"4\\",\\n \\"result\\": [\\n {\\n \\"displayName\\": \\"Instance.SpecModify\\",\\n \\"type\\": \\"UserOperator\\",\\n \\"level\\": \\"Info\\",\\n \\"status\\": \\"Executed\\",\\n \\"source\\": \\"webConsole\\",\\n \\"showContent\\": {\\n \\"actionSuggest\\": {\\n \\"suggestType\\": \\"promptText\\",\\n \\"suggestActions\\": [\\n \\"“”\\"\\n ],\\n \\"suggestText\\": \\"“”\\"\\n },\\n \\"instanceId\\": \\"es-cn-a5cb2dece****\\",\\n \\"desc\\": \\"Instance.SpecModify\\",\\n \\"eventStatus\\": \\"Executed\\",\\n \\"eventTime\\": \\"2025-05-08 18:31:01\\",\\n \\"executeStartTime\\": \\"2025-05-08 18:31:00\\",\\n \\"executeFinishTime\\": \\"2025-05-08 18:41:01\\",\\n \\"opsChangeId\\": \\"f183728022a1c769e97b4*****\\"\\n },\\n \\"mustOps\\": false,\\n \\"scheduleExecuteTime\\": \\"2025-05-08 18:41:01\\",\\n \\"scheduleFinishTime\\": \\"2025-05-08 18:41:01\\",\\n \\"autoAlarm\\": false,\\n \\"product\\": \\"elasticsearch\\",\\n \\"dryRun\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListExtendfiles' => [ + 'path' => '/openapi/logstashes/{InstanceId}/extendfiles', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ecsInstanceId' => [ - 'description' => 'The ID of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'i-bp13y63575oypr****', - ], - 'cloudAssistantStatus' => [ - 'description' => 'Indicates whether the Cloud Assistant client is installed. Valid values:'."\n" - ."\n" - .'* true: installed'."\n" - .'* false: not installed'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'ecsInstanceName' => [ - 'description' => 'The name of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'ECS_beat', - ], - 'osType' => [ - 'description' => 'The operating system type of the ECS instance. Valid values:'."\n" - ."\n" - .'* windows: Windows Server'."\n" - .'* linux: Linux'."\n", - 'type' => 'string', - 'example' => 'linux', - ], - 'ipAddress' => [ - 'description' => 'The IP addresses of the ECS instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'host' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '192.168.xx.xx', - ], - 'ipType' => [ - 'description' => 'The type of the IP address. Valid values:'."\n" - ."\n" - .'* public: public IP address'."\n" - .'* private: private IP address'."\n", - 'type' => 'string', - 'example' => 'public', - ], - ], - ], - ], - 'agentStatus' => [ - 'description' => 'The status of the shipper on the ECS instance. Valid values:'."\n" - ."\n" - .'* heartOk: The heartbeat is normal.'."\n" - .'* heartLost: The heartbeat is abnormal.'."\n" - .'* uninstalled: The shipper is not installed.'."\n" - .'* failed: The shipper fails to be installed.'."\n", - 'type' => 'string', - 'example' => 'heartOk', - ], - 'status' => [ - 'description' => 'The status of the ECS instance. Valid values:'."\n" - ."\n" - .'* running: The instance is running.'."\n" - .'* starting: The instance is being started.'."\n" - .'* stopping: The instance is being stopped.'."\n" - .'* stopped: The instance is stopped.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'tags' => [ - 'description' => 'The tags of the ECS instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'tagValue' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'xyz', - ], - 'tagKey' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - ], + 'filePath' => ['description' => 'The extension file path.', 'type' => 'string', 'example' => '/ssd/1/share/ls-cn-oew1qbgl****/logstash/current/config/custom/mysql-connector-java-5.1.35.jar', 'title' => ''], + 'fileSize' => ['description' => 'The extension file size.', 'type' => 'integer', 'format' => 'int64', 'example' => '968668', 'title' => ''], + 'name' => ['description' => 'The extension file name.', 'type' => 'string', 'example' => 'mysql-connector-java-5.1.35.jar', 'title' => ''], + 'sourceType' => ['description' => 'The source type.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E1FD7642-7C40-4FF2-9C0F-21F1A1746F70\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"Result\\": [\\n {\\n \\"cloudAssistantStatus\\": \\"true\\",\\n \\"ecsInstanceName\\": \\"ECS_beat\\",\\n \\"ecsInstanceId\\": \\"i-bp13y63575oypr****\\",\\n \\"osType\\": \\"linux\\",\\n \\"status\\": \\"running\\",\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"abc\\",\\n \\"tagValue\\": \\"xyz\\"\\n }\\n ],\\n \\"ipAddress\\": [\\n {\\n \\"ipType\\": \\"public\\",\\n \\"host\\": \\"192.168.xx.xx\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListNodes', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"filePath\\": \\"/ssd/1/share/ls-cn-oew1qbgl****/logstash/current/config/custom/mysql-connector-java-5.1.35.jar\\",\\n \\"fileSize\\": 968668,\\n \\"name\\": \\"mysql-connector-java-5.1.35.jar\\",\\n \\"sourceType\\": \\"ORIGIN\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Logstash extension file configuration', + 'summary' => 'Retrieves the extension file configuration of a Logstash instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RestartCollector' => [ - 'summary' => 'Restarts a shipper.', - 'path' => '/openapi/collectors/{ResId}/actions/restart', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExtendfiles'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListExtendfiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], + ], + 'ListILMPolicies' => [ + 'path' => '/openapi/instances/{InstanceId}/ilm-policies', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ResId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the shipper.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-77uqof2s7rg5c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-m7r23wodb006n****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'policyName', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The name of the index lifecycle policy.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'policy-1', 'title' => ''], ], ], 'responses' => [ @@ -16071,746 +13475,823 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], 'Result' => [ - 'description' => 'Indicates whether the shipper is restarted. Valid values:'."\n" - ."\n" - .'* true: The shipper is restarted.'."\n" - .'* false: The shipper fails to be restarted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '84B4038A-AF38-4BF4-9FAD-EA92A4FFF00A', + 'description' => 'The list of index lifecycle policies returned by the request.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'The name of the index lifecycle policy.', 'type' => 'string', 'example' => 'policy-1', 'title' => ''], + 'phases' => ['description' => 'The index lifecycle content.', 'type' => 'object', 'example' => '{"hot":{"minAge":"0ms","actions":{"rollover":{"maxSize":"50gb","maxAge":"30d"},"setPriority":{"priority":100}}},"delete":{"minAge":"3d","actions":{"delete":{}}}}', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"84B4038A-AF38-4BF4-9FAD-EA92A4FFF00A\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RestartCollector', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n {\\n \\"name\\": \\"policy-1\\",\\n \\"phases\\": {\\n \\"hot\\": {\\n \\"minAge\\": \\"0ms\\",\\n \\"actions\\": {\\n \\"rollover\\": {\\n \\"maxSize\\": \\"50gb\\",\\n \\"maxAge\\": \\"30d\\"\\n },\\n \\"setPriority\\": {\\n \\"priority\\": 100\\n }\\n }\\n },\\n \\"delete\\": {\\n \\"minAge\\": \\"3d\\",\\n \\"actions\\": {\\n \\"delete\\": {}\\n }\\n }\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query index lifecycle policies', + 'summary' => 'Queries the list of index lifecycle policies that have been created for a cluster.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => '**Data structure of the phases field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|{key}|Struct| |No|The current lifecycle phase. The following three phases are supported: hot (the hot data phase, in which the index is actively being updated and queried); cold (the cold data phase, in which the index is no longer updated and is rarely queried. The information still needs to be searchable, but slower queries are acceptable.); delete (the delete phase, in which the index is no longer needed and can be safely deleted).|'."\n" + .'|minAge|String|30d|No|The time required for the index to reach the target phase.|'."\n" + .'|actions|Struct| |No|The policy settings for the current phase. For more information, see the **Data structure of the actions field** below.|.'."\n" + ."\n" + .'**Data structure of the actions field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|rollover|Struct| |No|The index rollover operation in the hot phase. For more information, see the **Data structure of the rollover field** below.|'."\n" + .'|setPriority|Struct| |No|The index priority in the hot or cold phase. For more information, see the **Data structure of the setPriority field** below.|'."\n" + .'|allocate|Struct| |No|The allocation operation in the cold phase. For more information, see the **Data structure of the allocate field** below.|'."\n" + .'|delete|Struct| {} |No|The delete index operation. When the delete phase is enabled, this parameter is required and must be an empty object.|.'."\n" + ."\n" + .'**Data structure of the rollover field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|maxAge|String|30d|No|The time threshold required to trigger an index rollover. Specify at least one of maxAge, maxDocs, and maxSize. Unit: d (days) or h (hours).|'."\n" + .'|maxDocs|Integer|10000|No|The document count threshold required to trigger an index rollover.|'."\n" + .'|maxSize|String|50gb|No|The index size threshold required to trigger an index rollover. Specify at least one of maxAge, maxDocs, and maxSize. Unit: MB or GB.|.'."\n" + ."\n" + .'**Data structure of the setPriority field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|priority|Integer|100|No|The default priority of the current node.|.'."\n" + ."\n" + .'**Data structure of the allocate field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|numberOfReplicas|Integer|1|No|The number of replicas to allocate. If specified, the default value is 1. This parameter is used together with migrate. When automatic migration is enabled, replica allocation is performed by default.|'."\n" + .'|require |Struct| |No|An optional setting that is available for hot-warm architecture clusters. For more information, see the **Data structure of the require field** below.|.'."\n" + ."\n" + .'**Data structure of the require field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|boxType|String|warm|No|The custom node attribute identifier. This parameter is available for hot-warm architecture clusters and is used to migrate data to warm nodes. Valid values: warm.|.', 'extraInfo' => ' ', - ], - 'ReinstallCollector' => [ - 'summary' => 'Installs a shipper that failed to be installed when you create the shipper.', - 'path' => '/openapi/collectors/{ResId}/actions/reinstall', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListILMPolicies'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListILMPolicies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], ], + ], + 'ListIndexTemplates' => [ + 'path' => '/openapi/instances/{InstanceId}/index-templates', + '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' => 'ResId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ct-cn-l871nd0u73c45****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'indexTemplate', 'in' => 'query', - 'schema' => [ - 'description' => 'The request body parameters. For more information, see the Request body section in this topic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The index template name.', 'type' => 'string', 'required' => false, 'example' => 'my-template', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => 'Indicates whether the shipper is installed. Valid values:'."\n" - ."\n" - .'* true: The shipper is installed.'."\n" - .'* false: The shipper fails to be installed.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{'."\n" - .' "restartType": "nodeEcsId",'."\n" - .' "nodes":["i-bp1gyhphjaj73jsr****","i-bp10piq1mkfnyw9t****"]'."\n" - .'}', - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the instance list. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page for a paged query. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], 'Result' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'description' => 'The index template list information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result object information.', + 'type' => 'object', + 'properties' => [ + 'dataStream' => ['description' => 'Indicates whether the data stream is enabled. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + ."\n" + .'- false (default): not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'indexTemplate' => ['description' => 'The index template name.', 'type' => 'string', 'example' => 'my-template', 'title' => ''], + 'ilmPolicy' => ['description' => 'The index lifecycle policy name.', 'type' => 'string', 'example' => 'my_ilm_policy', 'title' => ''], + 'priority' => ['description' => 'The index template priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'indexPatterns' => [ + 'description' => 'The index pattern information.', + 'type' => 'array', + 'items' => ['description' => 'The index pattern.', 'type' => 'string', 'example' => 'console-*', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'template' => [ + 'description' => 'The component template.', + 'type' => 'object', + 'properties' => [ + 'settings' => ['description' => 'The settings configuration.', 'type' => 'string', 'example' => '{\\"mydata\\":{}}', 'title' => ''], + 'mappings' => ['description' => 'The mappings configuration.', 'type' => 'string', 'example' => '{\\"properties\\":{\\"created_at\\":{\\"format\\":\\"EEE MMM dd HH:mm:ss Z yyyy\\",\\"type\\":\\"date\\"},\\"host_name\\":{\\"type\\":\\"keyword\\"}}}', 'title' => ''], + 'aliases' => ['description' => 'The aliases configuration.', 'type' => 'string', 'example' => '{\\"index.number_of_shards\\":\\"1\\"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ReinstallCollector', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify the information about the shipper that you want to install. '."\n" - .'| Parameter | Type | Required | Example | Description | '."\n" - .'| ---- | ---- | ---- | ---- | '."\n" - .'| nodes| List\\<String> | Yes | \\["ecs-cn-abc"] |The ID of the Elastic Compute Service (ECS) instance on which you want to install the shipper. | '."\n" - .'| restartType| String | Yes | nodeEcsId |The type of the object on which you want to install the shipper. You can set this parameter only to nodeEcsId, which indicates ECS instances. |'."\n" - ."\n" - .'Sample code:'."\n" - ."\n" - .' {'."\n" - .' "restartType": "nodeEcsId",'."\n" - .' "nodes":["i-bp1gyhphjaj73jsr****","i-bp10piq1mkfnyw9t****"]'."\n" - .' }', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n {\\n \\"dataStream\\": true,\\n \\"indexTemplate\\": \\"my-template\\",\\n \\"ilmPolicy\\": \\"my_ilm_policy\\",\\n \\"priority\\": 100,\\n \\"indexPatterns\\": [\\n \\"console-*\\"\\n ],\\n \\"template\\": {\\n \\"settings\\": \\"{\\\\\\\\\\\\\\"mydata\\\\\\\\\\\\\\":{}}\\",\\n \\"mappings\\": \\"{\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"created_at\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"format\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"EEE MMM dd HH:mm:ss Z yyyy\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"host_name\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keyword\\\\\\\\\\\\\\"}}}\\",\\n \\"aliases\\": \\"{\\\\\\\\\\\\\\"index.number_of_shards\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query index templates', + 'summary' => 'Queries a list of index templates.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateInstance' => [ - 'summary' => 'Updates the configurations of a cluster, such as the number of nodes, the number of roles, specifications, and disk configurations.', - 'path' => '/openapi/instances/{InstanceId}', - 'methods' => [ - 'put', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-20T13:20:12.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIndexTemplates'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListIndexTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], ], + ], + 'ListInstance' => [ + 'path' => '/openapi/instances', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '64319', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1ptcb30009****', - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the instance list.'."\n" + .'Start value: **1**, default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The result of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The number of entries per page for paginated queries. Maximum value: **100**, default value: **10**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'orderActionType', + 'name' => 'description', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of data nodes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'upgrade', - ], + 'schema' => ['description' => 'The instance name. Fuzzy search is supported. For example, if you search for all instances matching **abc**, all instances named **abc**, **abcde**, **xyabc**, and **xabcy** may be returned.', 'type' => 'string', 'required' => false, 'example' => 'aliyunes_test1', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'nodeAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'nodeSpec' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/NodeSpec', - ], - 'masterConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/MasterNodeConfiguration', - ], - 'clientNodeConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ClientNodeConfiguration', - ], - 'warmNodeConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/WarmNodeConfiguration', - ], - 'kibanaConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/KibanaNodeConfiguration', - ], - 'elasticDataNodeConfiguration' => [ - 'description' => '', - 'required' => false, - '$ref' => '#/components/schemas/ElasticDataNodeConfiguration', - ], - 'instanceCategory' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'advanced', - ], - 'updateType' => [ - 'title' => 'normal: 原地变更'."\n" - .'blue_green: 蓝绿变更', - 'type' => 'string', - ], - ], - 'required' => false, - 'example' => '{ "nodeSpec": { "spec": "elasticsearch.r5.xlarge" } }', - ], + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-v641a0ta3000g****', 'title' => ''], ], [ - 'name' => 'force', + 'name' => 'esVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The instance version.', 'type' => 'string', 'required' => false, 'example' => '6.7_with_X-Pack', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzvowej3i****', 'title' => ''], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'schema' => ['description' => 'The instance tags.', 'type' => 'string', 'required' => false, 'example' => '[{"tagKey":"key1","tagValue":"value1"}]', 'title' => ''], + ], + [ + 'name' => 'vpcId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) where the instance is deployed.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp16k1dvzxtmagcva****', 'title' => ''], + ], + [ + 'name' => 'zoneId', + 'in' => 'query', + 'schema' => ['description' => 'The zone ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', 'title' => ''], + ], + [ + 'name' => 'paymentType', + 'in' => 'query', + 'schema' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- postpaid: pay-as-you-go'."\n" + ."\n" + .'- prepaid: subscription', 'type' => 'string', 'required' => false, 'example' => 'postpaid', 'title' => ''], + ], + [ + 'name' => 'instanceCategory', + 'in' => 'query', + 'schema' => ['description' => 'The edition type of the instance. Valid values:'."\n" + ."\n" + .'- x-pack: Commercial Edition'."\n" + ."\n" + .'- advanced/IS: Enhanced Edition'."\n" + ."\n" + .'- community: Basic Edition', 'type' => 'string', 'required' => false, 'example' => 'advanced', 'title' => ''], + ], + [ + 'name' => 'status', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Result' => [ - 'description' => 'The state of the instance. Valid values:'."\n" - ."\n" - .'* active: normal'."\n" - .'* activating: taking effect'."\n" - .'* inactive: frozen'."\n" - .'* invalid: invalid'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', 'type' => 'object', 'properties' => [ - 'nodeAmount' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" + 'X-Total-Count' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'advancedDedicateMaster' => ['description' => 'Indicates whether the instance contains dedicated master nodes. Valid values:'."\n" ."\n" - .'* prepaid: subscription'."\n" - .'* postpaid: pay-as-you-go'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'createdAt' => [ - 'description' => 'The private domain name of the instance.'."\n", - 'type' => 'string', - 'example' => '2018-07-13T03:58:07.253Z', - ], - 'status' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'paymentType' => [ - 'description' => 'The edition of the dedicated KMS instance.'."\n", - 'type' => 'string', - 'example' => 'postpaid', - ], - 'domain' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'es-cn-abc.elasticsearch.aliyuncs.com', - ], - 'description' => [ - 'description' => 'The configuration of data nodes.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'esVersion' => [ - 'description' => 'The node specifications.'."\n", - 'type' => 'string', - 'example' => '5.5.3_with_X-Pack', - ], - 'instanceId' => [ - 'description' => 'The storage space of the node. Unit: GB.'."\n", - 'type' => 'string', - 'example' => 'es-cn-abc', - ], - 'nodeSpec' => [ - 'description' => 'The storage type of the node. Valid values:'."\n" + .'- true: The instance contains dedicated master nodes.'."\n" ."\n" - .'* cloud_ssd: standard SSD'."\n" - .'* cloud_efficiency: ultra disk'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The configuration of Kibana nodes.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.xlarge', - ], - 'disk' => [ - 'description' => 'The node specifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], - 'diskType' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', + .'- false: The instance does not contain dedicated master nodes.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'nodeAmount' => ['description' => 'The number of data nodes in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'createdAt' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2018-07-13T03:58:07.253Z', 'title' => ''], + 'status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- active: normal'."\n" + ."\n" + .'- activating: taking effect'."\n" + ."\n" + .'- inactive: frozen'."\n" + ."\n" + .'- invalid: invalid. The cluster does not exist or is inaccessible. In this case, some fields in the API response may be missing, such as domain and kibanaDomain.'."\n" + ."\n" + .'- unknown: unknown. The cluster does not exist or is inaccessible. In this case, some fields in the API response may be missing, such as domain and kibanaDomain.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'dedicateMaster' => ['description' => 'Indicates whether the instance contains dedicated master nodes (deprecated). Valid values:'."\n" + ."\n" + .'- true: The instance contains dedicated master nodes.'."\n" + ."\n" + .'- false: The instance does not contain dedicated master nodes.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'serviceVpc' => ['description' => 'Indicates whether the instance is a service VPC.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'paymentType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- **prepaid**: subscription'."\n" + ."\n" + .'- **postpaid**: pay-as-you-go', 'type' => 'string', 'example' => 'postpaid', 'title' => ''], + 'resourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aekzvowej3i****', 'title' => ''], + 'postpaidServiceStatus' => ['description' => 'The status of the pay-as-you-go service that is overlaid on a subscription instance. Valid values:'."\n" + ."\n" + .'- **active**: normal'."\n" + ."\n" + .'- **closed**: closed'."\n" + ."\n" + .'- **indebt**: frozen due to overdue payment', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'description' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'es-cn-abc', 'title' => ''], + 'esVersion' => ['description' => 'The instance version.', 'type' => 'string', 'example' => '6.7_with_X-Pack', 'title' => ''], + 'isNewDeployment' => ['description' => 'Indicates whether the instance uses the new deployment architecture.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'updatedAt' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2018-07-18T10:10:04.484Z', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-cn-v641a0ta3000g****', 'title' => ''], + 'tags' => [ + 'description' => 'The instance tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - 'kibanaConfiguration' => [ - 'description' => 'The size of the node storage space.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The storage type of the node. This parameter can be ignored.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.n4.small', - ], - 'amount' => [ - 'description' => 'The configuration of dedicated master nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'extendConfigs' => [ + 'description' => 'The extended configurations of the cluster.', + 'type' => 'array', + 'items' => ['description' => 'The extended configurations of the cluster.', 'type' => 'object', 'example' => '[{ "configType": "aliVersion", "aliVersion": "ali1.3.0" }]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'clientNodeConfiguration' => [ + 'description' => 'The configuration of client nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications. For more information about the specifications, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.large', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Only ultra disks (cloud_efficiency) are supported.', 'type' => 'string', 'example' => 'cloud_efficiency', 'title' => ''], + 'specInfo' => ['description' => 'The description of node specifications.', 'type' => 'string', 'example' => '1C 2G', 'title' => ''], ], - 'disk' => [ - 'description' => 'The node specifications.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'title' => '', + 'example' => '', + ], + 'elasticDataNodeConfiguration' => [ + 'description' => 'The configuration of elastic data nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications. For more information about the specifications, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.large', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether disk encryption is enabled for the node. Valid values:'."\n" + ."\n" + .'- true: Disk encryption is enabled.'."\n" + ."\n" + .'- false: Disk encryption is not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Valid values:'."\n" + ."\n" + .'- cloud_ssd: standard SSD'."\n" + ."\n" + .'- cloud_essd: enhanced SSD (ESSD)'."\n" + ."\n" + .'- cloud_efficiency: ultra disk', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'specInfo' => ['description' => 'The description of node specifications.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], - 'diskType' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', + 'title' => '', + 'example' => '', + ], + 'kibanaConfiguration' => [ + 'description' => 'The configuration of Kibana nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications. For more information about the specifications, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'specInfo' => ['description' => 'The description of node specifications.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'masterConfiguration' => [ - 'description' => 'The storage space of the node. Unit: GB.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The storage type of the node. Only cloud_ssd(SSD cloud disk) is supported.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.large', + 'masterConfiguration' => [ + 'description' => 'The configuration of master nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications. For more information about the specifications, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.large', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Only cloud_ssd (standard SSD) is supported.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'specInfo' => ['description' => 'The description of node specifications.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], - 'amount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', + 'title' => '', + 'example' => '', + ], + 'networkConfig' => [ + 'description' => 'The network configuration.', + 'type' => 'object', + 'properties' => [ + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-abc', 'title' => ''], + 'vsArea' => ['description' => 'The zone where the instance is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou-e', 'title' => ''], + 'type' => ['description' => 'The network type. Only Virtual Private Cloud (VPC) is supported.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-def', 'title' => ''], + 'whiteIpGroupList' => [ + 'title' => '', + 'description' => 'The whitelist group settings for the public and private networks of the cluster.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'groupName' => ['title' => '', 'description' => 'The group name.', 'type' => 'string', 'example' => 'default'], + 'whiteIpType' => [ + 'title' => '', + 'description' => 'The network type. PRIVATE_ES: Elasticsearch private network. PUBLIC_KIBANA: Kibana public network. PUBLIC_ES: Elasticsearch public network. PRIVATE_KIBANA: Kibana private network.', + 'type' => 'string', + 'example' => 'PUBLIC_KIBANA', + 'enum' => ['PRIVATE_ES', 'PUBLIC_KIBANA', 'PUBLIC_ES', 'PRIVATE_KIBANA'], + ], + 'ips' => [ + 'title' => '', + 'description' => 'The IP address whitelist.', + 'type' => 'array', + 'items' => ['description' => 'The IP address whitelist.', 'type' => 'string', 'example' => '["0.0.0.0", "127.0.XX.XX"]', 'title' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'title' => '', + 'example' => '', + ], + 'nodeSpec' => [ + 'description' => 'The configuration of data nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications. For more information about the specifications, see [Product specifications](~~271718~~).', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether disk encryption is used. Valid values:'."\n" + ."\n" + .'- true: Disk encryption is used.'."\n" + .'- false: Disk encryption is not used.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Valid values:'."\n" + ."\n" + .'- cloud_ssd: standard SSD'."\n" + ."\n" + .'- cloud_efficiency: ultra disk', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + 'performanceLevel' => ['description' => 'The performance level of the ESSD. This parameter is required when diskType is cloud_essd. Valid values: PL1, PL2, and PL3.', 'type' => 'string', 'example' => 'PL1', 'title' => ''], + 'specInfo' => ['description' => 'The description of node specifications.', 'type' => 'string', 'example' => '1C 2G ', 'title' => ''], ], - 'diskType' => [ + 'title' => '', + 'example' => '', + ], + 'vpcInstanceId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1uag5jj38c****', 'title' => ''], + 'kibanaIPWhitelist' => [ + 'title' => '', + 'description' => 'The public network access whitelist for Kibana nodes of the cluster.', + 'type' => 'array', + 'items' => ['description' => 'The public network access whitelist for Kibana nodes of the cluster.', 'type' => 'string', 'example' => '"0.0.0.0/0"', 'title' => ''], + 'example' => '', + ], + 'kibanaPrivateIPWhitelist' => [ + 'title' => '', + 'description' => 'The private network access whitelist for Kibana nodes of the cluster.', + 'type' => 'array', + 'items' => ['description' => 'The private network access whitelist for Kibana nodes of the cluster.', 'type' => 'string', 'example' => '["192.168.XX.XX"]', 'title' => ''], + 'example' => '', + ], + 'publicIpWhitelist' => [ + 'title' => '', + 'description' => 'The public network access whitelist for the Elasticsearch cluster.', + 'type' => 'array', + 'items' => ['description' => 'The public network access whitelist for the Elasticsearch cluster.', 'type' => 'string', 'example' => '[ "0.0.0.0/0" ]', 'title' => ''], + 'example' => '', + ], + 'privateNetworkIpWhiteList' => [ + 'title' => '', + 'description' => 'The private network access whitelist for the Elasticsearch cluster.', + 'type' => 'array', + 'items' => ['description' => 'The private network access whitelist for the Elasticsearch cluster.', 'type' => 'string', 'example' => '["192.168.XX.XX/25"]', 'title' => ''], + 'example' => '', + ], + 'endTime' => ['description' => 'The expiration time of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1715826092044', 'title' => ''], + 'archType' => ['description' => 'The deployment mode and architecture type:'."\n" + .'exclusive: basic management and control'."\n" + .'public: cloud-native management and control', 'type' => 'string', 'example' => 'public', 'title' => ''], + 'domain' => ['description' => 'The internal endpoint of the instance.', 'type' => 'string', 'example' => 'es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com', 'title' => ''], + 'port' => ['description' => 'The access port of the instance.'."\n" + .'><notice>When the instance is being created or the instance status is abnormal, this value may be empty or 0.></notice>', 'type' => 'string', 'example' => '9200', 'title' => ''], + 'protocol' => ['description' => 'The access protocol. Valid values: HTTP and HTTPS.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'zoneCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], + 'zoneInfos' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'zoneId' => ['type' => 'string', 'example' => 'cn-hangzhou-i', 'description' => '', 'title' => ''], + 'status' => ['type' => 'string', 'example' => 'NORMAL', 'description' => '', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'cloud_ssd', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => ''], + 'Message' => ['title' => '', 'description' => 'Message', 'type' => 'string', 'example' => ''], + 'RequestId' => ['title' => '', 'description' => 'RequestId', 'type' => 'string', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Elasticsearch Instance List', + 'summary' => 'Queries the information about Elasticsearch instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' > The following response examples contain most of the parameters in the response. The actual response prevails. We recommend that you do not depend on obtaining these parameters in your program.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-06-12T08:42:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-07T06:21:23.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-10T03:21:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-04T07:17:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-10T04:08:37.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-27T11:53:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstance'], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"nodeAmount\\": 2,\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"status\\": \\"active\\",\\n \\"paymentType\\": \\"postpaid\\",\\n \\"domain\\": \\"es-cn-abc.elasticsearch.aliyuncs.com\\",\\n \\"description\\": \\"test\\",\\n \\"esVersion\\": \\"5.5.3_with_X-Pack\\",\\n \\"instanceId\\": \\"es-cn-abc\\",\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.xlarge\\",\\n \\"disk\\": 40,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"kibanaConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 1,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n }\\n },\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateInstance', - 'description' => 'es-cn-n6w1ptcb30009\\*\\*\\*\\*'."\n", - 'requestParamsDescription' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n", - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"Result\\": [\\n {\\n \\"advancedDedicateMaster\\": false,\\n \\"nodeAmount\\": 2,\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"status\\": \\"active\\",\\n \\"dedicateMaster\\": false,\\n \\"serviceVpc\\": true,\\n \\"paymentType\\": \\"postpaid\\",\\n \\"resourceGroupId\\": \\"rg-aekzvowej3i****\\",\\n \\"postpaidServiceStatus\\": \\"active\\",\\n \\"description\\": \\"es-cn-abc\\",\\n \\"esVersion\\": \\"6.7_with_X-Pack\\",\\n \\"isNewDeployment\\": \\"true\\",\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"instanceId\\": \\"es-cn-v641a0ta3000g****\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"dev\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n [\\n {\\n \\"configType\\": \\"aliVersion\\",\\n \\"aliVersion\\": \\"ali1.3.0\\"\\n }\\n ]\\n ],\\n \\"clientNodeConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_efficiency\\",\\n \\"specInfo\\": \\"1C 2G\\"\\n },\\n \\"elasticDataNodeConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"kibanaConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 1,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-abc\\",\\n \\"vsArea\\": \\"cn-hangzhou-e\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-def\\",\\n \\"whiteIpGroupList\\": [\\n {\\n \\"groupName\\": \\"default\\",\\n \\"whiteIpType\\": \\"PUBLIC_KIBANA\\",\\n \\"ips\\": [\\n \\"[\\\\\\"0.0.0.0\\\\\\", \\\\\\"127.0.XX.XX\\\\\\"]\\"\\n ]\\n }\\n ]\\n },\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 50,\\n \\"diskEncryption\\": false,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"performanceLevel\\": \\"PL1\\",\\n \\"specInfo\\": \\"1C 2G \\"\\n },\\n \\"vpcInstanceId\\": \\"vpc-bp1uag5jj38c****\\",\\n \\"kibanaIPWhitelist\\": [\\n \\"\\\\\\"0.0.0.0/0\\\\\\"\\"\\n ],\\n \\"kibanaPrivateIPWhitelist\\": [\\n \\"[\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"publicIpWhitelist\\": [\\n \\"[ \\\\\\"0.0.0.0/0\\\\\\" ]\\"\\n ],\\n \\"privateNetworkIpWhiteList\\": [\\n \\"[\\\\\\"192.168.XX.XX/25\\\\\\"]\\"\\n ],\\n \\"endTime\\": 1715826092044,\\n \\"archType\\": \\"public\\",\\n \\"domain\\": \\"es-cn-nif1q8auz0005****.elasticsearch.aliyuncs.com\\",\\n \\"port\\": \\"9200\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"zoneCount\\": 1,\\n \\"zoneInfos\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-i\\",\\n \\"status\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], - 'GetSuggestShrinkableNodes' => [ - 'summary' => 'Call GetSuggestShrinkableNodes to specify the type and number of nodes to obtain the nodes that can be removed.', - 'path' => '/openapi/instances/{InstanceId}/suggest-shrinkable-nodes', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInstanceHistoryEvents' => [ + 'summary' => 'Queries the list of hardware O&M events triggered by an Elasticsearch cluster.', + 'path' => '/openapi/events', + 'methods' => ['post'], + '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' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-2r42l7a740005****', 'title' => ''], ], [ - 'name' => 'nodeType', + 'name' => 'nodeIP', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of removing nodes. WORKER indicates hot node and WORKER_WARM indicates warm node.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WORKER', - ], + 'schema' => ['description' => 'The IP address of the node that triggered the event.', 'type' => 'string', 'required' => false, 'example' => '10.1.xx.xx', 'title' => ''], ], [ - 'name' => 'count', + 'name' => 'eventType', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The number of nodes that you want to remove.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + 'description' => 'The event type.', + 'type' => 'array', + 'items' => ['description' => 'The event type. Separate multiple types with commas (,). Valid values:'."\n" + ."\n" + .'- ECS:AUTO_RESTART: Automatic restart of an ECS node.'."\n" + .'- Instance:InstanceFailure.Reboot:Executed: ECS instance reboot completed (instance error).'."\n" + .'- Instance:InstanceFailure.Reboot:Executing: ECS instance reboot started (instance error).'."\n" + .'- Instance:SystemFailure.Reboot:Executed: ECS instance reboot completed (system error).'."\n" + .'- Instance:SystemFailure.Reboot:Executing: ECS instance reboot started (system error).'."\n" + .'- Instance:SystemFailure.Reboot:Failed: ECS instance reboot failed (system error).', 'type' => 'string', 'required' => false, 'example' => 'Instance:InstanceFailure.Reboot:Executed', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ignoreStatus', + 'name' => 'eventLevel', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'Specifies whether to ignore the instance status. Default value: false.'."\n", - 'type' => 'boolean', + 'description' => 'The event level.', + 'type' => 'array', + 'items' => ['description' => 'The event level. Separate multiple levels with commas (,). Valid values:'."\n" + ."\n" + .'- INFO: information'."\n" + .'- WARN: warning'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'required' => false, 'example' => 'INFO,WARN', 'title' => ''], 'required' => false, - 'example' => 'false', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - 'Result' => [ - 'description' => 'The return results.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'port' => [ - 'description' => 'The access port number of the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9200', - ], - 'host' => [ - 'description' => 'The IP address of the node.'."\n", - 'type' => 'string', - 'example' => '192.168.**.**', - ], - ], - ], - ], - ], - ], + [ + 'name' => 'eventCreateStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time for querying by event creation time. Specify a timestamp in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1645596516000', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n {\\n \\"port\\": 9200,\\n \\"host\\": \\"192.168.**.**\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetSuggestShrinkableNodes', - 'requestParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ValidateShrinkNodes' => [ - 'summary' => 'Checks whether specific nodes can be removed from a specified Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/validate-shrink-nodes', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'eventCreateEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for querying by event creation time. Specify a timestamp in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1645596516000', 'title' => ''], ], - ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', + [ + 'name' => 'eventExecuteStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time for querying by event execution time. Specify a timestamp in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1645596516000', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '2'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'name' => 'eventExecuteEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for querying by event execution time. Specify a timestamp in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1645596516000', 'title' => ''], ], [ - 'name' => 'nodeType', + 'name' => 'eventFinashStartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Returned results:'."\n" - ."\n" - .'* true: can be scaled in'."\n" - .'* false: cannot be scaled in.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WORKER', - ], + 'schema' => ['description' => 'The start time for querying by event completion time. Specify a timestamp in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1645596516000', 'title' => ''], ], [ - 'name' => 'ignoreStatus', + 'name' => 'eventFinashEndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The end time for querying by event completion time. Specify a timestamp in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1645596516000', 'title' => ''], ], [ - 'name' => 'count', + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The starting document offset. The value must be a non-negative integer. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'size', 'in' => 'query', + 'schema' => ['description' => 'The number of events to return. The value must be a non-negative integer. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'eventCycleStatus', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The lifecycle status of the event.', + 'type' => 'array', + 'items' => ['description' => 'The lifecycle status of the event. Separate multiple statuses with commas (,). Valid values:'."\n" + ."\n" + .'- FAILED: failed'."\n" + .'- EXECUTED: executed'."\n" + .'- EXECUTING: executing.', 'type' => 'string', 'required' => false, 'example' => 'EXECUTED,FAILED', 'title' => ''], 'required' => false, - 'example' => '2', + 'title' => '', + 'example' => '', ], ], [ @@ -16818,880 +14299,879 @@ 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body parameters.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The request object.', 'type' => 'object', 'properties' => [ - 'nodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'WORKER', - ], - 'host' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.xx', - ], - 'port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9200', - ], - 'zoneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai-c', - ], - 'hostName' => [ - 'description' => '', + 'sortField' => [ + 'title' => '', + 'description' => 'The field by which the results are sorted. Valid values:'."\n" + ."\n" + .'- event_time: event creation time'."\n" + .'- event_execute_start_time: event execution time'."\n" + .'- event_execute_finish_time: event completion time.', 'type' => 'string', + 'example' => 'event_time', + 'enum' => ['eventCreateTime', 'eventExecuteTime', 'eventFinishTime'], 'required' => false, - 'example' => 'es-cn-pl32xxxxxxx-data-f-1', ], + 'desc' => ['title' => '', 'description' => 'Specifies whether to sort in descending order. Valid values:'."\n" + ."\n" + .'- true (default): Yes.'."\n" + .'- false: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D1A6830A-F59B-4E05-BFAC-9496C21DBBA7', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'X-Total-Failed' => ['description' => 'The total number of failures.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'X-Total-Success' => ['description' => 'The total number of successes.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The result object.', + 'type' => 'object', + 'properties' => [ + 'eventCreateTime' => ['description' => 'The event creation time.', 'type' => 'string', 'example' => '2017-12-07T00:00:00Z', 'title' => ''], + 'eventLevel' => ['description' => 'The event level. Valid values:'."\n" + .'- INFO: information'."\n" + .'- WARN: warning'."\n" + .'- CRITICAL: critical.', 'type' => 'string', 'example' => 'INFO', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-cn-2r42l7a740005****', 'title' => ''], + 'eventFinashTime' => ['description' => 'The event completion time.', 'type' => 'string', 'example' => '2017-12-07T00:00:00Z', 'title' => ''], + 'eventCycleStatus' => ['description' => 'The event status. Valid values:'."\n" + .'- FAILED: failed'."\n" + .'- EXECUTED: executed'."\n" + .'- EXECUTING: executing.', 'type' => 'string', 'example' => 'EXECUTED', 'title' => ''], + 'regionId' => ['description' => 'The region ID where the event occurred.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'nodeIP' => ['description' => 'The IP address of the node that generated the event.', 'type' => 'string', 'example' => '10.1.xx.xx', 'title' => ''], + 'eventExecuteTime' => ['description' => 'The event execution time.', 'type' => 'string', 'example' => '2017-12-07T00:00:00Z', 'title' => ''], + 'eventType' => ['description' => 'The event type. Valid values:'."\n" + .'- ECS:AUTO_RESTART: Automatic restart of an ECS node.'."\n" + .'- Instance:InstanceFailure.Reboot:Executed: ECS instance reboot completed (instance error).'."\n" + .'- Instance:InstanceFailure.Reboot:Executing: ECS instance reboot started (instance error).'."\n" + .'- Instance:SystemFailure.Reboot:Executed: ECS instance reboot completed (system error).'."\n" + .'- Instance:SystemFailure.Reboot:Executing: ECS instance reboot started (system error).'."\n" + .'- Instance:SystemFailure.Reboot:Failed: ECS instance reboot failed (system error).', 'type' => 'string', 'example' => 'ECS:AUTO_RESTART', 'title' => ''], + 'ecsId' => ['description' => 'The ECS instance ID.', 'type' => 'string', 'example' => 'i-2ze8s9cjdf2cv969****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'WORKER'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ShrinkNode' => [ - 'summary' => 'Removes nodes from an Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/actions/shrink', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1A6830A-F59B-4E05-BFAC-9496C21DBBA7\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 15,\\n \\"X-Total-Failed\\": 2,\\n \\"X-Total-Success\\": 13\\n },\\n \\"Result\\": [\\n {\\n \\"eventCreateTime\\": \\"2017-12-07T00:00:00Z\\",\\n \\"eventLevel\\": \\"INFO\\",\\n \\"instanceId\\": \\"es-cn-2r42l7a740005****\\",\\n \\"eventFinashTime\\": \\"2017-12-07T00:00:00Z\\",\\n \\"eventCycleStatus\\": \\"EXECUTED\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"nodeIP\\": \\"10.1.xx.xx\\",\\n \\"eventExecuteTime\\": \\"2017-12-07T00:00:00Z\\",\\n \\"eventType\\": \\"ECS:AUTO_RESTART\\",\\n \\"ecsId\\": \\"i-2ze8s9cjdf2cv969****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListInstanceHistoryEvents', + 'changeSet' => [ + ['createdAt' => '2022-12-16T09:44:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-21T10:21:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceHistoryEvents'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListInstanceHistoryEvents', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListInstanceIndices' => [ + 'summary' => 'Filters system indexes from the index list of a cluster.', + 'path' => '/openapi/instances/{InstanceId}/indices', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-tl329rbpc0001****', 'title' => ''], ], [ - 'name' => 'nodeType', + 'name' => 'all', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WORKER', - ], + 'schema' => ['description' => 'Specifies whether to retrieve all indexes. Valid values:'."\n" + ."\n" + .'- true: Returns the index list that includes system indexes.'."\n" + ."\n" + .'- false (default): Returns the index list that excludes system indexes.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The index name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'log-0001', 'title' => ''], ], [ - 'name' => 'ignoreStatus', + 'name' => 'isManaged', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to display only managed indexes. Valid values:'."\n" + ."\n" + .'- true: Displays only managed indexes.'."\n" + ."\n" + .'- false (default): Displays all indexes.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'count', + 'name' => 'isOpenstore', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'Specifies whether to display only OpenStore cold-phase indexes. Valid values:'."\n" + ."\n" + .'- true: Displays only OpenStore cold-phase indexes.'."\n" + ."\n" + .'- false (default): Displays all indexes.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'host' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.xx', - ], - 'zoneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai-c', - ], - 'nodeType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'WORKER', - ], - 'port' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '9200', - ], - 'hostName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-pl32xxxxxxx-data-f-1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the instance list. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page for paging. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Managed-StorageSize' => ['description' => 'The total size of managed indexes in the cloud. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '18093942932', 'title' => ''], + 'X-Managed-Count' => ['description' => 'The total number of managed indexes in the cloud.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'X-OSS-StorageSize' => ['description' => 'The total size of OpenStore cold-phase indexes for the instance. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '9093942932', 'title' => ''], + 'X-OSS-Count' => ['description' => 'The total number of OpenStore cold-phase indexes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', + 'Result' => [ + 'description' => 'The index list details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'phase' => ['description' => 'The current storage lifecycle phase. Valid values:'."\n" + ."\n" + .'- warm: Warm phase.'."\n" + ."\n" + .'- cold: Cold phase.'."\n" + ."\n" + .'- hot: Hot phase.'."\n" + ."\n" + .'- delete: Delete phase.'."\n" + ."\n" + .'> If this parameter is empty, the index is not managed by a lifecycle policy.', 'type' => 'string', 'example' => 'warm', 'title' => ''], + 'managedStatus' => ['description' => 'The managed status of the index. Valid values:'."\n" + ."\n" + .'- following: Managed.'."\n" + ."\n" + .'- closing: Being unmanaged.'."\n" + ."\n" + .'- closed: Not managed.', 'type' => 'string', 'example' => 'closing', 'title' => ''], + 'ilmExplain' => ['description' => 'The full lifecycle status of the index.', 'type' => 'string', 'example' => '{ "indices": { ".ds-console-2021.08.18-000002": { "index": ".ds-console-2021.08.18-000002", "managed": true, "policy": "console", "lifecycle_date_millis": 1629277498775, "age": "2.64h", "phase": "hot", "phase_time_millis": 1629277450334, "action": "complete", "action_time_millis": 1629278605586, "step": "complete", "step_time_millis": 1629278605586, "phase_execution": { "policy": "console", "phase_definition": { "min_age": "0s", "actions": { "rollover": { "max_size": "1gb", "max_age": "1d", "max_docs": 10000 }, "set_priority": { "priority": 1000 } } }, "version": 1, "modified_date_in_millis": 1629277370953 } } } }', 'title' => ''], + 'size' => ['description' => 'The total storage space occupied by the index. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '49298589', 'title' => ''], + 'createTime' => ['description' => 'The time when the index list was queried.', 'type' => 'string', 'example' => '2021-01-11T05:49:41.114Z', 'title' => ''], + 'name' => ['description' => 'The index name.', 'type' => 'string', 'example' => '.kibana_task_manager_1', 'title' => ''], + 'health' => ['description' => 'The health status of the index. Valid values:'."\n" + ."\n" + .'- green: Healthy.'."\n" + ."\n" + .'- yellow: Warning.'."\n" + ."\n" + .'- red: Abnormal.', 'type' => 'string', 'example' => 'green', 'title' => ''], + 'isManaged' => ['description' => 'This parameter is deprecated and can be ignored.', 'type' => 'string', 'example' => 'false', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Headers\\": {\\n \\"X-Managed-StorageSize\\": 18093942932,\\n \\"X-Managed-Count\\": 15,\\n \\"X-OSS-StorageSize\\": 9093942932,\\n \\"X-OSS-Count\\": 5\\n },\\n \\"Result\\": [\\n {\\n \\"phase\\": \\"warm\\",\\n \\"managedStatus\\": \\"closing\\",\\n \\"ilmExplain\\": \\"{ \\\\\\"indices\\\\\\": { \\\\\\".ds-console-2021.08.18-000002\\\\\\": { \\\\\\"index\\\\\\": \\\\\\".ds-console-2021.08.18-000002\\\\\\", \\\\\\"managed\\\\\\": true, \\\\\\"policy\\\\\\": \\\\\\"console\\\\\\", \\\\\\"lifecycle_date_millis\\\\\\": 1629277498775, \\\\\\"age\\\\\\": \\\\\\"2.64h\\\\\\", \\\\\\"phase\\\\\\": \\\\\\"hot\\\\\\", \\\\\\"phase_time_millis\\\\\\": 1629277450334, \\\\\\"action\\\\\\": \\\\\\"complete\\\\\\", \\\\\\"action_time_millis\\\\\\": 1629278605586, \\\\\\"step\\\\\\": \\\\\\"complete\\\\\\", \\\\\\"step_time_millis\\\\\\": 1629278605586, \\\\\\"phase_execution\\\\\\": { \\\\\\"policy\\\\\\": \\\\\\"console\\\\\\", \\\\\\"phase_definition\\\\\\": { \\\\\\"min_age\\\\\\": \\\\\\"0s\\\\\\", \\\\\\"actions\\\\\\": { \\\\\\"rollover\\\\\\": { \\\\\\"max_size\\\\\\": \\\\\\"1gb\\\\\\", \\\\\\"max_age\\\\\\": \\\\\\"1d\\\\\\", \\\\\\"max_docs\\\\\\": 10000 }, \\\\\\"set_priority\\\\\\": { \\\\\\"priority\\\\\\": 1000 } } }, \\\\\\"version\\\\\\": 1, \\\\\\"modified_date_in_millis\\\\\\": 1629277370953 } } } }\\",\\n \\"size\\": 49298589,\\n \\"createTime\\": \\"2021-01-11T05:49:41.114Z\\",\\n \\"name\\": \\".kibana_task_manager_1\\",\\n \\"health\\": \\"green\\",\\n \\"isManaged\\": \\"false\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List indexes of a cluster', + 'description' => 'The ListInstanceIndices operation is applicable only to Elasticsearch instances that have the indexing service enabled. Query index information by using the Elasticsearch API. For more information, see [cat indices API'."\n" + .'](https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceIndices'], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListInstanceIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'instances', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ShrinkNode', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpgradeEngineVersion' => [ - 'summary' => 'Upgrades the version or kernel of an Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/actions/upgrade-version', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListKibanaPlugins' => [ + 'summary' => 'Retrieves the list of plugins installed on the Kibana node of an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/kibana-plugins', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '64397', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchWSK8NP'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-oew1q8bev0002****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'page', 'in' => 'query', - 'schema' => [ - 'title' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。', - 'description' => 'The moderation results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The page number of the instance list. Default value: 1.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'dryRun', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'title' => '是否进行升级前校验。true表示校验，false表示不校验。'."\n" - .'注意：版本升级校验涉及集群YML、插件配置、集群状态、索引、资源等检查，强烈建议升级前进行前置校验，否则可能带来升级问题。', - 'description' => 'The monitoring type. Valid values:'."\n" - ."\n" - .'* checkClusterHealth: Cluster Health Status'."\n" - .'* checkConfigCompatible: Configuration Compatibility Status'."\n" - .'* checkClusterResource: resource space status'."\n" - .'* checkClusterSnapshot: Whether a snapshot exists'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The number of entries per page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'version' => [ - 'title' => '升级后的版本', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6.7', - ], - 'type' => [ - 'title' => '升级类型。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'engineVersion', - 'enum' => [ - 'engineVersion', - 'aliVersion', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '11234B4A-34CE-473B-8E61-AD95702E****', 'title' => ''], + 'Headers' => [ + 'description' => 'The request headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'plugins' => [ + 'Result' => [ + 'description' => 'The plugin information returned by the current request.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'name' => [ - 'title' => '插件名称', - 'type' => 'string', - ], - 'version' => [ - 'title' => '插件对应的ES版本如7.16.2', - 'type' => 'string', - ], - 'fileVersion' => [ - 'title' => '插件的fileVersion 参见ListUserPlugin返回结果', - 'type' => 'string', - ], - 'enable' => [ - 'title' => 'true 安装插件 false 卸载插件', - 'type' => 'string', - ], + 'specificationUrl' => ['description' => 'The URL of the plugin introduction. The value can be null.', 'type' => 'string', 'example' => 'https://xxxx', 'title' => ''], + 'name' => ['description' => 'The plugin name.', 'type' => 'string', 'example' => 'bsearch_querybuilder ', 'title' => ''], + 'description' => ['description' => 'The plugin description.', 'type' => 'string', 'example' => 'Customize DSL statements to query data.', 'title' => ''], + 'state' => ['description' => 'The installation status of the plugin.', 'type' => 'string', 'example' => 'INSTALLED', 'title' => ''], + 'source' => ['description' => 'The source of the plugin.', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11234B4A-34CE-473B-8E61-AD95702E****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 3\\n },\\n \\"Result\\": [\\n {\\n \\"specificationUrl\\": \\"https://xxxx\\",\\n \\"name\\": \\"bsearch_querybuilder\\\\t\\",\\n \\"description\\": \\"Customize DSL statements to query data.\\",\\n \\"state\\": \\"INSTALLED\\",\\n \\"source\\": \\"SYSTEM\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List kibana node plugins', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:25.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListKibanaPlugins'], + ], + ], + 'ramActions' => [ [ - 'name' => 'updateStrategy', - 'in' => 'query', - 'schema' => [ - 'title' => 'blue_green: 蓝绿变更'."\n" - .'normal： 原地变更'."\n" - .'intelligent： 智能变更', - 'type' => 'string', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListKibanaPlugins', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], ], + ], + 'ListKibanaPvlNetwork' => [ + 'summary' => 'Queries the details of the Kibana private network connection.', + 'path' => '/openapi/instances/{InstanceId}/actions/get-kibana-private', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json', 'application/x-www-form-urlencoded'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203895', + 'abilityTreeNodes' => ['FEATUREelasticsearch2PSU4E'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-vo93ngti8000a****', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The verification information.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC*****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***'], 'Result' => [ - 'description' => 'The type of the error. Valid values:'."\n" - ."\n" - .'* clusterStatus: the health status of the cluster.'."\n" - .'* clusterConfigYml: Cluster YML File'."\n" - .'* clusterConfigPlugins: Cluster Configuration File'."\n" - .'* clusterResource: cluster resources'."\n" - .'* clusterSnapshot: cluster snapshot'."\n", + 'description' => 'The array of result objects.', 'type' => 'array', 'items' => [ + 'description' => 'The private network connection information.', 'type' => 'object', 'properties' => [ - 'validateType' => [ - 'description' => 'The error code returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'checkClusterHealth', - ], - 'validateResult' => [ - 'description' => 'The error message returned.'."\n", + 'endpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'example' => 'es-cn-xxdjfia****-kibana', 'title' => ''], + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtma*****', 'title' => ''], + 'vSwitchIdsZone' => [ + 'description' => 'The vSwitch and zone information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'errorType' => [ - 'description' => 'The verification is passed. Valid values:'."\n" - ."\n" - .'* success: through'."\n" - .'* failed: failed'."\n", - 'type' => 'string', - 'example' => 'clusterStatus', - ], - 'errorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ClusterStatusNotHealth', - ], - 'errorMsg' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The cluster status is not health', - ], + 'zoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-e', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-xdefafns***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'status' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', + 'securityGroups' => [ + 'description' => 'The list of security groups.', + 'type' => 'array', + 'items' => ['description' => 'The security group.', 'type' => 'string', 'example' => 'sg-2zegcwar0pq4a****', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'endpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'ep-bp1tah7zbrwmkjef****', 'title' => ''], + 'endpointStatus' => ['description' => 'The endpoint status. Valid values:'."\n" + ."\n" + .'- Disconnected: not connected.'."\n" + ."\n" + .'- Connected: connected.', 'type' => 'string', 'example' => 'Connected', 'title' => ''], + 'createTime' => ['description' => 'The time when the Kibana private network connection was created.', 'type' => 'string', 'example' => '2024-03-07T06:26:28Z', 'title' => ''], + 'pvlId' => ['description' => 'The Kibana private network connection ID.', 'type' => 'string', 'example' => 'es-cn-27a3mul6l***-kibana-internal', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"endpointName\\": \\"es-cn-xxdjfia****-kibana\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"vSwitchIdsZone\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-e\\",\\n \\"vswitchId\\": \\"vsw-xdefafns***\\"\\n }\\n ],\\n \\"securityGroups\\": [\\n \\"sg-2zegcwar0pq4a****\\"\\n ],\\n \\"endpointId\\": \\"ep-bp1tah7zbrwmkjef****\\",\\n \\"endpointStatus\\": \\"Connected\\",\\n \\"createTime\\": \\"2024-03-07T06:26:28Z\\",\\n \\"pvlId\\": \\"es-cn-27a3mul6l***-kibana-internal\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'View kibana private network connection information', + 'description' => 'This API operation supports only cloud-native instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListKibanaPvlNetwork'], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC*****\\",\\n \\"Result\\": [\\n {\\n \\"validateType\\": \\"checkClusterHealth\\",\\n \\"validateResult\\": [\\n {\\n \\"errorType\\": \\"clusterStatus\\",\\n \\"errorCode\\": \\"ClusterStatusNotHealth\\",\\n \\"errorMsg\\": \\"The cluster status is not health\\"\\n }\\n ],\\n \\"status\\": \\"success\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpgradeEngineVersion', - 'description' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n", - 'requestParamsDescription' => "\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateInstanceSettings' => [ - 'summary' => 'Call UpdateInstanceSettings to update the YML configuration of a specified instance.', - 'path' => '/openapi/instances/{InstanceId}/instance-settings', - 'methods' => [ - 'patch', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListLogstash' => [ + 'path' => '/openapi/logstashes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '64413', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the instance list. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'updateStrategy', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The number of entries per page for paging. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'description', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The instance name. Fuzzy match is supported. For example, if you search for an instance named abc, instances named abc, abcde, xyabc, and xabcy may all be returned.', 'type' => 'string', 'required' => false, 'example' => 'ls-cn-abc', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'title' => '', - 'type' => 'object', - 'properties' => [ - 'esConfig' => [ - 'title' => '对于对象类型，指定待更新的 YML 参数的值。', - 'type' => 'object', - 'additionalProperties' => [ - 'title' => '指定待更新的 YML 参数的key', - 'type' => 'string', - ], - ], - ], - 'docRequired' => false, - ], + 'name' => 'instanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ls-cn-n6w1o5jq****', 'title' => ''], ], [ - 'name' => 'force', + 'name' => 'version', 'in' => 'query', - 'schema' => [ - 'title' => '是否强制变更', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The instance version.', 'type' => 'string', 'required' => false, 'example' => '5.5.3_with_X-Pack', 'title' => ''], + ], + [ + 'name' => 'resourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfm2h5vbzd****', 'title' => ''], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'schema' => ['description' => 'The instance tags.', 'type' => 'string', 'required' => false, 'example' => '[{"tagKey":"key1","tagValue":"value1"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BB1C321A-211C-4FD7-BD8B-7F2FABE2****', - ], - ], - ], - ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AC442F2F-5068-4434-AA21-E78947A9****', 'title' => ''], + 'Headers' => [ + 'description' => 'The request header information.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'type' => 'string', + 'Result' => [ + 'description' => 'The list of instances returned by the current request.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'paymentType' => ['description' => 'The billing method of the instance. Valid values: prepaid (subscription) and postpaid (pay-as-you-go).', 'type' => 'string', 'example' => 'postpaid', 'title' => ''], + 'nodeAmount' => ['description' => 'The number of nodes in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'description' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'ls-cn-abc', 'title' => ''], + 'createdAt' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2018-07-13T03:58:07.253Z', 'title' => ''], + 'status' => ['description' => 'The status of the instance. Valid values: active (Normal), activating (Taking Effect), inactive (Frozen), and invalid (Expired).', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'updatedAt' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2018-07-18T10:10:04.484Z', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ls-cn-n6w1o5jq****', 'title' => ''], + 'version' => ['description' => 'The instance version. Currently, only 6.7.0_with_X-Pack and 7.4.0_with_X-Pack are supported.', 'type' => 'string', 'example' => '6.7.0_with_X-Pack', 'title' => ''], + 'Tags' => [ + 'description' => 'The instance tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'nodeSpec' => [ + 'description' => 'The configuration information of data nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The instance specification.', 'type' => 'string', 'example' => 'logstash.n4.small', 'title' => ''], + 'disk' => ['description' => 'The disk size of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'diskEncryption' => ['description' => 'Indicates whether disk encryption is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'diskType' => ['description' => 'The disk type.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'networkConfig' => [ + 'description' => "\n" + .'The network configuration.', + 'type' => 'object', + 'properties' => [ + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-abc', 'title' => ''], + 'vsArea' => ['description' => 'The zone where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-*', 'title' => ''], + 'type' => ['description' => 'The network type. Currently, only Virtual Private Cloud (VPC) is supported.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-def', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'resourceGroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'endTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '4928745600000', 'description' => '', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BB1C321A-211C-4FD7-BD8B-7F2FABE2****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateInstanceSettings', - 'description' => 'When you call this operation, take note of the following items:'."\n" - ."\n" - .'When the instance is in the activating, invalid, or inactive state, you cannot update the configuration.'."\n", - 'requestParamsDescription' => '## RequestBody'."\n" - ."\n" - .'The **esConfig** parameter needs to be filled in the RequestBody to specify the YML parameters and values to be updated. Example: '."\n" + 'title' => 'List logstash instances', + 'summary' => 'Displays the details of all or specified Logstash instances in a list.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The response also contains the following parameters.'."\n" + .'| Name | Type | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| enablePublic | Boolean | false | Indicates whether public network access is enabled. Default value: false.|'."\n" + .'| commodityCode | String | elasticsearch_logstash_post |The commodity code.|'."\n" + .'| endTime | Long | 4749897600000 | The expiration time of a subscription instance.|'."\n" + .'| clusterTasks | Array | [] | The task list of the instance.|'."\n" + .'| resourceGroupId | String | rg-acfm2h5vbzd**** | The ID of the resource group to which the instance belongs.|'."\n" + .'| zoneCount | Integer | 1 | The number of zones for the instance.|'."\n" + .'| protocol | String | HTTP | The access protocol of the instance.|'."\n" + .'| zoneInfos | Array | | The zone information.|'."\n" + .'| └zoneId| String | ap-southeast-1-i |The zone ID.|'."\n" + .'| └status | String | NORMAL |The zone status. Valid values: **ISOLATION** (offline) and **NORMAL** (normal).|'."\n" + .'| instanceType | String | logstash | The instance type.|'."\n" + .'| inited | Boolean | true | Indicates whether the instance has been initialized.|'."\n" + .'| config | Array | [] |The instance configuration.|'."\n" + .'| endpointList | Array | | The node information.|'."\n" + .'| └host | String | 172.16.xx.xx |The IP address of the node.|'."\n" + .'| └port | Integer | 9200 |The access port of the node.|'."\n" + .'| └zoneId | String | ap-southeast-1-i | The zone ID of the node.|.'."\n" ."\n" - .'```'."\n" - .'{'."\n" - .' "esConfig": {'."\n" - .' "thread_pool.bulk.queue_size": 500'."\n" - .' }'."\n" - .'}'."\n" - .'```', + .'> └ indicates a child parameter.', 'extraInfo' => ' ', - ], - 'UpdateHotIkDicts' => [ - 'summary' => 'null', - 'path' => '/openapi/instances/{InstanceId}/ik-hot-dict', - 'methods' => [ - 'put', + 'changeSet' => [ + ['createdAt' => '2022-12-16T09:44:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-20T12:32:58.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLogstash'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'elasticsearch:ListLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC442F2F-5068-4434-AA21-E78947A9****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"Result\\": [\\n {\\n \\"paymentType\\": \\"postpaid\\",\\n \\"nodeAmount\\": 2,\\n \\"description\\": \\"ls-cn-abc\\",\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"status\\": \\"active\\",\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"instanceId\\": \\"ls-cn-n6w1o5jq****\\",\\n \\"version\\": \\"6.7.0_with_X-Pack\\",\\n \\"Tags\\": [\\n {\\n \\"TagValue\\": \\"dev\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ],\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"logstash.n4.small\\",\\n \\"disk\\": 50,\\n \\"diskEncryption\\": false,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-abc\\",\\n \\"vsArea\\": \\"cn-hangzhou-*\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-def\\"\\n },\\n \\"resourceGroupId\\": \\"\\",\\n \\"endTime\\": 4928745600000\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListLogstashLog' => [ + 'summary' => 'Queries the logs of a Logstash instance.', + 'path' => '/openapi/logstashes/{InstanceId}/search-log', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-oew1q8bev0002****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-v0h1kzca****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'type', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The log type. Valid values:'."\n" + ."\n" + .'- LOGSTASH_INSTANCE_LOG: main log.'."\n" + .'- SEARCHSLOW: searching slow log.'."\n" + .'- INDEXINGSLOW: indexing slow log.'."\n" + .'- JVMLOG: GC log.'."\n" + .'- LOGSTASH_DEBUG_LOG: debug log.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'LOGSTASH_INSTANCE_LOG', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'query', + 'in' => 'query', + 'schema' => ['description' => 'The keyword to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'host:10.7.xx.xx AND level:info AND content:opening', 'title' => ''], + ], + [ + 'name' => 'beginTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query logs. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1531910852074', 'title' => ''], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query logs. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1531910852074', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the instance list. Default value: 1. Minimum value: 1. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page for a paged query. Default value: 20. Minimum value: 1. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -17699,223 +15179,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the dictionary file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'sourceType' => [ - 'description' => 'The source type of the dictionary file. Valid values:'."\n" - ."\n" - .'* OSS'."\n" - .'* ORIGIN'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'name' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'example' => 'deploy_0.dic', - ], - 'type' => [ - 'description' => 'The type of the dictionaries. Valid values:'."\n" - ."\n" - .'* MAIN: IK main dictionary'."\n" - .'* STOP: IK stopword list'."\n", - 'type' => 'string', - 'example' => 'MAIN', - ], + 'level' => ['description' => 'The log level. Valid values: trace, debug, info, warn, and error. GC logs do not have a level.', 'type' => 'string', 'example' => 'info', 'title' => ''], + 'content' => ['description' => 'The detailed content of the log.', 'type' => 'string', 'example' => '[logstash.outputs.fileextend] Opening file {:path=>\\"/ssd/1/ls-cn-v0h1kzca****/logstash/logs/debug/test\\"}', 'title' => ''], + 'timestamp' => ['description' => 'The timestamp when the log was generated. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1531985112420', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ls-cn-v0h1kzca****', 'title' => ''], + 'host' => ['description' => 'The IP address of the node that generated the log.', 'type' => 'string', 'example' => '192.168.xx.xx', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****\\",\\n \\"Result\\": [\\n {\\n \\"level\\": \\"info\\",\\n \\"content\\": \\"[logstash.outputs.fileextend] Opening file {:path=>\\\\\\\\\\\\\\"/ssd/1/ls-cn-v0h1kzca****/logstash/logs/debug/test\\\\\\\\\\\\\\"}\\",\\n \\"timestamp\\": 1531985112420,\\n \\"instanceId\\": \\"ls-cn-v0h1kzca****\\",\\n \\"host\\": \\"192.168.xx.xx\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query logstash instance logs', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The response also contains the following parameters.'."\n" + .'| Name | Type | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| Result | Struct | | The returned result.|'."\n" + .'| └time | String | 2020-07-22T16:58:00.506Z | The time when the log was generated.|'."\n" + .'| Headers | Struct | | The response header information.|'."\n" + .'| └X-Total-Count | Integer | 1 | The number of returned logs.|'."\n" + ."\n" + .'> └ indicates a child parameter.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:24.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLogstashLog'], ], + ], + 'ramActions' => [ [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], - ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], - ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListLogstashLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 6,\\n \\"sourceType\\": \\"OSS\\",\\n \\"name\\": \\"deploy_0.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateHotIkDicts', - 'description' => 'Before you call this operation, take note of the following items:'."\n" - ."\n" - .'* If the dictionary file is stored in an Object Storage Service (OSS) bucket, you must make sure that the access control list (ACL) of the bucket is public read.'."\n" - .'* If you do not set sourceType to ORIGIN for an uploaded dictionary file, the file will be deleted after you call this operation.'."\n", - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body.'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|dic\\_0.dic|The name of the dictionary file that you want to upload.|'."\n" - .'|ossObject|Array|Yes||The information about the dictionary file. This parameter is required if you set sourceType to OSS.|'."\n" - .'|└bucketName|String|Yes|search-cloud-test-cn-\\*\\*\\*\\*|The name of the OSS bucket that stores the dictionary file.|'."\n" - .'|└key|String|Yes|oss/dic\\_0.dic|The path of the dictionary file in the OSS bucket.|'."\n" - .'|sourceType|String|Yes|OSS|The source type of the dictionary file. Valid values: OSS and ORIGIN.**Note**:Your on-premises files can be referenced through OSS only after you upload the files to OSS.If you do not set sourceType to ORIGIN for an uploaded dictionary file, the file will be deleted after you call this operation.|'."\n" - .'|type|String|Yes|MAIN|The type of the dictionaries that you want to update. Valid values: MAIN and STOP.|'."\n" - ."\n\n" - .'**Note**└ indicates a child parameter.'."\n" - ."\n" - .'Sample code:'."\n" - ."\n" - .'```'."\n" - .'['."\n" - .' {'."\n" - .' "name":"deploy_0.dic",'."\n" - .' "ossObject":{'."\n" - .' "bucketName":"search-cloud-test-cn-****",'."\n" - .' "key":"user_dict/dict_0.dic"'."\n" - .' },'."\n" - .' "sourceType":"OSS",'."\n" - .' "type":"MAIN"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"deploy_2.dic",'."\n" - .' "ossObject":{'."\n" - .' "bucketName":"search-cloud-test-cn-****",'."\n" - .' "key":"user_dict/dict_2.dic"'."\n" - .' },'."\n" - .' "sourceType":"OSS",'."\n" - .' "type":"STOP"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"SYSTEM_MAIN.dic",'."\n" - .' "sourceType":"ORIGIN",'."\n" - .' "type":"MAIN"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"SYSTEM_STOPWORD.dic",'."\n" - .' "sourceType":"ORIGIN",'."\n" - .' "type":"STOP"'."\n" - .' }'."\n" - .']'."\n" - .'```', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateSynonymsDicts' => [ - 'summary' => 'Updates the synonym dictionaries of an Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/synonymsDict', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListLogstashPlugins' => [ + 'summary' => 'Calls ListLogstashPlugins to retrieve detailed information about all or specified plugins.', + 'path' => '/openapi/logstashes/{InstanceId}/plugins', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The plugin name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'logstash-filter-clone', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the plugin list. Default value: 1. Minimum value: 1. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page in paging settings. Minimum value: 1. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'source', + 'in' => 'query', + 'schema' => ['description' => 'The plugin source. Valid values:'."\n" + ."\n" + .'- USER: custom plugin'."\n" + .'- SYSTEM: system preset plugin.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'USER', 'title' => ''], ], ], 'responses' => [ @@ -17923,212 +15292,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7C5622CC-B312-426F-85AA-B0271*******', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '99407AB-2FA9-489E-A259-40CF6DCC**** ', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the dictionary file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '220', - ], - 'sourceType' => [ - 'description' => 'The source type of the dictionary file. Valid values:'."\n" - ."\n" - .'* OSS'."\n" - .'* ORIGIN'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'name' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'example' => 'deploy_0.txt', - ], - 'type' => [ - 'description' => 'The dictionary type. The value is fixed as SYNONYMS.'."\n", - 'type' => 'string', - 'example' => 'SYNONYMS', - ], + 'description' => ['description' => 'The plugin description.', 'type' => 'string', 'example' => 'The clone filter is for duplicating events.', 'title' => ''], + 'specificationUrl' => ['description' => 'The URL of the plugin documentation.', 'type' => 'string', 'example' => 'https://xxx.html', 'title' => ''], + 'state' => ['description' => 'The plugin status. Valid values:'."\n" + ."\n" + .'- INSTALLED: installed'."\n" + .'- UNINSTALLED: not installed'."\n" + .'- INSTALLING: being installed'."\n" + .'- UNINSTALLING: being uninstalled'."\n" + .'- UPGRADING: being upgraded'."\n" + .'- FAILED: installation failed'."\n" + .'- UNKNOWN: the cluster is disconnected and the creation status cannot be retrieved.', 'type' => 'string', 'example' => 'INSTALLED', 'title' => ''], + 'source' => ['description' => 'The plugin source.', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], + 'name' => ['description' => 'The plugin name.', 'type' => 'string', 'example' => 'logstash-filter-clone', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99407AB-2FA9-489E-A259-40CF6DCC****\\\\t\\",\\n \\"Result\\": [\\n {\\n \\"description\\": \\"The clone filter is for duplicating events.\\",\\n \\"specificationUrl\\": \\"https://xxx.html\\",\\n \\"state\\": \\"INSTALLED\\",\\n \\"source\\": \\"SYSTEM\\",\\n \\"name\\": \\"logstash-filter-clone\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Get logstash plugin list', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' The returned data also includes the following parameters.'."\n" + .'| Name | Type | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| Headers | Struct | | The response header information.|'."\n" + .'| └X-Total-Count | Integer | 131 | The number of returned plugins.|'."\n" + ."\n" + .'> └ indicates a child parameter.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:24.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLogstashPlugins'], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C5622CC-B312-426F-85AA-B0271*******\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 220,\\n \\"sourceType\\": \\"OSS\\",\\n \\"name\\": \\"deploy_0.txt\\",\\n \\"type\\": \\"SYNONYMS\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateSynonymsDicts', - 'description' => 'Before you call this operation, take note of the following items:'."\n" - ."\n" - .'* If the dictionary file is stored in an Object Storage Service (OSS) bucket, you must make sure that the access control list (ACL) of the bucket is public read.'."\n" - .'* If you do not set sourceType to ORIGIN for an uploaded dictionary file, the file will be deleted after you call this operation.'."\n", - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body.'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|dic\\_0.txt|The name of the dictionary file that you want to upload. The dictionary file must be a TXT file.|'."\n" - .'|ossObject|Array|No||The information about the dictionary file. This parameter is required if you set sourceType to OSS.|'."\n" - .'|└bucketName|String|No|search-cloud-test-cn-\\*\\*\\*\\*|The name of the OSS bucket that stores the dictionary file.|'."\n" - .'|└key|String|No|oss/dic\\_0.txt|The path of the dictionary file in the OSS bucket.|'."\n" - .'|sourceType|String|Yes|OSS|The source type of the dictionary file. Valid values: OSS and ORIGIN.**Note**Your on-premises files can be referenced through OSS only after you upload the files to OSS.If you do not set sourceType to ORIGIN for an uploaded dictionary file, the file will be deleted after you call this operation.|'."\n" - .'|type|String|Yes|SYNONYMS|The type of the dictionaries that you want to update. Set the value to SYNONYMS.|'."\n" - ."\n\n" - .'**Note**└ indicates a child parameter.'."\n" - ."\n" - .'Sample code:'."\n" - ."\n" - .'```'."\n" - .'['."\n" - .' {'."\n" - .' "name":"deploy_0.txt",'."\n" - .' "ossObject":{'."\n" - .' "bucketName":"search-cloud-test-cn-****",'."\n" - .' "key":"user_dict/dict_0.dic"'."\n" - .' },'."\n" - .' "sourceType":"OSS",'."\n" - .' "type":"SYNONYMS"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"SYSTEM_STOPWORD.txt",'."\n" - .' "sourceType":"ORIGIN",'."\n" - .' "type":"SYNONYMS"'."\n" - .' }'."\n" - .']'."\n" - .'```', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateDict' => [ - 'summary' => 'Updates a dictionary of an Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/dict', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListNodes' => [ + 'summary' => 'Historical report list of intelligent O&M.', + 'path' => '/openapi/collectors/{ResId}/nodes', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the returned results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The number of results per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'ecsInstanceIds', + 'in' => 'query', + 'schema' => ['description' => 'The list of ECS instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'i-bp1ei8ysh7orb6eq****', 'title' => ''], + ], + [ + 'name' => 'ecsInstanceName', + 'in' => 'query', + 'schema' => ['description' => 'The ECS instance name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'schema' => ['description' => 'The tag information of the ECS instance. The tag key (tagKey) and tag value (tagValue) must be included.', 'type' => 'string', 'required' => false, 'example' => '[{"tagKey":"abc","tagValue":"xyz"}]', 'title' => ''], + ], + [ + 'name' => 'ResId', + 'in' => 'path', + 'schema' => ['description' => 'The collector ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-l871nd0u73c45****', 'title' => ''], ], ], 'responses' => [ @@ -18136,230 +15443,196 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E1FD7642-7C40-4FF2-9C0F-21F1A1746F70', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of returned records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the dictionary file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2782602', - ], - 'sourceType' => [ - 'description' => 'The source type of the dictionary file. Valid values:'."\n" - ."\n" - .'* OSS'."\n" - .'* ORIGIN'."\n", - 'type' => 'string', - 'example' => 'ORIGIN', - ], - 'name' => [ - 'description' => 'The name of the dictionary file.'."\n", - 'type' => 'string', - 'example' => 'SYSTEM_MAIN.dic', + 'ecsInstanceId' => ['description' => 'The ECS instance ID.', 'type' => 'string', 'example' => 'i-bp13y63575oypr****', 'title' => ''], + 'cloudAssistantStatus' => ['description' => 'Indicates whether Cloud Assistant is enabled. Valid values:'."\n" + ."\n" + .'- true: enabled.'."\n" + .'- false: not enabled.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ecsInstanceName' => ['description' => 'The ECS instance name.', 'type' => 'string', 'example' => 'ECS_beat', 'title' => ''], + 'osType' => ['description' => 'The operating system type of the ECS instance. Valid values:'."\n" + ."\n" + .'- windows: Windows Server.'."\n" + .'- linux: Linux.', 'type' => 'string', 'example' => 'linux', 'title' => ''], + 'ipAddress' => [ + 'description' => 'The list of IP address information of the ECS instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'host' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '192.168.xx.xx', 'title' => ''], + 'ipType' => ['description' => 'The type of the IP address. Valid values:'."\n" + ."\n" + .'- public: public IP address.'."\n" + .'- private: private IP address.', 'type' => 'string', 'example' => 'public', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'type' => [ - 'description' => 'The dictionary type. Valid values:'."\n" - ."\n" - .'* MAIN: IK main dicrionary'."\n" - .'* STOP: IK stopword list'."\n", - 'type' => 'string', - 'example' => 'MAIN', + 'agentStatus' => ['description' => 'The status of each collector on the ECS instance. Valid values:'."\n" + ."\n" + .'- heartOk: normal heartbeat.'."\n" + .'- heartLost: abnormal heartbeat.'."\n" + .'- uninstalled: not installed.'."\n" + .'- failed: installation failed.', 'type' => 'string', 'example' => 'heartOk', 'title' => ''], + 'status' => ['description' => 'The status of the ECS instance. Valid values:'."\n" + ."\n" + .'- running: running.'."\n" + .'- starting: starting.'."\n" + .'- stopping: stopping.'."\n" + .'- stopped: stopped.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'tags' => [ + 'description' => 'The tag information of the ECS instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'tagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'xyz', 'title' => ''], + 'tagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateDict', - 'description' => 'Before you call this operation, take note of the following items:'."\n" - ."\n" - .'* If the dictionary file is stored in an Object Storage Service (OSS) bucket, you must make sure that the access control list (ACL) of the bucket is public read.'."\n" - .'* If you do not set sourceType to ORIGIN for an uploaded dictionary file, the file will be deleted after you call this operation.'."\n", - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body.'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|dic\\_0.dic|The name of the dictionary file that you want to upload.|'."\n" - .'|ossObject|Array|Yes||The information about the dictionary file. This parameter is required if you set sourceType to OSS.|'."\n" - .'|└bucketName|String|Yes|search-cloud-test-cn-\\*\\*\\*\\*|The name of the OSS bucket that stores the dictionary file.|'."\n" - .'|└key|String|Yes|oss/dic\\_0.dic|The path of the dictionary file in the OSS bucket.|'."\n" - .'|sourceType|String|Yes|OSS|The source type of the dictionary file. Valid values: OSS and ORIGIN.**Note**Your on-premises files can be referenced through OSS only after you upload the files to OSS.If you do not set sourceType to ORIGIN for an uploaded dictionary file, the file will be deleted after you call this operation.|'."\n" - .'|type|String|Yes|MAIN|The type of the dictionary that you want to update. Valid values: MAIN and STOP.|'."\n" - ."\n\n" - .'**Note**└ indicates a child parameter.'."\n" - ."\n" - .'Sample code:'."\n" - ."\n" - .'```'."\n" - .'['."\n" - .' {'."\n" - .' "name":"deploy_0.dic",'."\n" - .' "ossObject":{'."\n" - .' "bucketName":"search-cloud-test-cn-****",'."\n" - .' "key":"user_dict/dict_0.dic"'."\n" - .' },'."\n" - .' "sourceType":"OSS",'."\n" - .' "type":"MAIN"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"deploy_2.dic",'."\n" - .' "ossObject":{'."\n" - .' "bucketName":"search-cloud-test-cn-****",'."\n" - .' "key":"user_dict/dict_2.dic"'."\n" - .' },'."\n" - .' "sourceType":"OSS",'."\n" - .' "type":"STOP"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"SYSTEM_MAIN.dic",'."\n" - .' "sourceType":"ORIGIN",'."\n" - .' "type":"MAIN"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"SYSTEM_STOPWORD.dic",'."\n" - .' "sourceType":"ORIGIN",'."\n" - .' "type":"STOP"'."\n" - .' }'."\n" - .']'."\n" - .'```', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E1FD7642-7C40-4FF2-9C0F-21F1A1746F70\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"Result\\": [\\n {\\n \\"ecsInstanceId\\": \\"i-bp13y63575oypr****\\",\\n \\"cloudAssistantStatus\\": \\"true\\",\\n \\"ecsInstanceName\\": \\"ECS_beat\\",\\n \\"osType\\": \\"linux\\",\\n \\"ipAddress\\": [\\n {\\n \\"host\\": \\"192.168.xx.xx\\",\\n \\"ipType\\": \\"public\\"\\n }\\n ],\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"status\\": \\"running\\",\\n \\"tags\\": [\\n {\\n \\"tagValue\\": \\"xyz\\",\\n \\"tagKey\\": \\"abc\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Machine Status Under a Collector', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateAdvancedSetting' => [ - 'summary' => 'Call UpdateAdvancedSetting to change the garbage collector configuration for the specified instance.', - 'path' => '/openapi/instances/{InstanceId}/actions/update-advanced-setting', - 'methods' => [ - 'post', - 'put', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodes'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListNodes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + ], + ], + 'ListPipeline' => [ + 'summary' => 'Retrieves the pipeline list of a Logstash instance.', + 'path' => '/openapi/logstashes/{InstanceId}/pipelines', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-09k1ruw79000u****', - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'pipelineId', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The pipeline ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pipeline_test', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the current page for a paged query. Valid values: 1 to 200. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of pipelines per page for a paged query. Valid values: 1 to 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '15', 'title' => ''], ], ], 'responses' => [ @@ -18367,156 +15640,131 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: garbage collector configuration changed successfully'."\n" - .'* false: garbage collector configuration changed successfully failed'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'pipelineStatus' => ['description' => 'The pipeline status. Valid values:'."\n" + ."\n" + .'- NOT_DEPLOYED: not deployed.'."\n" + .'- RUNNING: running.'."\n" + .'- DELETED: deleted. This status is not displayed in the console.', 'type' => 'string', 'example' => 'NOT_DEPLOYED', 'title' => ''], + 'gmtCreatedTime' => ['description' => 'The time when the pipeline was created.', 'type' => 'string', 'example' => '2020-08-05T03:10:38.188Z', 'title' => ''], + 'gmtUpdateTime' => ['description' => 'The time when the pipeline was last updated.', 'type' => 'string', 'example' => '2020-08-05T08:43:31.757Z', 'title' => ''], + 'pipelineId' => ['description' => 'The pipeline ID.', 'type' => 'string', 'example' => 'pipeline_test', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateAdvancedSetting', - 'requestParamsDescription' => '## RequestBody'."\n" - ."\n" - .'The following parameters must be specified in RequestBody to specify the modified garbage collector configuration. '."\n" - ."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .'| --------- | ---- | -------- | ------- | ----------- |'."\n" - .'| gcName | String | Yes | CMS | The new name of the garbage collector. Supported types: CMS and G1. |'."\n" - .'Example:'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "gcName":"CMS"'."\n" - .'}'."\n" - .'```', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 2\\n },\\n \\"Result\\": [\\n {\\n \\"pipelineStatus\\": \\"NOT_DEPLOYED\\",\\n \\"gmtCreatedTime\\": \\"2020-08-05T03:10:38.188Z\\",\\n \\"gmtUpdateTime\\": \\"2020-08-05T08:43:31.757Z\\",\\n \\"pipelineId\\": \\"pipeline_test\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Logstash pipeline list', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateExtendConfig' => [ - 'path' => '/openapi/instances/{InstanceId}/extend-configs/actions/update', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipeline'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPipeline', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], + ], + 'ListPipelineIds' => [ + 'path' => '/openapi/instances/{InstanceId}/pipeline-ids', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-7g1umu96oit2e****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The request body parameters. For more information, see the RequestBody section below.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{ "userName":"elastic", "password":"xxxxxx" }', 'title' => ''], ], ], 'responses' => [ @@ -18524,146 +15772,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', + 'description' => 'The list of results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'pipelineId' => ['description' => 'The pipeline ID created in Kibana.', 'type' => 'string', 'example' => 'testKibanaManagement', 'title' => ''], + 'available' => ['description' => 'Indicates whether the pipeline is available. Valid values:'."\n" + ."\n" + .'- true: Available.'."\n" + ."\n" + .'- false: Not available.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'code' => ['description' => 'The error code returned when the pipeline is unavailable.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'message' => ['description' => 'The error message returned when the pipeline is unavailable.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateExtendConfig', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"pipelineId\\": \\"testKibanaManagement\\",\\n \\"available\\": true,\\n \\"code\\": \\"OK\\",\\n \\"message\\": \\"OK\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List logstash pipeline iDs', + 'summary' => 'Retrieves the list of pipeline IDs for a Logstash instance.', + 'description' => '> Pipeline management is divided into configuration file management and Kibana pipeline management. Kibana pipeline management is not available in the console for some regions.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to verify the Kibana information for managing pipelines.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'|userName| String | Yes | elastic |The username for logging on to the Kibana console. Default value: elastic.|'."\n" + .'|password | String | Yes |xxxxxx |The password for logging on to the Kibana console.|.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateTemplate' => [ - 'path' => '/openapi/instances/{InstanceId}/templates/{TemplateName}', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineIds'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPipelineIds', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'ListPlugins' => [ + 'summary' => 'Retrieves the plugin list of a specified Alibaba Cloud Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/plugins', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The plugin name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'analysis-ik', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'TemplateName', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dynamicSettings', - ], + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{ "content": "{\\n\\t\\"persistent\\":{\\n\\t\\t\\"search\\":{\\n\\t\\t\\t\\"max_buckets\\":\\"10000\\"\\n\\t\\t}\\n\\t}\\n}" }', - ], + 'name' => 'source', + 'in' => 'query', + 'schema' => ['description' => 'The plugin source type. Only SYSTEM (system plugin) is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SYSTEM', 'title' => ''], ], ], 'responses' => [ @@ -18671,138 +15923,160 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A5D8E74-565C-43DC-B031-29289FA9****', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'Result' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'specificationUrl' => ['description' => 'The URL of the plugin documentation.', 'type' => 'string', 'example' => 'https://xxxx.html', 'title' => ''], + 'name' => ['description' => 'The plugin name.', 'type' => 'string', 'example' => 'analysis-ik', 'title' => ''], + 'description' => ['description' => 'The plugin description.', 'type' => 'string', 'example' => 'IK analysis plug-in for Elasticsearch.', 'title' => ''], + 'state' => ['description' => 'The plugin status.', 'type' => 'string', 'example' => 'INSTALLED', 'title' => ''], + 'source' => ['description' => 'The plugin source type.', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A5D8E74-565C-43DC-B031-29289FA9****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 2\\n },\\n \\"Result\\": [\\n {\\n \\"specificationUrl\\": \\"https://xxxx.html\\",\\n \\"name\\": \\"analysis-ik\\",\\n \\"description\\": \\"IK analysis plug-in for Elasticsearch.\\",\\n \\"state\\": \\"INSTALLED\\",\\n \\"source\\": \\"SYSTEM\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve instance plugin list', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T03:46:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:24.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPlugins'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateAliwsDict' => [ - 'summary' => 'Updates the dictionary file of the analysis-aliws plug-in.', - 'path' => '/openapi/instances/{InstanceId}/aliws-dict', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSearchLog' => [ + 'summary' => 'Queries logs of different types for an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/search-log', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchCDBLP9'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'title' => '', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****'], ], [ - 'name' => 'clientToken', + 'name' => 'type', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The log type. Valid values:'."\n" + .'- INSTANCELOG: primary log.'."\n" + .'- SEARCHSLOW: searching slow log.'."\n" + .'- INDEXINGSLOW: indexing slow log.'."\n" + .'- JVMLOG: GC log.'."\n" + .'- ES_SEARCH_ACCESS_LOG: Elasticsearch access log.'."\n" + .'- AUDIT: audit log.'."\n" + ."\n" + .'For limits on viewing logs, see [Query logs](~~72026~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCELOG', 'title' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'query', + 'in' => 'query', + 'schema' => ['description' => 'The keyword to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'host:172.16.**.** AND content:netty', 'title' => ''], + ], + [ + 'name' => 'beginTime', + 'in' => 'query', + 'schema' => ['description' => 'The start timestamp of the log, in milliseconds. The value must be within the last 7 days. If this parameter is not specified, all logs within the \\[current time - 7 days, endTime\\] range are queried.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1531910852074', 'title' => ''], + ], + [ + 'name' => 'endTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp of the log, in milliseconds. The value must be within the last 7 days. Specify this parameter. If this parameter is not specified, an empty result is returned.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1531910852074', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the plug-in list. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page for a paged query. Default value: 20. Minimum value: 1. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '50', 'minimum' => '1', 'default' => '20', 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -18810,201 +16084,112 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****', 'title' => ''], + 'Headers' => [ + 'description' => 'The response headers.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The total number of records for the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The list of logs returned by the request.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the dictionary file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6226', - ], - 'sourceType' => [ - 'description' => 'The source type of the dictionary file. Valid values:'."\n" - ."\n" - .'* OSS'."\n" - .'* ORIGIN'."\n", - 'type' => 'string', - 'example' => 'OSS', - ], - 'name' => [ - 'description' => 'The name of the uploaded dictionary file.'."\n", - 'type' => 'string', - 'example' => 'aliws_ext_dict.txt', - ], - 'type' => [ - 'description' => 'The dictionary type. The value is fixed as ALI_WS.'."\n", - 'type' => 'string', - 'example' => 'ALI_WS', - ], + 'contentCollection' => ['description' => 'The log details. Different log types return different content fields.', 'type' => 'object', 'example' => '{"level": "info", "host": "192.168.**.**", "time": "2019-03-18T08:16:12.741Z","content": "[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...])."}', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + 'level' => ['description' => 'The log level. Valid values:'."\n" + ."\n" + .'- warn: warning log'."\n" + .'- info: information log'."\n" + .'- error: error log'."\n" + .'- trace: trace log'."\n" + .'- debug: debug log'."\n" + ."\n" + .'The level information has been migrated to the contentCollection field.', 'type' => 'string', 'example' => 'info', 'title' => ''], + 'host' => ['description' => 'The IP address of the node that generated the log.', 'type' => 'string', 'example' => '192.168.**.**', 'title' => ''], + 'content' => ['description' => 'The detailed log content. This field has been migrated to the contentCollection field.', 'type' => 'string', 'example' => '[GC (Allocation Failure) 2018-07-19T17:24:20.682+0800: 7516.513: [ParNew: 6604768K->81121K(7341504K), 0.0760606 secs] 7226662K->703015K(31813056K), 0.0762507 secs] [Times: user=0.52 sys=0.00, real=0.07 secs] ', 'title' => ''], + 'timestamp' => ['description' => 'The timestamp when the log was generated, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1531985112420', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + '4XX' => [], + '5XX' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 1000\\n },\\n \\"Result\\": [\\n {\\n \\"contentCollection\\": {\\n \\"level\\": \\"info\\",\\n \\"host\\": \\"192.168.**.**\\",\\n \\"time\\": \\"2019-03-18T08:16:12.741Z\\",\\n \\"content\\": \\"[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...]).\\"\\n },\\n \\"instanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"level\\": \\"info\\",\\n \\"host\\": \\"192.168.**.**\\",\\n \\"content\\": \\"[GC (Allocation Failure) 2018-07-19T17:24:20.682+0800: 7516.513: [ParNew: 6604768K->81121K(7341504K), 0.0760606 secs] 7226662K->703015K(31813056K), 0.0762507 secs] [Times: user=0.52 sys=0.00, real=0.07 secs] \\",\\n \\"timestamp\\": 1531985112420\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query instance logs', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The Result.contentCollection field contains the following parameters.'."\n" + .'| Name | Type | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| time | String | 2020-07-21T11:12:53.057Z |The time when the log was generated.|'."\n" + .'| content | String | [o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...]).| The detailed log content.|'."\n" + .'| host |String| 192.168.\\*\\*.\\*\\* | The IP address of the node that generated the log. |'."\n" + .'| level | String | warn | The log level. Valid values: warn (warning log), info (information log), error (error log), trace (trace log), and debug (debug log).|.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-05T06:36:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchLog'], ], + ], + 'ramActions' => [ [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], - ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], - ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListSearchLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 6226,\\n \\"sourceType\\": \\"OSS\\",\\n \\"name\\": \\"aliws_ext_dict.txt\\",\\n \\"type\\": \\"ALI_WS\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateAliwsDict', - 'description' => 'Before you call this operation, take note of the following items:'."\n" - ."\n" - .'* Elasticsearch V5.X clusters do not support the analysis-aliws plug-in.'."\n" - .'* If the dictionary file is stored in an Object Storage Service (OSS) bucket, you must make sure that the access control list (ACL) of the bucket is public read.'."\n" - .'* If you do not set sourceType to ORIGIN for an uploaded dictionary file, the file will be deleted after you call this operation.'."\n", - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body.'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|name|String|Yes|aliws\\_ext\\_dict.txt|The name of the dictionary file that you want to upload.|'."\n" - .'|ossObject|Array|Yes||The information about the dictionary file. This parameter is required if you set sourceType to OSS.|'."\n" - .'|└bucketName|String|Yes|search-cloud-test-cn-\\*\\*\\*\\*|The name of the OSS bucket that stores the dictionary file.|'."\n" - .'|└key|String|Yes|oss/aliws\\_ext\\_dict.txt|The path of the dictionary file in the OSS bucket.|'."\n" - .'|sourceType|String|Yes|OSS|The source type of the dictionary file. Valid values: OSS and ORIGIN.**Note**Your on-premises files can be referenced through OSS only after you upload the files to OSS.If you do not set sourceType to ORIGIN for an uploaded dictionary file, the file will be deleted after you call this operation.|'."\n" - .'|type|String|Yes|ALI\\_WS|The dictionary type. Set the value to ALI\\_WS.|'."\n" - ."\n\n" - .'**Note**└ indicates a child parameter.'."\n" - ."\n" - .'Sample code:'."\n" - ."\n" - .'```'."\n" - .'['."\n" - .' {'."\n" - .' "name":"deploy_0.txt",'."\n" - .' "ossObject":{'."\n" - .' "bucketName":"search-cloud-test-cn-****",'."\n" - .' "key":"user_dict/dict_0.txt"'."\n" - .' },'."\n" - .' "sourceType":"OSS",'."\n" - .' "type":"ALI_WS"'."\n" - .' },'."\n" - .' {'."\n" - .' "name":"aliws_ext_dict.txt",'."\n" - .' "sourceType":"ORIGIN",'."\n" - .' "type":"ALI_WS"'."\n" - .' }'."\n" - .']'."\n" - .'```', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateBlackIps' => [ - 'summary' => '修改ES实例访问黑名单，已废弃', - 'path' => '/openapi/instances/{InstanceId}/black-ips', - 'methods' => [ - 'patch', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListShardRecoveries' => [ + 'path' => '/openapi/instances/{InstanceId}/cat-recovery', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-7mz293m9a003j****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'activeOnly', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to display shard data recovery tracking information. Valid values:'."\n" + ."\n" + .'- true: Displays only ongoing shard data recovery tracking information.'."\n" + ."\n" + .'- false: Displays all shard data recovery tracking information.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -19012,120 +16197,128 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], 'Result' => [ - 'type' => 'object', - 'properties' => [ - 'esIPBlacklist' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'index' => ['description' => 'The index name.', 'type' => 'string', 'example' => 'my-index-000001', 'title' => ''], + 'sourceHost' => ['description' => 'The IP address of the source node.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'sourceNode' => ['description' => 'The source node.', 'type' => 'string', 'example' => '2Kni3dJ', 'title' => ''], + 'filesTotal' => ['description' => 'The total number of files.', 'type' => 'integer', 'format' => 'int64', 'example' => '79', 'title' => ''], + 'bytesPercent' => ['description' => 'The data recovery progress.', 'type' => 'string', 'example' => '80%', 'title' => ''], + 'translogOps' => ['description' => 'The number of translog operations to be recovered.', 'type' => 'integer', 'format' => 'int64', 'example' => '12086', 'title' => ''], + 'translogOpsPercent' => ['description' => 'The progress of translog operation recovery.', 'type' => 'string', 'example' => '80%', 'title' => ''], + 'bytesTotal' => ['description' => 'The total amount of data to be recovered.', 'type' => 'integer', 'format' => 'int64', 'example' => '12086', 'title' => ''], + 'targetHost' => ['description' => 'The IP address of the target node.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'targetNode' => ['description' => 'The target node.', 'type' => 'string', 'example' => 'YVVKLmW', 'title' => ''], + 'filesPercent' => ['description' => 'The file recovery progress.', 'type' => 'string', 'example' => '80.0%', 'title' => ''], + 'stage' => ['description' => 'The stage of the data recovery process. Valid values:'."\n" + ."\n" + .'- done: Recovery is complete.'."\n" + ."\n" + .'- finalize: Cleanup operations are in progress.'."\n" + ."\n" + .'- index: Reading index metadata and copying bytes from the source to the target.'."\n" + ."\n" + .'- init: Recovery has not started.'."\n" + ."\n" + .'- start: Recovery is starting.'."\n" + ."\n" + .'- translog: Replaying the transaction log.', 'type' => 'string', 'example' => 'done', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": [\\n {\\n \\"index\\": \\"my-index-000001\\",\\n \\"sourceHost\\": \\"192.168.XX.XX\\",\\n \\"sourceNode\\": \\"2Kni3dJ\\",\\n \\"filesTotal\\": 79,\\n \\"bytesPercent\\": \\"80%\\",\\n \\"translogOps\\": 12086,\\n \\"translogOpsPercent\\": \\"80%\\",\\n \\"bytesTotal\\": 12086,\\n \\"targetHost\\": \\"192.168.XX.XX\\",\\n \\"targetNode\\": \\"YVVKLmW\\",\\n \\"filesPercent\\": \\"80.0%\\",\\n \\"stage\\": \\"done\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Shard recovery data list', + 'summary' => 'Queries the data progress list of ongoing and completed shard recoveries. By default, only ongoing shard recovery information is returned.', + 'description' => '> Shard recovery is the process of synchronizing data from a primary shard to a replica shard. After recovery is complete, the replica shard becomes available for search.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-07T04:30:48.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListShardRecoveries'], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListShardRecoveries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], ], - 'responseDemo' => null, ], - 'DescribeTemplates' => [ - 'path' => '/openapi/instances/{InstanceId}/templates', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSnapshotReposByInstanceId' => [ + 'summary' => 'Retrieves the list of cross-cluster OSS repository settings for the current instance.', + 'path' => '/openapi/instances/{InstanceId}/snapshot-repos', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-0pp1jxvcl000z****', 'title' => ''], ], ], 'responses' => [ @@ -19133,499 +16326,311 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], 'Result' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'content' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\n\\t\\"persistent\\":{\\n\\t\\t\\"search\\":{\\n\\t\\t\\t\\"max_buckets\\":\\"10000\\"\\n\\t\\t}\\n\\t}\\n}', - ], - 'templateName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dynamicSettings', - ], + 'snapWarehouse' => ['description' => 'The name of the referenced repository.', 'type' => 'string', 'example' => 'aliyun_snapshot_from_es-cn-6ja1ro4jt000c****', 'title' => ''], + 'repoPath' => ['description' => 'The repository address.', 'type' => 'string', 'example' => 'es-cn-6ja1ro4jt000c****', 'title' => ''], + 'status' => ['description' => 'The status of the referenced repository. Valid values:'."\n" + .'- available: The repository is active.'."\n" + .'- unavailable: The repository is inactive.', 'type' => 'string', 'example' => 'available', 'title' => ''], + 'instanceId' => ['description' => 'The referenced instance ID.', 'type' => 'string', 'example' => 'es-cn-6ja1ro4jt000c****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"content\\": \\"{\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"persistent\\\\\\\\\\\\\\":{\\\\\\\\n\\\\\\\\t\\\\\\\\t\\\\\\\\\\\\\\"search\\\\\\\\\\\\\\":{\\\\\\\\n\\\\\\\\t\\\\\\\\t\\\\\\\\t\\\\\\\\\\\\\\"max_buckets\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10000\\\\\\\\\\\\\\"\\\\\\\\n\\\\\\\\t\\\\\\\\t}\\\\\\\\n\\\\\\\\t}\\\\\\\\n}\\",\\n \\"templateName\\": \\"dynamicSettings\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeTemplates', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": [\\n {\\n \\"snapWarehouse\\": \\"aliyun_snapshot_from_es-cn-6ja1ro4jt000c****\\",\\n \\"repoPath\\": \\"es-cn-6ja1ro4jt000c****\\",\\n \\"status\\": \\"available\\",\\n \\"instanceId\\": \\"es-cn-6ja1ro4jt000c****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List cross-cluster OSS repositories of an elasticsearch instance', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListAckClusters' => [ - 'path' => '/openapi/ack-clusters', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSnapshotReposByInstanceId'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListSnapshotReposByInstanceId', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListStatsEventRecords' => [ + 'path' => '/openapi/event/statsEventRecords', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', + 'abilityTreeCode' => '254770', + 'abilityTreeNodes' => ['FEATUREelasticsearchGHNE3U'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'page', + 'name' => 'eventType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'enumValueTitles' => ['UserOperator' => 'Cluster change event ', 'HealthCheck' => 'Cluster health event ', 'SystemUpdate' => 'System change event '], + 'description' => 'Event type', + 'type' => 'string', 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '3', + 'example' => 'UserOperator', + 'title' => '', ], ], [ - 'name' => 'size', + 'name' => 'status', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '20', - ], + 'schema' => ['description' => 'Status of the management event', 'type' => 'string', 'required' => false, 'example' => 'Executed', 'title' => ''], ], [ - 'name' => 'vpcId', + 'name' => 'level', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the virtual private cloud (VPC) to which the ACK clusters belong.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp12nu14urf0upaf4****', - ], + 'schema' => ['description' => 'Event level ', 'type' => 'string', 'required' => false, 'example' => 'Info', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response ', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F93EAA49-284F-4FCE-9E67-FA23FB4BB512', - ], + 'RequestId' => ['description' => 'Request ID ', 'title' => 'ID of the request ', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****'], 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'clusterType' => [ - 'description' => 'The type of the cluster. The value is fixed as ManagedKubernetes.'."\n", - 'type' => 'string', - 'example' => 'ManagedKubernetes', - ], - 'vpcId' => [ - 'description' => 'The ID of the VPC to which the cluster belongs.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp12nu14urf0upaf4****', - ], - 'name' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'clusterId' => [ - 'description' => 'The ID of cluster.'."\n", - 'type' => 'string', - 'example' => 'c5ea2c2d9a3cf499481292f60425d****', + 'description' => 'Return Result ', + 'type' => 'object', + 'properties' => [ + 'total' => ['description' => 'Total number of entries. ', 'type' => 'string', 'example' => '6', 'title' => ''], + 'result' => [ + 'description' => 'Return Result ', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result ', + 'type' => 'object', + 'properties' => [ + 'type' => ['description' => 'Event type ', 'type' => 'string', 'example' => 'UserOperator', 'title' => ''], + 'status' => ['description' => 'Event status ', 'type' => 'string', 'example' => 'Executed', 'title' => ''], + 'level' => ['description' => 'Event level ', 'type' => 'string', 'example' => 'Info', 'title' => ''], + 'cnt' => ['description' => 'Number of events ', 'type' => 'string', 'example' => '4', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F93EAA49-284F-4FCE-9E67-FA23FB4BB512\\",\\n \\"Result\\": [\\n {\\n \\"clusterType\\": \\"ManagedKubernetes\\",\\n \\"vpcId\\": \\"vpc-bp12nu14urf0upaf4****\\",\\n \\"name\\": \\"test\\",\\n \\"clusterId\\": \\"c5ea2c2d9a3cf499481292f60425d****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListAckClusters', - 'summary' => 'Queries a list of Container Service for Kubernetes (ACK) clusters.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The response parameters described in the following table are also returned.'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|Headers|Struct||The header of the response.|'."\n" - .'|└X-Total-Count|Integer|2|The total number of entries returned.|'."\n" - ."\n\n" - .'>└ indicates a child parameter.', - 'extraInfo' => ' ', - ], - 'ListDictInformation' => [ - 'path' => '/openapi/instances/{InstanceId}/dict/_info', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Statistics of management event records ', + 'summary' => 'Statistics of management event records ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": {\\n \\"total\\": \\"6\\",\\n \\"result\\": [\\n {\\n \\"type\\": \\"UserOperator\\",\\n \\"status\\": \\"Executed\\",\\n \\"level\\": \\"Info\\",\\n \\"cnt\\": \\"4\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListTagResources' => [ + 'summary' => 'Retrieves the relationships between all instances and tags.', + 'path' => '/openapi/tags', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the resource relationship list. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'bucketName', + 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'search-cloud-test-cn-****', - ], + 'schema' => ['description' => 'The number of entries per page in Settings for paged query and paging. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'key', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'oss/dic_0.dic', - ], + 'schema' => ['description' => 'The resource type definition.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'title' => ''], ], [ - 'name' => 'analyzerType', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ALIWS', - ], + 'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => '1d2db86sca4384811e0b5e8707e******', 'title' => ''], + ], + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'schema' => ['description' => 'The list of instance IDs to query. The value is in JSON array format and can contain up to 20 items.', 'type' => 'string', 'required' => false, 'example' => '["es-cn-aaa","es-cn-bbb"]', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => 'The list of tags to query. The value is in JSON string format and can contain up to 20 items.', 'type' => 'string', 'required' => false, 'example' => '[{"key":"env", "value":"dev"},{"key":"dev", "value":"IT"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7C4334EA-D22B-48BD-AE28-08EE68******', + 'PageSize' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6D****** ', 'title' => ''], + 'Headers' => [ + 'description' => 'The response header information. This parameter is empty and is for reference only. Do not create a dependency on this parameter in your program.'."\n" + .'> This parameter is not included in the response example.', + 'type' => 'object', + 'properties' => [ + 'X-Total-Count' => ['description' => 'The resource count of TagResource resources found.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Result' => [ - 'description' => '', + 'TagResources' => [ + 'description' => 'The tag resource group.', 'type' => 'object', 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'STOP', - ], - 'fileSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2202301', - ], - 'ossObject' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'oss/dict_0*.dic', - ], - 'bucketName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-osstest*', - ], - 'etag' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2ABAB5E70BBF631145647F6BE533****', + 'TagResource' => [ + 'description' => 'The tag resource.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], + 'ResourceType' => ['description' => 'The resource type. The value is fixed as `ALIYUN::ELASTICSEARCH::INSTANCE`.', 'type' => 'string', 'example' => 'ALIYUN::ELASTICSEARCH::INSTANCE', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'es-cn-oew1q8bev0002****', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6D******\\\\t\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagValue\\": \\"dev\\",\\n \\"ResourceType\\": \\"ALIYUN::ELASTICSEARCH::INSTANCE\\",\\n \\"ResourceId\\": \\"es-cn-oew1q8bev0002****\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query instance visible resource tag relationships', + 'requestParamsDescription' => '- Specify at least one of the **ResourceIds** and **Tags** parameters. Otherwise, an error is returned.'."\n" + .'- You can query only visible system tags. You cannot query invisible tags.'."\n" + .' > System tags are tags that cloud services add to user instances. System tags are classified into visible tags and invisible tags.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-28T06:40:20.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListTagResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C4334EA-D22B-48BD-AE28-08EE68******\\",\\n \\"Result\\": {\\n \\"type\\": \\"STOP\\",\\n \\"fileSize\\": 2202301,\\n \\"ossObject\\": {\\n \\"key\\": \\"oss/dict_0*.dic\\",\\n \\"bucketName\\": \\"es-osstest*\\",\\n \\"etag\\": \\"2ABAB5E70BBF631145647F6BE533****\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListDictInformation', - 'summary' => 'Queries information about a dictionary.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListEcsInstances' => [ - 'summary' => 'When you create a Beats collector, call the ListEcsInstances to obtain the list of ECS instances.', - 'path' => '/openapi/ecs', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTags' => [ + 'summary' => 'Queries all labels created by the user in the current region.', + 'path' => '/openapi/tags/all-tags', + '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' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => '\\["i-bp13y63575oypr9d\\*\\*\\*\\*","i-bp1gyhphjaj73jsr\\*\\*\\*\\*"]'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'ecsInstanceIds', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'test'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["i-bp13y63575oypr9d****","i-bp1gyhphjaj73jsr****"]', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20. Minimum value: 1. Maximum value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '50', 'minimum' => '1', 'example' => '20', 'title' => ''], ], [ - 'name' => 'ecsInstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => '\\[{ "tagKey":"a","tagValue":"b"}]'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'tags', + 'name' => 'resourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'vpc-bp16k1dvzxtmagcva\\*\\*\\*\\*'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{ "tagKey":"a","tagValue":"b"}]', - ], - ], - [ - 'name' => 'vpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp16k1dvzxtmagcva****', - ], + 'schema' => ['description' => 'The resource type. Fixed value: INSTANCE.', 'type' => 'string', 'required' => false, 'example' => 'INSTANCE', 'title' => ''], ], ], 'responses' => [ @@ -19633,358 +16638,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Headers' => [ - 'description' => 'The number of returned records.'."\n", - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '11', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => 'Cloud Assistant the installation status, support:'."\n" - ."\n" - .'* true: The Prometheus agent was installed.'."\n" - .'* false: The Prometheus agent was not installed.'."\n", + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ecsInstanceId' => [ - 'description' => 'The tags of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'i-bp14ncqge8wy3l3d****', - ], - 'collectors' => [ - 'description' => 'The ID of the collector instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'configs' => [ - 'description' => 'The content of the file.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'fileName' => [ - 'description' => 'The information about the extended parameter.'."\n", - 'type' => 'string', - 'example' => 'fields.yml', - ], - 'content' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => '- key: log\\n title: Log file content\\n description: >\\n Contains log file lines.\\n ....', - ], - ], - ], - ], - 'dryRun' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'resType' => [ - 'description' => 'The version of the collector. If the machine type of the collector is ECS, only **6.8.5\\_with_community** is supported.'."\n", - 'type' => 'string', - 'example' => 'fileBeat', - ], - 'ownerId' => [ - 'description' => 'The ID of the Virtual Private Cloud to which the collector belongs.'."\n", - 'type' => 'string', - 'example' => '16852***488*****', - ], - 'resId' => [ - 'description' => 'The time when the collector was updated.'."\n", - 'type' => 'string', - 'example' => 'ct-cn-0v3xj86085dvq****', - ], - 'collectorPaths' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["/var/log"]', - ], - 'description' => '', - ], - 'gmtUpdateTime' => [ - 'description' => 'Specifies whether to verify and create a crawer. Valid values:'."\n" - ."\n" - .'* true: only verifies and does not create a'."\n" - .'* false: verifies and creates a'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'extendConfigs' => [ - 'description' => 'Whether Monitoring is enabled. This field is displayed when the **configType** is **collectorTargetInstance** and the **instanceType** is **Elasticsearch**. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'protocol' => [ - 'description' => 'The username that is used to access the instance. The default value is elastic. Displayed when the **configType** is **collectorTargetInstance** or **collectorElasticsearchForKibana**.'."\n", - 'type' => 'string', - 'example' => 'HTTP', - ], - 'enableMonitoring' => [ - 'description' => 'The ID of the host group. Displayed when the **configType** is **collectorDeployMachine**.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'instanceId' => [ - 'description' => 'The list of ECS instances on which the collector is deployed. Displayed when the **configType** is **collectorDeployMachines** and the **type** is **ECSInstanceId**.'."\n", - 'type' => 'string', - 'example' => 'es-cn-nif1z89fz003i****', - ], - 'hosts' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', - ], - 'description' => 'The path in which Filebeat is collected.'."\n", - ], - 'groupId' => [ - 'description' => 'The configuration type. Valid values:'."\n" - ."\n" - .'* collectorTargetInstance: Collector Output'."\n" - .'* collectorDeployMachine: Collector Deployment Machine'."\n" - .'* Collector Elasticsearch ForKibana: Elasticsearch instance information that supports the Kibana dashboard'."\n", - 'type' => 'string', - 'example' => 'default_ct-cn-5i2l75bz4776****', - ], - 'instanceType' => [ - 'description' => 'The transmission protocol, which must be the same as the access protocol of the instance specified by Output. HTTP and HTTPS. Displayed when the **configType** is **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch', - ], - 'machines' => [ - 'description' => 'The status of each crawl on the ECS instance. Valid values:'."\n" - ."\n" - .'* heartOk: The heartbeat is normal.'."\n" - .'* heartLost: The heartbeat is abnormal.'."\n" - .'* uninstalled'."\n" - .'* failed: The installation failed.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'instanceId' => [ - 'description' => 'The list of access addresses of the specified instance for the output of the collector. Displayed when the **configType** is **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'i-bp13y63575oypr9d****', - ], - 'agentStatus' => [ - 'description' => 'The IDs of ECS instances.'."\n", - 'type' => 'string', - 'example' => 'heartOk', - ], - ], - ], - ], - 'configType' => [ - 'description' => 'The instance type specified by Collector Output. Supports Elasticsearch and Logstash. Displayed when the **configType** is **collectorTargetInstance**.'."\n", - 'type' => 'string', - 'example' => 'collectorDeployMachine', - ], - 'userName' => [ - 'description' => 'The type of the machine on which the Collector is deployed. This parameter is displayed when the **configType** is **collectorDeployMachine**. Valid values:'."\n" - ."\n" - .'* ECSInstanceId:ECS'."\n" - .'* ACKCluster: Container Kubernetes'."\n", - 'type' => 'string', - 'example' => 'elastic', - ], - 'type' => [ - 'description' => 'The ID of the instance that is associated with the crawker. If the **configType** parameter is set to **collectorTargetInstance**, the value of this parameter is the ID of the output collector. If the **configType** parameter is set to **collectorDeployMachines** and the **type** parameter is set to **ACKCluster**, the value of this parameter is the ID of the ACK cluster.'."\n", - 'type' => 'string', - 'example' => 'ECSInstanceId', - ], - ], - ], - ], - 'resVersion' => [ - 'description' => 'The time when the crawl collector was created.'."\n", - 'type' => 'string', - 'example' => '6.8.5_with_community', - ], - 'vpcId' => [ - 'description' => 'The type of the collector. FileBeat, metricBeat, heartBeat, and auditBeat are supported.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtm******', - ], - 'name' => [ - 'description' => 'The configuration file information of the collector.'."\n", - 'type' => 'string', - 'example' => 'ct-testAbc', - ], - 'gmtCreatedTime' => [ - 'description' => 'The status of the collector. Valid values:'."\n" - ."\n" - .'* activating: The project is taking effect.'."\n" - .'* active: The instance has taken effect.'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'status' => [ - 'description' => 'The name of the collector.'."\n", - 'type' => 'string', - 'example' => 'activing', - ], - ], - ], - ], - 'cloudAssistantStatus' => [ - 'description' => 'The name of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'ecsInstanceName' => [ - 'description' => 'The ID of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'ecsTestName', - ], - 'osType' => [ - 'description' => 'The status of the ECS instance. Valid values:'."\n" - ."\n" - .'* running: The master instance is running'."\n" - .'* starting'."\n" - .'* stopping: The task is being stopped.'."\n" - .'* stopped: The node is stopped.'."\n", - 'type' => 'string', - 'example' => 'linux', - ], - 'ipAddress' => [ - 'description' => 'The type of the IP address that is used by the instance. Valid values:'."\n" - ."\n" - .'* public: public endpoint'."\n" - .'* private: private network address'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'host' => [ - 'description' => 'The information about the collectors on the ECS instance.'."\n", - 'type' => 'string', - 'example' => '172.16.xx.xx', - ], - 'ipType' => [ - 'description' => 'The IP address of the endpoint.'."\n", - 'type' => 'string', - 'example' => 'private', - ], - ], - ], - ], - 'tags' => [ - 'description' => 'The operating system type of the ECS instance. Valid values:'."\n" - ."\n" - .'* windows:Windows operating system'."\n" - .'* linux:Linux operating system'."\n", - 'type' => 'string', - 'example' => '[ { "tagKey": "a", "tagValue": "b" } ]', - ], - 'status' => [ - 'description' => 'The IP address of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'running', - ], + 'TagValue' => ['description' => 'The label value.', 'type' => 'string', 'example' => 'dev', 'title' => ''], + 'TagKey' => ['description' => 'The label key.', 'type' => 'string', 'example' => 'env', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"TagValue\\": \\"dev\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'List labels', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTags'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 11\\n },\\n \\"Result\\": [\\n {\\n \\"ecsInstanceId\\": \\"i-bp14ncqge8wy3l3d****\\",\\n \\"collectors\\": [\\n {\\n \\"configs\\": [\\n {\\n \\"fileName\\": \\"fields.yml\\",\\n \\"content\\": \\"- key: log\\\\\\\\n title: Log file content\\\\\\\\n description: >\\\\\\\\n Contains log file lines.\\\\\\\\n ....\\"\\n }\\n ],\\n \\"dryRun\\": false,\\n \\"resType\\": \\"fileBeat\\",\\n \\"ownerId\\": \\"16852***488*****\\",\\n \\"resId\\": \\"ct-cn-0v3xj86085dvq****\\",\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ],\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"extendConfigs\\": [\\n {\\n \\"protocol\\": \\"HTTP\\",\\n \\"enableMonitoring\\": true,\\n \\"instanceId\\": \\"es-cn-nif1z89fz003i****\\",\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ],\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"machines\\": [\\n {\\n \\"instanceId\\": \\"i-bp13y63575oypr9d****\\",\\n \\"agentStatus\\": \\"heartOk\\"\\n }\\n ],\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"userName\\": \\"elastic\\",\\n \\"type\\": \\"ECSInstanceId\\"\\n }\\n ],\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtm******\\",\\n \\"name\\": \\"ct-testAbc\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"status\\": \\"activing\\"\\n }\\n ],\\n \\"cloudAssistantStatus\\": \\"true\\",\\n \\"ecsInstanceName\\": \\"ecsTestName\\",\\n \\"osType\\": \\"linux\\",\\n \\"ipAddress\\": [\\n {\\n \\"host\\": \\"172.16.xx.xx\\",\\n \\"ipType\\": \\"private\\"\\n }\\n ],\\n \\"tags\\": \\"[ { \\\\\\"tagKey\\\\\\": \\\\\\"a\\\\\\", \\\\\\"tagValue\\\\\\": \\\\\\"b\\\\\\" } ]\\",\\n \\"status\\": \\"running\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListEcsInstances', - 'description' => '**Important** To call this operation, you must create the Aliyun Elasticsearch AccessingOOSRole and the system service role AliyunOOSAccessingECS 4ESRole to Elasticsearch the service account to obtain the ECS access permissions of the primary account. For more information, see [Collect ECS service logs](~~146446~~).', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DescribeAckOperator' => [ - 'path' => '/openapi/ack-clusters/{ClusterId}/operator', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListUserPlugin' => [ + 'path' => '/openapi/instances/{instanceId}/userPlugins', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19994,130 +16729,110 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '132386', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the ACK cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c79acd3fbf462423fb6450e513bb6****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-g4t3sz4wd0**', 'title' => ''], + ], + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => ['description' => 'Plugin Name.', 'type' => 'string', 'required' => false, 'example' => 'my-plugin', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'Page number for paging the plugin list.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'size', + 'in' => 'query', + 'schema' => ['description' => 'Number of records per page.', 'type' => 'string', 'required' => false, 'example' => '50', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6615EE8D-FD9D-4FD3-997E-6FEA5B8D82ED', - ], 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'version' => [ - 'description' => 'The version of ES-operator.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'status' => [ - 'description' => 'The installation status of ES-operator. Valid values:'."\n" - ."\n" - .'* deployed: ES-operator is installed.'."\n" - .'* not-deploy: ES-operator is not installed.'."\n" - .'* failed: ES-operator fails to be installed.'."\n" - .'* unknown: The installation status of ES-operator is unknown.'."\n", - 'type' => 'string', - 'example' => 'deployed', + 'description' => 'Return Result array', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result.', + 'type' => 'object', + 'properties' => [ + 'bingoPlugins' => [ + 'description' => 'List of plugins with the same name', + 'type' => 'array', + 'items' => [ + 'description' => 'Plugin information', + 'type' => 'object', + 'properties' => [ + 'name' => ['description' => 'Plugin Name.', 'type' => 'string', 'example' => 'dynamic-name', 'title' => ''], + 'source' => ['description' => 'Plugin Source. Valid values:'."\n" + ."\n" + .'- USER: Custom plugin '."\n" + .'- SYSTEM: Preset system plugin', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'state' => ['description' => 'Plugin Status'."\n" + ."\n" + .'- INSTALLED,'."\n" + .'- UNINSTALLED,'."\n" + .'- INSTALLING,'."\n" + .'- UNINSTALLING,'."\n" + .'- UPGRADING,'."\n" + .'- FAILED,'."\n" + .'- UNKNOWN,'."\n" + .'- UPLOADING,', 'type' => 'string', 'example' => 'UNINSTALLED', 'title' => ''], + 'elasticsearchVersion' => ['description' => 'Elasticsearch version of the plugin.', 'type' => 'string', 'example' => '8.17.0', 'title' => ''], + 'version' => ['description' => 'Plugin Version.', 'type' => 'string', 'example' => '8.17.0', 'title' => ''], + 'description' => ['description' => 'Plugin Description.', 'type' => 'string', 'example' => 'The plugin***', 'title' => ''], + 'fileVersion' => ['description' => 'Plugin UUID', 'type' => 'string', 'required' => false, 'example' => 'CAEQaRiBgIDI2tie6hkiIGIwM2I3MjZmNjk3YzR***', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'name' => ['description' => 'Plugin Name.', 'type' => 'string', 'example' => 'ct-test', 'title' => ''], + 'source' => ['description' => 'Plugin Source.', 'type' => 'string', 'example' => 'USER', 'title' => ''], + 'state' => ['description' => 'Plugin Status.', 'type' => 'string', 'example' => 'UNINSTALLED', 'title' => ''], + 'version' => ['description' => 'Plugin Version.', 'type' => 'string', 'example' => '8.17.0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '5EEF8FAE-EEDD***', 'title' => ''], + 'Headers' => ['description' => 'Response header information.', 'type' => 'object', 'example' => '{\'totalCount\': 1, \'X-Total-Count\': 1}', 'title' => ''], ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], - ], - ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], - ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], - ], + 'title' => 'Custom Plugin List', + 'summary' => 'Custom plugin list', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6615EE8D-FD9D-4FD3-997E-6FEA5B8D82ED\\",\\n \\"Result\\": {\\n \\"version\\": \\"1\\",\\n \\"status\\": \\"deployed\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeAckOperator', - 'summary' => 'Queries the information of ES-operator that is installed for a specified Container Service for Kubernetes (ACK) cluster.', - 'description' => '> Before you install a shipper on an ACK cluster, you can call this operation to query the installation status of ES-operator for the ACK cluster.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": [\\n {\\n \\"bingoPlugins\\": [\\n {\\n \\"name\\": \\"dynamic-name\\",\\n \\"source\\": \\"USER\\",\\n \\"state\\": \\"UNINSTALLED\\",\\n \\"elasticsearchVersion\\": \\"8.17.0\\",\\n \\"version\\": \\"8.17.0\\",\\n \\"description\\": \\"The plugin***\\",\\n \\"fileVersion\\": \\"CAEQaRiBgIDI2tie6hkiIGIwM2I3MjZmNjk3YzR***\\"\\n }\\n ],\\n \\"name\\": \\"ct-test\\",\\n \\"source\\": \\"USER\\",\\n \\"state\\": \\"UNINSTALLED\\",\\n \\"version\\": \\"8.17.0\\"\\n }\\n ],\\n \\"RequestId\\": \\"5EEF8FAE-EEDD***\\",\\n \\"Headers\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GetRegionConfiguration' => [ - 'path' => '/openapi/region', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListVpcEndpoints' => [ + 'path' => '/openapi/instances/{InstanceId}/vpc-endpoints', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20125,24 +16840,24 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '64288', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'zoneId', + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-2r429tctl000d****', 'title' => ''], + ], + [ + 'name' => 'size', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-f', - ], + 'schema' => ['description' => 'The number of entries per page for a paged query. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'page', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the list.'."\n" + ."\n" + .'Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -20150,629 +16865,157 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6F******', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'env' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'production', - ], - 'regionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'createUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://common-buy.aliyun.com/?commodityCode=elasticsearch&orderType=BUY#/buy', - ], - 'dataDiskList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'scaleLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', - ], - 'minSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'maxSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5120', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'valueLimitSet' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[2560,3072,3584,4096,4608,5120]', - ], - ], - ], - ], - ], - 'esVersionsLatestList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.5_with_X-Pack', - ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.5.3_with_X-Pack', - ], - ], - ], - ], - 'nodeSpecList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'memorySize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'cpuCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '16', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'local_efficiency', - ], - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticsearch.sn2ne.large', - ], - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '44000', - ], - 'specGroupType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'local_efficiency', - ], - 'enable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'clientNodeDiskList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'scaleLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '18', - ], - 'minSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'maxSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_efficiency', - ], - ], - ], - ], - 'masterDiskList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'scaleLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'minSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'maxSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - ], - ], - ], - 'supportVersions' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'instanceCategory' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'x-pack', - ], - 'supportVersionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.5', - ], - 'value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5.5.3', - ], - ], - ], - ], - ], - ], - ], - 'masterSpec' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge" ]', - ], - ], - 'clientNodeSpec' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.4xlarge","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]', - ], - ], - 'zones' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["cn-hangzhou-b","cn-hangzhou-f"]', - ], - ], - 'instanceSupportNodes' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[ "WORKER", "WORKER_WARM", "COORDINATING", "KIBANA", "MASTER", "ELASTIC_WORKER" ]', - ], - ], - 'esVersions' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[ "5.5.3_with_X-Pack"]', - ], - ], - 'node' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'maxAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'minAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'jvmConfine' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'memory' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'supportEsVersions' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["6.7.0_with_X-Pack","6.7.0_with_A-Pack","7.4.0_with_X-Pack"]', - ], - ], - 'supportGcs' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["CMS","G1"]', - ], - ], - ], - ], - 'clientNodeAmountRange' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'maxAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - 'minAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'warmNodeProperties' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'diskList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'scaleLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', - ], - 'minSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'diskEncryption' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'maxSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5120', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_efficiency', - ], - 'valueLimitSet' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[2560,3072,3584,4096,4608,5120]', - ], - ], - ], - ], - ], - 'spec' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.8xlarge","elasticsearch.ic5.large","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]', - ], - ], - 'amountRange' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'maxAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'minAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - ], - ], - 'kibanaNodeProperties' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["elasticsearch.n4.small","elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn1ne.large"]', - ], - ], - 'amountRange' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'maxAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'minAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - 'elasticNodeProperties' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'diskList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'scaleLimit' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', - ], - 'minSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - 'diskEncryption' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'maxSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5120', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'valueLimitSet' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[2560,3072,3584,4096,4608,5120]', - ], - ], - ], - ], - ], - 'spec' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["elasticsearch.sn2ne.large","elasticsearch.sn2ne.xlarge","elasticsearch.sn2ne.2xlarge","elasticsearch.sn2ne.4xlarge","elasticsearch.sn1ne.8xlarge","elasticsearch.ic5.large","elasticsearch.ic5.xlarge","elasticsearch.ic5.2xlarge","elasticsearch.ic5.3xlarge","elasticsearch.ic5.4xlarge","elasticsearch.r5.large","elasticsearch.r5.xlarge","elasticsearch.r5.2xlarge"]', - ], - ], - 'amountRange' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'maxAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - ], - 'minAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - ], - ], - 'logstashZones' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'description' => 'The endpoint details.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'endpointBusinessStatus' => ['description' => 'The business status of the endpoint. Valid values:'."\n" + ."\n" + .'- Normal: Normal.'."\n" + ."\n" + .'- FinancialLocked: Locked due to overdue payment.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'serviceId' => ['description' => 'The ID of the endpoint service associated with the endpoint.', 'type' => 'string', 'example' => 'epsrv-bp1w0p3jdirbfmt6****', 'title' => ''], + 'endpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'endpointId' => ['description' => 'The endpoint ID.', 'type' => 'string', 'example' => 'ep-bp1tah7zbrwmkjef****', 'title' => ''], + 'serviceName' => ['description' => 'The name of the endpoint service associated with the endpoint.', 'type' => 'string', 'example' => 'com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1w0p3jdirbfmt6****', 'title' => ''], + 'createTime' => ['description' => 'The time when the endpoint was created.', 'type' => 'string', 'example' => '2021-07-22T01:19:24Z', 'title' => ''], + 'connectionStatus' => ['description' => 'The endpoint connection status. Valid values:'."\n" + ."\n" + .'- Pending: Being modified.'."\n" + ."\n" + .'- Connecting: Connecting.'."\n" + ."\n" + .'- Connected: Connected.'."\n" + ."\n" + .'- Disconnecting: Disconnecting.'."\n" + ."\n" + .'- Disconnected: Not connected.'."\n" + ."\n" + .'- Deleting: Being deleted.'."\n" + ."\n" + .'- ServiceDeleted: The service associated with the endpoint has been deleted.', 'type' => 'string', 'example' => 'Disconnected', 'title' => ''], + 'endpointDomain' => ['description' => 'The endpoint domain name, which is used for connection configuration.', 'type' => 'string', 'example' => 'ep-bp18s6wy9420wdi4****.epsrv-bp1bz3efowa4kc0****.cn-hangzhou.privatelink.aliyuncs.com', 'title' => ''], + 'endpointStatus' => ['description' => 'The endpoint status. Valid values:'."\n" + ."\n" + .'- Creating: Being created.'."\n" + ."\n" + .'- Active: Available.'."\n" + ."\n" + .'- Pending: Being modified.'."\n" + ."\n" + .'- Deleting: Being deleted.', 'type' => 'string', 'example' => 'Active', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6F******\\",\\n \\"Result\\": {\\n \\"env\\": \\"production\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"createUrl\\": \\"https://common-buy.aliyun.com/?commodityCode=elasticsearch&orderType=BUY#/buy\\",\\n \\"dataDiskList\\": [\\n {\\n \\"scaleLimit\\": 2048,\\n \\"minSize\\": 20,\\n \\"maxSize\\": 5120,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"valueLimitSet\\": [\\n \\"[2560,3072,3584,4096,4608,5120]\\"\\n ]\\n }\\n ],\\n \\"esVersionsLatestList\\": [\\n {\\n \\"key\\": \\"5.5_with_X-Pack\\",\\n \\"value\\": \\"5.5.3_with_X-Pack\\"\\n }\\n ],\\n \\"nodeSpecList\\": [\\n {\\n \\"memorySize\\": 64,\\n \\"cpuCount\\": 16,\\n \\"diskType\\": \\"local_efficiency\\",\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"disk\\": 44000,\\n \\"specGroupType\\": \\"local_efficiency\\",\\n \\"enable\\": true\\n }\\n ],\\n \\"clientNodeDiskList\\": [\\n {\\n \\"scaleLimit\\": 18,\\n \\"minSize\\": 20,\\n \\"maxSize\\": 20,\\n \\"diskType\\": \\"cloud_efficiency\\"\\n }\\n ],\\n \\"masterDiskList\\": [\\n {\\n \\"scaleLimit\\": 20,\\n \\"minSize\\": 20,\\n \\"maxSize\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n }\\n ],\\n \\"supportVersions\\": [\\n {\\n \\"instanceCategory\\": \\"x-pack\\",\\n \\"supportVersionList\\": [\\n {\\n \\"key\\": \\"5.5\\",\\n \\"value\\": \\"5.5.3\\"\\n }\\n ]\\n }\\n ],\\n \\"masterSpec\\": [\\n \\"[\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.4xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.4xlarge\\\\\\",\\\\\\"elasticsearch.r5.large\\\\\\",\\\\\\"elasticsearch.r5.xlarge\\\\\\",\\\\\\"elasticsearch.r5.2xlarge\\\\\\" ]\\"\\n ],\\n \\"clientNodeSpec\\": [\\n \\"[\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.4xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.4xlarge\\\\\\",\\\\\\"elasticsearch.ic5.xlarge\\\\\\",\\\\\\"elasticsearch.ic5.2xlarge\\\\\\",\\\\\\"elasticsearch.ic5.3xlarge\\\\\\",\\\\\\"elasticsearch.ic5.4xlarge\\\\\\",\\\\\\"elasticsearch.r5.large\\\\\\",\\\\\\"elasticsearch.r5.xlarge\\\\\\",\\\\\\"elasticsearch.r5.2xlarge\\\\\\"]\\"\\n ],\\n \\"zones\\": [\\n \\"[\\\\\\"cn-hangzhou-b\\\\\\",\\\\\\"cn-hangzhou-f\\\\\\"]\\"\\n ],\\n \\"instanceSupportNodes\\": [\\n \\"[ \\\\\\"WORKER\\\\\\", \\\\\\"WORKER_WARM\\\\\\", \\\\\\"COORDINATING\\\\\\", \\\\\\"KIBANA\\\\\\", \\\\\\"MASTER\\\\\\", \\\\\\"ELASTIC_WORKER\\\\\\" ]\\"\\n ],\\n \\"esVersions\\": [\\n \\"[ \\\\\\"5.5.3_with_X-Pack\\\\\\"]\\"\\n ],\\n \\"node\\": {\\n \\"maxAmount\\": 50,\\n \\"minAmount\\": 2\\n },\\n \\"jvmConfine\\": {\\n \\"memory\\": 32,\\n \\"supportEsVersions\\": [\\n \\"[\\\\\\"6.7.0_with_X-Pack\\\\\\",\\\\\\"6.7.0_with_A-Pack\\\\\\",\\\\\\"7.4.0_with_X-Pack\\\\\\"]\\"\\n ],\\n \\"supportGcs\\": [\\n \\"[\\\\\\"CMS\\\\\\",\\\\\\"G1\\\\\\"]\\"\\n ]\\n },\\n \\"clientNodeAmountRange\\": {\\n \\"maxAmount\\": 25,\\n \\"minAmount\\": 2\\n },\\n \\"warmNodeProperties\\": {\\n \\"diskList\\": [\\n {\\n \\"scaleLimit\\": 2048,\\n \\"minSize\\": 500,\\n \\"diskEncryption\\": true,\\n \\"maxSize\\": 5120,\\n \\"diskType\\": \\"cloud_efficiency\\",\\n \\"valueLimitSet\\": [\\n \\"[2560,3072,3584,4096,4608,5120]\\"\\n ]\\n }\\n ],\\n \\"spec\\": [\\n \\"[\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.4xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.8xlarge\\\\\\",\\\\\\"elasticsearch.ic5.large\\\\\\",\\\\\\"elasticsearch.ic5.xlarge\\\\\\",\\\\\\"elasticsearch.ic5.2xlarge\\\\\\",\\\\\\"elasticsearch.ic5.3xlarge\\\\\\",\\\\\\"elasticsearch.ic5.4xlarge\\\\\\",\\\\\\"elasticsearch.r5.large\\\\\\",\\\\\\"elasticsearch.r5.xlarge\\\\\\",\\\\\\"elasticsearch.r5.2xlarge\\\\\\"]\\"\\n ],\\n \\"amountRange\\": {\\n \\"maxAmount\\": 50,\\n \\"minAmount\\": 2\\n }\\n },\\n \\"kibanaNodeProperties\\": {\\n \\"spec\\": [\\n \\"[\\\\\\"elasticsearch.n4.small\\\\\\",\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.large\\\\\\"]\\"\\n ],\\n \\"amountRange\\": {\\n \\"maxAmount\\": 20,\\n \\"minAmount\\": 1\\n }\\n },\\n \\"elasticNodeProperties\\": {\\n \\"diskList\\": [\\n {\\n \\"scaleLimit\\": 2048,\\n \\"minSize\\": 500,\\n \\"diskEncryption\\": true,\\n \\"maxSize\\": 5120,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"valueLimitSet\\": [\\n \\"[2560,3072,3584,4096,4608,5120]\\"\\n ]\\n }\\n ],\\n \\"spec\\": [\\n \\"[\\\\\\"elasticsearch.sn2ne.large\\\\\\",\\\\\\"elasticsearch.sn2ne.xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.2xlarge\\\\\\",\\\\\\"elasticsearch.sn2ne.4xlarge\\\\\\",\\\\\\"elasticsearch.sn1ne.8xlarge\\\\\\",\\\\\\"elasticsearch.ic5.large\\\\\\",\\\\\\"elasticsearch.ic5.xlarge\\\\\\",\\\\\\"elasticsearch.ic5.2xlarge\\\\\\",\\\\\\"elasticsearch.ic5.3xlarge\\\\\\",\\\\\\"elasticsearch.ic5.4xlarge\\\\\\",\\\\\\"elasticsearch.r5.large\\\\\\",\\\\\\"elasticsearch.r5.xlarge\\\\\\",\\\\\\"elasticsearch.r5.2xlarge\\\\\\"]\\"\\n ],\\n \\"amountRange\\": {\\n \\"maxAmount\\": 25,\\n \\"minAmount\\": 2\\n }\\n },\\n \\"logstashZones\\": [\\n \\"\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetRegionConfiguration', - 'summary' => 'Queries the configuration information about the current region.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": [\\n {\\n \\"endpointBusinessStatus\\": \\"Normal\\",\\n \\"serviceId\\": \\"epsrv-bp1w0p3jdirbfmt6****\\",\\n \\"endpointName\\": \\"test\\",\\n \\"endpointId\\": \\"ep-bp1tah7zbrwmkjef****\\",\\n \\"serviceName\\": \\"com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1w0p3jdirbfmt6****\\",\\n \\"createTime\\": \\"2021-07-22T01:19:24Z\\",\\n \\"connectionStatus\\": \\"Disconnected\\",\\n \\"endpointDomain\\": \\"ep-bp18s6wy9420wdi4****.epsrv-bp1bz3efowa4kc0****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"endpointStatus\\": \\"Active\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'View endpoint status', + 'summary' => 'Queries the status of endpoints in the VPC of a service account.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The minimum number of nodes.'."\n", + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListAckNamespaces' => [ - 'path' => '/openapi/ack-clusters/{ClusterId}/namespaces', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVpcEndpoints'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListVpcEndpoints', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], ], + ], + 'MigrateToOtherZone' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/migrate-zones', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'Specifies whether to perform a dry run to check whether zone node migration is feasible. Valid values:'."\n" + .'- true: performs only a validation check without executing the migration task.'."\n" + .'- false: executes the migration task after the validation check succeeds.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'ClusterId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c79acd3fbf462423fb6450e513bb6****', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -20780,137 +17023,124 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '95789100-A329-473B-9D14-9E0B7DB4BD5A', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'namespace' => [ - 'description' => 'The namespace of the cluster.'."\n", - 'type' => 'string', - 'example' => 'logging', - ], - 'status' => [ - 'description' => 'The status of the namespace.'."\n", - 'type' => 'string', - 'example' => 'Active', - ], - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The migration was successful.'."\n" + .'- false: The migration failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"95789100-A329-473B-9D14-9E0B7DB4BD5A\\",\\n \\"Result\\": [\\n {\\n \\"namespace\\": \\"logging\\",\\n \\"status\\": \\"Active\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListAckNamespaces', - 'summary' => 'View all namespaces of the specified Container Service for Kubernetes (ACK) cluster.', - 'description' => '> When you install a shipper on an ACK cluster, you must specify a namespace. You can call this operation to query all namespaces in the ACK cluster, and select a namespace based on your business requirements.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The response parameters described in the following table are also returned.'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Migrate zone', + 'summary' => 'Migrates nodes in a specified zone to a destination zone.', + 'description' => 'When you upgrade the specifications of an instance and encounter insufficient inventory in the current zone, you can resolve this issue by migrating zone nodes. Before calling this operation, make sure that:'."\n" ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|Headers|Struct||The header of the response.|'."\n" - .'|└X-Total-Count|Integer|5|The number of entries returned per page.|'."\n" - ."\n\n" - .'**Note**└ indicates a child parameter.', + .'- Your account has a zone with sufficient resources.'."\n" + ."\n" + .' After migrating nodes of the current specifications to another zone, you must manually [upgrade the cluster](~~96650~~). The cluster is not upgraded during the migration. Therefore, select a zone with sufficient resources to avoid cluster upgrade failures. Select a zone with a later alphabetical order first. For example, between ap-southeast-1e and ap-southeast-1h, select ap-southeast-1h first.'."\n" + ."\n" + .'- The cluster is in a healthy state.'."\n" + ."\n" + .' You can run the `GET _cat/health?v` command to check the cluster health status.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the zone migration information.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- | ---- |'."\n" + .'| fromZoneId| String | Yes | ap-southeast-1a |The zone where the instance currently resides.|'."\n" + .'| toZoneId| String | Yes | ap-southeast-1b |The destination zone to which the nodes are migrated.|'."\n" + .'| toVswitchId| String | Yes | vsw-bp1f7r0ma00pf9h2l**** |The vSwitch ID.|'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "fromZoneId": "ap-southeast-1a",'."\n" + .' "toZoneId": "ap-southeast-1b",'."\n" + .' "toVswitchId": "vsw-bp16t5hpc689dgkgc****"'."\n" + .'}'."\n" + .'```.', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'InstallAckOperator' => [ - 'summary' => 'Installs ES-operator for a Container Service for Kubernetes (ACK) cluster.', - 'path' => '/openapi/ack-clusters/{ClusterId}/operator', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-29T17:13:55.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateToOtherZone'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:MigrateToOtherZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'ModifyDeployMachine' => [ + 'path' => '/openapi/collectors/{ResId}/actions/modify-deploy-machines', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'ResId', 'in' => 'path', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c79acd3fbf462423fb6450e513bb6****', - ], + 'schema' => ['description' => 'The collector ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-xb1i7q79u65nk****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -20918,72 +17148,83 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Indicates whether ES-operator is installed. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EFA88951-7A6F-4A8E-AB8F-2BB7132BA751', - ], + 'Result' => ['description' => 'Indicates whether the update is successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C37CE536-6C0F-4778-9B59-6D94C7F7EB63', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"EFA88951-7A6F-4A8E-AB8F-2BB7132BA751\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'InstallAckOperator', - 'description' => '> Before you install a shipper for an ACK cluster, you must call this operation to install ES-operator for the cluster.'."\n", - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"C37CE536-6C0F-4778-9B59-6D94C7F7EB63\\"\\n}","type":"json"}]', + 'title' => 'Update machines on which a collector is installed', + 'summary' => 'Updates the ECS instances on which a collector is installed.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody also requires the following parameters to specify the target ECS instance information.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| machines| List | Yes | |The target ECS instance information.|'."\n" + .'| └instanceId | String | Yes | i-bp11u91xgubypcuz**** |The instance ID.|'."\n" + .'| type| String | Yes | ECSInstanceId |The type of machine on which the collector is deployed. Only ECSInstanceId (deployment on ECS instances) is supported.|'."\n" + .'| configType| String | Yes |collectorDeployMachine |The configuration type. Only collectorDeployMachine (the deployment machine of the collector) is supported.|.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'InstallUserPlugins' => [ - 'summary' => 'Installs custom plug-ins that are uploaded to the Elasticsearch console.', - 'path' => '/openapi/instances/{InstanceId}/plugins/user/actions/install', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T17:28:24.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDeployMachine'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyDeployMachine', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + ], + ], + 'ModifyElastictask' => [ + 'path' => '/openapi/instances/{InstanceId}/elastic-task', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20992,40 +17233,20 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '64337', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-i7m27ausp001l****', - ], - ], - [ - 'name' => 'force', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-6ja1ro4jt000c****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The scaling information.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{ "elasticExpansionTask": { "triggerType":"crontab", "cronExpression":"0 0 0 ? * MON", "elasticNodeCount":"2", "targetIndices":["*"], "replicaCount":"2" } }', 'title' => ''], ], ], 'responses' => [ @@ -21033,112 +17254,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], 'Result' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["pluginName1.zip", "pluginName2.zip"]', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'elasticExpansionTask' => [ + 'description' => 'The elastic node scale-out rule.', + 'type' => 'object', + 'properties' => [ + 'triggerType' => ['description' => 'The cause. The value is fixed as crontab, which indicates scheduled triggering.', 'type' => 'string', 'example' => 'crontab', 'title' => ''], + 'replicaCount' => ['description' => 'The number of replicas for the target index.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'elasticNodeCount' => ['description' => 'The target number of elastic data nodes during peak hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'cronExpression' => ['description' => 'The trigger cycle, specified as a Quartz Cron expression.', 'type' => 'string', 'example' => '0 0 0 ? * MON', 'title' => ''], + 'targetIndices' => [ + 'type' => 'array', + 'items' => ['description' => 'The name of the target elastic index. Wildcards are supported.', 'type' => 'string', 'example' => '["index"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'elasticShrinkTask' => [ + 'description' => 'The elastic node scale-in rule.', + 'type' => 'object', + 'properties' => [ + 'triggerType' => ['description' => 'The cause. Valid values: crontab, which indicates scheduled triggering.', 'type' => 'string', 'example' => 'crontab', 'title' => ''], + 'replicaCount' => ['description' => 'The number of replicas for the target index.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'elasticNodeCount' => ['description' => 'The target number of elastic data nodes during off-peak hours.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'cronExpression' => ['description' => 'The trigger cycle, specified as a Quartz Cron expression.', 'type' => 'string', 'example' => '4 4 4 ? * WED', 'title' => ''], + 'targetIndices' => [ + 'type' => 'array', + 'items' => ['description' => 'The name of the target elastic index. Wildcards are supported.', 'type' => 'string', 'example' => '["index"] ', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], + 404 => [ + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.', 'description' => 'The specified cluster does not exist. Check the cluster status and try again.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"pluginName1.zip\\\\\\", \\\\\\"pluginName2.zip\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'InstallUserPlugins', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify the information about the custom plug-ins.'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": {\\n \\"elasticExpansionTask\\": {\\n \\"triggerType\\": \\"crontab\\",\\n \\"replicaCount\\": 2,\\n \\"elasticNodeCount\\": 2,\\n \\"cronExpression\\": \\"0 0 0 ? * MON\\",\\n \\"targetIndices\\": [\\n \\"[\\\\\\"index\\\\\\"]\\"\\n ]\\n },\\n \\"elasticShrinkTask\\": {\\n \\"triggerType\\": \\"crontab\\",\\n \\"replicaCount\\": 2,\\n \\"elasticNodeCount\\": 2,\\n \\"cronExpression\\": \\"4 4 4 ? * WED\\",\\n \\"targetIndices\\": [\\n \\"[\\\\\\"index\\\\\\"] \\"\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Update cluster elastic scaling rules', + 'summary' => 'Updates the elastic scaling rules of a cluster.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the scaling information.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- | ---- |'."\n" + .'| elasticExpansionTask| | No | |The elastic node scale-out rule.|'."\n" + .'| └triggerType | String | Yes | crontab |The cause. Valid values: crontab, which indicates scheduled triggering.|'."\n" + .'| └cronExpression | String | Yes | 0 0 0 ? * MON |The trigger epoch, specified as a Quartz Cron expression.|'."\n" + .'| └elasticNodeCount | Integer | No | 2 |The target number of elastic data nodes during peak hours.|'."\n" + .'| └targetIndices | List | No | ["index"] |The name of the target elastic index. Wildcards are supported.|'."\n" + .'| └replicaCount | String | Yes | 2 |The number of replicas for the target index.|'."\n" + .'| elasticShrinkTask| | No | |The elastic node scale-in rule.|'."\n" + .'| └triggerType | String | Yes | crontab |The cause. Valid values: crontab, which indicates scheduled triggering.|'."\n" + .'| └cronExpression | String | Yes | 4 4 4 ? * WED |The trigger epoch, specified as a Quartz Cron expression.|'."\n" + .'| └elasticNodeCount | Integer | No | 2 |The target number of elastic data nodes during off-peak hours.|'."\n" + .'| └targetIndices | List | No | ["index"] |The name of the target elastic index. Wildcards are supported.|'."\n" + .'| └replicaCount | String | Yes | 2 |The number of replicas for the target index.|'."\n" ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|RequestBody|Array||||'."\n" - .'|└ name|String|Yes|pluginName1.zip|The name of a custom plug-in that is uploaded to the Elasticsearch console.|'."\n" - ."\n\n" - .'└ indicates a child parameter.'."\n" + .'> You must specify at least one of elasticExpansionTask and elasticShrinkTask. Both cannot be empty.'."\n" ."\n" - .'Sample code:'."\n" + .'The following example is provided.'."\n" ."\n" .'```'."\n" - .'['."\n" - .' {"name": "pluginName1.zip"},'."\n" - .' {"name": "pluginName2.zip"}'."\n" - .']'."\n" + .'{'."\n" + .' "elasticExpansionTask":'."\n" + .' {'."\n" + .' "triggerType":"crontab",'."\n" + .' "cronExpression":"0 0 0 ? * MON",'."\n" + .' "elasticNodeCount":"2",'."\n" + .' "targetIndices":["*"],'."\n" + .' "replicaCount":"2"'."\n" + .' }'."\n" + .'}'."\n" .'```', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RecommendTemplates' => [ - 'path' => '/openapi/instances/{InstanceId}/recommended-templates', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyElastictask'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyElastictask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'ModifyInstanceMaintainTime' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/modify-maintaintime', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '64346', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-oew20apwz0007****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'usageScenario', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '*'."\n" - .'*'."\n" - .'*'."\n" - .'*'."\n" - .'*'."\n" - ."\n" - .'**'."\n" - ."\n" - .'****'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'general', - ], + 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body parameters. For more information, see the RequestBody section below.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{ "openMaintainTime": true, "maintainStartTime": "03:00Z", "maintainEndTime": "04:00Z" }', 'title' => ''], ], ], 'responses' => [ @@ -21146,229 +17405,372 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '66B060CF-7381-49C7-9B89-7757927FDA16', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'content' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\n\\t\\"persistent\\": {\\n\\t\\t\\"search\\": {\\n\\t\\t\\t\\"max_buckets\\": \\"10000\\"\\n\\t\\t}\\n\\t}\\n}', - ], - 'templateName' => [ - 'description' => '*'."\n" - .'*'."\n" - .'*'."\n" - .'*'."\n" - ."\n" - .'**'."\n" - ."\n" - .'****'."\n", - 'type' => 'string', - 'example' => 'dynamicSettings', - ], - ], - ], - ], + 'Result' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"66B060CF-7381-49C7-9B89-7757927FDA16\\",\\n \\"Result\\": [\\n {\\n \\"content\\": \\"{\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"persistent\\\\\\\\\\\\\\": {\\\\\\\\n\\\\\\\\t\\\\\\\\t\\\\\\\\\\\\\\"search\\\\\\\\\\\\\\": {\\\\\\\\n\\\\\\\\t\\\\\\\\t\\\\\\\\t\\\\\\\\\\\\\\"max_buckets\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"10000\\\\\\\\\\\\\\"\\\\\\\\n\\\\\\\\t\\\\\\\\t}\\\\\\\\n\\\\\\\\t}\\\\\\\\n}\\",\\n \\"templateName\\": \\"dynamicSettings\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RecommendTemplates', - 'requestParamsDescription' => ' ', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Modify and enable the maintenance window for an instance', + 'summary' => 'Modifies and enables the maintenance window for an instance.', + 'description' => 'Before calling this operation, note the following:'."\n" + .'- Before the scheduled maintenance, Alibaba Cloud sends SMS messages and emails to the contacts configured in your Alibaba Cloud account. Check your messages promptly.'."\n" + .'- On the day of instance maintenance, to ensure stability throughout the maintenance process, the instance enters the Effective state before the maintenance window begins. While the instance is in this state, access to the cluster and query operations such as performance monitoring are not affected. However, cluster change operations such as cluster upgrades and restarts are temporarily unavailable.'."\n" + .'- During the maintenance window, transient disconnections may occur. Ensure that your application has a reconnection mechanism.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the maintenance window information.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| maintainStartTime| String | No | 02:00Z |The start time of the maintenance window, in the HH:mmZ format (UTC).|'."\n" + .'| maintainEndTime| String | No | 06:00Z |The end time of the maintenance window, in the HH:mmZ format (UTC).|'."\n" + .'| openMaintainTime| boolean | Yes | true |Specifies whether to enable the maintenance window feature. Only **true** is supported, which indicates that the feature is enabled.|'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "openMaintainTime": true,'."\n" + .' "maintainStartTime": "03:00Z",'."\n" + .' "maintainEndTime": "04:00Z"'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ValidateSlrPermission' => [ - 'path' => '/openapi/user/servicerolepermission', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceMaintainTime'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyInstanceMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'ModifyScheduleExecuteTime' => [ + 'summary' => 'For O&M events in the Event Center, you can specify a restart event, and the system will restart the specified edge zone of the relevant instance at the scheduled time.', + 'path' => '/openapi/event/{instanceId}/actions/modify-execute-time', + 'methods' => ['put', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '64400', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchZEMBRN', - ], - 'tenantRelevance' => 'publicInformation', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-3h4k3axh33th9****', 'title' => ''], + ], + [ + 'name' => 'eventId', 'in' => 'query', + 'schema' => ['description' => 'Event ID.', 'type' => 'string', 'required' => false, 'example' => 'eb7efbc90864a0***', 'title' => ''], + ], + [ + 'name' => 'scheduleExecuteTime', + 'in' => 'query', + 'schema' => ['description' => 'Scheduled execution time (UTC)', 'type' => 'string', 'required' => false, 'example' => '2026-01-30T08:45:00Z', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['description' => 'Id of the request', 'title' => 'Id of the request', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9'], + 'result' => ['description' => 'Return Result', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify the scheduled execution time of an event', + 'extraInfo' => 'Common error codes are as follows:'."\n" + ."\n" + .'EventModifyExecuteTimeDirtyError: The scheduled execution time you specified is invalid or illegal.'."\n" + ."\n" + .'EventModifyExecuteTimeInsufficientError: The scheduled time for your change is later than the latest allowed scheduling time. Please adjust it.'."\n" + ."\n" + .'EventModifyExecuteTimeTooCloseError: The scheduled time is less than one scheduling cycle away from the current time.'."\n" + ."\n" + .'EventModifyExecuteTimeUnknownError: System Error. Please submit a ticket to resolve this issue.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"result\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ModifyWhiteIps' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/modify-white-ips', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'rolename', + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-0pp1jxvcl000z****', 'title' => ''], + ], + [ + 'name' => 'clientToken', 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to guarantee the idempotency of the request. The maximum length is 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'AliyunServiceRoleForElasticsearchCollector', + 'description' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'nodeType' => ['title' => '', 'description' => 'The node type. This parameter is required if you specify the whiteIpList parameter. Valid values:'."\n" + ."\n" + .'- WORKER: Elasticsearch cluster'."\n" + .'- KIBANA: Kibana cluster.', 'type' => 'string', 'required' => false, 'example' => 'WORKER'], + 'networkType' => ['title' => '', 'description' => 'The network type. This parameter is required if you specify the whiteIpList parameter. Valid values:'."\n" + ."\n" + .'- PRIVATE: private network'."\n" + .'- PUBLIC: public network.', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'], + 'modifyMode' => ['title' => '', 'description' => 'The modification mode. Valid values:'."\n" + ."\n" + .'- Cover (default): overwrites the original IP whitelist with the value of the ips parameter.'."\n" + .'- Append: adds the IP addresses specified in the ips parameter to the original IP whitelist.'."\n" + .'- Delete: removes the IP addresses specified in the ips parameter from the original IP whitelist. At least one IP address must be retained.', 'type' => 'string', 'required' => false, 'example' => 'Cover'], + 'whiteIpList' => [ + 'title' => '', + 'description' => 'The IP address whitelist. This parameter is available when whiteIpGroup is empty and updates the default group whitelist.', + 'type' => 'array', + 'items' => ['description' => 'The IP address whitelist. This parameter is available when whiteIpGroup is empty. The value of this parameter updates the IP whitelist configuration in the Default whitelist group.'."\n" + .'><notice>You cannot specify both whiteIpList and whiteIpGroup at the same time.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.xx', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'whiteIpGroup' => [ + 'title' => '', + 'description' => 'Updates the instance whitelist configuration by whitelist group. Only one whitelist group can be updated at a time.'."\n" + .'><notice>You cannot specify both whiteIpList and whiteIpGroup at the same time.'."\n" + .'></notice>.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['title' => '', 'description' => 'The name of the whitelist group. This parameter is required if you specify the whiteIpGroup parameter.', 'type' => 'string', 'required' => false, 'example' => 'test_group'], + 'ips' => [ + 'title' => '', + 'description' => 'The list of IP addresses in the whitelist group. This parameter is required if you specify the whiteIpGroup parameter.', + 'type' => 'array', + 'items' => ['description' => 'The list of IP addresses in the whitelist group. This parameter is required if you specify the whiteIpGroup parameter.', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.xx', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'whiteIpType' => [ + 'title' => '', + 'description' => 'The type of the IP whitelist. Valid values:'."\n" + ."\n" + .'- PRIVATE_KIBANA: Kibana internal-facing whitelist'."\n" + .'- PRIVATE_ES: Elasticsearch internal-facing whitelist'."\n" + .'- PUBLIC_ES: Elasticsearch public network access whitelist'."\n" + .'- PUBLIC_KIBANA: Kibana public network access whitelist.', + 'enumValueTitles' => ['PRIVATE_KIBANA' => 'Kibana internal-facing whitelist.', 'PRIVATE_ES' => 'Elasticsearch instance internal-facing whitelist.', 'PUBLIC_ES' => 'Elasticsearch instance public network access whitelist.', 'PUBLIC_KIBANA' => 'Kibana public network access whitelist.'], + 'type' => 'string', + 'required' => false, + 'example' => 'PRIVATE_ES', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'BC4ED7DD-8C84-49B5-8A95-456F82E44D13', - ], + 'Result' => ['description' => 'The result. Valid values:'."\n" + ."\n" + .'- true: The whitelist is updated.'."\n" + .'- false: The whitelist failed to be updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"BC4ED7DD-8C84-49B5-8A95-456F82E44D13\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ValidateSlrPermission', - 'summary' => 'Verify the SLR permissions of the current account.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'InitializeOperationRole' => [ - 'summary' => 'Creates a service-linked role.', - 'path' => '/openapi/user/slr', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG\\"\\n}","type":"json"}]', + 'title' => 'Update the access whitelist of a specified instance', + 'summary' => 'Calls ModifyWhiteIps to update the access whitelist of a specified instance.', + 'description' => '## Before you begin'."\n" + .'- You cannot update information for an instance whose instance status is activating, invalid, or freeze (inactive).'."\n" + .'- You can update the whitelist in two ways: IP whitelist list and IP whitelist group. The two methods cannot be used at the same time. In addition to InstanceId and clientToken, the two methods support different parameters:'."\n" + .' - IP whitelist list: whiteIpList, nodeType, networkType'."\n" + .' - IP whitelist group: modifyMode, whiteIpGroup'."\n" + .'- The public network access whitelist does not support private network IP addresses, and the internal-facing whitelist does not support public IP addresses.', + 'requestParamsDescription' => '><notice> Whitelist groups are added or deleted by calling the operation with modifyMode set to Cover. Delete and Append cannot add or delete whitelist groups. They can only modify the IP address list within a whitelist group. Details are as follows:'."\n" + ."\n" + .'- If modifyMode is set to Cover and ips is empty, the whitelist group is deleted. If groupName is not in the list of existing whitelist group names, a new whitelist group is created.'."\n" + .'- If modifyMode is set to Delete, at least one IP address must be retained after the deletion.'."\n" + .'- If modifyMode is set to Append, the whitelist group name must already exist. Otherwise, a NotFound error is returned.'."\n" + ."\n" + .'></notice>.', + 'changeSet' => [ + ['createdAt' => '2022-01-18T07:05:48.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyWhiteIps'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'MoveResourceGroup' => [ + 'path' => '/openapi/instances/{InstanceId}/resourcegroup', + 'methods' => ['patch', 'post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + [ + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -21376,155 +17778,237 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => 'Indicates whether the service-linked role is created. Valid values:'."\n" - ."\n" - .'* true: The service-linked role is created.'."\n" - .'* false: The service-linked role fails to be created.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '29101430-4797-4D1D-96C3-9FCBCCA8F845', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'nodeAmount' => ['description' => 'The number of data nodes of the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'publicDomain' => ['description' => 'The public network access address.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com', 'title' => ''], + 'createdAt' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2020-07-06T10:18:48.662Z', 'title' => ''], + 'status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- active: Normal.'."\n" + .'- activating: Taking effect.'."\n" + .'- inactive: Frozen.'."\n" + .'- invalid: Expired.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'publicPort' => ['description' => 'The public port.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'kibanaPort' => ['description' => 'The public port for Kibana.', 'type' => 'integer', 'format' => 'int32', 'example' => '5601', 'title' => ''], + 'paymentType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- prepaid: subscription.'."\n" + .'- postpaid: pay-as-you-go.', 'type' => 'string', 'example' => 'postpaid', 'title' => ''], + 'domain' => ['description' => 'The internal endpoint of the instance.', 'type' => 'string', 'example' => 'es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com', 'title' => ''], + 'description' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'es-cn-abc', 'title' => ''], + 'esVersion' => ['description' => 'The instance version.', 'type' => 'string', 'example' => '6.7.0_with_X-Pack', 'title' => ''], + 'kibanaDomain' => ['description' => 'The public network access address for Kibana.', 'type' => 'string', 'example' => 'es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com', 'title' => ''], + 'updatedAt' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2018-07-18T10:10:04.484Z', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + 'dictList' => [ + 'description' => 'The IK dictionary configuration.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'sourceType' => ['description' => 'The source type. Valid values:'."\n" + ."\n" + .'- OSS: OSS open storage. Make sure that the OSS bucket has public-read permission.'."\n" + .'- ORIGIN: retains the previously uploaded dictionary.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], + 'type' => ['description' => 'The dictionary type. Valid values:'."\n" + ."\n" + .'- STOP: stopword.'."\n" + .'- MAIN: main dictionary.'."\n" + .'- SYNONYMS: synonym dictionary.'."\n" + .'- ALI_WS: Alibaba dictionary.', 'type' => 'string', 'example' => 'MAIN', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'synonymsDicts' => [ + 'description' => 'The synonym dictionary configuration.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'sourceType' => ['description' => 'The source type. Valid values:'."\n" + ."\n" + .'- OSS: OSS open storage. Make sure that the OSS bucket has public-read permission.'."\n" + .'- ORIGIN: retains the previously uploaded dictionary.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], + 'type' => ['description' => 'The dictionary type. Valid values:'."\n" + ."\n" + .'- STOP: stopword.'."\n" + .'- MAIN: main dictionary.'."\n" + .'- SYNONYMS: synonym dictionary.'."\n" + .'- ALI_WS: Alibaba dictionary.', 'type' => 'string', 'example' => 'STOP', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'nodeSpec' => [ + 'description' => 'The configuration of data nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'networkConfig' => [ + 'description' => 'The network configuration.', + 'type' => 'object', + 'properties' => [ + 'vpcId' => ['description' => 'The virtual private cloud (VPC) ID.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtmagcva****', 'title' => ''], + 'vsArea' => ['description' => 'The zone where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'type' => ['description' => 'The network type. Only VPC is supported.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1k4ec6s7sjdbudw****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'kibanaConfiguration' => [ + 'description' => 'The configuration of Kibana nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'masterConfiguration' => [ + 'description' => 'The configuration of master nodes.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.large', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"29101430-4797-4D1D-96C3-9FCBCCA8F845\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'InitializeOperationRole', - 'description' => '> Before you perform auto scaling for a cluster at the China site (aliyun.com) or you use shippers to collect logs, you must create a service-linked role.'."\n", - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify the name of the service-linked role to be created.'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|rolename|String|Yes|AliyunServiceRoleForElasticsearchCollector|The name of the service-linked role. Valid values: AliyunServiceRoleForElasticsearchOps and AliyunServiceRoleForElasticsearchCollector. AliyunServiceRoleForElasticsearchOps is used for the auto scaling of clusters at the China site (aliyun.com). AliyunServiceRoleForElasticsearchCollector is used for the creation and management of Beats shippers.|', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating', 'description' => ''], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"nodeAmount\\": 2,\\n \\"publicDomain\\": \\"es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com\\",\\n \\"createdAt\\": \\"2020-07-06T10:18:48.662Z\\",\\n \\"status\\": \\"active\\",\\n \\"publicPort\\": 9200,\\n \\"kibanaPort\\": 5601,\\n \\"paymentType\\": \\"postpaid\\",\\n \\"domain\\": \\"es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com\\",\\n \\"description\\": \\"es-cn-abc\\",\\n \\"esVersion\\": \\"6.7.0_with_X-Pack\\",\\n \\"kibanaDomain\\": \\"es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com\\",\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"dictList\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ],\\n \\"synonymsDicts\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"STOP\\"\\n }\\n ],\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 50,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtmagcva****\\",\\n \\"vsArea\\": \\"cn-hangzhou-i\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-bp1k4ec6s7sjdbudw****\\"\\n },\\n \\"kibanaConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 1,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Modify instance resource group', + 'summary' => 'Modifies the resource group to which an instance belongs.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody parameter must also contain the following parameters to specify the resource group information for instance migration.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'|resourceGroupId| String | Yes | rg-acfm2h5vbzd**** |The ID of the target resource group. You can obtain the ID on the [Resource Group](https://resourcemanager.console.aliyun.com/resource-groups) page.|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListPlugins' => [ - 'summary' => 'Queries the plug-ins that are installed on a specified Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/plugins', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveResourceGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:MoveResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'OpenDiagnosis' => [ + 'path' => '/openapi/diagnosis/instances/{InstanceId}/actions/open-diagnosis', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '10'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], - ], - [ - 'name' => 'name', - 'in' => 'query', - 'schema' => [ - 'description' => 'SYSTEM'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'analysis-ik', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'source', + 'name' => 'lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'SYSTEM', - ], + 'schema' => ['description' => 'The language of the request. Default value: the language of the browser. Valid values:'."\n" + ."\n" + .'- en: English.'."\n" + .'- zh: Simplified Chinese.'."\n" + .'- zt: Traditional Chinese.'."\n" + .'- es: Spanish.'."\n" + .'- fr: French.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], ], 'responses' => [ @@ -21532,108 +18016,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The return results.'."\n", - 'type' => 'string', - 'example' => '5A5D8E74-565C-43DC-B031-29289FA9****', - ], - 'Headers' => [ - 'description' => 'The description of the plug-in.'."\n", - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The address of the plug-in description document.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'Result' => [ - 'description' => 'The status of the plug-in.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'specificationUrl' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'https://xxxx.html', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'analysis-ik', - ], - 'description' => [ - 'description' => 'The source type of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'IK analysis plug-in for Elasticsearch.', - ], - 'state' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INSTALLED', - ], - 'source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM', - ], - ], - ], - ], + 'Result' => ['description' => 'Indicates whether the intelligent O&M feature is enabled. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5A5D8E74-565C-43DC-B031-29289FA9****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 2\\n },\\n \\"Result\\": [\\n {\\n \\"specificationUrl\\": \\"https://xxxx.html\\",\\n \\"name\\": \\"analysis-ik\\",\\n \\"description\\": \\"IK analysis plug-in for Elasticsearch.\\",\\n \\"state\\": \\"INSTALLED\\",\\n \\"source\\": \\"SYSTEM\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListPlugins', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Enable intelligent O&M', + 'summary' => 'Enables the intelligent O&M feature for an instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'InstallSystemPlugin' => [ - 'path' => '/openapi/instances/{InstanceId}/plugins/system/actions/install', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenDiagnosis'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:OpenDiagnosis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'OpenHttps' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/open-https', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -21641,39 +18104,17 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'A unique token generated by the client to guarantee the idempotence of the request. The value of this parameter must be unique among different requests and can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], ], 'responses' => [ @@ -21681,254 +18122,229 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - 'Result' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["aliyun-sql"]', - ], - 'description' => 'The list of plug-ins to be installed.'."\n", - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The HTTPS protocol is enabled.'."\n" + .'- false: The HTTPS protocol failed to be enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"aliyun-sql\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'InstallSystemPlugin', - 'summary' => 'Call InstallSystemPlugin to install a system preset plug-in.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Enable HTTPS', + 'summary' => 'Enables the HTTPS protocol. Before enabling HTTPS, make sure that you have purchased client nodes.', + 'description' => '> - To ensure data security, enable the HTTPS protocol.'."\n" + .'- Except for versions 8.5 and 7.16<props="china"><ph> and version 7.10 in some regions</ph></props>, make sure that you have purchased client nodes before enabling HTTPS.', + 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UninstallPlugin' => [ - 'summary' => 'Call UninstallPlugin to uninstall the preset plug-in.', - 'path' => '/openapi/instances/{InstanceId}/plugins/actions/uninstall', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenHttps'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:OpenHttps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'PluginAnalysis' => [ + 'summary' => 'Upload a custom plugin to the plugin repository. After uploading, the plugin is in the pending installation status.', + 'path' => '/openapi/instances/{instanceId}/plugins/actions/analysis', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'get', + 'abilityTreeCode' => '132275', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'Instance ID. ', 'type' => 'string', 'required' => false, 'example' => 'es-cn-6ja1ro4jt000c****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'Request body parameters '."\n" + ."\n" + .'```json', 'type' => 'string', 'required' => false, 'example' => ' {'."\n" + .' "name": "plugin_name.zip",// plugin name'."\n" + .' "ossObject": {'."\n" + .' "bucketName": "bucketName",// oss bucket name'."\n" + .' "key": "my_plugin_dir/plugin_name.zip" // oss file name '."\n" + .' }'."\n" + .' }', 'title' => ''], ], [ - 'name' => 'force', + 'name' => 'dryRun', 'in' => 'query', - 'schema' => [ - 'title' => '是否强制卸载。可取消安装正在安装中的插件，仅限于新架构实例。默认值：false。', - 'type' => 'boolean', - 'default' => 'false', - ], + 'schema' => ['description' => 'Whether to perform pre-upgrade validation: '."\n" + ."\n" + .'- true: Validate only '."\n" + .'- false: Upload directly ', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'RequestId' => ['description' => 'ID of the request', 'title' => 'ID of the request', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****'], 'Result' => [ + 'description' => 'Return Result.', 'type' => 'array', 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["aliyun-mysql"]', + 'description' => 'Return Result.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'Plugin Description.', 'type' => 'string', 'example' => 'plugin description', 'title' => ''], + 'elasticsearchVersion' => ['description' => 'Plugin version.', 'type' => 'string', 'example' => '8.17.0', 'title' => ''], + 'name' => ['description' => 'Plugin Name.', 'type' => 'string', 'example' => 'plugin_name ', 'title' => ''], + 'securityPolicy' => ['description' => 'Plugin security policy.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'version' => ['description' => 'Plugin Version.', 'type' => 'string', 'example' => '8.17.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'description' => 'The list of plug-ins to be unloaded. If the unloading fails, an exception is returned.'."\n", + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Upload a Custom plugin to the plugin library ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"aliyun-mysql\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UninstallPlugin', - 'requestParamsDescription' => '## RequestBody'."\n" - ."\n" - .'Enter the name of the plug-in in the RequestBody. The format is `["pluginname1","pluginname2",…, "plugin_namen"]`. Example: `["aliyun-sql","codec-compression"]`.', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"description\\": \\"plugin description\\",\\n \\"elasticsearchVersion\\": \\"8.17.0\\",\\n \\"name\\": \\"plugin_name\\\\t\\",\\n \\"securityPolicy\\": \\"null\\",\\n \\"version\\": \\"8.17.0\\"\\n }\\n ]\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'GetEmonMonitorData' => [ - 'summary' => 'GetEmonMonitorData', - 'path' => '/openapi/emon/projects/{ProjectId}/metrics/query', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PostEmonTryAlarmRule' => [ + 'summary' => 'Sends a test alert message by calling PostEmonTryAlarmRule.', + 'path' => '/openapi/emon/projects/{ProjectId}/alarm-groups/{AlarmGroupId}/alarm-rules/_test', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchEC84H8', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchEC84H8'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-185320276651****', - ], + 'schema' => ['description' => 'The ID of the monitoring alert project, in the format of **es-<yourUID>**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-133071096032****', 'title' => ''], + ], + [ + 'name' => 'AlarmGroupId', + 'in' => 'path', + 'schema' => ['description' => 'One of the IDs from the alert list obtained through the [GetEmonGrafanaAlerts](~~254890~~) operation. Specify the ID as needed.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123', 'title' => ''], ], [ 'name' => 'body', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -21936,141 +18352,108 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2D184B55-FA51-43F7-A1EF-E68A0545****', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'integrity' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '1.0', - ], - 'summary' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'messageWatermark' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1522127381471', - ], - 'dps' => [ - 'description' => '', - 'type' => 'object', - 'example' => ' { "1586249280": 465.1980465119913, "1586249300": 213.45243650423305 }', - ], - 'tags' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{"taskName":"et-xxx","userId":"123456"}', - ], - 'metric' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'elasticbuild.elasticsearch.source.total_doc_count', - ], - ], - ], - ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '""', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the alert message was sent. Valid values: true (sent) and false (failed to send).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Send an alert message', + 'description' => '> This API operation can be called up to 10 times per hour.', + 'requestParamsDescription' => '** RequestBody**.'."\n" + ."\n" + .'The RequestBody must also include the following parameters to specify the test alert message to send.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| alarmRuleName | String | Yes | test_rule | The name of the test alert rule. |'."\n" + .'| AlarmChannel | Object | Yes | | The notification method. |'."\n" + .'| └phone | Boolean | No | true | Specifies whether to make a phone call. Valid values: true (make a phone call) and false (do not make a phone call). |'."\n" + .'| └sms | Boolean | No | true | Specifies whether to send an SMS message. Valid values: true (send an SMS message) and false (do not send an SMS message). |'."\n" + .'| └dingWebHook | Boolean | No | true | Specifies whether to send a DingTalk message. Valid values: true (send a DingTalk message) and false (do not send a DingTalk message). |'."\n" + .'| receivers | List | Yes | | The list of message recipients. |'."\n" + .'| └id | long | Yes | 19 | The ID of the contact or contact group. |'."\n" + .'| └contactGroup | Boolean | No | false | Specifies whether this ID is a contact group ID. Valid values: true (contact group ID) and false (not a contact group ID). |.'."\n" + ."\n" + .'> └ indicates a child parameter.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-08-21T02:49:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:23.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PostEmonTryAlarmRule'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:PostEmonTryAlarmRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"2D184B55-FA51-43F7-A1EF-E68A0545****\\",\\n \\"Success\\": true,\\n \\"Result\\": [\\n {\\n \\"integrity\\": 1,\\n \\"summary\\": 10,\\n \\"messageWatermark\\": 1522127381471,\\n \\"dps\\": {\\n \\"1586249280\\": 465.1980465119913,\\n \\"1586249300\\": 213.45243650423305\\n },\\n \\"tags\\": {\\n \\"taskName\\": \\"et-xxx\\",\\n \\"userId\\": \\"123456\\"\\n },\\n \\"metric\\": \\"elasticbuild.elasticsearch.source.total_doc_count\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'GetEmonMonitorData', - 'extraInfo' => ' ', ], - 'DescribeElasticsearchHealth' => [ - 'summary' => 'Check the health status of the cluster and whether it is running normally.', - 'path' => '/openapi/instances/{InstanceId}/elasticsearch-health', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RecommendTemplates' => [ + 'path' => '/openapi/instances/{InstanceId}/recommended-templates', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'abilityTreeCode' => '64346', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-tl325wxga000l****', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-oew20apwz0007****', 'title' => ''], + ], + [ + 'name' => 'usageScenario', + 'in' => 'query', + 'schema' => ['description' => 'The scenario-specific templatetype used by the cluster. Valid values:'."\n" + ."\n" + .'- general: general-purpose scenario'."\n" + .'- analysisVisualization: data analytics scenario'."\n" + .'- dbAcceleration: database acceleration scenario'."\n" + .'- search: search scenario'."\n" + .'- log: log scenario'."\n" + ."\n" + .'> Commercial model instances support the general-purpose, data analytics, database acceleration, and search scenarios. Advanced Edition instances support only the log scenario.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'general', 'title' => ''], ], ], 'responses' => [ @@ -22078,309 +18461,395 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The response code returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The response message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0731F217-2C8A-4D42-8BCD-5C352866E3B7', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '66B060CF-7381-49C7-9B89-7757927FDA16', 'title' => ''], 'Result' => [ - 'description' => 'The color that indicates the health status of the cluster.'."\n", - 'type' => 'string', - 'example' => 'GREEN', + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The template configuration content.', 'type' => 'string', 'example' => '{\\n\\t\\"persistent\\": {\\n\\t\\t\\"search\\": {\\n\\t\\t\\t\\"max_buckets\\": \\"10000\\"\\n\\t\\t}\\n\\t}\\n}', 'title' => ''], + 'templateName' => ['description' => 'The template name. Valid values:'."\n" + .'- staticSettings: cluster static configuration'."\n" + .'- dynamicSettings: cluster dynamic configuration'."\n" + .'- indexTemplate: index template configuration'."\n" + .'- ilmPolicy: index lifecycle configuration'."\n" + ."\n" + .'> Advanced Edition instances of version 6.7.0 or later support enabling the index lifecycle template.', 'type' => 'string', 'example' => 'dynamicSettings', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"0731F217-2C8A-4D42-8BCD-5C352866E3B7\\",\\n \\"Result\\": \\"GREEN\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeElasticsearchHealth', - 'description' => 'An Elasticsearch cluster can be in a health state indicated by one of the following colors:'."\n" - ."\n" - .'* GREEN: Primary shards and replica shards for the primary shards are normally allocated.'."\n" - .'* YELLOW: Primary shards are normally allocated, but replica shards for the primary shards are not normally allocated.'."\n" - .'* RED: Primary shards are not normally allocated.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66B060CF-7381-49C7-9B89-7757927FDA16\\",\\n \\"Result\\": [\\n {\\n \\"content\\": \\"{\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"persistent\\\\\\\\\\\\\\": {\\\\\\\\n\\\\\\\\t\\\\\\\\t\\\\\\\\\\\\\\"search\\\\\\\\\\\\\\": {\\\\\\\\n\\\\\\\\t\\\\\\\\t\\\\\\\\t\\\\\\\\\\\\\\"max_buckets\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"10000\\\\\\\\\\\\\\"\\\\\\\\n\\\\\\\\t\\\\\\\\t}\\\\\\\\n\\\\\\\\t}\\\\\\\\n}\\",\\n \\"templateName\\": \\"dynamicSettings\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Retrieve recommended template list', + 'summary' => 'Calls RecommendTemplates to retrieve recommended cluster configurations.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetEmonGrafanaAlerts' => [ - 'summary' => '获取高级监控报警自定义Grafana监控报警项', - 'path' => '/openapi/emon/projects/{ProjectId}/grafana/proxy/api/alerts', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-04-09T11:50:22.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecommendTemplates'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RecommendTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'ReinstallCollector' => [ + 'summary' => 'Retries the installation of a collector that failed to install during creation.', + 'path' => '/openapi/collectors/{ResId}/actions/reinstall', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchEC84H8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'ResId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-133071096032****', - ], + 'schema' => ['description' => 'The collector ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-l871nd0u73c45****', 'title' => ''], ], [ - 'name' => 'body', + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body parameters. For more information, see the following RequestBody section.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{'."\n" + .' "restartType": "nodeEcsId",'."\n" + .' "nodes":["i-bp1gyhphjaj73jsr****","i-bp10piq1mkfnyw9t****"]'."\n" + .'}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The request result. Valid values:'."\n" + ."\n" + .'- true: The installation succeeded.'."\n" + .'- false: The installation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'title' => '', 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '08FA74C7-5654-4309-9729-D555AF587B7F', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"08FA74C7-5654-4309-9729-D555AF587B7F\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Retry collector installation', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the machine information for retrying the collector installation.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| nodes| List<String\\> | Yes | ["ecs-cn-abc"] |The IDs of the ECS instances on which to retry the collector installation.|'."\n" + .'| restartType| String | Yes | nodeEcsId |The type for retrying the collector installation. Currently, only nodeEcsId is supported, which indicates an ECS instance.|'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "restartType": "nodeEcsId",'."\n" + .' "nodes":["i-bp1gyhphjaj73jsr****","i-bp10piq1mkfnyw9t****"]'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetEmonGrafanaDashboards' => [ - 'summary' => '获取高级监控报警自定义Grafana监控大盘列表', - 'path' => '/openapi/emon/projects/{ProjectId}/grafana/proxy/api/search', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T17:28:23.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReinstallCollector'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ReinstallCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + ], + ], + 'RemovePlugin' => [ + 'summary' => 'You can delete uploaded but uninstalled plugins from the plugin library. ', + 'path' => '/openapi/instances/{instanceId}/plugins/actions/remove', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchEC84H8', - ], + 'abilityTreeCode' => '133135', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-133071096032****', - ], + 'schema' => ['description' => 'Instance ID ', 'title' => 'A short description of struct ', 'type' => 'string', 'required' => false, 'example' => 'es-cn-3h4k3axh33th9****'], ], [ 'name' => 'body', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'in' => 'body', + 'schema' => ['description' => 'Request body. ', 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' {'."\n" + .' "name": "pluginName",'."\n" + .' "elasticsearchVersion": "8.17.0",'."\n" + .' "version": "8.17.0",'."\n" + .' "fileVersion": "CAEQbxiBgIDMoJqe6hkiIGYzM****",'."\n" + .' "state": "UNINSTALLED",'."\n" + .' "source": "USER",'."\n" + .' "pluginType": "CUSTOM_PLUGIN"'."\n" + .' }'."\n" + .']', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1E9D9827-2092-4385-9DA1-FC5A8D1DB3F5', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'ID of the request ', 'title' => 'ID of the request ', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****'], + 'Result' => ['description' => 'Return Result ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + ], + 'title' => 'Remove an uninstalled custom plugin ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'RenewInstance' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/renew', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The renewal was successful.'."\n" + .'- false: The renewal failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"1E9D9827-2092-4385-9DA1-FC5A8D1DB3F5\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'requestParamsDescription' => ' ', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Renew an elasticsearch instance', + 'summary' => 'Renews a subscription Elasticsearch instance.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following fields to specify the renewal information.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| duration | Integer | Yes | 1 | The renewal duration. If pricingCycle is set to Year, valid values are 1 to 3. If pricingCycle is set to Month, valid values are 1 to 9. |'."\n" + .'| pricingCycle | String | Yes | Year | The renewal cycle. Valid values: Year (yearly renewal), Month (monthly renewal). |'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "duration":1,'."\n" + .' "pricingCycle":"Year"'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'PostEmonTryAlarmRule' => [ - 'summary' => 'PostEmonTryAlarmRule', - 'path' => '/openapi/emon/projects/{ProjectId}/alarm-groups/{AlarmGroupId}/alarm-rules/_test', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RenewInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'RenewLogstash' => [ + 'path' => '/openapi/logstashes/{InstanceId}/actions/renew', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchEC84H8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-133071096032****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-n6w1o5jq****', 'title' => ''], ], [ - 'name' => 'AlarmGroupId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -22388,169 +18857,207 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '""', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The renewal was successful.'."\n" + .'- false: The renewal failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<PostEmonTryAlarmRuleResponse>\\n <Code>200</Code>\\n <Message>\\"\\"</Message>\\n <RequestId>3EC5731F-0944-4E4F-9DD5-1F976B3FCC3D</RequestId>\\n <Success>true</Success>\\n</PostEmonTryAlarmRuleResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC****\\"\\n}","type":"json"}]', + 'title' => 'Renew a logstash instance', + 'summary' => 'Renews a specified Logstash instance.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters.'."\n" + ."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| duration | Integer | Yes | 1 | The renewal duration.<br />If pricingCycle is set to Year, valid values: 1 to 3.<br />If pricingCycle is set to Month, valid values: 1 to 9. |'."\n" + .'| pricingCycle | String | Yes | Year | The renewal cycle. Valid values: Year, Month. |'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "duration":1,'."\n" + .' "pricingCycle":"Year"'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListSearchLog' => [ - 'summary' => 'Queries the logs of an Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/search-log', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewLogstash'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RenewLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RestartCollector' => [ + 'summary' => 'Restarts a collector to perform data collection.', + 'path' => '/openapi/collectors/{ResId}/actions/restart', + 'methods' => ['post'], + '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' => [ - 'FEATUREelasticsearchCDBLP9', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ResId', 'in' => 'path', - 'schema' => [ - 'title' => '', - 'description' => '1531910852074'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The collector instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-77uqof2s7rg5c****', 'title' => ''], ], [ - 'name' => 'type', + 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '1531910852074'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'INSTANCELOG', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The restart was successful.'."\n" + .'- false: The restart failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '84B4038A-AF38-4BF4-9FAD-EA92A4FFF00A', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'query', - 'in' => 'query', + '4XX' => [ 'schema' => [ - 'description' => '1'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'host:172.16.**.** AND content:netty', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'beginTime', - 'in' => 'query', + '5XX' => [ 'schema' => [ - 'description' => '20'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1531910852074', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"84B4038A-AF38-4BF4-9FAD-EA92A4FFF00A\\"\\n}","type":"json"}]', + 'title' => 'Restart a collector', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:23.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartCollector'], + ], + ], + 'ramActions' => [ [ - 'name' => 'endTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1531910852074', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RestartCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], ], ], + ], + ], + 'RestartInstance' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/restart', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'page', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q8auz0003****', 'title' => ''], + ], + [ + 'name' => 'force', 'in' => 'query', - 'schema' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to forcefully restart the cluster regardless of the cluster status.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '20', - 'default' => '20', - ], + 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'example' => '1. restart nodes example:'."\n" + .'{'."\n" + .' "restartType": "nodeIp",'."\n" + .' "nodes": ['."\n" + .' "es-cn-xx-data-j-0"'."\n" + .' ],'."\n" + .' "blueGreenDep": false'."\n" + .'}'."\n" + .'2. restart instance example:'."\n" + .'{'."\n" + .' "restartType": "instance",'."\n" + .' "blueGreenDep": false'."\n" + .'}'."\n", 'title' => ''], ], ], 'responses' => [ @@ -22558,204 +19065,348 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The list of logs returned by the request.'."\n", - 'type' => 'string', - 'example' => '7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****', - ], - 'Headers' => [ - 'description' => 'The level of the log. Valid values:'."\n" - ."\n" - .'* warn: warning log'."\n" - .'* info: information log'."\n" - .'* error: error log'."\n" - .'* trace: trace logs'."\n" - .'* debug: debug logs'."\n" - ."\n" - .'The level information has been migrated to the contentCollection field.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****', 'title' => ''], + 'Result' => [ + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The IP address of the node that generates the log.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - ], - ], - 'Result' => [ - 'description' => 'The content of the log entry. Migrated to the contentCollection field.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'contentCollection' => [ - 'description' => '', + 'nodeAmount' => ['description' => 'The number of data nodes in the instance.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'publicDomain' => ['description' => 'The public network access address.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com', 'title' => ''], + 'createdAt' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2020-07-06T10:18:48.662Z', 'title' => ''], + 'status' => ['description' => 'The status of the instance.'."\n" + ."\n" + .'Valid values: active, activating, inactive, and invalid.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'kibanaPort' => ['description' => 'The public port of Kibana.', 'type' => 'integer', 'format' => 'int32', 'example' => '5601', 'title' => ''], + 'publicPort' => ['description' => 'The public port.', 'type' => 'integer', 'format' => 'int32', 'example' => '9200', 'title' => ''], + 'paymentType' => ['description' => 'The billing method of the instance.'."\n" + ."\n" + .'Valid values: prepaid (subscription) and postpaid (pay-as-you-go).', 'type' => 'string', 'example' => 'postpaid', 'title' => ''], + 'domain' => ['description' => 'The internal endpoint of the instance.', 'type' => 'string', 'example' => 'es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com', 'title' => ''], + 'description' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'es-cn-abc', 'title' => ''], + 'esVersion' => ['description' => 'The instance version.', 'type' => 'string', 'example' => '6.7.0_with_X-Pack', 'title' => ''], + 'kibanaDomain' => ['description' => 'The Kibana public network access address.', 'type' => 'string', 'example' => 'es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com', 'title' => ''], + 'updatedAt' => ['description' => 'The time when the instance was last updated.', 'type' => 'string', 'example' => '2018-07-18T10:10:04.484Z', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + 'dictList' => [ + 'description' => 'The IK dictionary configuration.', + 'type' => 'array', + 'items' => [ 'type' => 'object', - 'example' => '{"level": "info", "host": "192.168.**.**", "time": "2019-03-18T08:16:12.741Z","content": "[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...])."}', + 'properties' => [ + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'type' => ['description' => 'The dictionary type. Valid values:'."\n" + ."\n" + .'- STOP: stopword dictionary'."\n" + .'- MAIN: main dictionary'."\n" + .'- SYNONYMS: synonym dictionary'."\n" + .'- ALI_WS: Alibaba dictionary.', 'type' => 'string', 'example' => 'MAIN', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], + 'sourceType' => ['description' => 'The source type. Valid values:'."\n" + ."\n" + .'- OSS: Object Storage Service (OSS). The OSS bucket must have public-read permissions.'."\n" + .'- ORIGIN: open-source Elasticsearch'."\n" + .'- UPLOAD: uploaded file.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'instanceId' => [ + 'title' => '', + 'example' => '', + ], + 'synonymsDicts' => [ + 'description' => 'The synonym dictionary configuration.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'type' => ['description' => 'The dictionary type. Valid values:'."\n" + ."\n" + .'- STOP: stopword dictionary'."\n" + .'- MAIN: main dictionary'."\n" + .'- SYNONYMS: synonym dictionary'."\n" + .'- ALI_WS: Alibaba dictionary.', 'type' => 'string', 'example' => 'STOP', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], + 'sourceType' => ['description' => 'The source type. Valid values:'."\n" + ."\n" + .'- OSS: Object Storage Service (OSS). The OSS bucket must have public-read permissions.'."\n" + .'- ORIGIN: open-source Elasticsearch'."\n" + .'- UPLOAD: uploaded file.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****', + 'title' => '', + 'example' => '', ], - 'level' => [ - 'description' => 'The timestamp when the log is generated. Unit: ms.'."\n", - 'type' => 'string', - 'example' => 'info', + 'title' => '', + 'example' => '', + ], + 'kibanaConfiguration' => [ + 'description' => 'The Kibana node configuration.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], ], - 'host' => [ - 'description' => 'Details of the log entry. Different content fields are returned for different log types.'."\n", - 'type' => 'string', - 'example' => '192.168.**.**', + 'title' => '', + 'example' => '', + ], + 'masterConfiguration' => [ + 'description' => 'The master node configuration.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.large', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Only cloud_ssd (standard SSD) is supported.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], ], - 'content' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => '[GC (Allocation Failure) 2018-07-19T17:24:20.682+0800: 7516.513: [ParNew: 6604768K->81121K(7341504K), 0.0760606 secs] 7226662K->703015K(31813056K), 0.0762507 secs] [Times: user=0.52 sys=0.00, real=0.07 secs] ', + 'title' => '', + 'example' => '', + ], + 'networkConfig' => [ + 'description' => 'The network configuration.', + 'type' => 'object', + 'properties' => [ + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtmagcva****', 'title' => ''], + 'vsArea' => ['description' => 'The zone where the instance is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou-i', 'title' => ''], + 'type' => ['description' => 'The network type. Only Virtual Private Cloud (VPC) is supported.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1k4ec6s7sjdbudw****', 'title' => ''], ], - 'timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531985112420', + 'title' => '', + 'example' => '', + ], + 'nodeSpec' => [ + 'description' => 'The data node configuration.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => 'The node specifications.', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [], - '5XX' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 1000\\n },\\n \\"Result\\": [\\n {\\n \\"contentCollection\\": {\\n \\"level\\": \\"info\\",\\n \\"host\\": \\"192.168.**.**\\",\\n \\"time\\": \\"2019-03-18T08:16:12.741Z\\",\\n \\"content\\": \\"[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...]).\\"\\n },\\n \\"instanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"level\\": \\"info\\",\\n \\"host\\": \\"192.168.**.**\\",\\n \\"content\\": \\"[GC (Allocation Failure) 2018-07-19T17:24:20.682+0800: 7516.513: [ParNew: 6604768K->81121K(7341504K), 0.0760606 secs] 7226662K->703015K(31813056K), 0.0762507 secs] [Times: user=0.52 sys=0.00, real=0.07 secs] \\",\\n \\"timestamp\\": 1531985112420\\n }\\n ]\\n}","errorExample":"{}"},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListSearchLog', - 'requestParamsDescription' => ' ', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating', 'description' => ''], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC****\\",\\n \\"Result\\": {\\n \\"nodeAmount\\": 2,\\n \\"publicDomain\\": \\"es-cn-n6w1o1x0w001c****.public.elasticsearch.aliyuncs.com\\",\\n \\"createdAt\\": \\"2020-07-06T10:18:48.662Z\\",\\n \\"status\\": \\"active\\",\\n \\"kibanaPort\\": 5601,\\n \\"publicPort\\": 9200,\\n \\"paymentType\\": \\"postpaid\\",\\n \\"domain\\": \\"es-cn-nif1q8auz0003****.elasticsearch.aliyuncs.com\\",\\n \\"description\\": \\"es-cn-abc\\",\\n \\"esVersion\\": \\"6.7.0_with_X-Pack\\",\\n \\"kibanaDomain\\": \\"es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com\\",\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"dictList\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"type\\": \\"MAIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"sourceType\\": \\"ORIGIN\\"\\n }\\n ],\\n \\"synonymsDicts\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"type\\": \\"STOP\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"sourceType\\": \\"ORIGIN\\"\\n }\\n ],\\n \\"kibanaConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 1,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtmagcva****\\",\\n \\"vsArea\\": \\"cn-hangzhou-i\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-bp1k4ec6s7sjdbudw****\\"\\n },\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"disk\\": 50,\\n \\"diskType\\": \\"cloud_ssd\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Restart elasticsearch', + 'summary' => 'Restarts an Elasticsearch cluster.', + 'description' => '> After the restart, the instance enters the activating state. After the restart is complete, the instance status changes to active. Alibaba Cloud Elasticsearch supports single-node restarts. Node restarts are classified into normal restarts and blue-green restarts.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody also requires the following parameters to specify restart configuration.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| restartType | String | No | instance | The restart type. Valid values:<br>**instance** (default): restarts the instance.<br>**nodeIp**: restarts a node. You must specify the IP address of the node.<br>**nodeEcsId**: restarts a node. You must specify the ID of the ECS instance in the cluster.|'."\n" + .'| nodes | List<String> | No | ["127.0.0.1"] | The IP addresses or IDs of the nodes to restart when you select node restart.|'."\n" + .'| blueGreenDep | Boolean | No | false | Specifies whether to enable blue-green deployment during node restart. Default value: **false**.|'."\n" + .'| batchCount | Double | No | 25.0 | The concurrency level for forceful instance restart.|'."\n" + .'| batchUnit | String | No | percent | The unit of **batchCount**. Default value: **percent**.|'."\n" + ."\n" + .'> * If **restartType** is not specified or is set to an empty string, the default value **instance** is used. When the value is **instance**, the **blueGreenDep** parameter is ignored, and the following conditions must be met:'."\n" + .' * If **force** is **true**, **batchCount** must be greater than 0 and less than or equal to 100. Otherwise, the RestartBatchValueError error is returned.'."\n" + .' * If **force** is **false**, **batchCount** defaults to 0. If it is set to another value, the NormalRestartNotSupportBatch error is returned.'."\n" + .'* If **restartType** is **nodeIp**, the **batchCount** parameter is ignored, and the following conditions must be met:'."\n" + .' * **nodes** cannot be empty. Otherwise, a parameter error is returned.'."\n" + .' * If **blueGreenDep** is **true**, blue-green deployment is enabled during the node restart. If it is **false**, blue-green deployment is not enabled, and a normal restart is performed.'."\n" + ."\n\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "restartType":"nodeIp",'."\n" + .' "nodes":["172.16.xx.xx","172.16.xx.xx"],'."\n" + .' "blueGreenDep":true'."\n" + .'}'."\n" + .'```.', + 'responseParamsDescription' => 'In the following response examples, only the parameters listed in the response data are guaranteed. Parameters not mentioned are for reference only. Do not rely on obtaining these parameters in your program.', 'extraInfo' => ' ', - ], - 'AddConnectableCluster' => [ - 'path' => '/openapi/instances/{InstanceId}/connected-clusters', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RestartInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'RestartLogstash' => [ + 'summary' => 'Restarts a specified instance. After the restart, the instance enters the activating (activing) state.', + 'path' => '/openapi/logstashes/{InstanceId}/actions/restart', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'es-cn-n6w1o1x0w001c\\*\\*\\*\\*'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-v0h1kzca****', 'title' => ''], + ], + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to force restart the instance. Valid values:'."\n" + ."\n" + .'- true: force restart'."\n" + .'- false (default): do not force restart.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '请求体。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{ "instanceId":"es-cn-09k1rgid9000g****" }', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'The following information is returned:'."\n" + 'batchCount' => ['title' => '', 'description' => 'The concurrency for force restart. This parameter does not need to be set during a blue-green restart because force restart is not supported in that scenario.', 'type' => 'number', 'format' => 'double', 'maximum' => '100', 'minimum' => '0', 'required' => false, 'example' => '20%'], + 'restartType' => [ + 'title' => '', + 'description' => 'The restart type. Valid values:'."\n" ."\n" - .'* true: The configuration is successful.'."\n" - .'* false: The configuration failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5A5D8E74-565C-43DC-B031-29289FA****', - ], - ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ + .'- instance: restart the instance'."\n" + .'- nodeIp: restart a node.', 'type' => 'string', + 'enum' => ['instance 实例重启', 'nodeType 角色类型重启', 'nodeIp 指定节点IP重启'], + 'required' => false, + 'example' => 'instance', ], - 'Message' => [ - 'type' => 'string', + 'nodes' => [ + 'title' => '', + 'description' => 'The node information selected when restarting nodes.', + 'type' => 'array', + 'items' => ['description' => 'The list of IP addresses of the nodes to restart, in JSON array format.', 'type' => 'string', 'required' => false, 'example' => '["192.168.1.1"]', 'title' => ''], + 'required' => false, + 'example' => '', ], - 'RequestId' => [ - 'type' => 'string', + 'nodeTypes' => [ + 'title' => '', + 'description' => 'The type of role node to restart. This parameter is not supported.', + 'type' => 'array', + 'items' => ['description' => 'The type of role node to restart. This parameter is not supported.', 'type' => 'string', 'required' => false, 'example' => 'kibana', 'title' => ''], + 'required' => false, + 'example' => '', ], + 'blueGreenDep' => ['title' => '', 'description' => 'Specifies whether to perform a blue-green restart. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + 'Result' => ['description' => 'The details of the current instance.', '$ref' => '#/components/schemas/Logstash', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5A5D8E74-565C-43DC-B031-29289FA****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'AddConnectableCluster', - 'summary' => 'Connects Elasticsearch clusters.', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": {\\n \\"endpointList\\": [\\n {\\n \\"host\\": \\"172.16.xx.xx\\",\\n \\"port\\": 9200,\\n \\"zoneId\\": \\"cn-hangzhou-i\\"\\n }\\n ],\\n \\"status\\": \\"NORMAL\\",\\n \\"description\\": \\"ls-cn-abc\\",\\n \\"resourceGroupId\\": \\"rg-acfm2h5vbzd****\\",\\n \\"endTime\\": 4749897600000,\\n \\"instanceId\\": \\"ls-cn-n6w1o5jq****\\",\\n \\"config\\": {\\n \\"key\\": \\"[]\\"\\n },\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"networkConfig\\": {\\n \\"type\\": \\"vpc\\",\\n \\"vpcId\\": \\"vpc-abc\\",\\n \\"vsArea\\": \\"cn-hangzhou-*\\",\\n \\"vswitchId\\": \\"vsw-def\\"\\n },\\n \\"zoneInfos\\": [\\n {\\n \\"status\\": \\"NORMAL\\",\\n \\"zoneId\\": \\"cn-hangzhou-i\\"\\n }\\n ],\\n \\"nodeAmount\\": 2,\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\",\\n \\"version\\": \\"6.7.0_with_X-Pack\\",\\n \\"dataNode\\": true,\\n \\"nodeSpec\\": {\\n \\"disk\\": 50,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"spec\\": \\"logstash.n4.small\\"\\n },\\n \\"paymentType\\": \\"postpaid\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"dev\\"\\n }\\n ],\\n \\"zoneCount\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Restart an instance', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The response also includes the Result parameter. For the metric description, see [ListLogstash](~~160534~~).', 'extraInfo' => ' ', - ], - 'DeleteConnectedCluster' => [ - 'path' => '/openapi/instances/{InstanceId}/connected-clusters', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartLogstash'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RestartLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'ResumeElasticsearchTask' => [ + 'path' => '/openapi/instances/{InstanceId}/actions/resume', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22763,138 +19414,118 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the current instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure the idempotency of the request. This parameter value is generated by the client. It must be unique across different requests and cannot exceed 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The return result:'."\n" + ."\n" + .'- true: The interrupted change was resumed successfully.'."\n" + .'- false: The interrupted change failed to be resumed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'connectedInstanceId', - 'in' => 'query', + '4XX' => [ 'schema' => [ - 'description' => 'The ID of the remote instance for which the network connection is established.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-09k1rgid9000g****', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: remove the interworking instance successfully'."\n" - .'* false: remove the interworking instance failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteConnectedCluster', - 'summary' => 'Call DeleteConnectedCluster to remove the interconnected instance.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'ResumeElasticsearchTask', + 'summary' => 'Resumes an interrupted change task for an instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdatePrivateNetworkWhiteIps' => [ - 'summary' => 'You can call this operation to update the VPC private network access whitelist of a specified Elasticsearch instance UpdatePrivateNetworkWhiteIps.', - 'path' => '/openapi/instances/{InstanceId}/private-network-white-ips', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeElasticsearchTask'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ResumeElasticsearchTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'ResumeLogstashTask' => [ + 'path' => '/openapi/logstashes/{InstanceId}/actions/resume', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Cover'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => ' es-cn-tl329rbpc0001****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-4591f1y6****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ - 'name' => 'modifyMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The results that are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only printable ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], ], 'responses' => [ @@ -22902,161 +19533,185 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6DEBE5EE-0368-4757-8F82-EF9C3972****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'privateNetworkIpWhiteList' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["192.168.XX.XX/25"]', - ], - 'description' => '', - ], - ], - ], + 'Code' => ['description' => 'The error code. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => 'InstanceNotFound', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is not returned if the call is successful.', 'type' => 'string', 'example' => 'The specified cluster does not exist. Check the cluster status and try again.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0FA05123-745C-42FD-A69B-AFF48EF9****', 'title' => ''], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The task is resumed.'."\n" + .'- false: The task failed to be resumed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"InstanceNotFound\\",\\n \\"Message\\": \\"The specified cluster does not exist. Check the cluster status and try again.\\",\\n \\"RequestId\\": \\"0FA05123-745C-42FD-A69B-AFF48EF9****\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Resume an interrupted instance change task', + 'summary' => 'Resumes an interrupted instance change task. After the task is resumed, the instance enters the activating state.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeLogstashTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ResumeLogstashTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], ], + ], + ], + 'RolloverDataStream' => [ + 'summary' => 'Creates a new index for a data stream or index alias.', + 'path' => '/openapi/instances/{InstanceId}/data-streams/{DataStream}/rollover', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. This value is generated by the client and must be unique across different requests. The token can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], [ + 'name' => 'DataStream', + 'in' => 'path', + 'schema' => ['description' => 'The data stream name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ds-001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The rollover succeeded.'."\n" + ."\n" + .'- false: The rollover failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6DEBE5EE-0368-4757-8F82-EF9C3972****\\",\\n \\"Result\\": {\\n \\"privateNetworkIpWhiteList\\": [\\n \\"[\\\\\\"192.168.XX.XX/25\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdatePrivateNetworkWhiteIps', - 'description' => '> In the following returned example, only the parameters in the returned data list are guaranteed to be included, and the parameters not mentioned are for reference only. For more information about the parameters, see [ListInstance](~~142230~~). You cannot force a dependency in a program to get these parameters.'."\n", - 'requestParamsDescription' => 'es-cn-tl329rbpc0001\\*\\*\\*\\*'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Roll over data', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdatePublicWhiteIps' => [ - 'summary' => 'null', - 'path' => '/openapi/instances/{InstanceId}/public-white-ips', - 'methods' => [ - 'patch', - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:23.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RolloverDataStream'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RolloverDataStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'RunPipelines' => [ + 'path' => '/openapi/logstashes/{InstanceId}/pipelines/action/run', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Cover'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-tl329rbpc0001****', - ], - ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'modifyMode', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The results that are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure idempotence of the request. The token can contain up to 64 ASCII characters and must be unique across different requests.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -23064,864 +19719,861 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'C82758DD-282F-4D48-934F-92170A33****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'publicIpWhitelist' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["0.0.0.0","10.2.XX.XX","110.0.XX.XX/8"]', - ], - 'description' => '', - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The deployment succeeded.'."\n" + .'- false: The deployment failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], - ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C82758DD-282F-4D48-934F-92170A33****\\",\\n \\"Result\\": {\\n \\"publicIpWhitelist\\": [\\n \\"[\\\\\\"0.0.0.0\\\\\\",\\\\\\"10.2.XX.XX\\\\\\",\\\\\\"110.0.XX.XX/8\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdatePublicWhiteIps', - 'description' => '> In the following example, only the parameters in the returned data list are guaranteed to be included. The parameters that are not mentioned are for reference only. For more information about the parameters, see [ListInstance](~~142230~~). You cannot force a dependency in a program to get these parameters.'."\n", - 'requestParamsDescription' => 'es-cn-tl329rbpc0001\\*\\*\\*\\*'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Deploy and run logstash pipelines', + 'summary' => 'Deploys Logstash pipelines immediately.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include a list of pipeline IDs that specify the pipelines to deploy. Example: `["PipelineId1","PipelineId2","..."]`.', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdatePublicNetwork' => [ - 'summary' => 'null', - 'path' => '/openapi/instances/{InstanceId}/public-network', - 'methods' => [ - 'patch', - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunPipelines'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RunPipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'ShrinkNode' => [ + 'summary' => 'Scales in nodes of a specified role in an Elasticsearch cluster.', + 'path' => '/openapi/instances/{InstanceId}/actions/shrink', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'nodeType', + 'in' => 'query', + 'schema' => ['description' => 'The type of nodes to scale in. Valid values:'."\n" + ."\n" + .'- WORKER: hot node'."\n" + .'- WORKER_WARM: warm node.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WORKER', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token generated by the client to guarantee the idempotency of the request. The maximum length is 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'ignoreStatus', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to ignore the cluster health status. Valid values:'."\n" + ."\n" + .'- true: Ignored.'."\n" + .'- false: Not ignored.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'count', + 'in' => 'query', + 'schema' => ['description' => 'The number of nodes to remove.'."\n" + .'><notice> This parameter applies only to ACK-based instances. When this parameter is specified, the host parameter in the request body is not supported.'."\n" + .'></notice>.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'array', + 'items' => [ + 'description' => 'The request object.', + 'type' => 'object', + 'properties' => [ + 'host' => ['description' => 'The IP address of the node.', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.xx', 'title' => ''], + 'zoneId' => ['description' => 'The zone ID of the instance node. For example, the zone ID for Singapore Zone C is ap-southeast-1c.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-c', 'title' => ''], + 'nodeType' => ['description' => 'The type of nodes to scale in. Valid values:'."\n" + ."\n" + .'- WORKER: hot node'."\n" + .'- WORKER_WARM: warm node.', 'type' => 'string', 'required' => false, 'example' => 'WORKER', 'title' => ''], + 'port' => ['description' => 'The access port number of the node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200', 'title' => ''], + 'hostName' => ['description' => 'The name of the node in a cloud-native ACK-based cluster. You can call the [ListAllNode](~~183958~~) operation to obtain the node name.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-pl32xxxxxxx-data-f-1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2A88ECA1-D827-4581-AD39-05149586****', - ], - 'Result' => [ - 'description' => 'The return results.'."\n", - 'type' => 'object', - 'properties' => [ - 'enablePublic' => [ - 'description' => 'The status of the public network access switch.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- true: The scale-in operation succeeded.'."\n" + .'- false: The scale-in operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2A88ECA1-D827-4581-AD39-05149586****\\",\\n \\"Result\\": {\\n \\"enablePublic\\": false\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdatePublicNetwork', - 'description' => 'When you call this operation, take note of the following items:'."\n" - ."\n" - .'When the instance is in the activating, invalid, or inactive state, its configuration cannot be updated.', - 'requestParamsDescription' => '## RequestBody'."\n" - ."\n" - .'You can also enter the **enablePublic** parameter in RequestBody (optional). The default value is false. The Boolean type. A value of true indicates that access to public endpoint is enabled. A value of false indicates that access to public endpoint is disabled. Example: '."\n" - ."\n" - .'You can also fill in the **enablePublic** parameter in the RequestBody (optional, the default is false). Boolean type. True means that public network address access is enabled and false means disabled. Example: '."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "enablePublic": true'."\n" - .'}'."\n" - .'```', + 'title' => 'Scale in cluster nodes', + 'description' => 'Note the following when you invoke this operation:<br>'."\n" + .'Before scaling in data nodes of a cluster, perform data migration from the nodes to be removed to other nodes. After you confirm that the nodes to be removed contain no data, proceed with the scale-in operation.', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateAdminPassword' => [ - 'summary' => 'You can call this operation to UpdateAdminPassword the password of the elastic account of the specified Elasticsearch instance.', - 'path' => '/openapi/instances/{InstanceId}/admin-pwd', - 'methods' => [ - 'patch', - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-21T04:36:38.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ShrinkNode'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + ], + 'StartCollector' => [ + 'summary' => 'Starts a collector to collect data.', + 'path' => '/openapi/collectors/{ResId}/actions/start', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ResId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'schema' => ['description' => 'The collector ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-77uqof2s7rg5c****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Indicates whether the password was updated. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'esAdminPassword' => [ - 'title' => 'Elasticsearch实例的elastic账号的密码。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es_password', - 'maxLength' => 32, - 'minLength' => 8, - ], + 'Result' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], - 'required' => false, - 'docRequired' => false, - 'example' => '{ "esAdminPassword": "es_password*" }', + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0FA05123-745C-42FD-A69B-AFF48EF9****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 400 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Start a collector', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:23.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartCollector'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:StartCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + ], + ], + 'StopCollector' => [ + 'summary' => 'Calls StopCollector to stop a running collector.', + 'path' => '/openapi/collectors/{ResId}/actions/stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'ResId', + 'in' => 'path', + 'schema' => ['description' => 'The collector ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-77uqof2s7rg5c****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The value can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Result' => ['description' => 'The returned result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 404 => [ + '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 500 => [ + '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0FA05123-745C-42FD-A69B-AFF48EF9****\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateAdminPassword', - 'description' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Stop a running collector', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyWhiteIps' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/modify-white-ips', - 'methods' => [ - 'patch', - 'post', + 'changeSet' => [ + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T17:28:22.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopCollector'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:StopCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopPipelines' => [ + 'path' => '/openapi/logstashes/{InstanceId}/pipelines/action/stop', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The node type. This parameter is required if you configure the whiteIpList parameter. Valid values:'."\n" - ."\n" - .'* WORKER'."\n" - .'* KIBANA'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-0pp1jxvcl000z****', - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The network type. This parameter is required if you configure the whiteIpList parameter. Valid values:'."\n" - ."\n" - .'* PRIVATE'."\n" - .'* PUBLIC'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => 'The update mode. Valid values:'."\n" - ."\n" - .'* Cover (default): overwrites the IP addresses in the specified IP address whitelist with the IP addresses specified by using the ips parameter.'."\n" - .'* Append: adds the IP addresses specified by using the ips parameter to the specified IP address whitelist.'."\n" - .'* Delete: deletes the IP addresses specified by using the ips parameter from the specified IP address whitelist. At least one IP address must be retained for the whitelist.'."\n", - 'type' => 'object', - 'properties' => [ - 'nodeType' => [ - 'title' => '节点类型。可选值：WORKER（Elasticsearch集群）、KIBANA（Kibana集群）。如果选填了whiteIpList参数，则该参数必填。', - 'description' => 'The IP addresses in the whitelist. This parameter is available if the whiteIpGroup parameter is left empty. The default IP address whitelist is updated based on the value of this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'WORKER', - ], - 'networkType' => [ - 'title' => '网络类型。可选值：PRIVATE（私网）、PUBLIC（公网）。如果选填了whiteIpList参数，则该参数必填。', - 'description' => 'The IP addresses in the whitelist. This parameter is available if the whiteIpGroup parameter is left empty. The default IP address whitelist is updated based on the value of this parameter.'."\n" - ."\n" - .'> You cannot configure both the whiteIpList and whiteIpGroup parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PUBLIC', - ], - 'modifyMode' => [ - 'title' => '修改方式，取值含义如下：'."\n" - ."\n" - .'Cover（默认值）：使用ips参数的值覆盖原IP白名单。'."\n" - ."\n" - .'Append：在原IP白名单中增加ips参数中输入的IP地址。'."\n" - ."\n" - .'Delete：Delete：在原IP白名单中删除ips参数中输入的IP地址，至少需要保留一个IP地址。', - 'description' => 'The information about the IP address whitelist that you want to update. You can specify only one whitelist.'."\n" - ."\n" - .'> You cannot configure both the whiteIpList and whiteIpGroup parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Cover', - ], - 'whiteIpList' => [ - 'title' => '白名单列表。whiteIpGroup为空时可用，更改默认分组白名单', - 'description' => 'The name of the whitelist. This parameter is required if you configure the whiteIpGroup parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP addresses in the whitelist. This parameter is required if you configure the whiteIpGroup parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.xx', - ], - 'required' => false, - ], - 'whiteIpGroup' => [ - 'title' => '以白名单组whiteIpGroup传参方式，更新实例白名单安全配置。仅支持更新一个白名单组。', - 'description' => 'The IP addresses in the whitelist. This parameter is required if you configure the whiteIpGroup parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'groupName' => [ - 'title' => '白名单组的组名。如果选填了whiteIpGroup参数，则该参数必填。', - 'description' => 'The type of the IP address whitelist. Valid values:'."\n" - ."\n" - .'* PRIVATE_KIBANA'."\n" - .'* PRIVATE_ES'."\n" - .'* PUBLIC_ES'."\n" - .'* PUBLIC_KIBANA'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_group', - ], - 'ips' => [ - 'title' => '白名单组中的IP列表。如果选填了whiteIpGroup参数，则该参数必填。', - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Indicates whether the IP address whitelist is updated. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.xx.xx', - ], - 'required' => false, - ], - 'whiteIpType' => [ - 'title' => 'ip白名单的类型', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PRIVATE_KIBANA' => '', - 'PRIVATE_ES' => '', - 'PUBLIC_ES' => '', - 'PUBLIC_KIBANA' => '', - ], - 'example' => 'PRIVATE_ES', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The pipelines are stopped.'."\n" + .'- false: The pipelines failed to be stopped.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyWhiteIpsResponse>\\n <Result>true</Result>\\n <RequestId>5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG</RequestId>\\n</ModifyWhiteIpsResponse>","errorExample":""}]', - 'title' => 'ModifyWhiteIps', - 'summary' => 'Updates an IP address whitelist of an Elasticsearch cluster.', - 'description' => 'The ID of the cluster.'."\n", - 'requestParamsDescription' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - ], - 'DescribeConnectableClusters' => [ - 'path' => '/openapi/instances/{InstanceId}/connectable-clusters', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Stop logstash pipelines', + 'summary' => 'Stops Logstash pipelines by calling StopPipelines.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include a list of pipeline IDs that specify the pipelines to be deployed. Example: `["PipelineId1","PipelineId2","..."]`.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPipelines'], + ], ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:StopPipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], + ], + 'TagResources' => [ + 'summary' => 'Creates tag-resource relationships for a specified instance.', + 'path' => '/openapi/tags', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The network type of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - [ - 'name' => 'alreadySetItems', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance that can communicate with each other.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The resource and tag information to create.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', + 'ResourceIds' => [ + 'title' => '', + 'description' => 'The resource IDs.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of resource IDs. The value is in JSON array format. A maximum of 20 items are supported.', 'type' => 'string', 'required' => true, 'example' => '["es-cn-aaa","es-cn-bbb"]'], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + 'example' => '', ], - 'Result' => [ - 'description' => '', + 'Tags' => [ + 'title' => '', + 'description' => 'The tag information.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The tag object.', 'type' => 'object', 'properties' => [ - 'networkType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc', - ], - 'instances' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-xxx', - ], + 'key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => true, 'example' => 'env'], + 'value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => true, 'example' => 'IT'], ], + 'required' => true, + 'example' => '', ], + 'required' => true, + 'maxItems' => 20, + 'minItems' => 1, + 'example' => '', + ], + 'ResourceType' => [ + 'title' => '', + 'description' => 'The resource type. Set this parameter to INSTANCE.', + 'type' => 'string', + 'required' => true, + 'example' => 'INSTANCE', + 'enum' => ['INSTANCE'], ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '', 'description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The tag-resource relationships are created.'."\n" + .'- false: The tag-resource relationships failed to be created.', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3D8795D9-8FF5-46B2-86E6-E3B407*******'], + ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"networkType\\": \\"vpc\\",\\n \\"instances\\": \\"es-cn-xxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeConnectableClusters', - 'summary' => 'Queries the Elasticsearch clusters that can be connected to a specified Elasticsearch cluster.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"3D8795D9-8FF5-46B2-86E6-E3B407*******\\"\\n}","type":"json"}]', + 'title' => 'Create tag-resource relationships', + 'requestParamsDescription' => '> - If a key exists in Tags, a value must also exist (the value can be an empty string). Otherwise, the InvalidParameter.TagKey error is returned.'."\n" + .'- If duplicate key-value pairs are passed in, the Duplicate.TagKey error is returned.'."\n" + .'- If the same tag key already exists before the custom Tags are passed in, the value of the existing tag key is overwritten.', 'extraInfo' => ' ', - ], - 'ListConnectedClusters' => [ - 'summary' => 'Call ListConnectedClusters to query the instances that are interconnected with the current instance.', - 'path' => '/openapi/instances/{InstanceId}/connected-clusters', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-05T06:36:42.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'tags', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:tags/{#tagsId}'], + ], + ], + ], + ], + ], + 'TransferNode' => [ + 'summary' => 'Performs data migration on a node to facilitate node scale-in operations.', + 'path' => '/openapi/instances/{InstanceId}/actions/transfer', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'nodeType', + 'in' => 'query', + 'schema' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'- WORKER: hot node'."\n" + .'- WORKER_WARM: warm node.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WORKER', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the current instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-0pp1jxvcl000z****', + 'description' => 'The request body.', + 'type' => 'array', + 'items' => [ + 'description' => 'The request object.', + 'type' => 'object', + 'properties' => [ + 'host' => ['description' => 'The IP address of the node.', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.xx', 'title' => ''], + 'port' => ['description' => 'The access port number of the node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200', 'title' => ''], + 'zoneId' => ['description' => 'The zone ID of the instance node. For example, the zone ID for Zone C in the China (Shanghai) region is cn-shanghai-c.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-c', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Result' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Result' => [ - 'description' => 'The return results.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'networkType' => [ - 'description' => 'The network type of the instance.'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'instances' => [ - 'description' => 'The ID of the remote instance that is connected to the network of the current instance.'."\n", - 'type' => 'string', - 'example' => 'es-cn-09k1rocex0006****', - ], - ], - ], - ], - ], - ], + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- true: The task was successful.'."\n" + .'- false: The task failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + ], + 400 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"Result\\": [\\n {\\n \\"networkType\\": \\"vpc\\",\\n \\"instances\\": \\"es-cn-09k1rocex0006****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListConnectedClusters', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Migrate node data', + 'requestParamsDescription' => "\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-01-21T04:36:38.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransferNode'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], ], 'TriggerNetwork' => [ - 'summary' => 'You can call this operation to enable or disable public or private network access for a Elasticsearch or Kibana cluster.', + 'summary' => 'Enables or shuts down public or private network access for an Elasticsearch or Kibana cluster.', 'path' => '/openapi/instances/{InstanceId}/actions/network-trigger', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], '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' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'title' => '实例ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****'], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '407d02b74c49beb5bfdac7ec8bde2488', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '407d02b74c49beb5bfdac7ec8bde2488', 'title' => ''], ], [ 'name' => 'body', @@ -23929,35 +20581,24 @@ 'style' => 'json', 'schema' => [ 'title' => '', - 'description' => '', + 'description' => 'The request body parameters.', 'type' => 'object', 'properties' => [ - 'nodeType' => [ - 'title' => '实例类型。KIBANA kibana公私网/WORKER 集群公私网', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'KIBANA', - ], - 'networkType' => [ - 'title' => '网络类型。PUBLIC：公网；PRIVATE：私网', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PUBLIC', - ], - 'actionType' => [ - 'title' => '动作类型。CLOSE：关闭; OPEN：开启', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OPEN', - ], + 'nodeType' => ['title' => '', 'description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- KIBANA: Kibana cluster.'."\n" + .'- WORKER: Elasticsearch cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'KIBANA'], + 'networkType' => ['title' => '', 'description' => 'The network type. Valid values:'."\n" + ."\n" + .'- PUBLIC: public network.'."\n" + .'- PRIVATE: private network.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'PUBLIC'], + 'actionType' => ['title' => '', 'description' => 'The action type. Valid values:'."\n" + ."\n" + .'- CLOSE: disable.'."\n" + .'- OPEN: enable.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'OPEN'], ], 'required' => false, + 'example' => '', ], ], ], @@ -23966,212 +20607,272 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5A5D8E74-565C-43DC-B031-29289FA****', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5A5D8E74-565C-43DC-B031-29289FA****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5A5D8E74-565C-43DC-B031-29289FA****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'TriggerNetwork', - ], - 'OpenHttps' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/open-https', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5A5D8E74-565C-43DC-B031-29289FA****\\"\\n}","type":"json"}]', + 'title' => 'Enable or shutdown public or private network access', + 'changeSet' => [ + ['createdAt' => '2022-12-13T08:50:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-18T07:07:26.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerNetwork'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TriggerNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'elasticsearch:TriggerNetworkNodeType', 'validationType' => 'always'], + ['conditionKey' => 'elasticsearch:TriggerNetworkAction', 'validationType' => 'always'], + ['conditionKey' => 'elasticsearch:TriggerNetworkType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'TurnOffZone' => [ + 'path' => '/openapi/instances/{instanceId}/actions/turnOff-zone', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'instanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-abc'], ], [ - 'name' => 'clientToken', + 'name' => 'zone', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The zone of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', 'title' => ''], + ], + [ + 'name' => 'hpAlbZoneDrained', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: open the HTTPS protocol successfully'."\n" - .'* false: open the HTTPS protocol failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Disable a zone for a multi-zone instance', + 'summary' => 'Disables an existing zone for a multi-zone instance. This operation is intended only for disaster recovery drills. Proceed with caution.', + 'description' => 'Disables an existing zone for a multi-zone instance. This operation is intended only for disaster recovery drills. Proceed with caution.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TurnOffZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'OpenHttps', - 'summary' => 'Call OpenHttps to enable the HTTPS protocol. Make sure that you have purchased a client node before enabling this feature.', - 'description' => '> To ensure data security, we recommend that you enable HTTPS.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","type":"json"}]', ], - 'CloseHttps' => [ - 'path' => '/openapi/instances/{InstanceId}/actions/close-https', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TurnOnZone' => [ + 'summary' => 'Reopens an offline zone for a multi-zone instance. This operation is intended only for disaster recovery drills. Proceed with caution.', + 'path' => '/openapi/instances/{instanceId}/actions/turnOn-zone', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-xxxx'], + ], + [ + 'name' => 'zone', + 'in' => 'query', + 'schema' => ['description' => 'The zone of the instance.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-i', 'title' => ''], + ], + [ + 'name' => 'hpAlbZoneDrained', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'default' => 'false', 'title' => '', 'description' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Reopen an offline zone', + 'description' => 'Reopens an offline zone for a multi-zone instance. This operation is intended only for disaster recovery drills. Proceed with caution.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TurnOnZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","type":"json"}]', + ], + 'UninstallKibanaPlugin' => [ + 'summary' => 'Uninstalls plug-ins from the Kibana node of an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/kibana-plugins/actions/uninstall', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-6ja1ro4jt000c****', 'title' => ''], + ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure idempotence of the request. The token can contain up to 64 ASCII characters and must be unique across different requests.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -24179,293 +20880,277 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], 'Result' => [ + 'type' => 'array', + 'items' => ['description' => 'The result of the operation. The list of uninstalled plug-ins.', 'type' => 'string', 'example' => '["bsearch_querybuilder"]', 'title' => ''], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CloseHttps', - 'summary' => 'Call CloseHttps to close the HTTPS protocol.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"bsearch_querybuilder\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Uninstall kibana plug-ins', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the names of the Kibana plug-ins to uninstall, in the format `["pluginname1","pluginname2",…,"plugin_namen"]`. Example: `["bsearch_label","bsearch_querybuilder"]`.', + 'responseParamsDescription' => '> The response also includes the Headers parameter, which indicates the request header information.', 'extraInfo' => ' ', - ], - 'CreateVpcEndpoint' => [ - 'summary' => '创建私网链接VPC终端节点', - 'path' => '/openapi/instances/{InstanceId}/vpc-endpoints', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:56.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallKibanaPlugin'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UninstallKibanaPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], ], + ], + 'UninstallLogstashPlugin' => [ + 'summary' => 'Uninstalls installed plug-ins from a Logstash instance.', + 'path' => '/openapi/logstashes/{InstanceId}/plugins/actions/uninstall', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-2r429tctl000d****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The returned result details.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value of this parameter must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'dryRun', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the user endpoint service associated with the endpoint.'."\n", - 'type' => 'boolean', + 'description' => 'The list of plug-in names to uninstall, in the format `["pluginName1","pluginName2",...,"pluginNamen"]`.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, - 'example' => 'false', + 'example' => '["logstash-input-datahub", "logstash-input-maxcompute" ]', + 'title' => '', ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'serviceId' => [ - 'title' => '终端节点服务ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'epsrv-hp3xdsq46ael67lo****', - ], - 'zoneId' => [ - 'title' => '可用区ID', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + 'Result' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of uninstalled plug-ins.', 'type' => 'string', 'example' => '["logstash-input-datahub", "logstash-input-maxcompute" ]', 'title' => ''], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-i', + 'title' => '', + 'example' => '', ], + 'Headers' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + 400 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The endpoint domain name, which is used to configure the connection.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Result' => [ - 'description' => 'The ID of the endpoint on the service VPC side.'."\n", - 'type' => 'object', - 'properties' => [ - 'serviceId' => [ - 'description' => 'The name of the service VPC-side endpoint.'."\n", - 'type' => 'string', - 'example' => 'epsrv-bp1w0p3jdirbfmt6****', - ], - 'endpointDomain' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ep-bp1tah7zbrwmkjef****.epsrv-bp1w0p3jdirbfmt6****.cn-hangzhou.privatelink.aliyuncs.com', - ], - 'endpointId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ep-bp1tah7zbrwmkjef****', - ], - 'endpointName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpcElasticSearchABC', - ], - ], - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": {\\n \\"serviceId\\": \\"epsrv-bp1w0p3jdirbfmt6****\\",\\n \\"endpointDomain\\": \\"ep-bp1tah7zbrwmkjef****.epsrv-bp1w0p3jdirbfmt6****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"endpointId\\": \\"ep-bp1tah7zbrwmkjef****\\",\\n \\"endpointName\\": \\"vpcElasticSearchABC\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateVpcEndpoint', - 'description' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D\\*\\*\\*'."\n", - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"logstash-input-datahub\\\\\\", \\\\\\"logstash-input-maxcompute\\\\\\" ]\\"\\n ],\\n \\"Headers\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'Uninstall installed plug-ins', + 'responseParamsDescription' => 'The response also includes the Headers parameter, which indicates the response header information.', 'extraInfo' => ' ', - ], - 'DeleteVpcEndpoint' => [ - 'summary' => 'Deletes an endpoint in the VPC within the Elasticsearch service account.', - 'path' => '/openapi/instances/{InstanceId}/vpc-endpoints/{EndpointId}', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2022-09-13T03:46:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-13T03:46:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-30T09:44:56.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallLogstashPlugin'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UninstallPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ], + ], + ], + ], + ], + 'UninstallPlugin' => [ + 'summary' => 'Uninstalls system plug-ins from an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/plugins/actions/uninstall', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-2r429tctl000d****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'schema' => ['description' => 'A unique token that is used to ensure idempotence. This parameter value is generated by the client and must be unique among different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'EndpointId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ep-bp18s6wy9420wdi4****', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The names of the system plug-ins that you want to uninstall.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["aliyun-sql","codec-compression"]', 'title' => ''], + ], + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to forcefully uninstall the plug-in. You can cancel the installation of a plug-in that is being installed. This parameter is applicable only to instances of the new architecture. Default value: false.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -24473,112 +21158,149 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], 'Result' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of plug-ins that are requested to be uninstalled. If the request fails, an exception is returned.', 'type' => 'string', 'example' => '["aliyun-mysql"]', 'title' => ''], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteVpcEndpoint', - 'requestParamsDescription' => ' ', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"aliyun-mysql\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'UninstallPlugin', + 'requestParamsDescription' => '## RequestBody'."\n" + .' '."\n" + .' The RequestBody parameter must also contain the names of the plug-ins that you want to uninstall. Format: `["pluginname1","pluginname2",…,"plugin_namen"]`. Example: `["aliyun-sql","codec-compression"]`. To obtain the plug-ins installed on an instance, see [ListPlugins](~~142232~~).', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListVpcEndpoints' => [ - 'path' => '/openapi/instances/{InstanceId}/vpc-endpoints', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-13T15:33:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T09:44:56.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallPlugin'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UninstallPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#AccountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'UntagResources' => [ + 'summary' => 'Deletes user resource tag associations for a specified instance.', + 'path' => '/openapi/tags', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-2r429tctl000d****', - ], + 'name' => 'ResourceIds', + 'in' => 'query', + 'schema' => ['description' => 'The list of resources to delete.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["es-cn-09k1rocex0006****","es-cn-oew1rgiev0009****"]', 'title' => ''], ], [ - 'name' => 'size', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The resource type. Set this to **INSTANCE**.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'INSTANCE', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'TagKeys', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n" - ."\n" - .'Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The list of tags to delete. A maximum of 20 items can be specified.', 'type' => 'string', 'required' => false, 'example' => '["tagKey1","tagKey2"]', 'title' => ''], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to delete all tags. Default value: **false**. This parameter is valid only when **TagKeys** is empty.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -24586,203 +21308,149 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - 'Result' => [ - 'description' => 'The details of the endpoints.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'endpointBusinessStatus' => [ - 'description' => 'The business status of the endpoint. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* FinancialLocked'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'serviceId' => [ - 'description' => 'The ID of the endpoint service with which the endpoint is associated.'."\n", - 'type' => 'string', - 'example' => 'epsrv-bp1w0p3jdirbfmt6****', - ], - 'endpointName' => [ - 'description' => 'The name of the endpoint.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'endpointId' => [ - 'description' => 'The ID of the endpoint.'."\n", - 'type' => 'string', - 'example' => 'ep-bp1tah7zbrwmkjef****', - ], - 'serviceName' => [ - 'description' => 'The name of the endpoint service with which the endpoint is associated.'."\n", - 'type' => 'string', - 'example' => 'com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1w0p3jdirbfmt6****', - ], - 'createTime' => [ - 'description' => 'The time when the endpoint was created.'."\n", - 'type' => 'string', - 'example' => '2021-07-22T01:19:24Z', - ], - 'connectionStatus' => [ - 'description' => 'The status of the endpoint connection. Valid values:'."\n" - ."\n" - .'* Pending'."\n" - .'* Connecting'."\n" - .'* Connected'."\n" - .'* Disconnecting'."\n" - .'* Disconnected'."\n" - .'* Deleting'."\n" - .'* ServiceDeleted'."\n", - 'type' => 'string', - 'example' => 'Disconnected', - ], - 'endpointDomain' => [ - 'description' => 'The domain name of the endpoint. The domain name is used for connection configuration.'."\n", - 'type' => 'string', - 'example' => 'ep-bp18s6wy9420wdi4****.epsrv-bp1bz3efowa4kc0****.cn-hangzhou.privatelink.aliyuncs.com', - ], - 'endpointStatus' => [ - 'description' => 'The status of the endpoint. Valid values:'."\n" - ."\n" - .'* Creating'."\n" - .'* Active'."\n" - .'* Pending'."\n" - .'* Deleting'."\n", - 'type' => 'string', - 'example' => 'Active', - ], - ], - ], - ], + 'Result' => ['description' => 'The returned result.'."\n" + ."\n" + .'- true: The deletion was successful.'."\n" + .'- false: The deletion failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6D******', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\",\\n \\"Result\\": [\\n {\\n \\"endpointBusinessStatus\\": \\"Normal\\",\\n \\"serviceId\\": \\"epsrv-bp1w0p3jdirbfmt6****\\",\\n \\"endpointName\\": \\"test\\",\\n \\"endpointId\\": \\"ep-bp1tah7zbrwmkjef****\\",\\n \\"serviceName\\": \\"com.aliyuncs.privatelink.cn-hangzhou.epsrv-bp1w0p3jdirbfmt6****\\",\\n \\"createTime\\": \\"2021-07-22T01:19:24Z\\",\\n \\"connectionStatus\\": \\"Disconnected\\",\\n \\"endpointDomain\\": \\"ep-bp18s6wy9420wdi4****.epsrv-bp1bz3efowa4kc0****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"endpointStatus\\": \\"Active\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListVpcEndpoints', - 'summary' => 'Queries the statuses of endpoints in the virtual private cloud (VPC) within the Elasticsearch service account.', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6D******\\"\\n}","type":"json"}]', + 'title' => 'Delete user resource tag associations', + 'description' => 'When calling this operation, note the following:'."\n" + .'- Only user tags can be deleted.'."\n" + .' '."\n" + .' > User tags are tags that users manually add to instances. System tags are tags that Alibaba Cloud services add to user instances. System tags are classified into visible tags and invisible tags.'."\n" + ."\n" + .'- If a tag is not associated with any resource, the tag is also deleted when the resource tag association is deleted.', + 'requestParamsDescription' => '- If TagKeys is empty and **All = true**, this operation deletes all resource tag associations for the resource. For resources without tags, the operation is not processed and a success response is returned.'."\n" + .'- If **TagKeys** is empty and **All = false**, the operation is not processed and a success response is returned.'."\n" + .'- If **TagKeys** is not empty, the **All** parameter is ignored regardless of whether it is set to true or false.'."\n" + .'- If **TagKeys** is specified, this operation deletes the specified tags from the resource. If a specified tag does not exist on the resource, the tag is skipped.'."\n" + .'- If the resource does not exist, this operation returns **InvalidResourceId.NotFound**.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateSnapshot' => [ - 'path' => '/openapi/instances/{InstanceId}/snapshots', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2025-08-21T02:49:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T09:44:56.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RemoveTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateAdminPassword' => [ + 'summary' => 'Updates the password of the elastic account for a specified Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/admin-pwd', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '64224', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch7ZNWUZ', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-nif1q9o8r0008****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. Generated by the client, this value must be unique across different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'esAdminPassword' => ['title' => '', 'description' => 'The new password.'."\n" + .'> The password must be 8 to 32 characters in length and must contain at least three of the following character types: uppercase letters, lowercase letters, and special characters: !@#$%^&*()_+-=.', 'type' => 'string', 'example' => 'es_password', 'maxLength' => 32, 'minLength' => 8, 'required' => false], + ], 'required' => false, 'docRequired' => false, + 'example' => '{ "esAdminPassword": "es_password*" }', + 'title' => '', ], ], ], @@ -24791,101 +21459,127 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: manual snapshot backup successfully'."\n" - .'* false: manual snapshot backup failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0FA05123-745C-42FD-A69B-AFF48EF9****', 'title' => ''], + 'Result' => ['description' => 'Indicates whether the password is updated. Valid values:'."\n" + ."\n" + .'- true: The password is updated.'."\n" + .'- false: The password failed to be updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateSnapshot', - 'summary' => 'Call CreateSnapshot to manually back up a cluster snapshot.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FA05123-745C-42FD-A69B-AFF48EF9****\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Update the elastic account password of an instance', + 'description' => 'When you invoke this operation, note the following:<br>'."\n" + .'You cannot update information when the instance status is activating, invalid, or freeze (inactive).', 'extraInfo' => ' ', - ], - 'AddSnapshotRepo' => [ - 'path' => '/openapi/instances/{InstanceId}/snapshot-repos', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:55.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAdminPassword'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateAdminPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateAdvancedSetting' => [ + 'summary' => 'Changes the garbage collector configuration of a specified Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/actions/update-advanced-setting', + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance for which you want to access OSS repositories across clusters.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-09k1ruw79000u****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -24893,142 +21587,139 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: Reference warehouse created successfully'."\n" - .'* false: Reference warehouse created failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The garbage collector configuration is changed.'."\n" + .'- false: The garbage collector configuration failed to be changed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'AddSnapshotRepo', - 'summary' => 'Call the AddSnapshotRepo to create a reference repository when configuring a cross-cluster OSS repository.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\"\\n}","type":"json"}]', + 'title' => 'Change the garbage collector configuration of a specified instance', 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody parameter also includes the following parameters to specify the new garbage collector configuration.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| gcName| String | Yes |CMS|The name of the garbage collector after the change. Valid values: CMS, G1.|'."\n" ."\n" - .'The following parameters must be set in RequestBody to specify the cross-cluster backup information. '."\n" - ."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .'| --------- | ---- | -------- | ------- | ----------- |'."\n" - .'| repoPath | String | Yes | es-cn-4591jumei000u**** | The ID of the instance for which you want to restore data. After this parameter is specified, Elasticsearch creates a snapshot of the instance from which you can restore data. '."\n" - ."\n" - .'The instance and the source instance must meet the following requirements:'."\n" - ."\n" - .'Instances within the same region belong to the same account, and the version of the source instance is earlier than or equal to the version of the destination instance. For more information, see [configure cross-cluster OSS repositories](https://www.alibabacloud.com/help/en/elasticsearch/latest/configure-a-shared-oss-repository). |'."\n" .'Example:'."\n" ."\n" .'```'."\n" .'{'."\n" - .' "repoPath" :"es-cn-4591jumei000u****"'."\n" + .' "gcName":"CMS"'."\n" .'}'."\n" - .'```', + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteSnapshotRepo' => [ - 'path' => '/openapi/instances/{InstanceId}/snapshot-repos', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:55.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAdvancedSetting'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateAdvancedSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateAliwsDict' => [ + 'summary' => 'Updates the dictionary of the AliNLP tokenizer plugin (analysis-aliws).', + 'path' => '/openapi/instances/{InstanceId}/aliws-dict', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'repoPath', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Reference instance ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1rux8i000w****', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. The client generates this value. The value must be unique across different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -25036,88 +21727,174 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: reference warehouse deleted successfully'."\n" - .'* false: reference warehouse deleted successfully failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileSize' => ['description' => 'The file size. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '6226', 'title' => ''], + 'sourceType' => ['description' => 'The source type of the dictionary file. Valid values:'."\n" + .'- OSS: uses OSS open storage.'."\n" + .'- ORIGIN: retains the previously uploaded dictionary.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'name' => ['description' => 'The name of the uploaded file.', 'type' => 'string', 'example' => 'aliws_ext_dict.txt', 'title' => ''], + 'type' => ['description' => 'The dictionary type. Valid values: ALI_WS (AliNLP tokenizer).', 'type' => 'string', 'example' => 'ALI_WS', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteSnapshotRepo', - 'summary' => 'Call DeleteSnapshotRepo to delete a cross-cluster OSS repository.', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 6226,\\n \\"sourceType\\": \\"OSS\\",\\n \\"name\\": \\"aliws_ext_dict.txt\\",\\n \\"type\\": \\"ALI_WS\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Update aliNLP tokenizer plugin', + 'description' => 'When calling this operation, note the following:'."\n" + .'- Instances of version 5.x do not support the AliNLP tokenizer plugin.'."\n" + .'- If the dictionary file is sourced from OSS, ensure that the OSS bucket has public-read permission.'."\n" + .'- If a previously uploaded dictionary is not configured with ORIGIN, calling this operation will delete the dictionary file.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The following parameters must also be specified in the RequestBody.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| name | String | Yes | aliws\\_ext\\_dict.txt | The name of the uploaded dictionary file. |'."\n" + .'| ossObject | Array | Yes | | The OSS open storage file description. Required when sourceType is set to OSS.|'."\n" + .'| └bucketName | String | Yes | search-cloud-test-cn-**** | The name of the OSS bucket.|'."\n" + .'| └key | String | Yes | oss/aliws\\_ext\\_dict.txt | The storage path of the dictionary file in the OSS bucket.|'."\n" + .'| sourceType | String | Yes | OSS | The source type of the dictionary file. Valid values: OSS (uses OSS open storage), ORIGIN (retains the previously uploaded dictionary).<br>**Note:**<br>Upload local files to OSS first, and then reference them from OSS.<br>If a previously uploaded dictionary is not configured with ORIGIN, it will be deleted by the system. |'."\n" + .'| type | String | Yes | ALI_WS | The dictionary type. Fixed value: ALI_WS (AliNLP tokenizer).|'."\n" + ."\n" + .'> └ indicates a child parameter.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "name":"deploy_0.txt",'."\n" + .' "ossObject":{'."\n" + .' "bucketName":"search-cloud-test-cn-****",'."\n" + .' "key":"user_dict/dict_0.txt"'."\n" + .' },'."\n" + .' "sourceType":"OSS",'."\n" + .' "type":"ALI_WS"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"aliws_ext_dict.txt",'."\n" + .' "sourceType":"ORIGIN",'."\n" + .' "type":"ALI_WS"'."\n" + .' }'."\n" + .']'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateSnapshotSetting' => [ - 'summary' => 'Call UpdateSnapshotSetting to update the data backup configuration of the specified instance.', - 'path' => '/openapi/instances/{InstanceId}/snapshot-setting', - 'methods' => [ - 'post', - 'put', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAliwsDict'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + ], + 'UpdateBlackIps' => [ + 'summary' => 'Modifies the access blacklist of an Elasticsearch instance. This operation is deprecated.', + 'path' => '/openapi/instances/{InstanceId}/black-ips', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-oew1rgiev0009****', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -25125,126 +21902,109 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Result' => [ - 'description' => 'The return results.'."\n", 'type' => 'object', 'properties' => [ - 'quartzRegex' => [ - 'description' => 'The start time of automatic backup.'."\n", - 'type' => 'string', - 'example' => '0 0 01 ? * * *', - ], - 'enable' => [ - 'description' => 'Specifies whether to enable automatic backup.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'esIPBlacklist' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": {\\n \\"quartzRegex\\": \\"0 0 01 ? * * *\\",\\n \\"enable\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateSnapshotSetting', - 'requestParamsDescription' => '## RequestBody'."\n" - ."\n" - .'The following parameters must be set in RequestBody to specify the modified backup data. '."\n" - ."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .'| --------- | ---- | -------- | ------- | ----------- |'."\n" - .'| quartzRegex | String | No | 0 0 01 ? * * * | The start time of automatic backup. When enable is true, it is required. |'."\n" - .'| enable | Boolean | Yes | true | Specifies whether to enable scheduled backups. |'."\n" - .'Example:'."\n" - ."\n" - .'```'."\n" - .'{'."\n" - .' "quartzRegex":"0 0 01 ? * * *",'."\n" - .' "enable":true'."\n" - .'}'."\n" - .'```', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeSnapshotSetting' => [ - 'summary' => 'Get the snapshot backup settings of the cluster, backup cycle.', - 'path' => '/openapi/instances/{InstanceId}/snapshot-setting', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:58.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBlackIps'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateBlackIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Result\\": {\\n \\"esIPBlacklist\\": [\\n \\"\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => '', + ], + 'UpdateCollector' => [ + 'path' => '/openapi/collectors/{ResId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25252,26 +22012,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '64257', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ResId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-0pp1jxvcl000z****', - ], + 'schema' => ['description' => 'The collector instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-77uqof2s7rg5c****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotency of the request. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -25279,82 +22035,273 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], 'Result' => [ - 'description' => 'The return results.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Enable' => [ - 'description' => 'Whether to enable automatic backup.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'resId' => ['description' => 'The collector instance ID.', 'type' => 'string', 'example' => 'ct-cn-0v3xj86085dvq****', 'title' => ''], + 'gmtUpdateTime' => ['description' => 'The time when the collector was last updated.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'dryRun' => ['description' => 'Indicates whether the collector is validated and created. Valid values:'."\n" + ."\n" + .'- true: Only validated, not created.'."\n" + .'- false: Validated and created.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ownerId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '16852099488*****', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the virtual private cloud (VPC) where the collector resides.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtma*****', 'title' => ''], + 'resType' => ['description' => 'The collector type. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat.', 'type' => 'string', 'example' => 'fileBeat', 'title' => ''], + 'resVersion' => ['description' => 'The collector version.', 'type' => 'string', 'example' => '6.8.5_with_community', 'title' => ''], + 'gmtCreatedTime' => ['description' => 'The time when the collector was created.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'status' => ['description' => 'The collector status. Valid values:'."\n" + ."\n" + .'- activing: Taking effect.'."\n" + ."\n" + .'- active: Active.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'name' => ['description' => 'The collector name.', 'type' => 'string', 'example' => 'ct-test', 'title' => ''], + 'configs' => [ + 'description' => 'The configuration file information of the collector.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The file content.', 'type' => 'string', 'example' => 'filebeat.inputs:xxx', 'title' => ''], + 'fileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'filebeat.yml', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'QuartzRegex' => [ - 'description' => 'Automatic backup time configuration, using Quartz Cron expression.'."\n", - 'type' => 'string', - 'example' => '0 0 01 ? * * *', + 'extendConfigs' => [ + 'description' => 'The extended parameter information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'successPodsCount' => ['description' => 'The number of pods that are successfully collected in the ACK cluster. This parameter is displayed when **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'protocol' => ['description' => 'The transport protocol, which must be consistent with the access protocol of the instance specified by the collector Output. Valid values: HTTP and HTTPS. This parameter is displayed when **configType** is set to **collectorTargetInstance**.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'userName' => ['description' => 'The username used to access the instance specified by the collector Output. Default value: elastic. This parameter is displayed when **configType** is set to **collectorTargetInstance** or **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'elastic', 'title' => ''], + 'totalPodsCount' => ['description' => 'The total number of pods collected in the ACK cluster. This parameter is displayed when **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'type' => ['description' => 'The type of machine on which the collector is deployed. This parameter is displayed when **configType** is set to **collectorDeployMachine**. Valid values:'."\n" + ."\n" + .'- ECSInstanceId: ECS.'."\n" + ."\n" + .'- ACKCluster: Container Kubernetes.', 'type' => 'string', 'example' => 'ECSInstanceId', 'title' => ''], + 'kibanaHost' => ['description' => 'The public network access address of Kibana after Kibana Dashboard is enabled. This parameter is displayed when **configType** is set to **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'enableMonitoring' => ['description' => 'Indicates whether Monitoring is enabled. This parameter is displayed when **configType** is set to **collectorTargetInstance** and **instanceType** is set to **elasticsearch**. Valid values: true (enabled) and false (disabled).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'configType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- collectorTargetInstance: the collector Output.'."\n" + .'- collectorDeployMachine: the machine on which the collector is deployed.'."\n" + .'- collectorElasticsearchForKibana: the Elasticsearch instance information that supports Kibana Dashboard.', 'type' => 'string', 'example' => 'collectorDeployMachine', 'title' => ''], + 'instanceType' => ['description' => 'The type of instance specified by the collector Output. Valid values: elasticsearch and logstash. This parameter is displayed when **configType** is set to **collectorTargetInstance**.', 'type' => 'string', 'example' => 'elasticsearch', 'title' => ''], + 'groupId' => ['description' => 'The machine group ID. This parameter is displayed when **configType** is set to **collectorDeployMachine**.', 'type' => 'string', 'example' => 'default_ct-cn-5i2l75bz4776****', 'title' => ''], + 'host' => ['description' => 'The internal-facing access address of Kibana on the private network after Kibana Dashboard is enabled. This parameter is displayed when **configType** is set to **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'instanceId' => ['description' => 'The ID of the instance associated with the collector. When **configType** is set to **collectorTargetInstance**, this parameter indicates the instance ID of the collector Output. When **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**, this parameter indicates the ACK (Container Kubernetes) cluster ID.', 'type' => 'string', 'example' => 'es-cn-nif1z89fz003i****', 'title' => ''], + 'machines' => [ + 'description' => 'Specific to the collectorDeployMachine type:'."\n" + ."\n" + .'The information about the ECS instances or ACK clusters on which the collector is deployed.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'agentStatus' => ['description' => 'The status of each collector on the ECS instance. Valid values:'."\n" + ."\n" + .'- heartOk: The heartbeat is normal.'."\n" + .'- heartLost: The heartbeat is abnormal.'."\n" + .'- uninstalled: Not installed.'."\n" + .'- failed: Installation failed.', 'type' => 'string', 'example' => 'heartOk', 'title' => ''], + 'instanceId' => ['description' => 'The list of ECS instance IDs.', 'type' => 'string', 'example' => 'i-bp13y63575oypr9d****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'hosts' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of access addresses of the instance specified by the collector Output. This parameter is displayed when **configType** is set to **collectorTargetInstance**.', 'type' => 'string', 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'collectorPaths' => [ + 'type' => 'array', + 'items' => ['description' => 'The collection path of Filebeat.', 'type' => 'string', 'example' => '["/var/log"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.', - ], + 400 => [ + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], + ], + [ + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": {\\n \\"Enable\\": true,\\n \\"QuartzRegex\\": \\"0 0 01 ? * * *\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeSnapshotSetting', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"resId\\": \\"ct-cn-0v3xj86085dvq****\\",\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"dryRun\\": false,\\n \\"ownerId\\": \\"16852099488*****\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"resType\\": \\"fileBeat\\",\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"status\\": \\"active\\",\\n \\"name\\": \\"ct-test\\",\\n \\"configs\\": [\\n {\\n \\"content\\": \\"filebeat.inputs:xxx\\",\\n \\"fileName\\": \\"filebeat.yml\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n {\\n \\"successPodsCount\\": \\"8\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"userName\\": \\"elastic\\",\\n \\"totalPodsCount\\": \\"10\\",\\n \\"type\\": \\"ECSInstanceId\\",\\n \\"kibanaHost\\": \\"https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"enableMonitoring\\": true,\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"host\\": \\"es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601\\",\\n \\"instanceId\\": \\"es-cn-nif1z89fz003i****\\",\\n \\"machines\\": [\\n {\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"instanceId\\": \\"i-bp13y63575oypr9d****\\"\\n }\\n ],\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Modify a collector', + 'summary' => 'Modifies the configuration of a collector.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody also requires the following parameters to specify the configuration information of the collector to be updated.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| dryRun | boolean | Yes | false | Specifies whether to validate and update the collector. Valid values: true (validate only without updating) and false (validate and update). |'."\n" + .'| name | String | Yes | ct-test | The collector name. |'."\n" + .'| status | String | Yes | activing | The collector status. Valid values: activing (taking effect) and active (active). |'."\n" + .'| resType | String | Yes | fileBeat | The collector type. Valid values: fileBeat, metricBeat, heartBeat, and auditBeat. |'."\n" + .'| vpcId | String | Yes | vpc-bp16k1dvzxtma\\***** | The ID of the VPC where the collector resides. |'."\n" + .'| resVersion | String | Yes | 6.8.5\\_with_community | The collector version. |'."\n" + .'| ownerId | String | Yes | 16852099488\\***** | The account ID. |'."\n" + .'| gmtCreatedTime | Date | Yes | 2020-06-20T07:26:47.000+0000 | The time when the collector was created. |'."\n" + .'| gmtUpdateTime | Date | Yes | 2020-06-20T07:26:47.000+0000 | The time when the collector was last updated. |'."\n" + .'| collectorPaths | List<String> | No | ["/var/log"] | The Filebeat collection path. |'."\n" + .'| configs | List | Yes | | The configuration file information of the collector. |'."\n" + .'| └fileName | String | Yes | filebeat.yml | The file name. |'."\n" + .'| └content | String | Yes | "filebeat.inputs:xxx" | The file content. |'."\n" + .'| extendConfigs | Array | Yes | | The extension configuration of the collector. |'."\n" + .'| └configType | String | Yes | collectorElasticsearchForKibana | The configuration type. Valid values: collectorTargetInstance (collector Output), collectorDeployMachine (deployment machine of the collector), and collectorElasticsearchForKibana (Elasticsearch instance information that supports Kibana Dashboard). |'."\n" + .'| └type | String | Yes | ECSInstanceId | The type of machine on which the collector is deployed. Valid values: ECSInstanceId (ECS) and ACKCluster (Container Kubernetes). This parameter is required when **configType** is set to **collectorDeployMachine**. |'."\n" + .'| └machines | Array | No | | The list of ECS instances on which the collector is deployed. This parameter is required when **configType** is set to **collectorDeployMachines** and **type** is set to **ECSInstanceId**. |'."\n" + .'| └└instanceId | String | No | i-bp13y63575oypr9d**** | The list of ECS instance IDs. |'."\n" + .'| └└agentStatus | String | No | failed | The status of each collector on the ECS instance. Valid values: heartOk (heartbeat is normal), heartLost (heartbeat is abnormal), uninstalled (not installed), and failed (installation failed). |'."\n" + .'| └groupId | String | | default_ct-cn-5i2l75bz4776**** | The machine group ID. This parameter is required when **configType** is set to **collectorDeployMachine**. |'."\n" + .'| └instanceId | String | Yes | es-cn-nif1z89fz003i**** | The ID of the instance associated with the collector. When **configType** is set to **collectorTargetInstance**, this parameter indicates the instance ID of the collector Output. When **configType** is set to **collectorDeployMachines** and **type** is set to **ACKCluster**, this parameter indicates the ACK cluster ID. |'."\n" + .'| └protocol | String | Yes | HTTP | The transport protocol, which must be consistent with the access protocol of the instance specified by the collector Output. Valid values: HTTP and HTTPS. This parameter is required when **configType** is set to **collectorTargetInstance**. |'."\n" + .'| └userName | String | Yes | elastic | The username used to access the instance specified by the collector Output. Default value: elastic. This parameter is required when **configType** is set to **collectorTargetInstance** or **collectorElasticsearchForKibana**. |'."\n" + .'| └enableMonitoring | Boolean | Yes | true | Specifies whether to enable Monitoring. This parameter is required when **configType** is set to **collectorTargetInstance** and **instanceType** is set to **elasticsearch**. Valid values: true (enabled) and false (disabled). |'."\n" + .'| └hosts | List<String> | No | ["es-cn-n6w1o1x\\*****.elasticsearch.aliyuncs.com:9200"] | The list of access addresses of the instance specified by the collector Output. This parameter is required when **configType** is set to **collectorTargetInstance**. |'."\n" + .'| └instanceType | String | Yes | elasticsearch | The type of instance specified by the collector Output. Valid values: elasticsearch and logstash. This parameter is required when **configType** is set to **collectorTargetInstance**. |'."\n" + .'| └host | String | No | es-cn-n6w1o1x0w001c****-kibana.internal.elasticsearch.aliyuncs.com:5601 | The internal-facing access address of Kibana on the private network after Kibana Dashboard is enabled. This parameter is required when **configType** is set to **collectorElasticsearchForKibana**. |'."\n" + .'| └kibanaHost | String | No | https://es-cn-nif1z89fz003i****.kibana.elasticsearch.aliyuncs.com:5601 | The public network access address of Kibana after Kibana Dashboard is enabled. This parameter is required when **configType** is set to **collectorElasticsearchForKibana**. |'."\n" + ."\n" + .'> └ indicates a child parameter.'."\n" + ."\n" + .'### Metric description for special parameters'."\n" + .'**extendConfigs** includes three configType values: collectorTargetInstance, collectorElasticsearchForKibana, and collectorDeployMachine. The required parameters vary depending on the deployment machine type. The specific combinations are as follows:'."\n" + ."\n" + .'- collectorTargetInstance'."\n" + .' - ECS'."\n" + .' configType, instanceId, instanceType, hosts, userName, password, protocol, enableMonitoring'."\n" + .' - ACK'."\n" + .' configType, instanceId, instanceType, userName, password, protocol, enableMonitoring'."\n" + ."\n" + .'- collectorElasticsearchForKibana'."\n" + .' - ECS'."\n" + .' configType, instanceId, host, kibanaHost, userName, password, protocol'."\n" + .' - ACK'."\n" + .' configType'."\n" + .' '."\n" + .'- collectorDeployMachine'."\n" + .' - ECS'."\n" + .' configType, type, machines, groupId'."\n" + .' - ACK'."\n" + .' configType, type, instanceId, totalPodsCount, successPodsCount.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListSnapshotReposByInstanceId' => [ - 'summary' => 'Call the ListSnapshotReposByInstanceId to get the cross-cluster OSS repositories of the current instance.', - 'path' => '/openapi/instances/{InstanceId}/snapshot-repos', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCollector'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], ], + ], + 'UpdateCollectorName' => [ + 'summary' => 'Calls UpdateCollectorName to modify the name of a collector.', + 'path' => '/openapi/collectors/{ResId}/actions/rename', + 'methods' => ['post'], + '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' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ResId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-0pp1jxvcl000z****', - ], + 'schema' => ['description' => 'The collector ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ct-cn-77uqof2s7rg5c****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The value of this parameter must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -25362,241 +22309,474 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'The return results.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'snapWarehouse' => [ - 'description' => 'Reference warehouse name.'."\n", - 'type' => 'string', - 'example' => 'aliyun_snapshot_from_es-cn-6ja1ro4jt000c****', - ], - 'repoPath' => [ - 'description' => 'The address of the repository.'."\n", - 'type' => 'string', - 'example' => 'es-cn-6ja1ro4jt000c****', - ], - 'status' => [ - 'description' => 'Reference warehouse status. available indicates that it is valid. unavailable indicates that it is invalid.'."\n", - 'type' => 'string', - 'example' => 'available', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'resId' => ['description' => 'The collector instance ID.', 'type' => 'string', 'example' => 'ct-cn-77uqof2s7rg5c****', 'title' => ''], + 'gmtUpdateTime' => ['description' => 'The time when the collector was last updated.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'dryRun' => ['description' => 'Indicates whether the collector is validated only without being created. Valid values:'."\n" + ."\n" + .'- true: Only validates without updating.'."\n" + .'- false: Validates and updates.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ownerId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '16852099488*****', 'title' => ''], + 'vpcId' => ['description' => 'The ID of the VPC where the collector resides.', 'type' => 'string', 'example' => 'vpc-bp16k1dvzxtma*****', 'title' => ''], + 'resType' => ['description' => 'The collector type. Valid values: fileBeat, metricBeat, heartBeat, and audiBeat.', 'type' => 'string', 'example' => 'fileBeat', 'title' => ''], + 'resVersion' => ['description' => 'The collector version. The supported versions depend on the type of machine on which the collector is deployed:'."\n" + ."\n" + .'- ECS: 6.8.5_with_community'."\n" + .'- ACK: 6.8.13_with_community.', 'type' => 'string', 'example' => '6.8.5_with_community', 'title' => ''], + 'gmtCreatedTime' => ['description' => 'The time when the collector was created.', 'type' => 'string', 'example' => '2020-06-20T07:26:47.000+0000', 'title' => ''], + 'status' => ['description' => 'The collector status. Valid values: activing (taking effect) and active (active).', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'name' => ['description' => 'The collector name.', 'type' => 'string', 'example' => 'ct-test', 'title' => ''], + 'configs' => [ + 'description' => 'The configuration file information of the collector.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'content' => ['description' => 'The file content.', 'type' => 'string', 'example' => '- key: log\\n title: Log file content\\n description: >\\n Contains log file lines.\\n ....', 'title' => ''], + 'fileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'fields.yml', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'instanceId' => [ - 'description' => 'Reference instance ID.'."\n", - 'type' => 'string', - 'example' => 'es-cn-6ja1ro4jt000c****', + 'title' => '', + 'example' => '', + ], + 'extendConfigs' => [ + 'description' => 'The extended configurations of the collector.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'successPodsCount' => ['description' => 'The number of pods that are successfully collected in the ACK cluster. Displayed when **configType** is **collectorDeployMachines** and **type** is **ACKCluster**.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'protocol' => ['description' => 'The transmission protocol. Valid values: **HTTP** and **HTTPS**.', 'type' => 'string', 'example' => 'HTTP', 'title' => ''], + 'userName' => ['description' => 'The username used to access the instance specified in the collector Output. Default value: elastic. Displayed when **configType** is **collectorTargetInstance** or **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'elastic', 'title' => ''], + 'totalPodsCount' => ['description' => 'The total number of pods collected in the ACK cluster. Displayed when **configType** is **collectorDeployMachines** and **type** is **ACKCluster**.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'type' => ['description' => 'The type of machine on which the collector is deployed. Displayed when **configType** is **collectorDeployMachine**. Valid values:'."\n" + ."\n" + .'- ECSInstanceId: ECS instance.'."\n" + .'- ACKCluster: Container Kubernetes cluster.', 'type' => 'string', 'example' => 'ECSInstanceId', 'title' => ''], + 'kibanaHost' => ['description' => 'The public network access address of Kibana after Kibana Dashboard is enabled. Displayed when **configType** is **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'https://es-cn-4591jumei000u****.kibana.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'enableMonitoring' => ['description' => 'Indicates whether Monitoring is enabled. Displayed when **configType** is **collectorTargetInstance** and **instanceType** is **elasticsearch**. Valid values:'."\n" + ."\n" + .'- true: Enabled.'."\n" + .'- false: Not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'configType' => ['description' => 'The configuration type. Valid values:'."\n" + ."\n" + .'- collectorTargetInstance: the collector Output.'."\n" + .'- collectorDeployMachine: the machine on which the collector is deployed.'."\n" + .'- collectorElasticsearchForKibana: the Elasticsearch instance that supports Kibana Dashboard.', 'type' => 'string', 'example' => 'collectorDeployMachine', 'title' => ''], + 'instanceType' => ['description' => 'The type of instance specified in the collector Output. Valid values: elasticsearch and logstash. Displayed when **configType** is **collectorTargetInstance**.', 'type' => 'string', 'example' => 'elasticsearch', 'title' => ''], + 'groupId' => ['description' => 'The machine group ID. Displayed when **configType** is **collectorDeployMachine**.', 'type' => 'string', 'example' => 'default_ct-cn-5i2l75bz4776****', 'title' => ''], + 'host' => ['description' => 'The internal-facing access address of Kibana on the private network after Kibana Dashboard is enabled. Displayed when **configType** is **collectorElasticsearchForKibana**.', 'type' => 'string', 'example' => 'es-cn-4591jumei000u****-kibana.internal.elasticsearch.aliyuncs.com:5601', 'title' => ''], + 'instanceId' => ['description' => 'The ID of the instance associated with the collector. When **configType** is **collectorTargetInstance**, this is the instance ID of the collector Output. When **configType** is **collectorDeployMachines** and **type** is **ACKCluster**, this is the ACK cluster ID.', 'type' => 'string', 'example' => 'es-cn-n6w1o1****', 'title' => ''], + 'machines' => [ + 'description' => 'The list of ECS machines on which the collector is deployed. Displayed when **configType** is **collectorDeployMachines** and **type** is **ECSInstanceId**.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'agentStatus' => ['description' => 'The status of the collector on the ECS instance. Valid values: **heartOk** (normal heartbeat), **heartLost** (abnormal heartbeat), **uninstalled** (not installed), and **failed** (installation failed).', 'type' => 'string', 'example' => 'heartOk', 'title' => ''], + 'instanceId' => ['description' => 'The list of ECS machine IDs.', 'type' => 'string', 'example' => 'c1b9fde5172b84f82b9928e825a7b8988', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'hosts' => [ + 'type' => 'array', + 'items' => ['description' => 'The list of access addresses for the instance specified in the collector Output. Displayed when **configType** is **collectorTargetInstance**.', 'type' => 'string', 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'collectorPaths' => [ + 'type' => 'array', + 'items' => ['description' => 'The fileBeat collection path. Displayed when the collector is deployed on an ECS instance.', 'type' => 'string', 'example' => '["/var/log"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": [\\n {\\n \\"snapWarehouse\\": \\"aliyun_snapshot_from_es-cn-6ja1ro4jt000c****\\",\\n \\"repoPath\\": \\"es-cn-6ja1ro4jt000c****\\",\\n \\"status\\": \\"available\\",\\n \\"instanceId\\": \\"es-cn-6ja1ro4jt000c****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListSnapshotReposByInstanceId', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"resId\\": \\"ct-cn-77uqof2s7rg5c****\\",\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"dryRun\\": false,\\n \\"ownerId\\": \\"16852099488*****\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"resType\\": \\"fileBeat\\",\\n \\"resVersion\\": \\"6.8.5_with_community\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"status\\": \\"active\\",\\n \\"name\\": \\"ct-test\\",\\n \\"configs\\": [\\n {\\n \\"content\\": \\"- key: log\\\\\\\\n title: Log file content\\\\\\\\n description: >\\\\\\\\n Contains log file lines.\\\\\\\\n ....\\",\\n \\"fileName\\": \\"fields.yml\\"\\n }\\n ],\\n \\"extendConfigs\\": [\\n {\\n \\"successPodsCount\\": \\"8\\",\\n \\"protocol\\": \\"HTTP\\",\\n \\"userName\\": \\"elastic\\",\\n \\"totalPodsCount\\": \\"10\\",\\n \\"type\\": \\"ECSInstanceId\\",\\n \\"kibanaHost\\": \\"https://es-cn-4591jumei000u****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"enableMonitoring\\": true,\\n \\"configType\\": \\"collectorDeployMachine\\",\\n \\"instanceType\\": \\"elasticsearch\\",\\n \\"groupId\\": \\"default_ct-cn-5i2l75bz4776****\\",\\n \\"host\\": \\"es-cn-4591jumei000u****-kibana.internal.elasticsearch.aliyuncs.com:5601\\",\\n \\"instanceId\\": \\"es-cn-n6w1o1****\\",\\n \\"machines\\": [\\n {\\n \\"agentStatus\\": \\"heartOk\\",\\n \\"instanceId\\": \\"c1b9fde5172b84f82b9928e825a7b8988\\"\\n }\\n ],\\n \\"hosts\\": [\\n \\"[\\\\\\"es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ]\\n }\\n ],\\n \\"collectorPaths\\": [\\n \\"[\\\\\\"/var/log\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Modify collector name', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameter to specify the new collector name.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| name| String | Yes |collectorName1 |The new name of the collector.|'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "name": "collectorName1"'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListAlternativeSnapshotRepos' => [ - 'summary' => 'Call ListAlternativeSnapshotRepos to get the OSS reference warehouses that can be added to the current instance.', - 'path' => '/openapi/instances/{InstanceId}/alternative-snapshot-repos', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T17:28:22.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCollectorName'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateCollectorName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateComponentIndex' => [ + 'summary' => 'Updates a composable index template for an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/component-index/{name}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-0pp1jxvcl000z****', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-t57p81n7ai89v****'], ], [ - 'name' => 'alreadySetItems', - 'in' => 'query', + 'name' => 'name', + 'in' => 'path', + 'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'component-openstore-index-template', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'Indicates whether to return the OSS reference repository added. The return value. Valid values: true and false.'."\n", - 'type' => 'boolean', + 'description' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'template' => [ + 'description' => 'The composable template information.', + 'type' => 'object', + 'properties' => [ + 'settings' => ['description' => 'The settings configuration of the template.', 'type' => 'object', 'required' => false, 'example' => '{ "index.number_of_replicas": 0 }', 'title' => ''], + 'mappings' => ['description' => 'The mappings configuration of the template.', 'type' => 'object', 'required' => false, 'example' => '{ "properties": { "@timestamp": { "type": "date" } } }', 'title' => ''], + 'aliases' => ['description' => 'The aliases configuration of the template.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + '_meta' => ['description' => 'The metadata, which is used to store information such as remarks.', 'type' => 'object', 'required' => false, 'example' => '{ "description": "set number of shards to one" }', 'title' => ''], + ], 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Result' => [ - 'description' => 'The return results.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'repoPath' => [ - 'description' => 'The address of the repository.'."\n", - 'type' => 'string', - 'example' => 'RepoPath', - ], - 'instanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'es-cn-6ja1ro4jt000c****', - ], - ], - ], - ], + 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9'], ], + 'example' => '', + ], + ], + 400 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"repoPath\\": \\"RepoPath\\",\\n \\"instanceId\\": \\"es-cn-6ja1ro4jt000c****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListAlternativeSnapshotRepos', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDiagnosisItems' => [ - 'summary' => 'Queries the intelligent diagnostic items of an Elasticsearch cluster.', - 'path' => '/openapi/diagnosis/items', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","type":"json"}]', + 'title' => 'Update a composable index template', + 'description' => 'For more information, see [Use OpenStore to store massive amounts of data](~~317694~~).', + 'changeSet' => [ + ['createdAt' => '2021-12-17T03:35:26.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateComponentIndex'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateComponentIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'UpdateDescription' => [ + 'summary' => 'Changes the name of an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/description', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '163553', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchMWTZRB', - 'FEATUREelasticsearchEC84H8', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'lang', + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1ptcb30009****', 'title' => ''], + ], + [ + 'name' => 'clientToken', 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. Generated by the client, this value must be unique across different requests and cannot exceed 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '', - 'zt' => '', - 'fr' => '', - 'zh' => '', - 'es' => '', + 'description' => 'The RequestBody parameter.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The new name of the instance.', 'type' => 'string', 'required' => false, 'example' => 'aliyunes_name_test', 'title' => ''], ], - 'example' => 'en', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FDF34727-1664-44C1-A8DA-3EB72D60****', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'key' => [ - 'title' => '诊断项标识。', - 'description' => '', - 'type' => 'string', - 'example' => 'ClusterBulkRejectDiagnostic', - ], - 'name' => [ - 'title' => '诊断项名称', - 'description' => '', - 'type' => 'string', - 'example' => '索引写入BulkReject诊断', - ], - 'description' => [ - 'title' => '诊断项说明', - 'description' => '', - 'type' => 'string', - 'example' => '诊断集群写数据是否有堆积当集群的数据写入存在堆积时，会造成BulkReject异常，可能会导致数据丢失，且会造成系统资源消耗严重', - ], - ], + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The updated instance name.', 'type' => 'string', 'example' => 'aliyunes_test_name', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 400 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FDF34727-1664-44C1-A8DA-3EB72D60****\\",\\n \\"Result\\": {\\n \\"description\\": \\"aliyunes_test_name\\"\\n }\\n}","type":"json"}]', + 'title' => 'Change instance name', + 'requestParamsDescription' => "\n", + 'responseParamsDescription' => '> The following response examples only guarantee the parameters included in the returned data list. Parameters not mentioned are for reference only. For metric descriptions, refer to [ListInstance](~~142230~~). Do not rely on obtaining these parameters in your program.', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDescription'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": [\\n {\\n \\"key\\": \\"ClusterBulkRejectDiagnostic\\",\\n \\"name\\": \\"索引写入BulkReject诊断\\",\\n \\"description\\": \\"诊断集群写数据是否有堆积当集群的数据写入存在堆积时，会造成BulkReject异常，可能会导致数据丢失，且会造成系统资源消耗严重\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListDiagnosisItems', ], 'UpdateDiagnosisSettings' => [ 'path' => '/openapi/diagnosis/instances/{InstanceId}/settings', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25604,49 +22784,27 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-45914gy290009****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-45914gy290009****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. The client generates this value. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'lang', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the response. Default value: en.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], + 'schema' => ['description' => 'The language of the response. Default value: en.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -25654,227 +22812,123 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: update successfully'."\n" - .'* false: update failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The update was successful.'."\n" + .'- false: The update failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateDiagnosisSettings', - 'summary' => 'Call UpdateDiagnosisSettings to update the instance of intelligent operation\\&maintenance (O\\&M) scene settings.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Modify intelligent O&M scenario settings', + 'summary' => 'Modifies the intelligent O&M scenario settings of a specified Elasticsearch instance.', 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody parameter also requires the following parameters to specify the intelligent O&M scenario configuration.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- | ---- |'."\n" + .'| scene| String | Yes | Business Analysis |The name of the intelligent O&M scenario to set. Supported values include Business Search, Data Acceleration, Statistics, Business Analysis, and custom scenario names.|'."\n" ."\n" - .'You must also specify the following parameters in RequestBody to configure intelligent maintenance. '."\n" - ."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .'| --------- | ---- | -------- | ------- | ----------- |'."\n" - .'| scene | String | Yes | Business Analysis | The name of the intelligent maintenance scenario to be configured. This function supports Business Search, Data Acceleration, Statistics, Business Analysis, and custom scenarios. |'."\n" .'Example:'."\n" ."\n" .'```'."\n" .'{'."\n" .' "scene":"Business Analysis"'."\n" .'}'."\n" - .'```', + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListDiagnoseReport' => [ - 'summary' => 'Queries the historical intelligent O\\&M reports of an Elasticsearch cluster.', - 'path' => '/openapi/diagnosis/instances/{InstanceId}/reports', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDiagnosisSettings'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDiagnosisSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateDict' => [ + 'summary' => 'Updates the user dictionary of an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/dict', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'spanish'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1qu7ei000p****', - ], - ], - [ - 'name' => 'lang', - 'in' => 'query', - 'schema' => [ - 'description' => '1594569600000'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'spanish', - ], - ], - [ - 'name' => 'startTime', - 'in' => 'query', - 'schema' => [ - 'description' => '1595174399999'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2000000000000', - 'minimum' => '1000000000000', - 'example' => '1594569600000', - ], - ], - [ - 'name' => 'endTime', - 'in' => 'query', - 'schema' => [ - 'description' => '1'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2000000000000', - 'minimum' => '1000000000000', - 'example' => '1595174399999', - ], - ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '20'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'true'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '20', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], ], [ - 'name' => 'detail', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'SYSTEM'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Used to ensure the idempotency of the request. This parameter value is generated by the client and must be unique across different requests, with a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'trigger', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SYSTEM', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -25882,398 +22936,327 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Headers' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], 'Result' => [ - 'description' => 'The trigger mode of health diagnostics. Valid values:'."\n" - ."\n" - .'* SYSTEM: The system is automatically triggered.'."\n" - .'* INNER: internal trigger'."\n" - .'* USER: manually triggered by the user'."\n", + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'instanceId' => [ - 'description' => 'The overall health of the cluster in the report. Supported: GREEN, YELLOW, RED, and UNKNOWN.'."\n", - 'type' => 'string', - 'example' => 'es-cn-abc', - ], - 'reportId' => [ - 'description' => 'The diagnosis status. Valid values: Supported: SUCCESS, FAILED, and RUNNING.'."\n", - 'type' => 'string', - 'example' => 'trigger__2020-08-17T17:09:02f', - ], - 'createTime' => [ - 'description' => 'The ID of the report.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535745731000', - ], - 'diagnoseItems' => [ - 'description' => 'The name of the item.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'item' => [ - 'description' => 'The health of the diagnostic item. Supported: GREEN, YELLOW, RED, and UNKNOWN.'."\n", - 'type' => 'string', - 'example' => 'IndexAliasUseDiagnostic', - ], - 'health' => [ - 'description' => 'The details of the diagnostic item.'."\n", - 'type' => 'string', - 'example' => 'YELLOW', - ], - 'detail' => [ - 'description' => 'The type of the diagnostic result. Valid values:'."\n" - ."\n" - .'* TEXT: text description'."\n" - .'* CONSOLE_API: console-triggered'."\n" - .'* ES_API: API triggered'."\n", - 'type' => 'object', - 'properties' => [ - 'result' => [ - 'description' => 'The suggestion for the diagnosis.'."\n", - 'type' => 'string', - 'example' => 'You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]', - ], - 'name' => [ - 'description' => 'The description of the diagnostic item.'."\n", - 'type' => 'string', - 'example' => 'Number of Replica Shards', - ], - 'suggest' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'You can call the following function in the Elasticsearch API....', - ], - 'type' => [ - 'description' => 'The full name of the diagnostic item.'."\n", - 'type' => 'string', - 'example' => 'ES_API', - ], - 'desc' => [ - 'description' => 'The diagnosis.'."\n", - 'type' => 'string', - 'example' => 'Check whether the number of replica shards is optimal and easy to maintain', - ], - ], - ], - ], - ], - ], - 'health' => [ - 'description' => 'Reports the list of diagnostic item information.'."\n", - 'type' => 'string', - 'example' => 'YELLOW', - ], - 'trigger' => [ - 'description' => 'The timestamp when the report was created.'."\n", - 'type' => 'string', - 'example' => 'USER', - ], - 'state' => [ - 'description' => 'The ID of the instance for diagnosis.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '2782602', 'title' => ''], + 'sourceType' => ['description' => 'The source type of the dictionary file. Valid values:'."\n" + ."\n" + .'- OSS: Object Storage Service (OSS).'."\n" + .'- ORIGIN: Retains the previously uploaded dictionary.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'SYSTEM_MAIN.dic', 'title' => ''], + 'type' => ['description' => 'The type of the dictionary. Valid values:'."\n" + ."\n" + .'- MAIN: IK main dictionary.'."\n" + .'- STOP: IK stopword dictionary.', 'type' => 'string', 'example' => 'MAIN', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 15\\n },\\n \\"Result\\": [\\n {\\n \\"instanceId\\": \\"es-cn-abc\\",\\n \\"reportId\\": \\"trigger__2020-08-17T17:09:02f\\",\\n \\"createTime\\": 1535745731000,\\n \\"diagnoseItems\\": [\\n {\\n \\"item\\": \\"IndexAliasUseDiagnostic\\",\\n \\"health\\": \\"YELLOW\\",\\n \\"detail\\": {\\n \\"result\\": \\"You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]\\",\\n \\"name\\": \\"Number of Replica Shards\\",\\n \\"suggest\\": \\"You can call the following function in the Elasticsearch API....\\",\\n \\"type\\": \\"ES_API\\",\\n \\"desc\\": \\"Check whether the number of replica shards is optimal and easy to maintain\\"\\n }\\n }\\n ],\\n \\"health\\": \\"YELLOW\\",\\n \\"trigger\\": \\"USER\\",\\n \\"state\\": \\"SUCCESS\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListDiagnoseReport', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 2782602,\\n \\"sourceType\\": \\"ORIGIN\\",\\n \\"name\\": \\"SYSTEM_MAIN.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Update Instance User Dictionary', + 'description' => 'When calling this operation, note the following:'."\n" + ."\n" + .'- If the dictionary file originates from OSS, ensure that the OSS storage space is publicly readable.'."\n" + .'- If previously uploaded dictionaries are not configured with ORIGIN, the dictionary files will be deleted after this operation is called.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| name | String | Yes | dic_0.dic | The name of the dictionary file to upload. |'."\n" + .'| ossObject | Array | Yes | | The description of the OSS open storage file. Required when sourceType is set to OSS.|'."\n" + .'| └bucketName | String | Yes | search-cloud-test-cn-**** | The name of the OSS storage space (Bucket).|'."\n" + .'| └key | String | Yes | oss/dic_0.dic | The storage path of the dictionary file in the OSS Bucket.|'."\n" + .'| sourceType | String | Yes | OSS | The source type of the dictionary file. Valid values: OSS (use OSS open storage), ORIGIN (retain previously uploaded dictionaries).<br>**Note:**<br>Local files must be uploaded to OSS first, and then referenced through OSS.<br>If previously uploaded dictionaries are not configured with ORIGIN, they will be deleted by the system. |'."\n" + .'| type | String | Yes | MAIN | The type of dictionary to update. Valid values: MAIN (IK main dictionary) or STOP (IK stopword dictionary).|'."\n" + ."\n" + .'> └ indicates a child parameter.'."\n" + ."\n" + .'The following is an example.'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "name":"deploy_0.dic",'."\n" + .' "ossObject":{'."\n" + .' "bucketName":"search-cloud-test-cn-****",'."\n" + .' "key":"user_dict/dict_0.dic"'."\n" + .' },'."\n" + .' "sourceType":"OSS",'."\n" + .' "type":"MAIN"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"deploy_2.dic",'."\n" + .' "ossObject":{'."\n" + .' "bucketName":"search-cloud-test-cn-****",'."\n" + .' "key":"user_dict/dict_2.dic"'."\n" + .' },'."\n" + .' "sourceType":"OSS",'."\n" + .' "type":"STOP"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"SYSTEM_MAIN.dic",'."\n" + .' "sourceType":"ORIGIN",'."\n" + .' "type":"MAIN"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"SYSTEM_STOPWORD.dic",'."\n" + .' "sourceType":"ORIGIN",'."\n" + .' "type":"STOP"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListDiagnoseReportIds' => [ - 'summary' => 'Queries the IDs of the historical intelligent O\\\\\\&M reports of an Elasticsearch cluster.', - 'path' => '/openapi/diagnosis/instances/{InstanceId}/report-ids', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDict'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'UpdateDynamicSettings' => [ + 'summary' => 'Modify Cluster Dynamic Configuration', + 'path' => '/openapi/instances/{InstanceId}/dynamic-settings', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'A client token used to ensure the idempotency of the request.', 'type' => 'string', 'example' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1qu7ei000p****', - ], + 'schema' => ['description' => 'The ID of the Elasticsearch instance.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'lang', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the reports.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'spanish', - ], + 'schema' => ['description' => 'The ID of the region where the instance is deployed.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'startTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The value must be a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2000000000000', - 'minimum' => '1000000000000', - 'example' => '1595088000000', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body, which contains the dynamic settings to be updated.', 'type' => 'string', 'title' => '', 'example' => ''], ], [ - 'name' => 'endTime', + 'name' => 'mode', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The value must be a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2000000000000', - 'minimum' => '1000000000000', - 'example' => '1595174399999', - ], + 'schema' => ['description' => 'The update mode for the dynamic settings.', 'type' => 'string', 'title' => '', 'example' => ''], ], - [ - 'name' => 'page', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of the page to return. Valid values: 1 to 200. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'Indicates whether the dynamic settings were successfully updated.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'The response body returned when the request is successful.', + 'example' => '', ], ], - [ - 'name' => 'size', - 'in' => 'query', + 400 => [ 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values: 1 to 500. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '1', - 'example' => '15', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => 'The response body returned when the request parameters are invalid.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'trigger', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to trigger health diagnostics. Valid values: SYSTEM, INNER, and USER.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SYSTEM', - ], - ], - ], - 'responses' => [ - 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Result' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["scheduled__2020-09-13T00:40:00"]', - ], - ], - 'Headers' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'The response body returned when authentication fails.', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'The response body returned when the specified resource is not found.', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'description' => 'The response body returned when an internal server error occurs.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"scheduled__2020-09-13T00:40:00\\\\\\"]\\"\\n ],\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListDiagnoseReportIds', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDiagnoseReport' => [ - 'path' => '/openapi/diagnosis/instances/{InstanceId}/reports/{ReportId}', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-05-30T06:29:10.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDynamicSettings'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDynamicSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": false,\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + ], + 'UpdateExtendConfig' => [ + 'path' => '/openapi/instances/{InstanceId}/extend-configs/actions/update', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-mp91kzb8m0009****', - ], - ], - [ - 'name' => 'lang', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'ReportId', + 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'scheduled__2020-09-15T00:40:00', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -26281,207 +23264,124 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'trigger' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'createTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1535745731000', - ], - 'reportId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'trigger__2020-08-17T17:09:02', - ], - 'state' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-abc', - ], - 'health' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'YELLOW', - ], - 'diagnoseItems' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'item' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'IndexAliasUseDiagnostic', - ], - 'health' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'YELLOW', - ], - 'detail' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ES_API', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Number of Replica Shards', - ], - 'desc' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Check whether the number of replica shards is optimal and easy to maintain', - ], - 'result' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]', - ], - 'suggest' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'You can call the following function in the Elasticsearch API....', - ], - ], - ], - ], - ], - ], - ], - ], + 'Result' => ['description' => 'The result. Valid values:'."\n" + ."\n" + .'- true: The scenario-based configuration template was modified.'."\n" + .'- false: The scenario-based configuration template failed to be modified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"trigger\\": \\"SYSTEM\\",\\n \\"createTime\\": 1535745731000,\\n \\"reportId\\": \\"trigger__2020-08-17T17:09:02\\",\\n \\"state\\": \\"SUCCESS\\",\\n \\"instanceId\\": \\"es-cn-abc\\",\\n \\"health\\": \\"YELLOW\\",\\n \\"diagnoseItems\\": [\\n {\\n \\"item\\": \\"IndexAliasUseDiagnostic\\",\\n \\"health\\": \\"YELLOW\\",\\n \\"detail\\": {\\n \\"type\\": \\"ES_API\\",\\n \\"name\\": \\"Number of Replica Shards\\",\\n \\"desc\\": \\"Check whether the number of replica shards is optimal and easy to maintain\\",\\n \\"result\\": \\"You may need to adjust the numbers of replica shards of some indices as follows: [geoname08 : 0 -> 1][geoname09 : 0 -> 1][geonametest01 : 0 -> 1]\\",\\n \\"suggest\\": \\"You can call the following function in the Elasticsearch API....\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeDiagnoseReport', - 'summary' => 'Queries a historical intelligent O\\&M report.', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","type":"json"}]', + 'title' => 'Modify scenario-based configuration template', + 'summary' => 'Modifies the scenario-based configuration template of an Elasticsearch instance.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The following parameters must also be specified in the RequestBody to define the scenario-based configuration template information.'."\n" + ."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- | ---- |'."\n" + .'| configType | String | Yes | usageScenario | The configuration type. Supported value: usageScenario (Scenarios configuration). |'."\n" + .'| value | String | Yes | general | The scenario value. Valid values for Commercial Edition instances: general (general-purpose computing scenario), analysisVisualization (data analysis scenario), dbAcceleration (database acceleration scenario), and search (search scenario). Valid values for Enhanced Edition instances: log (logging scenario). |'."\n" + ."\n\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "configType": "usageScenario",'."\n" + .' "value": "search"'."\n" + .'}'."\n" + .'```', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeDiagnosisSettings' => [ - 'path' => '/openapi/diagnosis/instances/{InstanceId}/settings', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExtendConfig'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateExtendConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateExtendfiles' => [ + 'path' => '/openapi/logstashes/{InstanceId}/extendfiles', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of an instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-68n1n8b7f000a****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'lang', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the returned result. Default value: en.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], + 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. This parameter value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The request body parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -26489,279 +23389,394 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5E82B8A8-EED7-4557-A6E9-D1AD3E58****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'The return results.'."\n", - 'type' => 'object', - 'properties' => [ - 'updateTime' => [ - 'description' => 'The timestamp of the last update for Intelligent Maintenance scenarios.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1588994035385', - ], - 'scene' => [ - 'description' => 'Scenarios of intelligent maintenance.'."\n", - 'type' => 'string', - 'example' => 'Business Search', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileSize' => ['description' => 'The size of the extension file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1853083', 'title' => ''], + 'name' => ['description' => 'The name of the extension file.', 'type' => 'string', 'example' => 'mysql-connector-java-6.0.2.jar', 'title' => ''], + 'sourceType' => ['description' => 'The source of the extension file. Only ORIGIN (retained original extension file) is supported.', 'type' => 'string', 'example' => 'ORIGIN', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5E82B8A8-EED7-4557-A6E9-D1AD3E58****\\",\\n \\"Result\\": {\\n \\"updateTime\\": 1588994035385,\\n \\"scene\\": \\"Business Search\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeDiagnosisSettings', - 'summary' => 'Call DescribeDiagnosisSettings to obtain the scenario settings of intelligent maintenance.', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 1853083,\\n \\"name\\": \\"mysql-connector-java-6.0.2.jar\\",\\n \\"sourceType\\": \\"ORIGIN\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Update extension file configuration', + 'summary' => 'Updates the extension file configuration of a Logstash instance.', + 'description' => 'When calling this operation, note the following: Currently, this operation only supports deleting extension files that have been uploaded through the console. To add or modify extension files, perform the operations in the console.', + 'requestParamsDescription' => '# RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the updated extension file configuration.'."\n" + ."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'|------------|--------|----------|----------------------------------|-------------|'."\n" + .'| name | String | Yes | mysql-connector-java-6.0.2.jar | The name of the extension file. The file name extension must be .jar. The file name does not support Chinese characters and cannot exceed 100 characters in length. |'."\n" + .'| sourceType | String | Yes | ORIGIN | The source of the extension file. Currently, only ORIGIN is supported, which retains the corresponding extension file. Extension files for which this parameter is not configured are deleted. The features for adding and modifying extension files are under development. You can perform all management operations in the console. |.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListDiagnoseIndices' => [ - 'path' => '/openapi/diagnosis/instances/{InstanceId}/indices', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExtendfiles'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateExtendfiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'UpdateFalconSeek' => [ + 'summary' => 'Toggle the FalconSeek cloud-native kernel attribute for instances of Version 8.17.', + 'path' => '/openapi/instances/{InstanceId}/falconseek', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => [], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'lang', + 'name' => 'enable', 'in' => 'query', + 'schema' => ['description' => 'true: Enabled, false: shutdown', 'title' => 'true: Enabled, false: shutdown', 'type' => 'boolean', 'required' => true, 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The language. Multiple languages are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en', + 'description' => 'Schema of Response', + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'ID of the request', 'title' => 'ID of the request', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****'], + ], + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Toggle the FalconSeek cloud-native kernel attribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateHotIkDicts' => [ + 'summary' => 'Updates the IK hot-word dictionary of an Alibaba Cloud Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/ik-hot-dict', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-oew1q8bev0002****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. This value is generated by the client and must be unique across different requests. The token can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'RequestBody.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '请参见RequestBody中的示例', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F05ED12E-140A-4ACB-B059-3A508A69F2E1', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'sourceType' => ['description' => 'The source type of the dictionary file. Valid values:'."\n" + ."\n" + .'- OSS: uses OSS open storage.'."\n" + .'- ORIGIN: retains a previously uploaded dictionary.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'deploy_0.dic', 'title' => ''], + 'type' => ['description' => 'The dictionary type. Valid values:'."\n" + ."\n" + .'- MAIN: IK main tokenizer dictionary.'."\n" + .'- STOP: IK stopword dictionary.', 'type' => 'string', 'example' => 'MAIN', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => '["my_index_aliws", "aliyun-index-test","filebeat-6.7.0-2020.11.15", "filebeat-6.7.0-2020.12.27"]', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F05ED12E-140A-4ACB-B059-3A508A69F2E1\\",\\n \\"Result\\": [\\n \\"[\\\\\\"my_index_aliws\\\\\\", \\\\\\"aliyun-index-test\\\\\\",\\\\\\"filebeat-6.7.0-2020.11.15\\\\\\", \\\\\\"filebeat-6.7.0-2020.12.27\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListDiagnoseIndices', - 'summary' => 'Queries the indexes for health diagnosis performed on an Elasticsearch cluster.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'title' => 'Update instance IK hot-word dictionary', + 'description' => 'When calling this operation, note the following:'."\n" + ."\n" + .'- If the dictionary file is sourced from OSS, make sure the OSS bucket has public-read permission.'."\n" + .'- If a previously uploaded dictionary is not configured with ORIGIN, the dictionary file will be deleted after this operation is called.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The following parameters must also be specified in the RequestBody.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| name | String | Yes | dic_0.dic | The name of the uploaded dictionary file. |'."\n" + .'| ossObject | Array | Yes | | The OSS open storage file description. Required when sourceType is set to OSS. |'."\n" + .'| └bucketName | String | Yes | search-cloud-test-cn-**** | The name of the OSS bucket. |'."\n" + .'| └key | String | Yes | oss/dic_0.dic | The storage path of the dictionary file in the OSS bucket. |'."\n" + .'| sourceType | String | Yes | OSS | The source type of the dictionary file. Valid values: OSS (uses OSS open storage), ORIGIN (retains a previously uploaded dictionary).<br>**Note**:<br>Local files must first be uploaded to OSS and then referenced through OSS.<br>If a previously uploaded dictionary is not configured with ORIGIN, it will be deleted by the system. |'."\n" + .'| type | String | Yes | MAIN | The type of dictionary to update. Valid values: MAIN (IK main tokenizer dictionary), STOP (IK stopword dictionary). |'."\n" + ."\n" + .'- └ indicates a child parameter.'."\n" + .'- The RequestBody must include all API parameters. For example, when adding stopwords, dictionary files from the default or already installed dictionaries must also be included in the RequestBody. In the following example, `"sourceType":"ORIGIN"` represents existing dictionary files.'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "name":"deploy_0.dic",'."\n" + .' "ossObject":{'."\n" + .' "bucketName":"search-cloud-test-cn-****",'."\n" + .' "key":"user_dict/dict_0.dic"'."\n" + .' },'."\n" + .' "sourceType":"OSS",'."\n" + .' "type":"MAIN"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"deploy_2.dic",'."\n" + .' "ossObject":{'."\n" + .' "bucketName":"search-cloud-test-cn-****",'."\n" + .' "key":"user_dict/dict_2.dic"'."\n" + .' },'."\n" + .' "sourceType":"OSS",'."\n" + .' "type":"STOP"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"SYSTEM_MAIN.dic",'."\n" + .' "sourceType":"ORIGIN",'."\n" + .' "type":"MAIN"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"SYSTEM_STOPWORD.dic",'."\n" + .' "sourceType":"ORIGIN",'."\n" + .' "type":"STOP"'."\n" + .' }'."\n" + .']'."\n" + .'```.', 'extraInfo' => ' ', - ], - 'OpenDiagnosis' => [ - 'path' => '/openapi/diagnosis/instances/{InstanceId}/actions/open-diagnosis', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHotIkDicts'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 6,\\n \\"sourceType\\": \\"OSS\\",\\n \\"name\\": \\"deploy_0.dic\\",\\n \\"type\\": \\"MAIN\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'UpdateILMPolicy' => [ + 'summary' => 'Modifies the lifecycle policy of an Elasticsearch index.', + 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Indicates whether the intelligent O\\&M feature is enabled. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif24adwc0082w2ka****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'lang', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], + 'name' => 'PolicyName', + 'in' => 'path', + 'schema' => ['description' => 'The name of the index lifecycle policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my-policy', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -26769,483 +23784,761 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Result' => ['description' => 'The returned result.', 'type' => 'string', 'example' => 'my-policy', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'OpenDiagnosis', - 'summary' => 'Enables the intelligent O\\\\\\&M feature for an instance.', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"my-policy\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Modify index lifecycle policy', + 'requestParamsDescription' => '## RequestBody'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|name|String|my-policy |Yes|The name of the index lifecycle policy.|'."\n" + .'|phases|Map| |No|The content of the index lifecycle policy. For more information, see **Data structure of the phases field**.|'."\n" + ."\n" + .'**Data structure of the phases field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|{key}|Struct| |No|The current lifecycle phase. Valid values: hot (the hot data phase, in which the Elasticsearch index is actively being updated and queried), cold (the cold data phase, in which the Elasticsearch index is no longer updated and is rarely queried. The data still needs to be searchable, but slower query performance is acceptable.), and delete (the delete phase, in which the Elasticsearch index is no longer needed and can be safely deleted).|'."\n" + .'|minAge|String|30d|No|The time required for the Elasticsearch index to reach the target phase.|'."\n" + .'|actions|Struct| |No|The policy settings for the current phase. For more information, see **Data structure of the actions field**.|'."\n" + ."\n" + .'**Data structure of the actions field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|rollver|Struct| |No|The Elasticsearch index rollover operation in the hot phase. For more information, see **Data structure of the rollver field**.|'."\n" + .'|setPriority|Struct| |No|The Elasticsearch index priority in the hot or cold phase. For more information, see **Data structure of the setPriority field**.|'."\n" + .'|allocate|Struct| |No|The allocation operation in the cold phase. For more information, see **Data structure of the allocate field**.|'."\n" + .'|delete|Struct| {} |No|The delete Elasticsearch index operation. When the delete phase is enabled, this parameter is required and must be set to an empty object.|'."\n" + ."\n" + .'**Data structure of the rollver field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|maxAge|String|30d|No|The time threshold that triggers an Elasticsearch index rollover. Specify at least one of maxAge, maxDocs, and maxSize. Unit: d (days) or h (hours).|'."\n" + .'|maxDocs|Integer|10000|No|The document count threshold that triggers an Elasticsearch index rollover.|'."\n" + .'|maxSize|String|50gb|No|The Elasticsearch index size threshold that triggers an Elasticsearch index rollover. Specify at least one of maxAge, maxDocs, and maxSize. Unit: MB or GB.|'."\n" + ."\n" + .'**Data structure of the setPriority field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|priority|Integer|100|No|The default priority of the current node.|'."\n" + ."\n" + .'**Data structure of the allocate field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|numberOfReplicas|Integer|1|No|The number of replicas to allocate. Default value: 1. This parameter is used together with migrate. When automatic migration is enabled, replica allocation is performed by default.|'."\n" + .'|require |Struct| |No|An optional setting available for hot-warm architecture clusters. For more information, see **Data structure of the require field**.|'."\n" + ."\n" + .'**Data structure of the require field**'."\n" + .'|Parameter|Type|Example|Required|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|boxType|String|warm|No|The custom node attribute identifier. This parameter is available for hot-warm architecture clusters and is used to migrate data to warm nodes. Valid values: warm.|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CloseDiagnosis' => [ - 'summary' => 'Disables the intelligent O\\&M feature for an Elasticsearch cluster.', - 'path' => '/openapi/diagnosis/instances/{InstanceId}/actions/close-diagnosis', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:57.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateILMPolicy'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateILMPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'UpdateIndexTemplate' => [ + 'summary' => 'Modifies the template configuration of an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/index-templates/{IndexTemplate}', + 'methods' => ['put'], + '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' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'Indicates whether intelligent O\\&M is successfully disabled. Valid values:'."\n" - ."\n" - .'* true: The call was successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-s9dsk3k4k****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w24n9u900am****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. The client generates this value. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'IndexTemplate', + 'in' => 'path', + 'schema' => ['description' => 'The index template name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my-template', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'The name of the updated index template.', 'type' => 'string', 'example' => 'my-template', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'lang', - 'in' => 'query', + 400 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'spanish', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CloseDiagnosis', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"my-template\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Modify instance template configuration', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody also requires the following parameters to specify the index template information to update.'."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|indexTemplate|String|Yes|my-template|The index template name. This value must be the same as the path value.|'."\n" + .'|indexPatterns|String|Yes|["schema1*","schema2*"]|The regular expression for index matching patterns.|'."\n" + .'|dataStream|Boolean|Yes|true|Specifies whether to enable data streams. Valid values: true (enabled) and false (disabled). Default value: false (disabled).|'."\n" + .'|priority|Integre|No|30|The priority of the cluster index template.|'."\n" + .'|ilmPolicy|String|No|policy-1|The Policy Name of the lifecycle policy.|'."\n" + .'|template|Object|No| |The component template.|'."\n" + ."\n" + .'Data structure of the template field'."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'| :--- | :--- | :--- | :--- | :--- |'."\n" + .'|settings|String|No|{\\"index.refresh_interval\\":\\"1s\\"}|The settings configuration.|'."\n" + .'|mappings|String|No|{"properties": {"created_at": {"type": "date","format": "EEE MMM dd HH:mm:ss Z yyyy"},"host_name": {"type": "keyword"}}}|The mappings configuration.|'."\n" + .'|aliases|String|No|{"mydata": {}}|The aliases configuration.|', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateKibanaSettings' => [ - 'summary' => 'Call UpdateKibanaSettings to modify the Kibana configuration. Currently, you can only modify the Kibana language configuration.', - 'path' => '/openapi/instances/{InstanceId}/actions/update-kibana-settings', - 'methods' => [ - 'patch', - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:57.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIndexTemplate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateIndexTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'UpdateInstance' => [ + 'summary' => 'Upgrades the configuration of an Elasticsearch cluster, including the number of nodes, roles, specifications, and disk configurations.', + 'path' => '/openapi/instances/{InstanceId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1ptcb30009****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****', - ], + 'schema' => ['description' => 'A unique token generated by the client to guarantee the idempotency of the request. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'orderActionType', + 'in' => 'query', + 'schema' => ['description' => 'The type of configuration change. Valid values:'."\n" + ."\n" + .'- upgrade (default): upgrade'."\n" + .'- downgrade: downgrade.', 'type' => 'string', 'required' => false, 'example' => 'upgrade', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The request body parameters.', + 'type' => 'object', + 'properties' => [ + 'nodeAmount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'nodeSpec' => ['description' => 'The data node configuration.', '$ref' => '#/components/schemas/NodeSpec', 'required' => false, 'title' => '', 'example' => ''], + 'masterConfiguration' => ['description' => 'The dedicated master node configuration.', '$ref' => '#/components/schemas/MasterNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'clientNodeConfiguration' => ['description' => 'The client node configuration.', '$ref' => '#/components/schemas/ClientNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'warmNodeConfiguration' => ['description' => '冷数据节点配置。', '$ref' => '#/components/schemas/WarmNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'kibanaConfiguration' => ['description' => 'The Kibana node configuration.', '$ref' => '#/components/schemas/KibanaNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'elasticDataNodeConfiguration' => ['description' => 'The elastic node configuration.', '$ref' => '#/components/schemas/ElasticDataNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'instanceCategory' => ['description' => 'The edition type. Valid values:'."\n" + ."\n" + .'- x-pack: Commercial Edition instance'."\n" + .'- advanced: Advanced Edition instance'."\n" + .'- IS: Advanced Edition instance with Indexing Service enabled'."\n" + .'- community: Basic Edition instance'."\n" + .'> To create an Advanced Edition instance with OpenStore enabled, you must also enable Indexing Service.', 'type' => 'string', 'required' => false, 'example' => 'advanced', 'title' => ''], + 'updateType' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + ], 'required' => false, - 'docRequired' => false, + 'example' => '{ "nodeSpec": { "spec": "elasticsearch.r5.xlarge" } }', + 'title' => '', ], ], + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to forcibly restart the instance. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false (default).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => 'Return results:'."\n" - ."\n" - .'* true: The Kibana language modified successfully'."\n" - .'* false: The Kibana language modified failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC*****', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'nodeAmount' => ['description' => 'The number of data nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'createdAt' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2018-07-13T03:58:07.253Z', 'title' => ''], + 'status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- active: Normal'."\n" + .'- activating: Taking effect'."\n" + .'- inactive: Frozen'."\n" + .'- invalid: Invalid.', 'type' => 'string', 'example' => 'active', 'title' => ''], + 'paymentType' => ['description' => 'The billing method of the instance. Valid values:'."\n" + ."\n" + .'- prepaid: subscription'."\n" + .'- postpaid: pay-as-you-go.', 'type' => 'string', 'example' => 'postpaid', 'title' => ''], + 'domain' => ['description' => '实例的私网访问域名。', 'type' => 'string', 'example' => 'es-cn-abc.elasticsearch.aliyuncs.com', 'title' => ''], + 'description' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'esVersion' => ['description' => 'The instance version.', 'type' => 'string', 'example' => '5.5.3_with_X-Pack', 'title' => ''], + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-cn-abc', 'title' => ''], + 'nodeSpec' => [ + 'description' => 'The data node configuration.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.xlarge', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Valid values:'."\n" + ."\n" + .'- cloud_ssd: standard SSD'."\n" + .'- cloud_efficiency: ultra disk.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'kibanaConfiguration' => [ + 'description' => 'The Kibana node configuration.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'elasticsearch.n4.small', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. You can ignore this parameter.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'masterConfiguration' => [ + 'description' => 'The master node configuration.', + 'type' => 'object', + 'properties' => [ + 'spec' => ['description' => '节点规格。', 'type' => 'string', 'example' => 'elasticsearch.sn2ne.large', 'title' => ''], + 'amount' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'disk' => ['description' => 'The storage size of the node. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'diskType' => ['description' => 'The storage type of the node. Only cloud_ssd (standard SSD) is supported.', 'type' => 'string', 'example' => 'cloud_ssd', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC*****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateKibanaSettings', - 'requestParamsDescription' => '## RequestBody'."\n" + 'title' => 'Upgrade cluster configuration', + 'description' => 'When you call this operation, note the following items:'."\n" + ."\n" + .'For more precautions, see [Upgrade cluster configuration](~~96650~~) and [Downgrade cluster configuration](~~198887~~).', + 'requestParamsDescription' => "\n" + .'For the list of node specifications supported by Elasticsearch, see [Alibaba Cloud Elasticsearch pricing](https://www.aliyun.com/price/product?spm=a2c4g.11186623.2.10.653c6c88NcQPZY#/elasticsearch/detail) and [Product specifications](~~271718~~).'."\n" + ."\n" + .'The following examples show the request body parameters:'."\n" + .'**Upgrade**.'."\n" + ."\n" + .' > During an upgrade, you cannot decrease the storage size, storage type, number of nodes, or the number of CPU cores or memory size of the specification.'."\n" + ."\n" + .'- Upgrade storage size'."\n" + .' Currently, only data nodes, warm nodes, and elastic data nodes support storage size upgrades.'."\n" ."\n" - .'You can also specify the Kibana language by setting the **i18n.locale** parameter in RequestBody (optional, valid value: en by default). Example: '."\n" + .'- Upgrade storage type'."\n" + .' Currently, only data nodes, elastic data nodes, and dedicated master nodes support storage type upgrades.'."\n" ."\n" + .' - Upgrade the storage type of dedicated master nodes to ESSD cloud disk.'."\n" .'```'."\n" .'{'."\n" - .' "i18n.locale":"en"'."\n" + .' "masterConfiguration": {'."\n" + .' "diskType": "cloud_essd"'."\n" + .' }'."\n" .'}'."\n" + .'```.'."\n" + ."\n" + .' - When the storage type of dedicated master nodes is ESSD cloud disk, upgrade the storage performance level to PL3.'."\n" + .' After you specify **performanceLevel**, **diskType** is automatically set to **cloud_essd**.'."\n" + .' After you specify **cloud_essd**, **performanceLevel** defaults to **PL1**.'."\n" + ."\n" + .' ```'."\n" + .' {'."\n" + .' "masterConfiguration": {'."\n" + .' "performanceLevel": "PL3"'."\n" + .' }'."\n" + .' }'."\n" + .' ```.'."\n" + ."\n" + .'- Upgrade the number of nodes'."\n" + .' Currently, only data nodes, warm nodes, elastic data nodes, and client nodes support increasing the number of nodes.'."\n" + .' The method for increasing the number of data nodes differs from that of other node types. See the following examples.'."\n" + ."\n" + .' - Increase the number of data nodes to 12.'."\n" .'```'."\n" - .'> The `i18n.locale` parameter can only be en (English) or zh-CN (Chinese).', - 'responseParamsDescription' => ' ', + .'{'."\n" + .' "nodeAmount": 12'."\n" + .'}'."\n" + .'```.'."\n" + ."\n" + .'- Upgrade node specifications'."\n" + .'Upgrade the data node specification to 4 vCPUs and 32 GB of memory.'."\n" + .'```'."\n" + .'{'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.r5.xlarge"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Upgrade multiple configurations of the same node type at the same time'."\n" + .' To upgrade multiple configurations of the same node type at the same time, include all the configurations in the request body.'."\n" + ."\n" + .' - Increase the number of client nodes to 8 and upgrade the specification to 4 vCPUs and 8 GB of memory.'."\n" + .'```'."\n" + .'{'."\n" + .' "clientNodeConfiguration": {'."\n" + .' "amount": 8,'."\n" + .' "spec": "elasticsearch.sn1ne.xlarge"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .' - Increase the number of data nodes to 12 and upgrade the storage type to ESSD cloud disk.'."\n" + .'```'."\n" + .'{'."\n" + .' "nodeAmount": 12,'."\n" + .' "nodeSpec": {'."\n" + .' "diskType": "cloud_essd"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Enable nodes'."\n" + .' Refer to the [createInstance](~~148782~~) operation to set the complete node resource configuration.'."\n" + ."\n" + .' - Enable client nodes and set the client node configuration.'."\n" + .'```'."\n" + .'{'."\n" + .' "clientNodeConfiguration": {'."\n" + .' "amount": 5,'."\n" + .' "disk": 20,'."\n" + .' "spec": "elasticsearch.sn1ne.xlarge"'."\n" + .' }'."\n" + .'}'."\n" + .'```.'."\n" + ."\n" + .' - Enable elastic data nodes and set the elastic data node configuration. This configuration applies only to the China site.'."\n" + .'```'."\n" + .'{'."\n" + .' "elasticNodeConfiguration": {'."\n" + .' "disk": 200,'."\n" + .' "amount": 5,'."\n" + .' "diskType": "cloud_essd",'."\n" + .' "spec": "elasticsearch.sn1ne.xlarge"'."\n" + .' }'."\n" + .'}'."\n" + .'```.'."\n" + ."\n" + .' - Enable warm nodes and set the warm node configuration.'."\n" + .'```'."\n" + .'{'."\n" + .' "warmNodeConfiguration": {'."\n" + .' "disk": 1000,'."\n" + .' "amount": 3,'."\n" + .' "spec": "elasticsearch.sn1ne.xlarge"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Upgrade to enable OpenStore (this configuration applies only to the China site)'."\n" + .' Instances with warm nodes enabled and instances whose data node storage type is ESSD cloud disk do not support enabling OpenStore through an upgrade.'."\n" + .' If the instance type is standard Commercial Edition, after you enable OpenStore through an upgrade, the instance type is also upgraded from standard Commercial Edition to Advanced Edition with Indexing Service enabled.'."\n" + ."\n" + .' - Convert data node specifications to OpenStore.'."\n" + .'```'."\n" + .'{'."\n" + .' "nodeAmount": 6,'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "openstore.i2g.4xlarge",'."\n" + .' "diskType": "cloud_ssd",'."\n" + .' "disk": 100'."\n" + .' }'."\n" + .'}'."\n" + .'```.'."\n" + ."\n" + .'- Specify the change method'."\n" + .' - The default change method is intelligent change. You can specify it as blue-green change (blue_green) or in-place change (normal).'."\n" + .'```'."\n" + .'{'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.r5.xlarge"'."\n" + .' },'."\n" + .' "updateType": "blue_green" ## Use normal for in-place change.'."\n" + .'}'."\n" + .'```'."\n" + .' - Enable forced change.'."\n" + .'```'."\n" + .'{'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.r5.xlarge"'."\n" + .' },'."\n" + .' "force": true'."\n" + .'}'."\n" + .'```'."\n" + .'- Use the dryRun feature for upgrade pre-validation'."\n" + .'Add the dryRun field to the request body.'."\n" + .'```'."\n" + .'{'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.r5.xlarge"'."\n" + .' },'."\n" + .' "dryRun": true'."\n" + .'}'."\n" + .'```.'."\n" + ."\n" + .'**Downgrade**'."\n" + .' > During a downgrade, you cannot increase the storage size, storage type, number of nodes, or the number of CPU cores or memory size of the specification.<br>The UpdateInstance operation cannot decrease the number of nodes. To decrease the number of nodes, use the [ShrinkNode](~~144668~~) operation.<br>You cannot downgrade the storage size of nodes, and enabled nodes cannot be disabled.<br>Forced change is not supported, and you cannot specify the change type. Intelligent change is used by default.<br>During a downgrade, set the **orderActionType** parameter to **Downgrade**.<br>You can downgrade multiple resource configurations at the same time and use the dryRun feature for pre-validation.'."\n" + ."\n" + .' Change the storage type of dedicated master nodes to standard SSD.'."\n" + .'```'."\n" + .'{'."\n" + .' "masterConfiguration": {'."\n" + .' "diskType": "cloud_ssd"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Downgrade specifications'."\n" + .'Downgrade the data node specification to 4 vCPUs and 32 GB of memory.'."\n" + .'```'."\n" + .'{'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.r5.xlarge"'."\n" + .' }'."\n" + .'}'."\n" + .'```.', 'extraInfo' => ' ', - ], - 'DescribeKibanaSettings' => [ - 'summary' => 'Get the configuration of the Kibana node for the Elasticsearch cluster.', - 'path' => '/openapi/instances/{InstanceId}/kibana-settings', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-09-27T11:48:51.000Z', 'description' => 'Request parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{"map.includeElasticMapsService": "false", "server.ssl.cert": "/home/admin/packages/kibana/config/cert/client.crt", "server.ssl.enabled": "true", "server.ssl.key": "/home/admin/packages/kibana/config/cert/client.key", "xpack.reporting.capture.browser.chromium.disableSandbox": "true"}', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6D*****', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": {\\n \\"map.includeElasticMapsService\\": \\"false\\",\\n \\"server.ssl.cert\\": \\"/home/admin/packages/kibana/config/cert/client.crt\\",\\n \\"server.ssl.enabled\\": \\"true\\",\\n \\"server.ssl.key\\": \\"/home/admin/packages/kibana/config/cert/client.key\\",\\n \\"xpack.reporting.capture.browser.chromium.disableSandbox\\": \\"true\\"\\n },\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6D*****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeKibanaSettingsResponse>\\n <RequestId>F99407AB-2FA9-489E-A259-40CF6D*****</RequestId>\\n</DescribeKibanaSettingsResponse>","errorExample":""}]', - 'title' => 'DescribeKibanaSettings', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"nodeAmount\\": 2,\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"status\\": \\"active\\",\\n \\"paymentType\\": \\"postpaid\\",\\n \\"domain\\": \\"es-cn-abc.elasticsearch.aliyuncs.com\\",\\n \\"description\\": \\"test\\",\\n \\"esVersion\\": \\"5.5.3_with_X-Pack\\",\\n \\"instanceId\\": \\"es-cn-abc\\",\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.xlarge\\",\\n \\"disk\\": 40,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"kibanaConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.n4.small\\",\\n \\"amount\\": 1,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"masterConfiguration\\": {\\n \\"spec\\": \\"elasticsearch.sn2ne.large\\",\\n \\"amount\\": 3,\\n \\"disk\\": 20,\\n \\"diskType\\": \\"cloud_ssd\\"\\n }\\n },\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n}","type":"json"}]', ], - 'ListKibanaPlugins' => [ - 'summary' => 'Queries a list of Kibana plug-ins.', - 'path' => '/openapi/instances/{InstanceId}/kibana-plugins', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateInstanceChargeType' => [ + 'summary' => 'Transforms the billing method of an Elasticsearch instance from pay-as-you-go to a subscription instance.', + 'path' => '/openapi/instances/{InstanceId}/actions/convert-pay-type', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchWSK8NP', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-oew1q8bev0002****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-0pp1jxvcl000z****', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'size', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'title' => '', + 'description' => 'The request body for changing the billing method.', + 'type' => 'object', + 'properties' => [ + 'paymentInfo' => [ + 'title' => '', + 'description' => 'The billing information of the instance after the conversion.', + 'type' => 'object', + 'properties' => [ + 'duration' => ['title' => '', 'description' => 'The billing duration. If pricingCycle is set to Year, valid values: 1 to 3. If pricingCycle is set to Month, valid values: 1 to 9.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], + 'pricingCycle' => ['title' => '', 'description' => 'The subscription unit. This parameter is required. Valid values:'."\n" + ."\n" + .'- Year: year'."\n" + .'- Month: month.', 'type' => 'string', 'example' => 'Month', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + 'paymentType' => ['title' => '', 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- prepaid: subscription'."\n" + ."\n" + .'- postpaid: pay-as-you-go.', 'type' => 'string', 'example' => 'prepaid', 'required' => false], + ], 'required' => false, 'docRequired' => false, - 'example' => '10', + 'example' => '', ], ], ], @@ -27254,1455 +24547,1118 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '11234B4A-34CE-473B-8E61-AD95702E****', - ], - 'Headers' => [ - 'description' => 'The request header.'."\n", - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - ], - ], - 'Result' => [ - 'description' => 'The information about the plug-ins.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'specificationUrl' => [ - 'description' => 'The URL of the introduction to the plug-in. The value null is supported.'."\n", - 'type' => 'string', - 'example' => 'https://xxxx', - ], - 'name' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'bsearch_querybuilder ', - ], - 'description' => [ - 'description' => 'The description of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'Customize DSL statements to query data.', - ], - 'state' => [ - 'description' => 'The installation status of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'INSTALLED', - ], - 'source' => [ - 'description' => 'The source of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'SYSTEM', - ], - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The conversion was successful.'."\n" + .'- false: The conversion failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"11234B4A-34CE-473B-8E61-AD95702E****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 3\\n },\\n \\"Result\\": [\\n {\\n \\"description\\": \\"Customize DSL statements to query data.\\",\\n \\"specificationUrl\\": \\"https://xxxx\\",\\n \\"state\\": \\"INSTALLED\\",\\n \\"source\\": \\"SYSTEM\\",\\n \\"name\\": \\"bsearch_querybuilder\\\\t\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListKibanaPlugins', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'InstallKibanaSystemPlugin' => [ - 'path' => '/openapi/instances/{InstanceId}/kibana-plugins/system/actions/install', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', + 400 => [ 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-n6w1o1x0w00******', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'clientToken', - 'in' => 'query', 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'body', - 'in' => 'body', + 404 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****', - ], - 'Result' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["bsearch_querybuilder"] ', - ], - 'description' => 'The list of plug-ins to be installed.'."\n", - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"bsearch_querybuilder\\\\\\"]\\\\t\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'InstallKibanaSystemPlugin', - 'summary' => 'Call InstallKibanaSystemPlugin to install the Kibana plug-in. The Kibana specification must be 2-Core 4 GB or higher.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\"\\n}","type":"json"}]', + 'title' => 'Change billing method', 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the billing information of the instance after it is converted to subscription.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| paymentInfo | Array | Yes | |The billing information of the instance after the conversion. |'."\n" + .'| └duration | Integer | Yes | 1 |The billing duration. If pricingCycle is set to Year, valid values: 1 to 3. If pricingCycle is set to Month, valid values: 1 to 9.|'."\n" + .'| └pricingCycle | String | Yes | Year |The billing cycle. Valid values: Year, Month. |'."\n" + .'| paymentType | String | Yes | prepaid |The current billing method of the instance. Currently, only converting pay-as-you-go instances to subscription is supported. Therefore, this parameter must be set to prepaid.|'."\n" + ."\n" + .'> └ indicates a child parameter.'."\n" ."\n" - .'You must also enter the name of the plug-in in the RequestBody field. The format is ` ["pluginname1","pluginname2",…, "plugin_namen"]`. Example: `["bsearch_label","bsearch_querybuilder"]`.', + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "paymentInfo":{ '."\n" + .' "duration":1,'."\n" + .' "pricingCycle":"Month"'."\n" + .' },'."\n" + .' "paymentType":"prepaid"'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UninstallKibanaPlugin' => [ - 'summary' => 'Call the UninstallKibanaPlugin to uninstall the Kibana plug-in.', - 'path' => '/openapi/instances/{InstanceId}/kibana-plugins/actions/uninstall', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2025-12-03T08:10:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T09:44:55.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceChargeType'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstanceChargeType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateInstanceSettings' => [ + 'summary' => 'Modifies the YML parameter settings of a specified Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/instance-settings', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '64413', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'es-cn-6ja1ro4jt000c****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], + ], + [ + 'name' => 'updateStrategy', + 'in' => 'query', + 'schema' => ['description' => 'The change strategy for Elasticsearch (for example, the change method used during index updates, cluster upgrades, or service deployments). Valid values:'."\n" + .'- blue_green: blue-green change. Implements seamless switchover by running two identical environments (blue and green) in parallel.'."\n" + .'- normal: in-place change. Performs changes directly in the current environment (for example, upgrades or scaling) without requiring additional resources.'."\n" + .'- intelligent: intelligent change. The system automatically analyzes the change type and environment state, and dynamically selects the optimal change method (blue-green change or in-place change).', 'type' => 'string', 'required' => false, 'example' => 'normal', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'A unique token generated by the client to guarantee the idempotency of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'title' => '', + 'description' => 'The values of the YML parameters that you want to update.', + 'type' => 'object', + 'properties' => [ + 'esConfig' => [ + 'title' => '', + 'description' => 'The YML file configuration of the instance.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['title' => '', 'description' => '指定待更新的 YML 参数的key', 'type' => 'string', 'example' => 'thread_pool.write.queue_size'], + 'example' => '', + ], + ], 'required' => false, 'docRequired' => false, + 'example' => '{ "esConfig": { "thread_pool.write.queue_size": 500 } }', ], ], + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to forcefully apply the change.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', - ], - 'Result' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["bsearch_querybuilder"]', - ], - 'description' => 'The returned result shows a list of uninstalled plug-ins.'."\n", - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BB1C321A-211C-4FD7-BD8B-7F2FABE2****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"bsearch_querybuilder\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UninstallKibanaPlugin', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB1C321A-211C-4FD7-BD8B-7F2FABE2****\\"\\n}","type":"json"}]', + 'title' => 'Modify YML parameter settings of an instance', + 'description' => 'When you invoke this operation, note the following:<br>'."\n" + .'You cannot update the configuration when the instance status is activating, invalid, or inactive (freeze).', 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody parameter must also include the **esConfig** parameter to specify the values of the YML parameters that you want to update. For more information about YML parameters, see [Configure YML parameters](~~61336~~).'."\n" + ."\n" + .'The following example adjusts the document write queue size and applies to Alibaba Cloud Elasticsearch 6.x, 7.x, and 8.x.'."\n" ."\n" - .'Enter the name of the Kibana plug-in in the RequestBody field. The format is `["pluginname1","pluginname2",…, "plugin_namen"]`. Example: `["bsearch_label","bsearch_querybuilder"]`.', + .'```'."\n" + .'{'."\n" + .' "esConfig": {'."\n" + .' "thread_pool.write.queue_size": 500'."\n" + .' }'."\n" + .'}'."\n" + .'```.', + 'responseParamsDescription' => 'The response also includes the Result parameter. For more information, see [ListInstance](~~142230~~).', 'extraInfo' => ' ', - ], - 'DeleteLogstash' => [ - 'path' => '/openapi/logstashes/{InstanceId}', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2025-12-03T08:10:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-12T08:42:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-25T10:37:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-30T09:44:55.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceSettings'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstanceSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateKeystores' => [ + 'summary' => 'Update keystore', + 'path' => '/openapi/instances/{InstanceId}/keystores', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], + 'tenantRelevance' => 'tenant', + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-n6w1o5jq****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-3h4k3axh33th9****', 'title' => ''], ], [ - 'name' => 'clientToken', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', + 'description' => 'Request body parameters.', + 'type' => 'object', + 'properties' => [ + 'update' => [ + 'description' => 'Add or update keystore', + 'additionalProperties' => ['description' => 'Updated keystore key value', 'type' => 'string', 'title' => '', 'example' => 'xpack.security.authc.realms.active_directory.my_ad.xxx'], + 'title' => 'Add or update keystore', + 'type' => 'object', + 'required' => false, + 'example' => '', + ], + 'remove' => [ + 'description' => 'Delete keystore configuration', + 'title' => 'Keys to delete', + 'type' => 'array', + 'items' => ['description' => 'Key to delete', 'type' => 'string', 'required' => false, 'example' => 'xpack.security.authc.realms.active_directory.my_ad.secure_bind_password', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'deleteType', + 'name' => 'force', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the release operation. Valid values:'."\n" - ."\n" - .'* immediate: The cluster is immediately deleted when it is released. After the cluster is deleted, the data stored in the cluster is deleted, and the system removes the cluster from the Logstash cluster list.'."\n" - .'* protective: The cluster is released 24 hours later. During the period of 24 hours, you can still find the cluster in the Logstash cluster list, and [restore the cluster](~~202205~~) or [immediately release the cluster](~~160591~~). After 24 hours elapse, the data stored in the cluster is deleted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'protective', - ], + 'schema' => ['description' => 'Whether to force the change. false: non-forced, true: forced', 'title' => 'Whether to force the change. false: non-forced, true: forced', 'type' => 'string', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '94B03BBA-A132-42C3-8367-0A0C1C45****', - ], + 'RequestId' => ['description' => 'ID of the request', 'title' => 'ID of the request', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"94B03BBA-A132-42C3-8367-0A0C1C45****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeleteLogstash', - 'summary' => 'Releases a Logstash cluster.', - 'description' => 'Before you call this operation, take note of the following information: After the cluster is released, the physical resources used by the cluster are reclaimed. The data stored in the cluster is deleted and cannot be recovered. The disks attached to the nodes in the cluster and the snapshots created for the cluster are released.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The response parameters also include the Result parameter. For more information about this parameter, see [ListLogstash](~~160534~~).'."\n", - 'extraInfo' => ' ', - ], - 'UpdateLogstash' => [ - 'summary' => 'Modifies the configuration of a specified Logstash cluster, such as the name, quota, disk size, and number of nodes.', - 'path' => '/openapi/logstashes/{InstanceId}', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update keystore settings', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'UpdateKibanaPvlNetwork' => [ + 'summary' => 'Update Kibana private network access', + 'path' => '/openapi/instances/{InstanceId}/actions/update-kibana-private', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '64388', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchDYS3SR', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203898', + 'abilityTreeNodes' => ['FEATUREelasticsearch2PSU4E'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-n6w1o5jq****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-vo93ngti8000a****', 'title' => ''], + ], + [ + 'name' => 'pvlId', + 'in' => 'query', + 'schema' => ['description' => 'The Kibana private network connection ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-vo93ngti8000a****-kibana-internal-internal', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['title' => '', 'description' => 'Used to ensure the idempotency of the request.', 'type' => 'string', 'example' => 'xxxx', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'nodeSpec' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'title' => '实例规格', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'elasticsearch.sn1ne.large', - 'enum' => [ - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - '', - ], - ], - 'disk' => [ - 'title' => '实例磁盘大小。单位GB。步长为20，最大值受磁盘规格影响', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2048', - 'minimum' => '20', - 'example' => '20', - ], - 'diskType' => [ - 'title' => '磁盘存储类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_efficiency', - 'enum' => [ - '', - '', - ], - ], - ], - 'required' => false, - ], - 'nodeAmount' => [ - 'title' => '实例节点数量。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', + 'endpointName' => ['description' => 'The endpoint name.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-text-kibana', 'title' => ''], + 'securityGroups' => [ + 'description' => 'The list of security groups.', + 'type' => 'array', + 'items' => ['description' => 'The security group ID.', 'type' => 'string', 'required' => false, 'example' => 'sg-xdjiow****', 'title' => ''], 'required' => false, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '3', + 'title' => '', + 'example' => '', ], ], 'required' => false, - 'docRequired' => false, + 'example' => 'xxxx', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Result' => ['description' => 'The result. Valid values:'."\n" + ."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Update Kibana private network', + 'description' => '1. This API operation supports only cloud-native instances. For instances of the legacy architecture, use the TriggerNetwork operation.'."\n" + .'2. The Kibana specifications must be greater than 1 vCPU and 2 GB of memory.', + 'changeSet' => [ + ['createdAt' => '2025-12-03T08:10:54.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateKibanaPvlNetwork'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TriggerNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateLogstash', ], - 'UpdateLogstashDescription' => [ - 'summary' => 'Changes the name of a specified Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}/description', - 'methods' => [ - 'patch', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateKibanaSettings' => [ + 'summary' => 'Modifies the Kibana configuration. Currently, only the Kibana language configuration can be modified.', + 'path' => '/openapi/instances/{InstanceId}/actions/update-kibana-settings', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-n6w1o5jq****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure the idempotence of the request. The token must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'type' => 'string', - ], - ], - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Result' => [ - 'description' => 'The result returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'logstash_name', - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The Kibana language was modified.'."\n" + .'- false: The Kibana language failed to be modified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC*****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"description\\": \\"logstash_name\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateLogstashDescription', - 'description' => 'When you call this operation, take note of the following items: You cannot change the name of a cluster that is in the activating, invalid, or inactive state.'."\n", - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the description parameter in the request body to specify the new name of the cluster. The following code provides an example:'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC*****\\"\\n}","type":"json"}]', + 'title' => 'Modify kibana configuration', + 'requestParamsDescription' => '## RequestBody'."\n" + .'You can also specify the **i18n.locale** parameter (optional, default value: en) in the RequestBody to set the Kibana language. Example:'."\n" ."\n" - .' {'."\n" - .' "description": "logstash_name"'."\n" - .' }'."\n", - 'responseParamsDescription' => 'The returned result also contains the following parameters.'."\n" + .'```'."\n" + .'{'."\n" + .' "i18n.locale":"en"'."\n" + .'}'."\n" + .'```'."\n" ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|instanceId|String|ls-cn-n6w1o5jq\\*\\*\\*\\*|The ID of the cluster.|'."\n" - .'|description|String|ls-cn-abc|The name of the cluster.|'."\n" - .'|nodeAmount|Integer|2|The number of nodes in the cluster.|'."\n" - .'|paymentType|String|postpaid|The billing method of the cluster. Valid values: prepaid and postpaid. The value prepaid indicates the subscription billing method. The value postpaid indicates the pay-as-you-go billing method.|'."\n" - .'|status|String|active|The status of the cluster. Valid values: active, activating, inactive, and invalid.|'."\n" - .'|esVersion|String|6.7.0\\_with\\_X-Pack|The version of the cluster.|'."\n" - .'|createdAt|String|2018-07-13T03:58:07.253Z|The time when the cluster was created.|'."\n" - .'|updatedAt|String|2018-07-13T03:58:07.253Z|The time when the cluster was last updated.|'."\n" - .'|nodeSpec|||The configuration information of the nodes.|'."\n" - .'|└spec|String|logstash.n4.small|The specification category.|'."\n" - .'|└disk|Integer|40|The disk size.|'."\n" - .'|networkConfig|||The network configurations.|'."\n" - .'|└type|String|vpc|The network type. Only the virtual private cloud (VPC) is supported.|'."\n" - .'|└vpcId|String|vpc-abc|The ID of the VPC.|'."\n" - .'|└vswitchId|String|vsw-abc|The ID of the vSwitch.|'."\n" - .'|vsArea|String|cn-hangzhou-\\*|The zone where the cluster resides.|'."\n" - .'|domainList|||The list of domain names.|'."\n" - .'|└domain|String|ls-cn-abc.logstash.aliyuncs.com|The internal endpoint of the cluster.|'."\n" - .'|└port|Integer|7001|The port number.|'."\n" - ."\n\n" - .'**Note**└ indicates a child parameter. For more information about the parameters, see [ListLogstash](~~160534~~).', + .'> The `i18n.locale` parameter can be set only to en (English) or zh-CN (Chinese).', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateLogstashChargeType' => [ - 'path' => '/openapi/logstashes/{InstanceId}/actions/convert-pay-type', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:55.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateKibanaSettings'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateKibanaSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateKibanaSso' => [ + 'summary' => 'Enable or disable Alibaba Cloud account authentication for Kibana. After Alibaba Cloud account authentication is enabled, you must log on with your Alibaba Cloud account before you can use Kibana features.', + 'path' => '/openapi/instances/{InstanceId}/actions/kibana-sso', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json', 'application/x-www-form-urlencoded'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254296', + 'abilityTreeNodes' => ['FEATUREelasticsearch2PSU4E'], + ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-n6w1o5jq****', - ], + 'schema' => ['description' => 'instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-bkh4h4rft00***', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'enable', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'true: Enabled; false: shutdown', 'title' => 'true: Enabled; false: shutdown', 'type' => 'string', 'required' => true, 'example' => 'false'], ], [ - 'name' => 'body', - 'in' => 'body', + 'name' => 'networkType', + 'in' => 'query', 'schema' => [ + 'description' => 'PUBLIC, PRIVATE', + 'title' => 'PUBLIC, PRIVATE', 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'required' => true, + 'example' => 'PUBLIC, PRIVATE', + 'enum' => [], ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response', + 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Indicates whether the billing method of the cluster is switched. Valid values:'."\n" - ."\n" - .'* true: The billing method is switched.'."\n" - .'* false: The billing method fails to be switched.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'RequestId' => ['description' => 'Id of the request', 'title' => 'Id of the request', 'type' => 'string', 'example' => 'C82758DD-282F-4D48-934F-92170A33****'], + 'Result' => ['description' => 'Return Result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Modify the Alibaba Cloud account authentication configuration for Kibana', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateLogstashChargeType', - 'summary' => 'Switches the billing method of a Logstash cluster from pay-as-you-go to subscription.', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body.'."\n" - ."\n" - .'| Parameter | Type | Required | Example | Description | | ---- | ---- | ---- | ---- | | paymentInfo | Array | Yes | | The payment information after the billing method of the cluster is switched. | | └duration | Integer | Yes | 1 | The subscription duration. If you set pricingCycle to Year, you can set this parameter to a value that ranges from 1 to 3. If you set pricingCycle to Month, you can set this parameter to a value that ranges from 1 to 9. | | └pricingCycle | String | Yes | Year | The subscription type. Valid values: Year and Month. | | paymentType | String | Yes | prepaid | The current billing method of the cluster. You can switch the billing method of a cluster only from pay-as-you-go to subscription. Therefore, you can set this parameter only to prepaid. |'."\n" - ."\n" - .'> └ indicates a child parameter.'."\n" - ."\n" - .'Sample code:'."\n" - ."\n" - .' {'."\n" - .' "paymentInfo":{ '."\n" - .' "duration":1,'."\n" - .' "pricingCycle":"Month"'."\n" - .' },'."\n" - .' "paymentType":"prepaid"'."\n" - .' }'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C82758DD-282F-4D48-934F-92170A33****\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'ListLogstash' => [ - 'summary' => 'Queries the information about a Logstash cluster or all Logstash clusters.', - 'path' => '/openapi/logstashes', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateKibanaWhiteIps' => [ + 'summary' => 'Updates the Kibana access whitelist of a specified Alibaba Cloud Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/kibana-white-ips', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => 'ls-cn-n6w1o5jq\\*\\*\\*\\*'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => '5.5.3\\_with_X-Pack'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'description', - 'in' => 'query', - 'schema' => [ - 'description' => 'rg-acfm2h5vbzd\\*\\*\\*\\*'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ls-cn-abc', - ], - ], - [ - 'name' => 'instanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '\\[{"tagKey":"key1","tagValue":"value1"}]'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ls-cn-n6w1o5jq****', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-tl329rbpc0001****', 'title' => ''], ], [ - 'name' => 'version', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5.5.3_with_X-Pack', - ], + 'schema' => ['description' => 'A unique token generated by the client to guarantee the idempotency of the request. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'resourceGroupId', + 'name' => 'modifyMode', 'in' => 'query', 'schema' => [ - 'description' => 'Details of the request header.'."\n", + 'title' => '', + 'description' => 'The modification mode. Valid values:'."\n" + ."\n" + .'- Cover (default): Overwrites the original IP whitelist with the value of the ips parameter.'."\n" + ."\n" + .'- Append: Adds the IP addresses specified in the ips parameter to the original IP whitelist.'."\n" + ."\n" + .'- Delete: Removes the IP addresses specified in the ips parameter from the original IP whitelist. At least one IP address must be retained.', 'type' => 'string', 'required' => false, - 'example' => 'rg-acfm2h5vbzd****', + 'example' => 'Cover', + 'default' => 'Cover', + 'enum' => ['Cover', 'Append', 'Delete'], ], ], [ - 'name' => 'tags', - 'in' => 'query', + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'kibanaIPWhitelist' => [ + 'title' => '', + 'description' => 'The Kibana node IP access whitelist. This parameter cannot be set together with the whitelist group.', + 'type' => 'array', + 'items' => ['description' => 'The IP address whitelist. This parameter is available when whiteIpGroup is empty. The value of this parameter updates the IP whitelist configuration in the Default whitelist group.'."\n" + ."\n" + .'You cannot configure kibanaIPWhitelist and whiteIpGroup at the same time.', 'type' => 'string', 'required' => false, 'example' => '["110.0.XX.XX/8"]', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'whiteIpGroup' => [ + 'title' => '', + 'description' => 'Updates the Kibana access whitelist configuration by using the whitelist group method. Only one whitelist group can be updated at a time.'."\n" + ."\n" + .'You cannot configure kibanaIPWhitelist and whiteIpGroup at the same time.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['title' => '', 'description' => 'The name of the whitelist group. This parameter is required if the whiteIpGroup parameter is specified.', 'type' => 'string', 'example' => 'test_group_name', 'required' => false], + 'whiteIpType' => ['title' => '', 'description' => 'The whitelist type. Only PUBLIC_KIBANA (public network access whitelist) is supported.', 'type' => 'string', 'example' => 'PUBLIC_KIBANA', 'required' => false], + 'ips' => [ + 'title' => '', + 'description' => 'The list of IP addresses in the whitelist group.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of IP addresses in the whitelist group. This parameter is required if the whiteIpGroup parameter is specified.', 'type' => 'string', 'required' => false, 'example' => '["0.0.0.0", "10.2.XX.XX"]'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => '[{"tagKey":"key1","tagValue":"value1"}]', + 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Detailed information about the matching instances.'."\n", - 'type' => 'string', - 'example' => 'AC442F2F-5068-4434-AA21-E78947A9****', - ], - 'Headers' => [ - 'description' => 'The billing method of the instance. Supported: prepaid (subscription) and postpaid (pay-as-you-go).'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E5EF11F1-DBAE-4020-AC24-DFA6C4345CAE', 'title' => ''], + 'Result' => [ + 'description' => 'The details of the Elasticsearch instance.', 'type' => 'object', 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The number of data nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'kibanaPrivateIPWhitelist' => [ + 'description' => 'The Kibana internal-facing whitelist.', + 'type' => 'array', + 'items' => ['description' => 'The Kibana internal-facing whitelist.', 'type' => 'string', 'example' => '[ "192.168.XX.XX/24" ]', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - ], - 'Result' => [ - 'description' => 'The name of the VPC.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'createdAt' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => '2018-07-13T03:58:07.253Z', - ], - 'instanceId' => [ - 'description' => 'The tag value of the cloud disk.'."\n", - 'type' => 'string', - 'example' => 'ls-cn-n6w1o5jq****', - ], - 'networkConfig' => [ - 'description' => 'The network type. Currently, only Virtual Private Cloud (VPC) is supported.'."\n", - 'type' => 'object', - 'properties' => [ - 'vswitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-def', - ], - 'vsArea' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-*', - ], - 'vpcId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vpc-abc', - ], - 'type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc', - ], - ], - ], - 'description' => [ - 'description' => 'The time when the instance was last updated.'."\n", - 'type' => 'string', - 'example' => 'ls-cn-abc', - ], - 'resourceGroupId' => [ - 'type' => 'string', - ], - 'version' => [ - 'description' => 'The tag key of the cloud disk.'."\n", - 'type' => 'string', - 'example' => '6.7.0_with_X-Pack', - ], - 'nodeSpec' => [ - 'description' => 'Specifies whether to use disk encryption. Valid values:'."\n" - ."\n" - .'* true: Enables the concurrent query feature for queries other than aggregate queries.'."\n" - .'* false: Disables the concurrent query feature for queries other than aggregate queries.'."\n", - 'type' => 'object', - 'properties' => [ - 'disk' => [ - 'description' => 'The network configurations.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'diskType' => [ - 'description' => 'The zone where the cluster resides.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - 'diskEncryption' => [ - 'description' => 'The ID of the VPC.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'spec' => [ - 'description' => 'The type of the disk.'."\n", - 'type' => 'string', - 'example' => 'logstash.n4.small', - ], - ], - ], - 'nodeAmount' => [ - 'description' => 'The state of the instance. Valid values: Normal, Active, Inactive, and Invalid.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Tags' => [ - 'description' => 'The configuration information of the data node.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TagKey' => [ - 'description' => 'The disk size of the node.'."\n", - 'type' => 'string', - 'example' => 'env', - ], - 'TagValue' => [ - 'description' => 'The instance type of the ECS instance.'."\n", - 'type' => 'string', - 'example' => 'dev', + 'kibanaIPWhitelist' => [ + 'description' => 'The Kibana access whitelist.', + 'type' => 'array', + 'items' => ['description' => 'The Kibana access whitelist.', 'type' => 'string', 'example' => '["0.0.XX.XX", "10.2.XX.XX", "110.0.XX.XX/9"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'networkConfig' => [ + 'description' => 'The network configuration.', + 'type' => 'object', + 'properties' => [ + 'vpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1jy348ibzulk6hn****', 'title' => ''], + 'vswitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1a0mifpletdd1da****', 'title' => ''], + 'vsArea' => ['description' => 'The region where the instance resides.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + 'type' => ['description' => 'The network type.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], + 'whiteIpGroupList' => [ + 'description' => 'The whitelist group list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The whitelist group list.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'example' => 'test_group_name', 'title' => ''], + 'ips' => [ + 'description' => 'The list of IP addresses in the whitelist group.', + 'type' => 'array', + 'items' => ['description' => 'The list of IP addresses in the whitelist group.', 'type' => 'string', 'example' => '["0.0.0.0", "10.2.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'whiteIpType' => ['description' => 'The whitelist type.', 'type' => 'string', 'example' => 'PUBLIC_KIBANA', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'paymentType' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => 'postpaid', - ], - 'status' => [ - 'description' => 'The version of the instance. Currently, only 6.7.0\\_with_X-Pack and 7.4.0\\_with_X-Pack are supported.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'updatedAt' => [ - 'description' => 'The tag of the instance. Valid values:'."\n", - 'type' => 'string', - 'example' => '2018-07-18T10:10:04.484Z', - ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AC442F2F-5068-4434-AA21-E78947A9****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 10\\n },\\n \\"Result\\": [\\n {\\n \\"createdAt\\": \\"2018-07-13T03:58:07.253Z\\",\\n \\"instanceId\\": \\"ls-cn-n6w1o5jq****\\",\\n \\"networkConfig\\": {\\n \\"vswitchId\\": \\"vsw-def\\",\\n \\"vsArea\\": \\"cn-hangzhou-*\\",\\n \\"vpcId\\": \\"vpc-abc\\",\\n \\"type\\": \\"vpc\\"\\n },\\n \\"description\\": \\"ls-cn-abc\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"version\\": \\"6.7.0_with_X-Pack\\",\\n \\"nodeSpec\\": {\\n \\"disk\\": 50,\\n \\"diskType\\": \\"cloud_ssd\\",\\n \\"diskEncryption\\": false,\\n \\"spec\\": \\"logstash.n4.small\\"\\n },\\n \\"nodeAmount\\": 2,\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"env\\",\\n \\"TagValue\\": \\"dev\\"\\n }\\n ],\\n \\"paymentType\\": \\"postpaid\\",\\n \\"status\\": \\"active\\",\\n \\"updatedAt\\": \\"2018-07-18T10:10:04.484Z\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListLogstash', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E5EF11F1-DBAE-4020-AC24-DFA6C4345CAE\\",\\n \\"Result\\": {\\n \\"kibanaPrivateIPWhitelist\\": [\\n \\"[ \\\\\\"192.168.XX.XX/24\\\\\\" ]\\"\\n ],\\n \\"kibanaIPWhitelist\\": [\\n \\"[\\\\\\"0.0.XX.XX\\\\\\", \\\\\\"10.2.XX.XX\\\\\\", \\\\\\"110.0.XX.XX/9\\\\\\"]\\"\\n ],\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-bp1jy348ibzulk6hn****\\",\\n \\"vswitchId\\": \\"vsw-bp1a0mifpletdd1da****\\",\\n \\"vsArea\\": \\"cn-hangzhou-h\\",\\n \\"type\\": \\"vpc\\",\\n \\"whiteIpGroupList\\": [\\n {\\n \\"groupName\\": \\"test_group_name\\",\\n \\"ips\\": [\\n \\"[\\\\\\"0.0.0.0\\\\\\", \\\\\\"10.2.XX.XX\\\\\\"]\\"\\n ],\\n \\"whiteIpType\\": \\"PUBLIC_KIBANA\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Update kibana access whitelist of an instance', + 'description' => '## Before you begin'."\n" + .'- When you invoke this operation, you cannot update information if the instance status is activating, invalid, or freeze (inactive).'."\n" + .'- You can update the whitelist in two ways: IP whitelist list and IP whitelist group. The two methods cannot be used at the same time. In addition to InstanceId and clientToken, the two methods support different parameters, as follows: '."\n" + .' - IP whitelist list: kibanaIPWhitelist'."\n" + .' - IP whitelist group: modifyMode, whiteIpGroup'."\n" + .'- The public network access whitelist does not support private IP addresses, and the internal-facing whitelist does not support public IP addresses.', + 'requestParamsDescription' => '><notice> Adding and deleting whitelist groups are implemented by calls with modifyMode set to Cover. Delete and Append cannot add or delete whitelist groups. They can only modify the IP address list in a whitelist group. Details are as follows:'."\n" + ."\n" + .'- When modifyMode is set to Cover, the whitelist group is deleted if ips is empty. If groupName is not in the list of existing whitelist group names, a new whitelist group is created.'."\n" + .'- When modifyMode is set to Delete, at least one IP address must be retained after deletion.'."\n" + .'- When modifyMode is set to Append, the whitelist group name must already exist. Otherwise, a NotFound error is returned.'."\n" + ."\n" + .'></notice>.', + 'responseParamsDescription' => '> The following response examples only guarantee the parameters listed in the response data. Parameters not mentioned are for reference only and must not be relied upon in your program.', 'extraInfo' => ' ', - ], - 'DescribeLogstash' => [ - 'summary' => 'Queries the information about a Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-09-13T08:10:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-13T08:10:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-30T09:44:55.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateKibanaWhiteIps'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateKibanaWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'UpdateLogstash' => [ + 'summary' => 'Modifies some information about a specified instance, such as the number of nodes, quota, name, and disk size.', + 'path' => '/openapi/logstashes/{InstanceId}', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '64388', + 'abilityTreeNodes' => ['FEATUREelasticsearchDYS3SR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-s9dsk3k4k****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-n6w1o5jq****', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'Detailed information about the instance.'."\n", - 'type' => 'string', - 'example' => 'C9334241-4837-46C2-B24B-9BDC517318DE', - ], - 'Result' => [ - 'description' => 'The configurations of the instance.'."\n", + 'nodeSpec' => [ + 'description' => 'The node specifications.', 'type' => 'object', 'properties' => [ - 'config' => [ - 'description' => 'The billing method of the instance. Valid values:'."\n" - ."\n" - .'* prepaid: subscription'."\n" - .'* postpaid: pay-as-you-go'."\n", - 'type' => 'object', - 'example' => '{"slowlog.threshold.warn": "2s","slowlog.threshold.info": "1s","slowlog.threshold.debug": "500ms","slowlog.threshold.trace": "100ms" }', - ], - 'paymentType' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'prepaid', - ], - 'ResourceGroupId' => [ - 'description' => 'The number of data nodes.'."\n", - 'type' => 'string', - 'example' => 'rg-aekzvowej3i****', - ], - 'nodeAmount' => [ - 'description' => 'The name of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'description' => [ - 'description' => 'The time when the instance was created.'."\n", - 'type' => 'string', - 'example' => 'ls-cn-abc', - ], - 'createdAt' => [ - 'description' => 'The state of the instance. Four states are supported:'."\n" - ."\n" - .'* Normal: active'."\n" - .'* Active: activating'."\n" - .'* Freeze: inactive'."\n" - .'* Invalid: invalid'."\n", - 'type' => 'string', - 'example' => '2020-02-06T14:12:03.672Z', - ], - 'status' => [ - 'description' => 'The ID of the virtual private cloud (VPC) to which the elastic container instances belong.'."\n", - 'type' => 'string', - 'example' => 'active', - ], - 'vpcInstanceId' => [ - 'description' => 'The time when the instance was last updated.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtmagcva****', - ], - 'updatedAt' => [ - 'description' => 'The edition of the dedicated KMS instance.'."\n", - 'type' => 'string', - 'example' => '2020-02-06T14:22:36.850Z', - ], - 'version' => [ - 'description' => 'The ID of the instance.'."\n", + 'spec' => [ + 'title' => '', + 'description' => 'The specification information. For more information, see [Product specifications](~~271718~~).', + 'enumValueTitles' => [ + 'elasticsearch.ic5.3xlarge' => 'elasticsearch.ic5.3xlarge', 'elasticsearch.sn1ne.4xlarge' => 'elasticsearch.sn1ne.4xlarge', 'elasticsearch.r5.large' => 'elasticsearch.r5.large', 'elasticsearch.sn1ne.8xlarge' => 'elasticsearch.sn1ne.8xlarge', 'elasticsearch.sn2ne.xlarge' => 'elasticsearch.sn2ne.xlarge', 'elasticsearch.r5.2xlarge' => 'elasticsearch.r5.2xlarge', 'elasticsearch.ic5.4xlarge' => 'elasticsearch.ic5.4xlarge', 'elasticsearch.sn2ne.4xlarge' => 'elasticsearch.sn2ne.4xlarge', 'elasticsearch.ic5.xlarge' => 'elasticsearch.ic5.xlarge', 'elasticsearch.sn2ne.large' => 'elasticsearch.sn2ne.large', + 'elasticsearch.sn2ne.2xlarge' => 'elasticsearch.sn2ne.2xlarge', 'elasticsearch.ic5.2xlarge' => 'elasticsearch.ic5.2xlarge', 'elasticsearch.sn1ne.large' => 'elasticsearch.sn1ne.large', 'elasticsearch.r5.xlarge' => 'elasticsearch.r5.xlarge', + ], 'type' => 'string', - 'example' => '7.4.0_with_X-Pack', + 'example' => 'elasticsearch.sn1ne.large', + 'enum' => ['elasticsearch.sn1ne.large', 'elasticsearch.sn2ne.large', 'elasticsearch.r5.large', 'elasticsearch.ic5.xlarge', 'elasticsearch.sn2ne.xlarge', 'elasticsearch.r5.xlarge', 'elasticsearch.ic5.2xlarge', 'elasticsearch.sn2ne.2xlarge', 'elasticsearch.r5.2xlarge', 'elasticsearch.ic5.3xlarge', 'elasticsearch.ic5.4xlarge', 'elasticsearch.sn1ne.4xlarge', 'elasticsearch.sn2ne.4xlarge', 'elasticsearch.sn1ne.8xlarge'], + 'required' => false, ], - 'instanceId' => [ - 'description' => 'The access information of the node.'."\n", + 'disk' => ['title' => '', 'description' => 'The disk size. Unit: GB.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2048', 'minimum' => '20', 'example' => '20', 'required' => false], + 'diskType' => [ + 'title' => '', + 'description' => 'The disk type. Valid values:'."\n" + .'- cloud_efficiency: ultra cloud disk'."\n" + .'- cloud_ssd: SSD cloud disk.', + 'enumValueTitles' => ['cloud_efficiency' => 'cloud_efficiency', 'cloud_ssd' => 'cloud_ssd'], 'type' => 'string', - 'example' => 'ls-cn-abc', - ], - 'endpointList' => [ - 'description' => 'The ID of the zone where the node resides.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'zoneId' => [ - 'description' => 'The port number.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - ], - 'port' => [ - 'description' => 'The IP address of the node.'."\n", - 'type' => 'string', - 'example' => '9600', - ], - 'host' => [ - 'description' => 'The tags added to the ALB instance.'."\n", - 'type' => 'string', - 'example' => '172.16.**.**', - ], - ], - ], - ], - 'Tags' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'tagKey' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'env', - ], - 'tagValue' => [ - 'description' => 'The information about the zones.'."\n", - 'type' => 'string', - 'example' => 'dev', - ], - ], - ], - ], - 'ZoneInfos' => [ - 'description' => 'The status of the zone. Valid values:'."\n" - ."\n" - .'* ISOLATION: offline'."\n" - .'* NORMAL'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'status' => [ - 'description' => 'The zone ID of the new instance.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'zoneId' => [ - 'description' => 'The configuration of cluster extension parameters.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-b', - ], - ], - ], - ], - 'ExtendConfigs' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]', - ], - 'description' => 'The configuration information of the node.'."\n", - ], - 'nodeSpec' => [ - 'description' => 'The specifications of the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'spec' => [ - 'description' => 'The disk size of the node.'."\n", - 'type' => 'string', - 'example' => 'elasticsearch.sn1ne.large', - ], - 'disk' => [ - 'description' => 'Whether to use disk encryption:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'diskEncryption' => [ - 'description' => 'The disk type of the node.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'diskType' => [ - 'description' => 'The network configurations.'."\n", - 'type' => 'string', - 'example' => 'cloud_ssd', - ], - ], - ], - 'networkConfig' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'object', - 'properties' => [ - 'vpcId' => [ - 'description' => 'The zone where the cluster resides.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtmagcva****', - ], - 'vsArea' => [ - 'description' => 'The network type of the instance. Valid values: Currently, only Virtual Private Cloud (VPC) are supported.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-*', - ], - 'type' => [ - 'description' => 'The ID of the vSwitch to which the instance is connected.'."\n", - 'type' => 'string', - 'example' => 'vpc', - ], - 'vswitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-bp1k4ec6s7sjdbudw****', - ], - ], + 'example' => 'cloud_efficiency', + 'enum' => ['cloud_efficiency', 'cloud_ssd'], + 'required' => false, ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'nodeAmount' => ['title' => '', 'description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20', 'minimum' => '1', 'example' => '3'], ], + 'required' => false, + 'docRequired' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'Indicates whether the instance information is modified. Valid values:'."\n" + ."\n" + .'- true: The instance information is modified.'."\n" + .'- false: The instance information failed to be modified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C9334241-4837-46C2-B24B-9BDC517318DE\\",\\n \\"Result\\": {\\n \\"config\\": {\\n \\"slowlog.threshold.warn\\": \\"2s\\",\\n \\"slowlog.threshold.info\\": \\"1s\\",\\n \\"slowlog.threshold.debug\\": \\"500ms\\",\\n \\"slowlog.threshold.trace\\": \\"100ms\\"\\n },\\n \\"paymentType\\": \\"prepaid\\",\\n \\"ResourceGroupId\\": \\"rg-aekzvowej3i****\\",\\n \\"nodeAmount\\": 2,\\n \\"description\\": \\"ls-cn-abc\\",\\n \\"createdAt\\": \\"2020-02-06T14:12:03.672Z\\",\\n \\"status\\": \\"active\\",\\n \\"vpcInstanceId\\": \\"vpc-bp16k1dvzxtmagcva****\\",\\n \\"updatedAt\\": \\"2020-02-06T14:22:36.850Z\\",\\n \\"version\\": \\"7.4.0_with_X-Pack\\",\\n \\"instanceId\\": \\"ls-cn-abc\\",\\n \\"endpointList\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-b\\",\\n \\"port\\": \\"9600\\",\\n \\"host\\": \\"172.16.**.**\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"tagKey\\": \\"env\\",\\n \\"tagValue\\": \\"dev\\"\\n }\\n ],\\n \\"ZoneInfos\\": [\\n {\\n \\"status\\": \\"NORMAL\\",\\n \\"zoneId\\": \\"cn-hangzhou-b\\"\\n }\\n ],\\n \\"ExtendConfigs\\": [\\n [\\n {\\n \\"configType\\": \\"aliVersion\\",\\n \\"aliVersion\\": \\"ali1.3.0\\"\\n }\\n ]\\n ],\\n \\"nodeSpec\\": {\\n \\"spec\\": \\"elasticsearch.sn1ne.large\\",\\n \\"disk\\": 20,\\n \\"diskEncryption\\": true,\\n \\"diskType\\": \\"cloud_ssd\\"\\n },\\n \\"networkConfig\\": {\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtmagcva****\\",\\n \\"vsArea\\": \\"cn-hangzhou-*\\",\\n \\"type\\": \\"vpc\\",\\n \\"vswitchId\\": \\"vsw-bp1k4ec6s7sjdbudw****\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeLogstash', - 'requestParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RenewLogstash' => [ - 'path' => '/openapi/logstashes/{InstanceId}/actions/renew', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Modify partial instance information', + 'description' => '### Before you begin'."\n" + .'You cannot modify instance information when the instance status is activating, invalid, or freeze (inactive).', + 'changeSet' => [ + ['createdAt' => '2024-07-04T03:24:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-05T06:36:43.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLogstash'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'UpdateLogstashChargeType' => [ + 'path' => '/openapi/logstashes/{InstanceId}/actions/convert-pay-type', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28710,39 +25666,22 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-n6w1o5jq****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-n6w1o5jq****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence. Generated by the client. The value must be unique across requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -28750,367 +25689,262 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'The returned result. Valid values:'."\n" - ."\n" - .'* true: The cluster is renewed.'."\n" - .'* false: The cluster fails to be renewed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The conversion succeeded.'."\n" + .'- false: The conversion failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], + ['errorCode' => 'InstanceActivating', 'errorMessage' => 'Instance is activating.', 'description' => 'Instance is activating.'], + ['errorCode' => 'InstanceNotFound', 'errorMessage' => 'The instanceId provided does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RenewLogstash', - 'summary' => 'Renews a Logstash cluster.', - 'requestParamsDescription' => '## Request body'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'UpdateLogstashChargeType', + 'summary' => 'Converts a pay-as-you-go Alibaba Cloud Logstash instance to a subscription instance.', + 'requestParamsDescription' => '## RequestBody'."\n" ."\n" - .'You must configure the following parameters in the request body.'."\n" + .'The following parameters must also be specified in the RequestBody.'."\n" ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|duration|Integer|Yes|1|The renewal period.If you set the pricingCycle parameter to Year, you can set this parameter to a value that ranges from 1 to 3.If you set the pricingCycle parameter to Month, you can set this parameter to a value that ranges from 1 to 9.|'."\n" - .'|pricingCycle|String|Yes|Year|The unit of the renewal period. Valid values: Year and Month.|'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- | ---- |'."\n" + .'| paymentInfo | Array | Yes | | The billing information of the instance after conversion.|'."\n" + .'| └duration | Integer | Yes | 1 | The subscription duration. If pricingCycle is set to Year, valid values: 1 to 3. If pricingCycle is set to Month, valid values: 1 to 9.|'."\n" + .'| └pricingCycle | String | Yes | Year | The billing cycle. Valid values: Year, Month.|'."\n" + .'| paymentType | String | Yes | prepaid | The current billing type of the instance. Currently, only conversion from pay-as-you-go to subscription is supported. Set this parameter to prepaid.|'."\n" ."\n\n" - .'Sample code:'."\n" + ."\n" + .'> └ indicates a child parameter.'."\n" + ."\n" + .'Example:'."\n" ."\n" .'```'."\n" .'{'."\n" - .' "duration":1,'."\n" - .' "pricingCycle":"Year"'."\n" + .' "paymentInfo":{ '."\n" + .' "duration":1,'."\n" + .' "pricingCycle":"Month"'."\n" + .' },'."\n" + .' "paymentType":"prepaid"'."\n" .'}'."\n" - .'```', + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RestartLogstash' => [ - 'summary' => 'Restarts a specified Logstash cluster. After the cluster is restarted, it is in the activating state.', - 'path' => '/openapi/logstashes/{InstanceId}/actions/restart', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLogstashChargeType'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateLogstashChargeType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateLogstashDescription' => [ + 'summary' => 'Modifies the name of a specified Logstash instance.', + 'path' => '/openapi/logstashes/{InstanceId}/description', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-v0h1kzca****', - ], - ], - [ - 'name' => 'force', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-n6w1o5jq****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token generated by the client to ensure idempotence of the request. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'batchCount' => [ - 'title' => '强制重启百分比。蓝绿重启时，无法强制重启，无需设置。', - 'description' => '', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '20%', - ], - 'restartType' => [ - 'title' => '重启类型'."\n", - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'instance', - 'enum' => [ - '', - '', - '', - ], - ], - 'nodes' => [ - 'title' => '节点重启时，选择的节点IP', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '["192.168.1.1"]', - ], - 'required' => false, - ], - 'nodeTypes' => [ - 'title' => '角色重启时，选择的角色类型。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'kibana', - ], - 'required' => false, - ], - 'blueGreenDep' => [ - 'title' => '是否蓝绿重启', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, + 'docRequired' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], 'Result' => [ - 'description' => '', - '$ref' => '#/components/schemas/Logstash', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'description' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'logstash_name', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": {\\n \\"endpointList\\": [\\n {\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"zoneId\\": \\"\\"\\n }\\n ],\\n \\"status\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"endTime\\": 0,\\n \\"instanceId\\": \\"\\",\\n \\"config\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"createdAt\\": \\"\\",\\n \\"networkConfig\\": {\\n \\"type\\": \\"\\",\\n \\"vpcId\\": \\"\\",\\n \\"vsArea\\": \\"\\",\\n \\"vswitchId\\": \\"\\"\\n },\\n \\"zoneInfos\\": [\\n {\\n \\"status\\": \\"\\",\\n \\"zoneId\\": \\"\\"\\n }\\n ],\\n \\"nodeAmount\\": 0,\\n \\"updatedAt\\": \\"\\",\\n \\"version\\": \\"\\",\\n \\"dataNode\\": true,\\n \\"nodeSpec\\": {\\n \\"disk\\": 0,\\n \\"diskType\\": \\"\\",\\n \\"spec\\": \\"\\"\\n },\\n \\"paymentType\\": \\"\\",\\n \\"protocol\\": \\"\\",\\n \\"tags\\": [\\n {\\n \\"tagKey\\": \\"\\",\\n \\"tagValue\\": \\"\\"\\n }\\n ],\\n \\"zoneCount\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RestartLogstash', - 'requestParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'EstimatedLogstashRestartTime' => [ - 'path' => '/openapi/logstashes/{InstanceId}/estimated-time/restart-time', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], - ], - [ - 'name' => 'force', - 'in' => 'query', + 400 => [ 'schema' => [ - 'description' => 'Specifies whether to forcibly restart the cluster. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'body', - 'in' => 'body', 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'unit' => [ - 'description' => 'The unit.'."\n", - 'type' => 'string', - 'example' => 'second', - ], - 'value' => [ - 'description' => 'The estimated restart time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '600', - ], - ], - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"unit\\": \\"second\\",\\n \\"value\\": 600\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'EstimatedLogstashRestartTime', - 'summary' => 'Queries the estimated time that is required to restart a Logstash cluster.', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You can configure the following parameters in the request body to specify information about the restart. '."\n" - .'| Parameter | Type | Required | Example | Description |'."\n" - .' | ---- | ---- | ---- | ---- | '."\n" - .'| restartType| String | No | instance|The restart type. Valid values: instance and nodeIp. Default value: instance. |'."\n" - .' | nodes| List<String> | No| \\["127.0.xx.xx"] |The IP addresses of the nodes that you want to restart. This parameter is required if you set restartType to nodeIp. |'."\n" - .' | blueGreenDep| Boolean | No | false |Specifies whether to perform a blue-green restart. This parameter is required if you set restartType to instance. Default value: false. |'."\n" - .' | batch| Integer | No| 25.0 | The concurrency at which the cluster is forcibly restarted. The default value of this parameter is 1 divided by the total number of nodes in the cluster. | '."\n" - .'| batchUnit| String | No | percent |The unit of the value for the batch parameter. Default value: percent. |'."\n" - ."\n" - .'* If you set the restartType parameter to instance, you do not need to configure the blueGreenDep parameter.'."\n" - ."\n" - .' * If you set the force parameter to true, you must set the batch parameter to a value that is greater than 0 and less than or equal to 100. Otherwise, the system reports the RestartBatchValueError error.'."\n" - .' * If you set the force parameter to false, the default value of the batch parameter is 0. If you set the batch parameter to a value other than 0, the system reports the NormalRestartNotSupportBatch error.'."\n" - ."\n" - .'* If you set the restartType parameter to nodeIp, you do not need to configure the batch parameter.'."\n" - ."\n" - .' * If the nodes parameter is not configured, the system reports a parameter configuration error.'."\n" - .' * If you set the blueGreenDep parameter to true, the system performs a blue-green restart. If you set the blueGreenDep parameter to false, the system performs a normal restart.'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"description\\": \\"logstash_name\\"\\n }\\n}","type":"json"}]', + 'title' => 'Modify logstash instance name', + 'description' => 'When you call this operation, take note of the following items:'."\n" + .'You cannot modify the instance name when the instance status is activating, invalid, or freeze (inactive).', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the description field to specify the new instance name. Example:'."\n" ."\n" - .'Sample code:'."\n" + .'```'."\n" + .'{'."\n" + .' "description": "logstash_name"'."\n" + .'}'."\n" + .'```.', + 'responseParamsDescription' => 'The Result also contains the following parameters.'."\n" + .'| Parameter | Data type | Example | Description |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| instanceId | String | ls-cn-n6w1o5jq**** | The instance ID. |'."\n" + .'| description | String | ls-cn-abc | The instance name. |'."\n" + .'| nodeAmount | Integer | 2 | The number of nodes in the instance. |'."\n" + .'| paymentType | String | postpaid | The billing method of the instance. Valid values: prepaid (subscription) and postpaid (pay-as-you-go). |'."\n" + .'| status | String | active | The status of the instance. Valid values: active, activating, inactive, and invalid. |'."\n" + .'| esVersion | String | 6.7.0_with_X-Pack | The version of the instance. |'."\n" + .'| createdAt | String | 2018-07-13T03:58:07.253Z | The time when the instance was created. |'."\n" + .'| updatedAt | String | 2018-07-13T03:58:07.253Z | The time when the instance was last updated. |'."\n" + .'| nodeSpec | | | The configuration information of the nodes. |'."\n" + .'| └spec | String | logstash.n4.small | The node specification. |'."\n" + .'| └disk | Integer | 40 | The disk size of the node. |'."\n" + .'| networkConfig | | | The network configuration. |'."\n" + .'| └type | String | vpc | The network type. Currently, only Virtual Private Cloud (VPC) is supported. |'."\n" + .'| └vpcId | String | vpc-abc | The VPC ID. |'."\n" + .'| └vswitchId | String | vsw-abc | The vSwitch ID. |'."\n" + .'| vsArea | String | ap-southeast-1-* | The zone where the instance resides. |'."\n" + .'| domainList | | | The domain name list. |'."\n" + .'| └domain | String | ls-cn-abc.logstash.aliyuncs.com | The private domain name assigned to the instance. |'."\n" + .'| └port | Integer | 7001 | The port number. |.'."\n" ."\n" - .' {'."\n" - .' "restartType":"nodeIp",'."\n" - .' "nodes": ["172.16.xx.xx"],'."\n" - .' "blueGreenDep":true'."\n" - .' }', - 'responseParamsDescription' => ' ', + .'> └ indicates a sub-parameter. For descriptions of other parameters, see [ListLogstash](~~160534~~).', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLogstashDescription'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateLogstashDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + ], ], 'UpdateLogstashSettings' => [ - 'summary' => 'Updates the configuration of the specified Logstash instance.', + 'summary' => 'Updates the configuration of a specified Logstash instance.', 'path' => '/openapi/logstashes/{InstanceId}/instance-settings', - 'methods' => [ - 'patch', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], @@ -29118,32 +25952,17 @@ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'ls-cn-2r42btxr\\*\\*\\*\\*'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-2r42btxr****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-2r42btxr****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. This parameter value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -29151,122 +25970,172 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '71D0D1DA-B22F-58CB-AF5B-D1657A6A****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '71D0D1DA-B22F-58CB-AF5B-D1657A6A****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"71D0D1DA-B22F-58CB-AF5B-D1657A6A****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateLogstashSettings', - 'description' => 'When you call this operation, take note of the following items:'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"71D0D1DA-B22F-58CB-AF5B-D1657A6A****\\"\\n}","type":"json"}]', + 'title' => 'Update logstash instance configuration', + 'description' => 'When you invoke this operation, note the following: The instance configuration cannot be updated when the instance status is activating, invalid, or freeze (inactive).', + 'requestParamsDescription' => ' ** RequestBody**'."\n" ."\n" - .'If the instance is in the Active (activating), Invalid (invalid), and Inactive (inactive) state, the information cannot be updated.'."\n", - 'requestParamsDescription' => '**RequestBody**'."\n" - ."\n" - .'You must specify the following parameters in RequestBody to update the configurations of a specified Logstash instance. '."\n" - ."\n" - .'| Field | Type | Required | Example | Description |'."\n" - .'| ----- | ---- | -------- | ------- | ----------- |'."\n" - .'| config | Map | No | {"thread_pool.bulk.queue_size":500} | Used to update the YML configuration information of an instance. |', + .'The RequestBody must also include the following parameters to update the configuration of the specified Logstash instance.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'|config|Map|No|{"thread_pool.bulk.queue_size":500}|The YML configuration information used to update the instance.|.', + 'responseParamsDescription' => ' The response also contains the Result parameter. For metric description, see [ListLogstash](~~160534~~).', 'extraInfo' => ' ', - ], - 'ListExtendfiles' => [ - 'path' => '/openapi/logstashes/{InstanceId}/extendfiles', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLogstashSettings'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateLogstashSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], ], + ], + 'UpdatePipelineManagementConfig' => [ + 'summary' => 'Modifies the pipeline management method for a specified Logstash instance.', + 'path' => '/openapi/logstashes/{InstanceId}/pipeline-management-config', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'abilityTreeCode' => '64390', + 'abilityTreeNodes' => ['FEATUREelasticsearchDYS3SR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. The client generates this value. The value must be unique across different requests and can contain up to 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', + 'description' => 'The information about the associated Elasticsearch instance.', + 'type' => 'object', + 'properties' => [ + 'endpoints' => [ + 'title' => '', + 'description' => 'The list of access addresses of the Elasticsearch instance where Kibana resides after Kibana pipeline management is enabled.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of access addresses of the Elasticsearch instance where Kibana resides after Kibana pipeline management is enabled.', 'type' => 'string', 'example' => '["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]', 'required' => false], + 'required' => false, + 'example' => '', + ], + 'userName' => ['title' => '', 'description' => 'The username used to log on to Kibana.', 'type' => 'string', 'example' => 'elastic', 'required' => false], + 'password' => ['title' => '', 'description' => 'The password used to log on to Kibana.', 'type' => 'string', 'example' => '******', 'required' => false], + 'pipelineIds' => [ + 'title' => '', + 'description' => 'The list of pipelines managed by Kibana.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The list of pipelines managed by Kibana.', 'type' => 'string', 'example' => '["testKibanaManagement"]', 'required' => false], + 'required' => false, + 'example' => '', + ], + 'pipelineManagementType' => [ + 'title' => '', + 'description' => 'The pipeline management method. Valid values:'."\n" + ."\n" + .'- ES: Kibana pipeline management.'."\n" + .'- MULTIPLE_PIPELINE: configuration file management.', + 'enumValueTitles' => ['ES' => 'ES', 'MULTIPLE_PIPELINE' => 'MULTIPLE_PIPELINE'], + 'type' => 'string', + 'example' => 'ES', + 'enum' => ['ES', 'MULTIPLE_PIPELINE'], + 'required' => false, + ], + 'esInstanceId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'example' => '{ "pipelineManagementType": "ES", "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "pipelineIds": [ "testKibanaManagement" ], "userName": "elastic", "password": "xxxx", "esInstanceId": "es-cn-n6w1o1x0w001c****" }', + 'title' => '', ], ], ], @@ -29275,197 +26144,132 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'filePath' => [ - 'description' => 'The path of the driver file.'."\n", - 'type' => 'string', - 'example' => '/ssd/1/share/ls-cn-oew1qbgl****/logstash/current/config/custom/mysql-connector-java-5.1.35.jar', - ], - 'fileSize' => [ - 'description' => 'The size of the driver file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '968668', - ], - 'name' => [ - 'description' => 'The name of the driver file.'."\n", - 'type' => 'string', - 'example' => 'mysql-connector-java-5.1.35.jar', - ], - 'sourceType' => [ - 'description' => 'The source type.'."\n", - 'type' => 'string', - 'example' => 'ORIGIN', - ], - ], - ], - ], + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- true: The update was successful.'."\n" + .'- false: The update failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"filePath\\": \\"/ssd/1/share/ls-cn-oew1qbgl****/logstash/current/config/custom/mysql-connector-java-5.1.35.jar\\",\\n \\"fileSize\\": 968668,\\n \\"name\\": \\"mysql-connector-java-5.1.35.jar\\",\\n \\"sourceType\\": \\"ORIGIN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListExtendfiles', - 'summary' => 'Queries the extended file configuration of a Logstash instance.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListLogstashPlugins' => [ - 'summary' => 'Queries the information about a plug-in or all plug-ins.', - 'path' => '/openapi/logstashes/{InstanceId}/plugins', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Modify pipeline management method', + 'description' => '> Pipeline management methods include configuration file management and Kibana pipeline management. The console no longer supports Kibana pipeline management. You can use this feature only through the API.', + 'changeSet' => [ + ['createdAt' => '2024-08-07T03:24:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-04T03:24:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-05T06:36:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelineManagementConfig'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdatePipelineManagementConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ], + ], + ], ], + ], + 'UpdatePipelines' => [ + 'summary' => 'Calls UpdatePipelines to update Logstash pipeline information.', + 'path' => '/openapi/logstashes/{InstanceId}/pipelines', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '3'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'name', + 'name' => 'trigger', 'in' => 'query', - 'schema' => [ - 'description' => 'USER'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'logstash-filter-clone', - ], + 'schema' => ['description' => 'Specifies whether to immediately deploy the pipeline.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence. This parameter value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '3', - ], - ], - [ - 'name' => 'source', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the plug-in.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'USER', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -29473,250 +26277,165 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The address of the documentation for the plug-in.'."\n", - 'type' => 'string', - 'example' => '99407AB-2FA9-489E-A259-40CF6DCC**** ', - ], - 'Result' => [ - 'description' => 'The status of the plug-in. Valid values:'."\n" - ."\n" - .'* INSTALLED: Installed'."\n" - .'* UNINSTALLED: Not installed'."\n" - .'* INSTALLING: The instance is being installed.'."\n" - .'* UNINSTALLING: The instance is being uninstalled.'."\n" - .'* UPGRADING: The backup gateway is being upgraded.'."\n" - .'* FAILED: Installation failed'."\n" - .'* UNKNOWN: The cluster is lost and cannot be created.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'description' => [ - 'description' => 'The source of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'The clone filter is for duplicating events.', - ], - 'specificationUrl' => [ - 'description' => 'The name of the plug-in.'."\n", - 'type' => 'string', - 'example' => 'https://xxx.html', - ], - 'state' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INSTALLED', - ], - 'source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'logstash-filter-clone', - ], - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The update was successful.'."\n" + .'- false: The update failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99407AB-2FA9-489E-A259-40CF6DCC****\\\\t\\",\\n \\"Result\\": [\\n {\\n \\"description\\": \\"The clone filter is for duplicating events.\\",\\n \\"specificationUrl\\": \\"https://xxx.html\\",\\n \\"state\\": \\"INSTALLED\\",\\n \\"source\\": \\"SYSTEM\\",\\n \\"name\\": \\"logstash-filter-clone\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListLogstashPlugins', - 'requestParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'InstallLogstashSystemPlugin' => [ - 'path' => '/openapi/logstashes/{InstanceId}/plugins/system/actions/install', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'clientToken', - 'in' => 'query', + 404 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], - ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + 500 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC4****', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["logstash-input-datahub", "logstash-input-maxcompute"]', - ], - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Update logstash pipeline information', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the pipeline information to update.'."\n" + ."\n" + .'> The RequestBody must contain a pipeline array in JSON format.'."\n" + ."\n" + .'| Name | Type | Required | Example | Description | '."\n" + .'| ---- | ---- | ---- | ---- | ---- | '."\n" + .'| pipelineId| String | Yes | pipeline-test |The ID of the pipeline to update.| '."\n" + .'| description| String | No | this is a test |The description of the pipeline.|'."\n" + .'| config| String | Yes | input { } filter { } output { } |The specific configuration of the pipeline.|'."\n" + .'| workers| Integer | No | 2 |The number of worker threads for the pipeline.| '."\n" + .'| batchSize| Integer | No | 125 |The batch size of the pipeline.|'."\n" + .'| batchDelay| Integer | No | 50 |The batch delay of the pipeline.|'."\n" + .'| queueType| String | No | MEMORY |The queue type. Valid values: MEMORY, PERSISTED.|'."\n" + .'| pipelineStatus| String | No | RUNNING |The pipeline status. Valid values: NOT_DEPLOYED, RUNNING, DELETED. This parameter is required when trigger is set to true. | '."\n" + .'| queueMaxBytes| Integer| No | 1024 |The maximum number of bytes in the queue. |'."\n" + .'| queueCheckPointWrites|Integer|No| 1024 |The number of checkpoint writes for the queue.|'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "pipelineId": "test",'."\n" + .' "config": "input {\\n\\n}\\nfilter {\\n\\n}\\noutput {\\n \\n}"'."\n" + .' }'."\n" + .']'."\n" + .'```.', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelines'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdatePipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC4****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"logstash-input-datahub\\\\\\", \\\\\\"logstash-input-maxcompute\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'InstallLogstashSystemPlugin', - 'summary' => 'Installs a plug-in.', - 'description' => 'ls-cn-oew1qbgl\\*\\*\\*\\*'."\n", - 'requestParamsDescription' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n", - 'extraInfo' => ' ', ], - 'UninstallLogstashPlugin' => [ - 'summary' => 'Removes one or more Logstash plug-ins.', - 'path' => '/openapi/logstashes/{InstanceId}/plugins/actions/uninstall', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdatePrivateNetworkWhiteIps' => [ + 'summary' => 'Updates the VPC private network access whitelist of a specified instance.', + 'path' => '/openapi/instances/{InstanceId}/private-network-white-ips', + 'methods' => ['post'], + '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' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The list of plug-ins that have been uninstalled.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' es-cn-tl329rbpc0001****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The maximum length is 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'modifyMode', + 'in' => 'query', + 'schema' => ['description' => 'The modification mode. Valid values:'."\n" + ."\n" + .'- Cover (default): overwrites the original IP whitelist with the value of the ips parameter.'."\n" + ."\n" + .'- Append: adds the IP addresses specified in the ips parameter to the original IP whitelist.'."\n" + ."\n" + .'- Delete: removes the IP addresses specified in the ips parameter from the original IP whitelist. At least one IP address must be retained.', 'type' => 'string', 'required' => false, 'example' => 'Cover', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, - 'example' => '["logstash-input-datahub", "logstash-input-maxcompute" ]', - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -29724,347 +26443,157 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6DEBE5EE-0368-4757-8F82-EF9C3972****', 'title' => ''], 'Result' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["logstash-input-datahub", "logstash-input-maxcompute" ]', - ], - 'description' => '', - ], - 'Headers' => [ + 'description' => 'The returned result.', 'type' => 'object', + 'properties' => [ + 'privateNetworkIpWhiteList' => [ + 'type' => 'array', + 'items' => ['description' => 'The VPC private network access whitelist.', 'type' => 'string', 'example' => '["192.168.XX.XX/25"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": [\\n \\"[\\\\\\"logstash-input-datahub\\\\\\", \\\\\\"logstash-input-maxcompute\\\\\\" ]\\"\\n ],\\n \\"Headers\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UninstallLogstashPlugin', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6DEBE5EE-0368-4757-8F82-EF9C3972****\\",\\n \\"Result\\": {\\n \\"privateNetworkIpWhiteList\\": [\\n \\"[\\\\\\"192.168.XX.XX/25\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Update the VPC private network access whitelist of an instance', + 'description' => '## Before you begin'."\n" + ."\n" + .'- You cannot update the VPC private network access whitelist of an instance when the instance status is Activating (activating), Invalid (invalid), or Freeze (inactive).'."\n" + .'- You can update the whitelist in two ways: by using an IP whitelist list or by using an IP whitelist group. The two methods cannot be used at the same time. In addition to InstanceId and clientToken, the two methods support different parameters:'."\n" + .' - IP whitelist list: privateNetworkIpWhiteList'."\n" + .' - IP whitelist group: modifyMode, whiteIpGroup'."\n" + .'- The public network access whitelist does not support private IP addresses, and the private network access whitelist does not support public IP addresses.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'| ----- | ----- | ----- | ----- | ----- |'."\n" + .'|privateNetworkIpWhiteList|List<String>|No|["0.0.XX.XX","10.2.XX.XX","192.168.XX.XX/25"]|The IP address whitelist. This parameter is available when whiteIpGroup is empty. The value of this parameter updates the IP whitelist configuration in the Default whitelist group.<br>You cannot specify both privateNetworkIpWhiteList and whiteIpGroup.|'."\n" + .'|whiteIpGroup|Object|No| |Updates the instance whitelist configuration by using a whitelist group. Only one whitelist group can be updated at a time.<br>You cannot specify both privateNetworkIpWhiteList and whiteIpGroup.|'."\n" + .'|└ groupName|String|No|test_group_name|The name of the whitelist group. This parameter is required if whiteIpGroup is specified.|'."\n" + .'|└ ips|List<String>|No|["0.0.0.0", "10.2.XX.XX"]|The list of IP addresses in the whitelist group. This parameter is required if whiteIpGroup is specified.|'."\n" + ."\n" + .'><notice> Adding and deleting whitelist groups are implemented by calling the operation with modifyMode set to Cover. Delete and Append cannot add or delete whitelist groups. They can only modify the IP address list in a whitelist group. Details are as follows:'."\n" + ."\n" + .'- When modifyMode is set to Cover, the whitelist group is deleted if ips is empty. If groupName is not in the list of existing whitelist group names, a new whitelist group is created.'."\n" + .'- When modifyMode is set to Delete, at least one IP address must be retained in ips after the deletion.'."\n" + .'- When modifyMode is set to Append, the whitelist group name must already exist. Otherwise, a NotFound error is returned.'."\n" + ."\n" + .'></notice>.', + 'responseParamsDescription' => '> In the following response examples, only the parameters listed in the response data are guaranteed to be included. Parameters not mentioned are for reference only. For metric descriptions, refer to [ListInstance](~~142230~~). Do not rely on obtaining these parameters in your program.', 'extraInfo' => ' ', - ], - 'ListLogstashLog' => [ - 'summary' => 'Queries the logs of a Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}/search-log', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:54.000Z', 'description' => 'Error codes changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrivateNetworkWhiteIps'], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '1531910852074'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-v0h1kzca****', - ], - ], - [ - 'name' => 'type', - 'in' => 'query', - 'schema' => [ - 'description' => '1531910852074'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'LOGSTASH_INSTANCE_LOG', - ], - ], - [ - 'name' => 'query', - 'in' => 'query', - 'schema' => [ - 'description' => '1'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'host:10.7.xx.xx AND level:info AND content:opening', - ], - ], - [ - 'name' => 'beginTime', - 'in' => 'query', - 'schema' => [ - 'description' => '20'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1531910852074', - ], - ], - [ - 'name' => 'endTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1531910852074', - ], - ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'The severity level of the log entry. Including trace, debug, info, warn, error, etc. (GC logs have no level).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '20', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The details of the log.'."\n", - 'type' => 'string', - 'example' => '7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****', - ], - 'Result' => [ - 'description' => 'The timestamp of log generation. Unit: ms.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'level' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'example' => 'info', - ], - 'content' => [ - 'description' => 'The IP address of the node that generates the log.'."\n", - 'type' => 'string', - 'example' => '[logstash.outputs.fileextend] Opening file {:path=>\\"/ssd/1/ls-cn-v0h1kzca****/logstash/logs/debug/test\\"}', - ], - 'timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531985112420', - ], - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ls-cn-v0h1kzca****', - ], - 'host' => [ - 'description' => '', - 'type' => 'string', - 'example' => '192.168.xx.xx', - ], - ], - ], - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****\\",\\n \\"Result\\": [\\n {\\n \\"level\\": \\"info\\",\\n \\"content\\": \\"[logstash.outputs.fileextend] Opening file {:path=>\\\\\\\\\\\\\\"/ssd/1/ls-cn-v0h1kzca****/logstash/logs/debug/test\\\\\\\\\\\\\\"}\\",\\n \\"timestamp\\": 1531985112420,\\n \\"instanceId\\": \\"ls-cn-v0h1kzca****\\",\\n \\"host\\": \\"192.168.xx.xx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListLogstashLog', - 'requestParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateXpackMonitorConfig' => [ - 'summary' => 'Updates the X-Pack monitoring and alert configuration of a Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}/xpack-monitor-config', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdatePublicNetwork' => [ + 'summary' => 'Enables or disables the public network address for a specified Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/public-network', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token that is used to ensure idempotence. This parameter value is generated by the client and must be unique among different requests. The value cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'enable' => [ - 'title' => 'xpack 监控是否启用。设置为false时，无需设置其他参数', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - 'endpoints' => [ - 'title' => 'Elasticsearch实例的访问地址。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => 'Elasticsearch实例的访问地址。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200', - ], - 'required' => false, - 'maxItems' => 2, - 'minItems' => 1, - ], - 'userName' => [ - 'title' => 'Elasticsearch实例的用户名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'elastic', - ], - 'password' => [ - 'title' => 'Elasticsearch实例的访问密码。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], - ], - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -30072,227 +26601,152 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2A88ECA1-D827-4581-AD39-05149586****', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - ], - ], - ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'enablePublic' => ['description' => 'The status of the public network address switch.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdateXpackMonitorConfig', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListAvailableEsInstanceIds' => [ - 'path' => '/openapi/logstashes/{InstanceId}/available-elasticsearch-for-centralized-management', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], - ], - ], - 'responses' => [ - 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'endpoint' => [ - 'description' => 'The address that is used to access the Elasticsearch cluster over the Internet.'."\n", - 'type' => 'string', - 'example' => 'http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200', - ], - 'description' => [ - 'description' => 'The name of the Elasticsearch cluster.'."\n", - 'type' => 'string', - 'example' => 'instanceName', - ], - 'kibanaEndpoint' => [ - 'description' => 'The address that is used to access the Kibana console of the Elasticsearch cluster over the Internet.'."\n", - 'type' => 'string', - 'example' => 'https://es-cn-n6w1o1x0w001c****.kibana.elasticsearch.aliyuncs.com:5601', - ], - 'esInstanceId' => [ - 'description' => 'The ID of the Elasticsearch cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - ], - ], - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A88ECA1-D827-4581-AD39-05149586****\\",\\n \\"Result\\": {\\n \\"enablePublic\\": false\\n }\\n}","type":"json"}]', + 'title' => 'Enable or disable public network address for an instance', + 'description' => 'When you call this operation, note the following:<br>'."\n" + .'You cannot update information when the instance status is activating, invalid, or freeze (inactive).', + 'requestParamsDescription' => '## RequestBody'."\n" + .'You can also specify the **enablePublic** parameter in the RequestBody (optional, default value: false). This parameter is of the Boolean type. A value of true enables public network address access, and a value of false disables public network address access. Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "enablePublic": true'."\n" + .'}'."\n" + .'```.', + 'responseParamsDescription' => '> In the following response example, only the parameters included in the response data list are guaranteed. Parameters that are not mentioned are for reference only. For parameter descriptions, refer to [ListInstance](~~142230~~). Do not rely on obtaining these parameters in your program.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePublicNetwork'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdatePublicNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'elasticsearch:InstancePublicNetworkSwitch', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"endpoint\\": \\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\\",\\n \\"description\\": \\"instanceName\\",\\n \\"kibanaEndpoint\\": \\"https://es-cn-n6w1o1x0w001c****.kibana.elasticsearch.aliyuncs.com:5601\\",\\n \\"esInstanceId\\": \\"es-cn-n6w1o1x0w001c****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListAvailableEsInstanceIds', - 'summary' => 'Queries the Elasticsearch clusters that can be associated with a Logstash cluster when you configure the X-Pack Monitoring feature for the Logstash cluster.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'DescribeXpackMonitorConfig' => [ - 'path' => '/openapi/logstashes/{InstanceId}/xpack-monitor-config', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdatePublicWhiteIps' => [ + 'summary' => 'Updates the public endpoint access whitelist of a specified Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/public-white-ips', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-tl329rbpc0001****', 'title' => ''], + ], + [ + 'name' => 'clientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique token generated by the client to guarantee the idempotency of the request. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ + 'name' => 'modifyMode', + 'in' => 'query', + 'schema' => ['description' => 'The modification method. Valid values:'."\n" + ."\n" + .'- Cover (default): overwrites the original IP whitelist with the value of the ips parameter.'."\n" + ."\n" + .'- Append: adds the IP addresses specified in the ips parameter to the original IP whitelist.'."\n" + ."\n" + .'- Delete: removes the IP addresses specified in the ips parameter from the original IP whitelist. At least one IP address must be retained.', 'type' => 'string', 'required' => false, 'example' => 'Cover', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -30300,170 +26754,158 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C82758DD-282F-4D48-934F-92170A33****', 'title' => ''], 'Result' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'userName' => [ - 'description' => 'The username that is used to access the associated Elasticsearch cluster.'."\n", - 'type' => 'string', - 'example' => 'elastic', - ], - 'esInstanceId' => [ - 'description' => 'The ID of the associated Elasticsearch cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - 'enable' => [ - 'description' => 'Indicates whether the X-Pack Monitoring feature is enabled. Valid values:'."\n" - ."\n" - .'* true: enabled'."\n" - .'* false: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'endpoints' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]', - ], - ], - 'pipelineIds' => [ + 'publicIpWhitelist' => [ 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '[]', - ], + 'items' => ['description' => 'The public endpoint access whitelist.', 'type' => 'string', 'example' => '["0.0.0.0","10.2.XX.XX","110.0.XX.XX/8"]', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": {\\n \\"userName\\": \\"elastic\\",\\n \\"esInstanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"enable\\": true,\\n \\"endpoints\\": [\\n \\"[\\\\\\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\"\\n ],\\n \\"pipelineIds\\": [\\n \\"[]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribeXpackMonitorConfig', - 'summary' => 'Queries the X-Pack Monitoring configurations of a Logstash cluster.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C82758DD-282F-4D48-934F-92170A33****\\",\\n \\"Result\\": {\\n \\"publicIpWhitelist\\": [\\n \\"[\\\\\\"0.0.0.0\\\\\\",\\\\\\"10.2.XX.XX\\\\\\",\\\\\\"110.0.XX.XX/8\\\\\\"]\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Update instance public endpoint access whitelist', + 'description' => '## Before you begin'."\n" + .'- You cannot update the public endpoint access whitelist of an instance when the instance status is activating, invalid, or inactive (freeze).'."\n" + .'- You can update the whitelist in two ways: IP whitelist list and IP whitelist group. The two methods cannot be used at the same time. In addition to InstanceId and clientToken, the two methods support different parameters: '."\n" + .' - IP whitelist list: publicIpWhitelist'."\n" + .' - IP whitelist group: modifyMode, whiteIpGroup'."\n" + .'- The public network access whitelist does not support private network IP addresses, and the private network access whitelist does not support public network IP addresses.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'|Parameter|Type|Required|Example|Description|'."\n" + .'| ----- | ----- |----- |------| ------|'."\n" + .'|publicIpWhitelist|List<String>|Yes|["0.0.0.0/0","0.0.0.0/1"]|The IP address whitelist. This parameter is available when whiteIpGroup is empty. The value of this parameter updates the IP whitelist configuration in the Default whitelist group.<br>You cannot configure publicIpWhitelist and whiteIpGroup at the same time.|'."\n" + .'|whiteIpGroup|Object|No| |Updates the instance whitelist configuration by using a whitelist group. Only one whitelist group can be updated at a time.<br>You cannot configure publicIpWhitelist and whiteIpGroup at the same time. |'."\n" + .'|└ groupName|String |No |test_group_name| The name of the whitelist group. This parameter is required if whiteIpGroup is specified.|'."\n" + .'|└ ips| List<String> |No |["0.0.0.0", "10.2.XX.XX"]| The list of IP addresses in the whitelist group. This parameter is required if whiteIpGroup is specified.|'."\n" + ."\n" + .'><notice> Whitelist groups are added and deleted by calling the operation with modifyMode set to Cover. Delete and Append cannot add or delete whitelist groups. They can only modify the IP address list within a whitelist group. Details are as follows:'."\n" + ."\n" + .'- When modifyMode is set to Cover, the whitelist group is deleted if ips is empty. If groupName is not in the list of existing whitelist group names, a new whitelist group is created.'."\n" + .'- When modifyMode is set to Delete, at least one IP address must be retained after the deletion.'."\n" + .'- When modifyMode is set to Append, the whitelist group name must already exist. Otherwise, a NotFound error is returned.'."\n" + ."\n" + .'></notice>.', + 'responseParamsDescription' => '> In the following response examples, only the parameters included in the response data list are guaranteed. Parameters not mentioned are for reference only. For metric descriptions, refer to [ListInstance](~~142230~~). Do not rely on obtaining these parameters in your program.', 'extraInfo' => ' ', - ], - 'ValidateConnection' => [ - 'summary' => 'Tests the connectivity between a Logstash cluster and its associated Elasticsearch cluster when you configure the X-Pack Monitoring feature for the Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}/validate-connection', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:57.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePublicWhiteIps'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdatePublicWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateReadWritePolicy' => [ + 'summary' => 'Enables or disables the write high availability feature for a cluster. Currently, only instances in the China (Beijing) region are supported.', + 'path' => '/openapi/instances/{InstanceId}/actions/update-read-write-policy', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-oew1oxiro000f****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. This value is generated by the client and must be unique across different requests. The value can be up to 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -30471,151 +26913,137 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Indicates whether the connectivity is normal. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The write high availability feature is enabled or disabled.'."\n" + .'- false: Failed to enable or disable the write high availability feature.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ValidateConnection', - 'description' => '> Before you enable the X-Pack Monitoring feature for a Logstash cluster, you must associate the Logstash cluster with an Elasticsearch cluster. This way, you can view the monitoring data of the Logstash cluster in the Kibana console of the Elasticsearch cluster.'."\n", - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify the information of the associated Elasticsearch cluster. '."\n" - .'| Parameter | Type | Required | Example | Description | '."\n" - .'| ---- | ---- | ---- | ---- | '."\n" - .'| endpoints| List<String>|Yes|\\["http://es-cn-n6w1o1x0w001c\\*\\*\\*\\*.elasticsearch.aliyuncs.com:9200"]|The address that is used to access the Elasticsearch cluster. |'."\n" - .' | userName| String | Yes | elastic|The username that is used to access the Elasticsearch cluster. |'."\n" - .' | password| String | Yes | xxx|The password that is used to access the Elasticsearch cluster. |'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Enable or disable write high availability for a cluster', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody must also include the following parameters to specify the parameter settings of the high availability feature.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| writeHa | Boolean | No | true | Specifies whether to enable the write high availability feature. A value of true indicates enabled. A value of false indicates disabled. |'."\n" + .'| autoGeneratePk | Boolean | No | true | Specifies whether to automatically generate a document hash primary key when no primary key exists. The default value is true, which indicates that a primary key is automatically generated. A value of false indicates that no primary key is automatically generated.<br>The autoGeneratePk parameter cannot be modified independently. It takes effect only when writeHa is changed from false to true. |'."\n" + .'| writePolicy | String | No | sync | Specifies the temporary switch between synchronous and asynchronous high availability mode. This parameter takes effect only when high availability mode is enabled, that is, writeHa is set to true. You do not need to pass in the writeHa parameter when setting this parameter.<br>Valid values:<br>sync: temporarily switches from asynchronous write high availability mode to synchronous.<br>async: restores asynchronous write high availability mode after synchronous write is temporarily enabled. |'."\n" ."\n" - .'Sample code:'."\n" + .'Example:'."\n" ."\n" - .' {'."\n" - .' "endpoints": ['."\n" - .' "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"'."\n" - .' ],'."\n" - .' "userName": "elastic",'."\n" - .' "password": "xxxx"'."\n" - .' }', + .'```'."\n" + .'{'."\n" + .' "writeHa":true,'."\n" + .' "autoGeneratePk":true'."\n" + .'}'."\n" + .'```', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'InterruptLogstashTask' => [ - 'path' => '/openapi/logstashes/{InstanceId}/actions/interrupt', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:57.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateReadWritePolicy'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateReadWritePolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'UpdateSnapshotSetting' => [ + 'summary' => 'Updates the data backup configuration of a specified instance.', + 'path' => '/openapi/instances/{InstanceId}/snapshot-setting', + 'methods' => ['post', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-4591f1y6****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'es-cn-oew1rgiev0009****', 'title' => ''], ], [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -30623,368 +27051,301 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code returned. If the API operation is successfully called, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'Message' => [ - 'description' => 'The error message returned. If the API operation is successfully called, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => '.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0FA05123-745C-42FD-A69B-AFF48EF9****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****', 'title' => ''], 'Result' => [ - 'description' => 'Indicates whether the task is suspended. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'quartzRegex' => ['description' => 'The start time of automatic backup.', 'type' => 'string', 'example' => '0 0 01 ? * * *', 'title' => ''], + 'enable' => ['description' => 'Indicates whether automatic backup is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\".\\",\\n \\"Message\\": \\".\\",\\n \\"RequestId\\": \\"0FA05123-745C-42FD-A69B-AFF48EF9****\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'InterruptLogstashTask', - 'summary' => 'After the task is suspended, the Logstash cluster is in the suspended state.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ResumeLogstashTask' => [ - 'path' => '/openapi/logstashes/{InstanceId}/actions/resume', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-4591f1y6****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'clientToken', - 'in' => 'query', 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The error code returned. If the API operation is successfully called, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'InstanceNotFound', - ], - 'Message' => [ - 'description' => 'The error message returned. If the API operation is successfully called, this parameter is not returned.'."\n", - 'type' => 'string', - 'example' => 'The specified cluster does not exist. Check the cluster status and try again.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0FA05123-745C-42FD-A69B-AFF48EF9****', - ], - 'Result' => [ - 'description' => 'Indicates whether the change task is resumed. Valid values:'."\n" - ."\n" - .'* true: The change task is resumed.'."\n" - .'* false: The change task fails to be resumed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', - ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"InstanceNotFound\\",\\n \\"Message\\": \\"The specified cluster does not exist. Check the cluster status and try again.\\",\\n \\"RequestId\\": \\"0FA05123-745C-42FD-A69B-AFF48EF9****\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ResumeLogstashTask', - 'summary' => 'Resumes a change task of a Logstash cluster. After the task is resumed, the Logstash cluster is in the activating state.', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": {\\n \\"quartzRegex\\": \\"0 0 01 ? * * *\\",\\n \\"enable\\": true\\n }\\n}","type":"json"}]', + 'title' => 'UpdateSnapshotSetting', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody parameter also includes the following parameters that specify the updated data backup information.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- | ---- |'."\n" + .'| quartzRegex | String | No | 0 0 01 ? * * * | The start time of automatic backup. This parameter is required when enable is set to true. |'."\n" + .'| enable | Boolean | Yes | true | Specifies whether to enable scheduled backup. |'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "quartzRegex":"0 0 01 ? * * *",'."\n" + .' "enable":true'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreatePipelines' => [ - 'summary' => 'Creates a pipeline in a Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}/pipelines', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:54.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSnapshotSetting'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateSynonymsDicts' => [ + 'summary' => 'Updates the synonym dictionary of an Alibaba Cloud Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/synonymsDict', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], ], [ - 'name' => 'trigger', - 'in' => 'query', - 'schema' => [ - 'title' => '是否部署。true，保存并部署。false，仅保存。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - ], - [ - 'name' => 'ClientToken', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token used to ensure idempotence of the request. The client generates this value. The value must be unique across different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', - 'style' => 'json', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'pipelineId' => [ - 'title' => '管道Id。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'pipeline-test', - ], - 'description' => [ - 'title' => '管道描述。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a test', - ], - 'config' => [ - 'title' => '管道具体配置。', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'input { } filter { } output { }', - ], - 'workers' => [ - 'title' => '管道工作线程数。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - 'default' => '实例的CPU核数。', - ], - 'batchSize' => [ - 'title' => '管道批大小。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '125', - 'default' => '125', - ], - 'batchDelay' => [ - 'title' => '管道批延迟。单位ms。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - 'default' => '50', - ], - 'queueType' => [ - 'title' => '队列类型。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MEMORY', - 'enum' => [ - 'MEMORY', - 'PERSISTED', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7C5622CC-B312-426F-85AA-B0271*******', 'title' => ''], + 'Result' => [ + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'fileSize' => ['description' => 'The size of the dictionary file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '220', 'title' => ''], + 'sourceType' => ['description' => 'The source type of the dictionary file. Valid values:'."\n" + ."\n" + .'- OSS: OSS open storage.'."\n" + .'- ORIGIN: retains the previously uploaded dictionary.', 'type' => 'string', 'example' => 'OSS', 'title' => ''], + 'name' => ['description' => 'The name of the dictionary file.', 'type' => 'string', 'example' => 'deploy_0.txt', 'title' => ''], + 'type' => ['description' => 'The dictionary type. Valid values: SYNONYMS (synonym).', 'type' => 'string', 'example' => 'SYNONYMS', 'title' => ''], ], - ], - 'queueMaxBytes' => [ - 'title' => '队列最大字节数。单位：MB。', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - 'default' => '1024', - ], - 'queueCheckPointWrites' => [ - 'title' => '队列检查点写入数。', 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1024', - 'default' => '1024', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreatePipelines', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C5622CC-B312-426F-85AA-B0271*******\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 220,\\n \\"sourceType\\": \\"OSS\\",\\n \\"name\\": \\"deploy_0.txt\\",\\n \\"type\\": \\"SYNONYMS\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Update instance synonym dictionary', + 'description' => 'When calling this operation, note the following:'."\n" + ."\n" + .'- If the dictionary file is sourced from OSS, make sure the OSS bucket has public-read permission.'."\n" + .'- If a previously uploaded dictionary is not configured with ORIGIN, the dictionary file will be deleted after this operation is called.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The following parameters must also be specified in the RequestBody.'."\n" + .'| Parameter | Type | Required | Example | Description |'."\n" + .'| --- | --- | --- | --- | --- |'."\n" + .'| name | String | Yes | dic_0.txt | The name of the dictionary file to upload. The file must be a TXT file. |'."\n" + .'| ossObject | Array | No | | The description of the OSS open storage file. This parameter is required when sourceType is set to OSS.|'."\n" + .'| └bucketName | String | No | search-cloud-test-cn-**** | The name of the OSS bucket.|'."\n" + .'| └key | String | No | oss/dic_0.txt | The storage path of the dictionary file in the OSS bucket.|'."\n" + .'| sourceType | String | Yes | OSS | The source type of the dictionary file. Valid values: OSS (uses OSS open storage) and ORIGIN (retains the previously uploaded dictionary).<br>**Note:**<br>Upload local files to OSS first, and then reference them from OSS.<br>If a previously uploaded dictionary is not configured with ORIGIN, it will be deleted by the system.|'."\n" + .'| type | String | Yes | SYNONYMS | The type of dictionary to update. Set the value to SYNONYMS.|'."\n" + ."\n" + .'> └ indicates a child parameter.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "name":"deploy_0.txt",'."\n" + .' "ossObject":{'."\n" + .' "bucketName":"search-cloud-test-cn-****",'."\n" + .' "key":"user_dict/dict_0.dic"'."\n" + .' },'."\n" + .' "sourceType":"OSS",'."\n" + .' "type":"SYNONYMS"'."\n" + .' },'."\n" + .' {'."\n" + .' "name":"SYSTEM_STOPWORD.txt",'."\n" + .' "sourceType":"ORIGIN",'."\n" + .' "type":"SYNONYMS"'."\n" + .' }'."\n" + .']'."\n" + ."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeletePipelines' => [ - 'path' => '/openapi/logstashes/{InstanceId}/pipelines', - 'methods' => [ - 'delete', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSynonymsDicts'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'UpdateTemplate' => [ + 'path' => '/openapi/instances/{InstanceId}/templates/{TemplateName}', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -30992,38 +27353,31 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'name' => 'TemplateName', + 'in' => 'path', + 'schema' => ['description' => 'The template name. Valid values:'."\n" + .'- dynamicSettings: cluster dynamic settings'."\n" + .'- indexTemplate: index template configuration'."\n" + .'- ilmPolicy: index lifecycle configuration'."\n" + .'- staticSettings: cluster static settings.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dynamicSettings', 'title' => ''], ], [ - 'name' => 'pipelineIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the pipeline.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pipeline-test', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The template configuration content. For more information, see the RequestBody section below.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{ "content": "{\\n\\t\\"persistent\\":{\\n\\t\\t\\"search\\":{\\n\\t\\t\\t\\"max_buckets\\":\\"10000\\"\\n\\t\\t}\\n\\t}\\n}" }', 'title' => ''], ], ], 'responses' => [ @@ -31031,321 +27385,379 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Indicates whether the pipeline is deleted. Valid values:'."\n" - ."\n" - .'* true: The pipeline is deleted.'."\n" - .'* false: The pipeline fails to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Result' => ['description' => 'Indicates whether the scenario-specific template configuration is modified. Valid values:'."\n" + ."\n" + .'- true: The modification is successful.'."\n" + .'- false: The modification failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + ['errorCode' => 'ComponentCodeValueError', 'errorMessage' => 'component value is disable', 'description' => ''], ], [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', - ], + ['errorCode' => 'UserNotOpen', 'errorMessage' => 'Aliyun account is not open elasticsearch', 'description' => ''], + ['errorCode' => 'StsRoleAccountNoPermission', 'errorMessage' => 'Role account has no permission or expired', 'description' => ''], + ['errorCode' => 'SubAccountNoPermission', 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', 'description' => ''], + ['errorCode' => 'UserUnauthorized', 'errorMessage' => 'Authentication required', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DeletePipelines', - 'summary' => 'Deletes a pipeline that is configured for a Logstash cluster.', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","type":"json"}]', + 'title' => 'Modify instance scenario-specific template configuration', + 'summary' => 'Modifies the scenario-specific template configuration of a cluster.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody also requires the following parameters to specify the template configuration content.'."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| content| String | Yes | {\\n\\t\\"persistent\\":{\\n\\t\\t\\"search\\":{\\n\\t\\t\\t\\"max_buckets\\":\\"10000\\"\\n\\t\\t}\\n\\t}\\n} |The template configuration content.|'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "content": "{\\n\\t\\"persistent\\":{\\n\\t\\t\\"search\\":{\\n\\t\\t\\t\\"max_buckets\\":\\"10000\\"\\n\\t\\t}\\n\\t}\\n}"'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdatePipelines' => [ - 'summary' => 'Updates a pipeline of a Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}/pipelines', - 'methods' => [ - 'put', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTemplate'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateWhiteIps' => [ + 'summary' => 'Modifies the VPC internal-facing access whitelist of an Elasticsearch instance.', + 'path' => '/openapi/instances/{InstanceId}/white-ips', + 'methods' => ['patch', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-npk2154oi000b****', 'title' => ''], ], [ - 'name' => 'trigger', + 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to deploy the pipeline immediately.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'A unique token generated by the client to guarantee the idempotency of the request. The value must be unique across different requests and can contain a maximum of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'modifyMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The modification mode. Valid values:'."\n" + ."\n" + .'- Cover (default): overwrites the IP addresses in the original whitelist with the value of the ips parameter.'."\n" + ."\n" + .'- Append: adds the IP addresses specified in the ips parameter to the original whitelist.'."\n" + ."\n" + .'- Delete: removes the IP addresses specified in the ips parameter from the original whitelist. At least one IP address must be retained.', 'type' => 'string', 'required' => false, 'example' => 'Cover', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'object', + 'properties' => [ + 'esIPWhitelist' => [ + 'description' => 'The IP address information in the whitelist.', + 'type' => 'array', + 'items' => ['description' => 'The IP address whitelist list. This parameter is available when whiteIpGroup is empty. The value of this parameter updates the IP whitelist configuration in the Default whitelist group.'."\n" + .'><notice> You cannot configure esIPWhitelist and whiteIpGroup at the same time.'."\n" + .'></notice>.', 'type' => 'string', 'required' => false, 'example' => '["10.61.xx.xx", "106.11.xx.xx”]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'whiteIpGroup' => [ + 'description' => 'Updates the instance whitelist configuration by using the whitelist group method. Only one whitelist group can be updated at a time.'."\n" + .'><notice> You cannot configure esIPWhitelist and whiteIpGroup at the same time.'."\n" + .'></notice>.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'The name of the whitelist group. This parameter is required if the whiteIpGroup parameter is specified.', 'type' => 'string', 'required' => false, 'example' => 'test_group', 'title' => ''], + 'ips' => [ + 'description' => 'The list of IP addresses in the whitelist group.', + 'type' => 'array', + 'items' => ['description' => 'The list of IP addresses in the whitelist group. This parameter is required if the whiteIpGroup parameter is specified.', 'type' => 'string', 'required' => false, 'example' => '["10.2.xx.xx", "10.3.xx.xx"]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'whiteIpType' => ['description' => 'The type of the IP whitelist. The value is fixed as **PRIVATE_ES**, which indicates the private network internal-facing access whitelist.', 'type' => 'string', 'required' => false, 'example' => 'PRIVATE_ES', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8D58B014-BBD7-4D80-B219-00B9D5C6860C', 'title' => ''], 'Result' => [ - 'description' => 'Indicates whether the pipeline is updated. Valid values:'."\n" - ."\n" - .'* true: The pipeline is updated.'."\n" - .'* false: The pipeline fails to be updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'esIPWhitelist' => [ + 'description' => 'The private network internal-facing access whitelist (deprecated).', + 'type' => 'array', + 'items' => ['description' => 'The updated whitelist.', 'type' => 'string', 'example' => '["106.11.xx.xx", "10.61.xx.xx"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'networkConfig' => [ + 'description' => 'The network configuration.', + 'type' => 'object', + 'properties' => [ + 'whiteIpGroupList' => [ + 'description' => 'The list of whitelist groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The whitelist group information.', + 'type' => 'object', + 'properties' => [ + 'groupName' => ['description' => 'The name of the whitelist group. The default group is included by default.', 'type' => 'string', 'example' => 'test_group', 'title' => ''], + 'ips' => [ + 'description' => 'The IP address information in the whitelist group.', + 'type' => 'array', + 'items' => ['description' => 'The list of IP addresses in the whitelist group.', 'type' => 'string', 'example' => '["10.2.xx.xx", "10.3.xx.xx"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'whiteIpType' => ['description' => 'The whitelist type. The value is fixed as PRIVATE_ES, which indicates the private network internal-facing access whitelist.', 'type' => 'string', 'example' => 'PRIVATE_ES', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdatePipelines', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify the updated pipeline information.'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8D58B014-BBD7-4D80-B219-00B9D5C6860C\\",\\n \\"Result\\": {\\n \\"esIPWhitelist\\": [\\n \\"[\\\\\\"106.11.xx.xx\\\\\\", \\\\\\"10.61.xx.xx\\\\\\"]\\"\\n ],\\n \\"networkConfig\\": {\\n \\"whiteIpGroupList\\": [\\n {\\n \\"groupName\\": \\"test_group\\",\\n \\"ips\\": [\\n \\"[\\\\\\"10.2.xx.xx\\\\\\", \\\\\\"10.3.xx.xx\\\\\\"]\\"\\n ],\\n \\"whiteIpType\\": \\"PRIVATE_ES\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Modify the VPC internal-facing access whitelist of an instance', + 'description' => '## Before you begin'."\n" + .'- You cannot update information when the instance status is activating, invalid, or freeze (inactive).'."\n" + .'- You can update the whitelist in two ways: IP whitelist list and IP whitelist group. The two methods cannot be used at the same time, and they support different parameters besides InstanceId and clientToken. The details are as follows: '."\n" + .' - IP whitelist list: esIPWhitelist'."\n" + .' - IP whitelist group: modifyMode, whiteIpGroup'."\n" + .'- The public access whitelist does not support private network IP addresses, and the internal-facing access whitelist does not support public IP addresses.', + 'requestParamsDescription' => '><notice> Whitelist groups are added and deleted by calling the operation with modifyMode set to Cover. Delete and Append cannot add or delete whitelist groups. They can only modify the IP address list in a whitelist group. Details are as follows:'."\n" ."\n" - .'**Note**The request body must be in the JSON format.'."\n" - ."\n" - .'|Parameter|Type|Required|Example|Description|'."\n" - .'|---|---|---|---|---|'."\n" - .'|pipelineId|String|Yes|pipeline-test|The ID of the pipeline to be updated.|'."\n" - .'|description|String|No|this is a test|The description of the pipeline.|'."\n" - .'|config|String|Yes|input { } filter { } output { }|The configurations of the pipeline.|'."\n" - .'|workers|Integer|No|2|The number of worker threads for the pipeline.|'."\n" - .'|batchSize|Integer|No|125|The batch size of the pipeline.|'."\n" - .'|batchDelay|Integer|No|50|The batch delay of the pipeline.|'."\n" - .'|queueType|String|No|MEMORY|The type of the queue. Valid values: MEMORY and PERSISTED.|'."\n" - .'|pipelineStatus|String|No|RUNNING|The status of the pipeline. Valid values: NOT\\_DEPLOYED, RUNNING, and DELETED. If you set the trigger parameter to true, you must configure this parameter.|'."\n" - .'|queueMaxBytes|Integer|No|1024|The maximum number of bytes in a queue.|'."\n" - .'|queueCheckPointWrites|Integer|No|1024|The number of queue checkpoint writes.|'."\n" - ."\n\n" - .'Sample code:'."\n" + .'- When modifyMode is set to Cover, the whitelist group is deleted if ips is empty. If groupName is not in the list of existing whitelist group names, a new whitelist group is created.'."\n" + .'- When modifyMode is set to Delete, at least one IP address must be retained after deletion.'."\n" + .'- When modifyMode is set to Append, the whitelist group name must already exist. Otherwise, a NotFound error is returned.'."\n" ."\n" - .'```'."\n" - .'['."\n" - .' {'."\n" - .' "pipelineId": "test",'."\n" - .' "config": "input {\\n\\n}\\nfilter {\\n\\n}\\noutput {\\n \\n}"'."\n" - .' }'."\n" - .']'."\n" - .'```', - 'responseParamsDescription' => ' ', + .'></notice>.', + 'responseParamsDescription' => '> In the following response examples, only the parameters included in the response data list are guaranteed. Parameters not mentioned are for reference only. For parameter descriptions, refer to [ListInstance](~~142230~~). Do not rely on obtaining these parameters in your program.', 'extraInfo' => ' ', - ], - 'StopPipelines' => [ - 'path' => '/openapi/logstashes/{InstanceId}/pipelines/action/stop', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWhiteIps'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], ], + ], + 'UpdateXpackMonitorConfig' => [ + 'summary' => 'Updates the X-Pack monitoring and alerting configuration of a Logstash instance.', + 'path' => '/openapi/logstashes/{InstanceId}/xpack-monitor-config', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The X-Pack monitoring configuration.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['title' => '', 'description' => 'Specifies whether to enable X-Pack monitoring. Valid values:'."\n" + ."\n" + .'- true: Enable X-Pack monitoring.'."\n" + .'- false: Disable X-Pack monitoring.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true'], + 'endpoints' => [ + 'title' => '', + 'description' => 'The access endpoint of the Elasticsearch instance.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The access endpoint of the Elasticsearch instance.', 'type' => 'string', 'example' => 'http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200', 'required' => false], + 'required' => false, + 'maxItems' => 2, + 'minItems' => 1, + 'example' => '', + ], + 'userName' => ['title' => '', 'description' => 'The username of the Elasticsearch instance.', 'type' => 'string', 'example' => 'elastic', 'required' => false], + 'password' => ['title' => '', 'description' => 'The password of the Elasticsearch instance.', 'type' => 'string', 'example' => '******', 'required' => false], + ], 'required' => false, 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -31354,373 +27766,411 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'The returned result. Valid values:'."\n" - ."\n" - .'* true: The pipelines are stopped.'."\n" - .'* false: The pipelines fail to be stopped.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- true: The update was successful.'."\n" + .'- false: The update failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '4XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], '5XX' => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","type":"json"}]', + 'title' => 'Update x-Pack monitoring and alerting configuration', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-05T06:36:43.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateXpackMonitorConfig'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateXpackMonitorConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'StopPipelines', - 'summary' => 'Stops pipelines in a Logstash cluster.', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must specify the IDs of the pipelines in the request body. Example: `["PipelineId1","PipelineId2","..."]`.'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdatePipelineManagementConfig' => [ - 'summary' => 'Modifies the pipeline management method of the specified Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}/pipeline-management-config', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpgradeEngineVersion' => [ + 'summary' => 'Upgrades the version of an Elasticsearch instance. Both major version upgrades and kernel version upgrades are supported.', + 'path' => '/openapi/instances/{InstanceId}/actions/upgrade-version', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '64390', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchDYS3SR', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '64397', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-n6w1o1x0w001c****', 'title' => ''], ], [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['title' => '', 'description' => 'A client token that is used to ensure the idempotence of the request. The value is generated by the client and must be unique among different requests. The maximum length is 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****'], + ], + [ + 'name' => 'dryRun', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to perform a pre-upgrade check. Valid values:'."\n" + ."\n" + .'- true: performs a pre-upgrade check.'."\n" + .'- false (default): does not perform a pre-upgrade check.'."\n" + ."\n" + .'><warning> The version upgrade check involves checks on the cluster YML configuration, plug-in configuration, cluster status, indexes, and resources. We strongly recommend that you perform a pre-upgrade check before upgrading. Otherwise, upgrade issues may occur.'."\n" + .'></warning>.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The request body.', 'type' => 'object', 'properties' => [ - 'endpoints' => [ - 'title' => '开启Kibana管理管道后，Kibana所在Elasticsearch实例的访问地址列表。', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'title' => '开启Kibana管理管道后，Kibana所在Elasticsearch实例的访问地址', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]', - ], - 'required' => false, - ], - 'userName' => [ - 'title' => 'Kibana的用户名。管理方式为ES设置', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'elastic', - ], - 'password' => [ - 'title' => 'Kibana的密码。管理方式为ES设置', - 'description' => '', + 'version' => ['title' => '', 'description' => 'The version after the upgrade. If type is set to engineVersion, the value is the instance version, such as 6.7. If type is set to aliVersion, the value is the kernel version, such as ali1.2.0.', 'type' => 'string', 'example' => '6.7', 'required' => false], + 'type' => [ + 'title' => '', + 'description' => 'The upgrade type. Valid values:'."\n" + ."\n" + .'- engineVersion (default): major engine version upgrade.'."\n" + .'- aliVersion: kernel version upgrade.', 'type' => 'string', + 'example' => 'engineVersion', + 'enum' => ['engineVersion', 'aliVersion'], 'required' => false, - 'example' => '******', ], - 'pipelineIds' => [ - 'title' => 'Kibana管理的管道列表。管理方式为ES设置', - 'description' => '', + 'plugins' => [ 'type' => 'array', 'items' => [ - 'title' => 'Kibana管理的管道。管理方式为ES设置', - 'description' => '', - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'name' => ['title' => '', 'description' => 'The plug-in name.', 'type' => 'string', 'required' => false, 'example' => ''], + 'version' => ['title' => '', 'description' => 'The Elasticsearch version that corresponds to the plug-in, such as 7.16.2.', 'type' => 'string', 'required' => false, 'example' => ''], + 'fileVersion' => ['title' => '', 'description' => 'The file version of the plug-in. For more information, see the response of the ListUserPlugin operation.', 'type' => 'string', 'required' => false, 'example' => ''], + 'enable' => ['title' => '', 'description' => 'Specifies whether to install the plug-in. A value of true indicates that the plug-in is installed. A value of false indicates that the plug-in is uninstalled.', 'type' => 'string', 'required' => false, 'example' => ''], + ], 'required' => false, - 'example' => '["testKibanaManagement"]', + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - ], - 'pipelineManagementType' => [ - 'title' => '管道管理方式', 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ES', - 'enum' => [ - '', - '', - ], - ], - 'esInstanceId' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], 'required' => false, - 'example' => '{ "pipelineManagementType": "ES", "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "pipelineIds": [ "testKibanaManagement" ], "userName": "elastic", "password": "xxxx", "esInstanceId": "es-cn-n6w1o1x0w001c****" }', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'updateStrategy', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The update strategy. Valid values: blue_green (blue-green deployment), normal (in-place update), and intelligent (intelligent update).', 'type' => 'string', 'required' => false, 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC*****', 'title' => ''], 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', + 'description' => 'The returned result.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'validateType' => ['description' => 'The check type. Valid values:'."\n" + ."\n" + .'- checkClusterHealth: cluster health status.'."\n" + .'- checkConfigCompatible: configuration compatibility status.'."\n" + .'- checkClusterResource: resource space status.'."\n" + .'- checkClusterSnapshot: whether a snapshot exists.', 'type' => 'string', 'example' => 'checkClusterHealth', 'title' => ''], + 'validateResult' => [ + 'description' => 'The check information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'errorType' => ['description' => 'The error type. Valid values:'."\n" + ."\n" + .'- clusterStatus: cluster health status.'."\n" + .'- clusterConfigYml: cluster YML file.'."\n" + .'- clusterConfigPlugins: cluster configuration file.'."\n" + .'- clusterResource: cluster resources.'."\n" + .'- clusterSnapshot: cluster snapshot.', 'type' => 'string', 'example' => 'clusterStatus', 'title' => ''], + 'errorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ClusterStatusNotHealth', 'title' => ''], + 'errorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The cluster status is not health', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'status' => ['description' => 'Indicates whether the check is passed. Valid values:'."\n" + ."\n" + .'- success: passed.'."\n" + .'- failed: not passed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 404 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'UpdatePipelineManagementConfig', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DC*****\\",\\n \\"Result\\": [\\n {\\n \\"validateType\\": \\"checkClusterHealth\\",\\n \\"validateResult\\": [\\n {\\n \\"errorType\\": \\"clusterStatus\\",\\n \\"errorCode\\": \\"ClusterStatusNotHealth\\",\\n \\"errorMsg\\": \\"The cluster status is not health\\"\\n }\\n ],\\n \\"status\\": \\"success\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Upgrade instance version or kernel patch version', + 'description' => '> The version upgrade feature currently supports only the following upgrade paths: 5.5.3 to 5.6.16, 5.6.16 to 6.3.2, and 6.3.2 to 6.7.0. Upgrades between other versions are not supported. For more information, see [Upgrade version](~~148786~~).', + 'requestParamsDescription' => "\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListPipeline' => [ - 'summary' => 'Queries a list of pipelines.', - 'path' => '/openapi/logstashes/{InstanceId}/pipelines', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2025-01-02T09:09:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-21T06:36:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-31T09:24:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-06T03:13:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-01T08:52:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-16T03:51:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-16T03:51:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-30T09:44:56.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeEngineVersion'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpgradeEngineVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + ], + ], + 'UpgradeInfo' => [ + 'path' => '/openapi/instances/{instanceId}/upgradeInfo', + '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' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeCode' => '132519', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'instanceId', 'in' => 'path', + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-6ja1ro4jt000c****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '15'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'ID of the request', 'title' => 'ID of the request', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****'], + 'Result' => [ + 'description' => 'Result body', + 'type' => 'object', + 'properties' => [ + 'UpgradeInfo' => [ + 'description' => 'Upgrade information.', + 'type' => 'object', + 'properties' => [ + 'CurRepoVersion' => ['description' => 'Current repo version.', 'type' => 'string', 'example' => '1.7.3', 'title' => ''], + 'UpdateRepoVersion' => ['description' => 'Upgradable repo version.', 'type' => 'string', 'example' => '1.7.3', 'title' => ''], + 'Upgrade' => ['description' => 'Indicates whether an upgradable version exists.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'curApackVersion' => ['description' => 'Current Milvus version', 'type' => 'string', 'example' => '2.2.4', 'title' => ''], + 'upgradeApackVersion' => ['description' => 'Upgradable Milvus version.', 'type' => 'string', 'example' => '2.2.4', 'title' => ''], + 'curEsVersion' => ['description' => 'Current ES version', 'type' => 'string', 'example' => '8.17.0', 'title' => ''], + 'upgradeEsVersion' => ['description' => 'Upgradable ES version', 'type' => 'string', 'example' => '8.17.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Query version information available for upgrade', + 'summary' => 'Query whether a minor version is available for upgrade.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****\\",\\n \\"Result\\": {\\n \\"UpgradeInfo\\": {\\n \\"CurRepoVersion\\": \\"1.7.3\\",\\n \\"UpdateRepoVersion\\": \\"1.7.3\\",\\n \\"Upgrade\\": false,\\n \\"curApackVersion\\": \\"2.2.4\\",\\n \\"upgradeApackVersion\\": \\"2.2.4\\",\\n \\"curEsVersion\\": \\"8.17.0\\",\\n \\"upgradeEsVersion\\": \\"8.17.0\\"\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ValidateConnection' => [ + 'summary' => 'Validates the connectivity of an Elasticsearch instance that provides X-Pack monitoring.', + 'path' => '/openapi/logstashes/{InstanceId}/validate-connection', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'pipelineId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'pipeline_test', - ], + 'name' => 'InstanceId', + 'in' => 'path', + 'schema' => ['description' => 'The Logstash instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ls-cn-oew1qbgl****', 'title' => ''], ], [ - 'name' => 'page', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The header of the response.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'A unique token used to ensure the idempotence of the request. The client generates this value. The value must be unique among different requests and cannot exceed 64 ASCII characters in length.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '15', - ], + 'name' => 'body', + 'in' => 'body', + 'schema' => ['description' => 'The information about the Elasticsearch instance to which you want to validate connectivity.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{ "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "xxxx" }', 'title' => ''], ], ], 'responses' => [ @@ -31728,333 +28178,298 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The response.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Headers' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.'."\n", - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => 'The time when the pipeline was updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - ], - ], - 'Result' => [ - 'description' => 'The time when the pipeline was created.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'pipelineStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'NOT_DEPLOYED', - ], - 'gmtCreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-08-05T03:10:38.188Z', - ], - 'gmtUpdateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-08-05T08:43:31.757Z', - ], - 'pipelineId' => [ - 'description' => 'The status of the pipeline. Supported:'."\n" - ."\n" - .'* NOT_DEPLOYED: The node is not deployed.'."\n" - .'* RUNNING'."\n" - .'* DELETED: Deleted. The console does not display this status.'."\n", - 'type' => 'string', - 'example' => 'pipeline_test', - ], - ], - ], - ], + 'Result' => ['description' => 'The returned result. Valid values:'."\n" + ."\n" + .'- true: The validation succeeded.'."\n" + .'- false: The validation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 2\\n },\\n \\"Result\\": [\\n {\\n \\"pipelineStatus\\": \\"NOT_DEPLOYED\\",\\n \\"gmtCreatedTime\\": \\"2020-08-05T03:10:38.188Z\\",\\n \\"gmtUpdateTime\\": \\"2020-08-05T08:43:31.757Z\\",\\n \\"pipelineId\\": \\"pipeline_test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListPipeline', - 'requestParamsDescription' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","type":"json"}]', + 'title' => 'Validate monitoring connectivity', + 'description' => '> To enable X-Pack monitoring for Logstash, configure an Elasticsearch instance. After the configuration, you can monitor the Logstash instance in the Kibana console of the corresponding Elasticsearch instance.', + 'requestParamsDescription' => '## RequestBody'."\n" + .'The RequestBody also supports the following parameters to specify restart parameter information.'."\n" + ."\n" + .'| Name | Type | Required | Example | Description |'."\n" + .'|-----------|--------------|----------|------------------------------------------------------------------------|------------------------------------------------|'."\n" + .'| endpoints | List<String> | Yes | ["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"] | The access addresses of the Elasticsearch instance that provides X-Pack monitoring. |'."\n" + .'| userName | String | Yes | elastic | The username of the Elasticsearch instance. |'."\n" + .'| password | String | Yes | xxx | The password of the Elasticsearch instance. |'."\n" + ."\n" + .' * When restartType is set to instance, the blueGreenDep parameter is ignored.'."\n" + .' * If force is set to true, batch must be greater than 0 and less than or equal to 100. Otherwise, the system returns a RestartBatchValueError error.'."\n" + .' * If force is set to false, batch defaults to 0. If you specify other values, the system returns a NormalRestartNotSupportBatch error.'."\n" + .' * When restartType is set to nodeIp, the batch parameter is ignored.'."\n" + .' * If nodeIp is empty, the system returns a parameter error.'."\n" + .' * If blueGreenDep is set to true, a blue-green restart is performed. If blueGreenDep is set to false, a normal restart is performed.'."\n" + ."\n" + .'Sample request:'."\n" + .'```'."\n" + .'{'."\n" + .' "restartType":"nodeIp",'."\n" + .' "nodes": ["172.16.xx.xx"],'."\n" + .' "blueGreenDep":true'."\n" + .'}'."\n" + .'```.', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribePipeline' => [ - 'path' => '/openapi/logstashes/{InstanceId}/pipelines/{PipelineId}', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:56.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateConnection'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ValidateConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ], + ], + ], + ], + ], + 'ValidateShrinkNodes' => [ + 'summary' => 'Checks whether specific nodes in a specified instance can be scaled in.', + 'path' => '/openapi/instances/{InstanceId}/validate-shrink-nodes', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The information about the returned pipeline. For more information, see [logstash.yml](https://www.elastic.co/guide/en/logstash/6.7/logstash-settings-file.html).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], ], [ - 'name' => 'PipelineId', - 'in' => 'path', + 'name' => 'nodeType', + 'in' => 'query', + 'schema' => ['description' => 'The type of nodes to scale in. Valid values:'."\n" + ."\n" + .'- WORKER: hot node'."\n" + .'- WORKER_WARM: warm node', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WORKER', 'title' => ''], + ], + [ + 'name' => 'ignoreStatus', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to ignore the cluster health status.'."\n" + ."\n" + .'- true: ignores the cluster health status.'."\n" + .'- false (default): does not ignore the cluster health status.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'count', + 'in' => 'query', + 'schema' => ['description' => 'The number of nodes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the ApsaraVideo Media Processing (MPS) queue that is used to run the job.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pipeline_test', + 'description' => 'The request body.', + 'type' => 'array', + 'items' => [ + 'description' => 'The request object.', + 'type' => 'object', + 'properties' => [ + 'nodeType' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'- WORKER: hot node'."\n" + .'- WORKER_WARM: warm node', 'type' => 'string', 'required' => false, 'example' => 'WORKER', 'title' => ''], + 'host' => ['description' => 'The IP address of the node.', 'type' => 'string', 'required' => false, 'example' => '192.168.xx.xx', 'title' => ''], + 'port' => ['description' => 'The access port number of the node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200', 'title' => ''], + 'zoneId' => ['description' => 'The zone ID of the node in the instance. For example, the zone ID of China (Shanghai) Zone C is cn-shanghai-c.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-c', 'title' => ''], + 'hostName' => ['description' => 'The node name of the cloud-native ACK-based cluster. You can call the [ListAllNode](~~183958~~) operation to obtain the node name.', 'type' => 'string', 'required' => false, 'example' => 'es-cn-pl32xxxxxxx-data-f-1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The time when the pipeline was updated.'."\n", - 'type' => 'string', - 'example' => '829F38F6-E2D6-4109-90A6-888160BD1***', - ], - 'Result' => [ - 'description' => 'The type of the queue. Valid values:'."\n" - ."\n" - .'* MEMORY: a traditional memory-based queue.'."\n" - .'* PERSISTED: disk-based ACKed queue (persistent queue).'."\n", - 'type' => 'object', - 'properties' => [ - 'pipelineId' => [ - 'description' => 'Number of queue checkpoint writes.'."\n", - 'type' => 'string', - 'example' => 'pipeline_test', - ], - 'gmtUpdateTime' => [ - 'description' => 'The total capacity of the queue in bytes. Unit: MB.'."\n", - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'queueType' => [ - 'description' => 'The specific configuration of the pipeline.'."\n", - 'type' => 'string', - 'example' => 'MEMORY', - ], - 'queueCheckPointWrites' => [ - 'description' => 'Pipeline batch delay. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'queueMaxBytes' => [ - 'description' => 'The number of pipeline workers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'config' => [ - 'description' => 'The description of the pipeline.'."\n", - 'type' => 'string', - 'example' => 'input { } filter { } output { }', - ], - 'batchDelay' => [ - 'description' => 'The time when the pipeline was created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'workers' => [ - 'description' => 'The size of the pipeline batch.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'description' => [ - 'description' => 'The state of the MPS queue. Valid values:'."\n" - ."\n" - .'* NOT_DEPLOYED: The node is not deployed.'."\n" - .'* RUNNING'."\n" - .'* DELETED: Deleted. The console does not display this status.'."\n", - 'type' => 'string', - 'example' => 'this is a test', - ], - 'gmtCreatedTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-06-20T07:26:47.000+0000', - ], - 'batchSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '125', - ], - 'pipelineStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'RUNNING', - ], - ], - ], + 'Result' => ['description' => 'The returned result.'."\n" + ."\n" + .'- true: The nodes can be scaled in.'."\n" + .'- false: The nodes cannot be scaled in.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"829F38F6-E2D6-4109-90A6-888160BD1***\\",\\n \\"Result\\": {\\n \\"pipelineId\\": \\"pipeline_test\\",\\n \\"gmtUpdateTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"queueType\\": \\"MEMORY\\",\\n \\"queueCheckPointWrites\\": 1024,\\n \\"queueMaxBytes\\": 1024,\\n \\"config\\": \\"input { } filter { } output { }\\",\\n \\"batchDelay\\": 50,\\n \\"workers\\": 2,\\n \\"description\\": \\"this is a test\\",\\n \\"gmtCreatedTime\\": \\"2020-06-20T07:26:47.000+0000\\",\\n \\"batchSize\\": 125,\\n \\"pipelineStatus\\": \\"RUNNING\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribePipeline', - 'summary' => 'Queries the information about a pipeline in a Logstash cluster.', - 'requestParamsDescription' => ' ', + 'title' => 'ValidateShrinkNodes', + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribePipelineManagementConfig' => [ - 'summary' => 'Queries the management configurations of pipelines in a Logstash cluster.', - 'path' => '/openapi/logstashes/{InstanceId}/pipeline-management-config', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-30T09:44:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-21T04:36:38.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateShrinkNodes'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + ], + 'ValidateSlrPermission' => [ + 'path' => '/openapi/user/servicerolepermission', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -32063,29 +28478,23 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'abilityTreeCode' => '64400', + 'abilityTreeNodes' => ['FEATUREelasticsearchZEMBRN'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'Used to ensure the idempotency of the request. This parameter value is generated by the client and must be unique across different requests, with a maximum length of 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ - 'name' => 'clientToken', + 'name' => 'rolename', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The service-linked role name. Valid values:'."\n" + ."\n" + .'<props="china">- AliyunServiceRoleForElasticsearchOps: Performs elastic scaling tasks for a cluster.</props>- AliyunServiceRoleForElasticsearchCollector: Creates and manages Beats collectors.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'AliyunServiceRoleForElasticsearchCollector', 'title' => ''], ], ], 'responses' => [ @@ -32093,2472 +28502,4514 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'endpoints' => [ - 'description' => 'The access addresses of the Elasticsearch cluster. Specify each address in the `http://Endpoint of the Elasticsearch cluster:Port number` format.'."\n", - 'type' => 'string', - 'example' => '["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]', - ], - 'userName' => [ - 'description' => 'The username that is used to access the Elasticsearch cluster.'."\n", - 'type' => 'string', - 'example' => 'elastic', - ], - 'pipelineManagementType' => [ - 'description' => 'The pipeline management method. Valid values: Kibana and MULTIPLE_PIPELINE.'."\n", - 'type' => 'string', - 'example' => 'MULTIPLE_PIPELINE', - ], - 'esInstanceId' => [ - 'description' => 'The ID of the Elasticsearch cluster.'."\n", - 'type' => 'string', - 'example' => 'es-cn-n6w1o1x0w001c****', - ], - 'pipelineIds' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["testKibanaManagement"]', - ], - ], - ], - ], + 'Result' => ['description' => 'Indicates whether the service-linked role has been created. Valid values:'."\n" + ."\n" + .'- true: The role has been created.'."\n" + .'- false: The role has not been created.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BC4ED7DD-8C84-49B5-8A95-456F82E44D13', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '4XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": {\\n \\"endpoints\\": \\"[\\\\\\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\\\\\\"]\\",\\n \\"userName\\": \\"elastic\\",\\n \\"pipelineManagementType\\": \\"MULTIPLE_PIPELINE\\",\\n \\"esInstanceId\\": \\"es-cn-n6w1o1x0w001c****\\",\\n \\"pipelineIds\\": [\\n \\"[\\\\\\"testKibanaManagement\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'DescribePipelineManagementConfig', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"BC4ED7DD-8C84-49B5-8A95-456F82E44D13\\"\\n}","type":"json"}]', + 'title' => 'ValidateSlrPermission', + 'summary' => 'Verifies the service-linked role (SLR) permission of the current account.', + 'description' => '> When you use a collector to collect logs from different data sources, you must first authorize the creation of a service-linked role. You can call this operation to check whether the service-linked role has been created.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RunPipelines' => [ - 'path' => '/openapi/logstashes/{InstanceId}/pipelines/action/run', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-04-09T11:50:22.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-26T04:35:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateSlrPermission'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ValidateSlrPermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ValidateTransferableNodes' => [ + 'summary' => 'Validates whether data on specific nodes in a specified instance can be migrated.', + 'path' => '/openapi/instances/{InstanceId}/validate-transfer-nodes', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the Logstash cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'es-cn-nif1q9o8r0008****', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'nodeType', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'- WORKER: hot node'."\n" + .'- WORKER_WARM: warm node'."\n" + ."\n" + .'> COORDINATING (client node) and KIBANA (Kibana node) are not supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'WORKER', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The request body.', + 'type' => 'array', + 'items' => [ + 'description' => 'The request object.', + 'type' => 'object', + 'properties' => [ + 'host' => ['description' => 'The IP address of the node.', 'type' => 'string', 'required' => false, 'example' => '172.16.xx.xx', 'title' => ''], + 'port' => ['description' => 'The access port number of the node.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '9200', 'title' => ''], + 'zoneId' => ['description' => 'The zone ID of the instance node. For example, the ID of Zone C in the China (Shanghai) region is cn-shanghai-c.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-c', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'The returned result. Valid values:'."\n" - ."\n" - .'* true: successful'."\n" - .'* false: failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], + 'Result' => ['description' => 'The result. Valid values:'."\n" + ."\n" + .'- true: The data can be migrated.'."\n" + .'- false: The data cannot be migrated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - '4XX' => [ + 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - '5XX' => [ + [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', - ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', - ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', - ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + 500 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'RunPipelines', - 'summary' => 'Runs pipelines in a Logstash cluster.', - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must specify the IDs of the pipelines in the request body. Example: `["PipelineId1","PipelineId2","..."]`.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]', + 'title' => 'Validate whether data on nodes in an instance can be migrated', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateLogstash' => [ - 'summary' => 'Creates a Logstash cluster.', - 'path' => '/openapi/logstashes', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-01-21T04:36:38.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateTransferableNodes'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], ], + ], + 'createInstance' => [ + 'summary' => 'Creates an Elasticsearch instance.', + 'path' => '/openapi/instances', + 'methods' => ['post'], + 'schemes' => ['http', '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' => 'paid', + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'clientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', - ], + 'schema' => ['description' => 'Used to ensure the idempotency of the request. The parameter value is generated by the client and must be unique across different requests. The value cannot exceed 64 ASCII characters.'."\n", 'type' => 'string', 'required' => false, 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', 'title' => ''], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'paymentType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'prepaid', - ], - 'version' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '6.7_with_X-Pack', - ], - 'nodeAmount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '2', - ], - 'nodeSpec' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'disk' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50', - ], - 'diskType' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_ssd', - ], - 'spec' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'logstash.n4.small', - ], - ], - 'required' => true, - ], - 'networkConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'type' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc', - ], - 'vpcId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp16k1dvzxtmagcva****', - ], - 'vswitchId' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1k4ec6s7sjdbudw****', - ], - 'vsArea' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou-i', - ], - ], - 'required' => true, - ], - 'paymentInfo' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'duration' => [ - 'title' => '包月周期', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'pricingCycle' => [ - 'title' => '日期单位', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - ], - 'isAutoRenew' => [ - 'title' => '是否自动续费', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'autoRenewDuration' => [ - 'title' => '自动续费包月周期', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', + 'description' => 'Request body parameters.', + 'type' => 'object', + 'properties' => [ + 'zoneCount' => ['description' => 'The number of zones for the instance. Valid values: 1, 2, and 3. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'paymentType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- postpaid: pay-as-you-go.'."\n" + .'- prepaid: subscription.', 'type' => 'string', 'required' => false, 'example' => 'postpaid', 'title' => ''], + 'paymentInfo' => ['description' => 'The billing details of the subscription instance. This parameter is required when you create a subscription instance.', '$ref' => '#/components/schemas/PaymentInfo', 'required' => false, 'title' => '', 'example' => ''], + 'nodeAmount' => ['description' => 'The number of data nodes. Valid values: 2 to 50.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '3', 'title' => ''], + 'instanceCategory' => ['description' => 'The edition type:'."\n" + .'- x-pack: creates a commercial edition instance, or a kernel-enhanced edition instance without Indexing Service or OpenStore enabled.'."\n" + .'- IS: creates a kernel-enhanced edition instance with Indexing Service or OpenStore enabled.', 'type' => 'string', 'required' => false, 'example' => 'advanced', 'title' => ''], + 'esAdminPassword' => ['description' => 'The access password of the instance. The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@#$%^&*()_+-=). The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'Es_password', 'title' => ''], + 'esVersion' => ['description' => 'The instance version. Valid values:'."\n" + .'- 8.5.1_with_X-Pack'."\n" + .'- 7.10_with_X-Pack'."\n" + .'- 6.7_with_X-Pack'."\n" + .'- 7.7_with_X-Pack'."\n" + .'- 6.8_with_X-Pack'."\n" + .'- 6.3_with_X-Pack'."\n" + .'- 5.6_with_X-Pack'."\n" + .'- 5.5.3_with_X-Pack'."\n" + ."\n" + .'> The versions listed above may not include all versions supported by Elasticsearch instances. You can call the [GetRegionConfiguration](~~254099~~) operation to view the actually supported versions.', 'type' => 'string', 'required' => true, 'example' => '5.5.3_with_X-Pack', 'title' => ''], + 'nodeSpec' => ['description' => 'Data node configuration.'."\n" + ."\n" + .'> In the Beijing, Shanghai, Hangzhou, and Shenzhen regions, when you use createInstance to create an instance with next-generation cloud disk data nodes, you must specify the instance family with the `.new` suffix, for example, elasticsearch.sn1ne.large.new.', '$ref' => '#/components/schemas/NodeSpec', 'required' => false, 'title' => '', 'example' => ''], + 'masterConfiguration' => ['description' => 'Dedicated master node configuration.'."\n" + .'> In the Beijing, Shanghai, Hangzhou, and Shenzhen regions, when you use createInstance to create an instance with next-generation cloud disk dedicated master nodes, you must specify the instance family with the `.new` suffix, for example, elasticsearch.sn1ne.large.new.', '$ref' => '#/components/schemas/MasterNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'warmNodeConfiguration' => ['description' => 'Cold data node configuration.', '$ref' => '#/components/schemas/WarmNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'clientNodeConfiguration' => ['description' => 'Coordinating node configuration.', '$ref' => '#/components/schemas/ClientNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'elasticDataNodeConfiguration' => ['description' => 'Elastic node configuration.', '$ref' => '#/components/schemas/ElasticDataNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'kibanaConfiguration' => ['description' => 'Kibana node configuration.'."\n" + ."\n" + .'> We strongly recommend that you enable the Kibana node.', '$ref' => '#/components/schemas/KibanaNodeConfiguration', 'required' => false, 'title' => '', 'example' => ''], + 'networkConfig' => ['description' => 'Network configuration.'."\n" + ."\n" + .'> Specifying IP whitelists is not supported when creating an instance.', 'required' => true, '$ref' => '#/components/schemas/NetworkConfig', 'title' => '', 'example' => ''], + 'resourceGroupId' => ['title' => '', 'description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-aekzu7tsu4n****', 'required' => false], + 'description' => ['title' => '', 'description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'es'], + 'tags' => [ + 'title' => '', + 'description' => 'Instance tags.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'Instance tag.', + 'type' => 'object', + 'properties' => [ + 'tagKey' => ['title' => '', 'description' => 'The tag key of the instance.', 'type' => 'string', 'required' => false, 'example' => 'KeyTest'], + 'tagValue' => ['title' => '', 'description' => 'The tag value of the instance.', 'type' => 'string', 'required' => false, 'example' => 'KeyValue'], ], + 'required' => false, + 'example' => '', ], 'required' => false, - ], - 'description' => [ - 'title' => 'Logstash实例别名。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ls-cn-abc', - ], - 'resourceGroupId' => [ - 'title' => 'Logstash实例所属资源组。', - 'type' => 'string', - 'required' => false, + 'example' => '', ], ], - 'required' => true, - 'docRequired' => true, - 'example' => '7.4.0_with_X-Pack', + 'required' => false, + 'example' => '{ "description": "xpack-hot-cold", "nodeAmount": 2, "esVersion": "7.10_with_X-Pack", "instanceCategory": "x-pack", "nodeSpec": { "spec": "elasticsearch.sn2ne.xlarge", "disk": 20, "diskType": "cloud_ssd" }, "warmNodeConfiguration": { "spec": "elasticsearch.sn1ne.xlarge", "amount": 3, "diskType": "cloud_efficiency", "disk": 500 }, "networkConfig": { "type": "vpc", "vpcId": "vpc-8vbfu74bmw4m7m84a****", "vswitchId": "vsw-8vbnk6cmurbpump2f****", "vsArea": "cn-zhangjiakou-c" }, "paymentType": "postpaid", "esAdminPassword": "yourPassword", "kibanaConfiguration": { "spec": "elasticsearch.sn1ne.large" } }', + 'title' => '', ], ], ], 'responses' => [ - 200 => [ - 'headers' => [], + 202 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3', 'title' => ''], 'Result' => [ - 'description' => '', - '$ref' => '#/components/schemas/Logstash', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'instanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'es-is-0u2ecp69tt****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 400 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 404 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 500 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****\\",\\n \\"Result\\": {\\n \\"endpointList\\": {\\n \\"undefined\\": [\\n {\\n \\"host\\": \\"\\",\\n \\"port\\": 0,\\n \\"zoneId\\": \\"\\"\\n }\\n ]\\n },\\n \\"status\\": \\"\\",\\n \\"description\\": \\"\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"endTime\\": 0,\\n \\"instanceId\\": \\"\\",\\n \\"config\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"createdAt\\": \\"\\",\\n \\"networkConfig\\": {\\n \\"type\\": \\"\\",\\n \\"vpcId\\": \\"\\",\\n \\"vsArea\\": \\"\\",\\n \\"vswitchId\\": \\"\\"\\n },\\n \\"zoneInfos\\": {\\n \\"undefined\\": [\\n {\\n \\"status\\": \\"\\",\\n \\"zoneId\\": \\"\\"\\n }\\n ]\\n },\\n \\"nodeAmount\\": 0,\\n \\"updatedAt\\": \\"\\",\\n \\"version\\": \\"\\",\\n \\"dataNode\\": true,\\n \\"nodeSpec\\": {\\n \\"disk\\": 0,\\n \\"diskType\\": \\"\\",\\n \\"spec\\": \\"\\"\\n },\\n \\"paymentType\\": \\"\\",\\n \\"protocol\\": \\"\\",\\n \\"tags\\": {\\n \\"undefined\\": [\\n {\\n \\"tagKey\\": \\"\\",\\n \\"tagValue\\": \\"\\"\\n }\\n ]\\n },\\n \\"zoneCount\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CreateLogstash', - 'responseParamsDescription' => ' ', - 'extraInfo' => "\n", - ], - 'UpdateExtendfiles' => [ - 'path' => '/openapi/logstashes/{InstanceId}/extendfiles', - 'methods' => [ - 'put', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an Elasticsearch instance', + 'description' => '### Precautions'."\n" + .'- Before using this operation, make sure that you fully understand the billing methods and pricing of Elasticsearch. For more information, see [Alibaba Cloud Elasticsearch pricing](https://www.aliyun.com/price/product?spm=a2c4g.11186623.2.7.657d2cbeRoSPCd#/elasticsearch/detail).'."\n" + .'- Real-name verification is required to create instances.<props="china"><ph> For more information, see [Real-name verification](~~37175~~).</ph></props>'."\n" + .'- You do not need to specify a zone when creating an instance. By default, the instance is in the same zone as the selected VPC.'."\n" + ."\n", + 'requestParamsDescription' => '> - For the list of node specifications supported by Alibaba Cloud Elasticsearch, see [Alibaba Cloud Elasticsearch pricing](https://www.aliyun.com/price/product?spm=a2c4g.11186623.2.10.653c6c88NcQPZY#/elasticsearch/detail) and [Product specifications](~~271718~~).'."\n" + .'- The diskType parameter specifies the storage type of nodes. This parameter is required for cloud disk specifications and optional for local disk specifications.'."\n" + ."\n\n" + ."\n" + .'The following are request body parameter examples:'."\n" + ."\n" + .'- Create a general commercial edition instance with both cold and hot nodes.'."\n" + .'```'."\n" + .'{'."\n" + .' "description": "xpack-hot-cold",'."\n" + .' "nodeAmount": 2,'."\n" + .' "esVersion": "7.10_with_X-Pack",'."\n" + .' "instanceCategory": "x-pack",'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.sn2ne.xlarge",'."\n" + .' "disk": 20,'."\n" + .' "diskType": "cloud_ssd"'."\n" + .' },'."\n" + .' "warmNodeConfiguration": {'."\n" + .' "spec": "elasticsearch.sn1ne.xlarge",'."\n" + .' "amount": 3,'."\n" + .' "diskType": "cloud_efficiency",'."\n" + .' "disk": 500'."\n" + .' },'."\n" + .' "networkConfig": {'."\n" + .' "type": "vpc",'."\n" + .' "vpcId": "vpc-8vbfu74bmw4m7m84a****",'."\n" + .' "vswitchId": "vsw-8vbnk6cmurbpump2f****",'."\n" + .' "vsArea": "cn-zhangjiakou-c"'."\n" + .' },'."\n" + .' "paymentType": "postpaid",'."\n" + .' "esAdminPassword": "yourPassword",'."\n" + .' "kibanaConfiguration": {'."\n" + .' "spec": "elasticsearch.sn1ne.large"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Create an Indexing Service edition instance with hot nodes only.'."\n" + .'```'."\n" + .'{'."\n" + .' "description": "is-hot",'."\n" + .' "nodeAmount": 2,'."\n" + .' "esVersion": "7.10_with_X-Pack",'."\n" + .' "instanceCategory": "IS",'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.sn1ne.xlarge",'."\n" + .' "disk": 20,'."\n" + .' "diskType": "cloud_ssd"'."\n" + .' },'."\n" + .' "networkConfig": {'."\n" + .' "type": "vpc",'."\n" + .' "vpcId": "vpc-8vbfu74bmw4m7m84a****",'."\n" + .' "vswitchId": "vsw-8vbnk6cmurbpump2f****",'."\n" + .' "vsArea": "cn-zhangjiakou-c"'."\n" + .' },'."\n" + .' "paymentType": "postpaid",'."\n" + .' "esAdminPassword": "yourPassword",'."\n" + .' "kibanaConfiguration": {'."\n" + .' "spec": "elasticsearch.sn1ne.large"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Create an Indexing Service edition instance with cold nodes only.'."\n" + .'```'."\n" + .'{'."\n" + .' "description": "is-cold",'."\n" + .' "nodeAmount": 2,'."\n" + .' "esVersion": "7.10_with_X-Pack",'."\n" + .' "instanceCategory": "IS",'."\n" + .' "warmNodeConfiguration": {'."\n" + .' "spec": "group.c6.large.500",'."\n" + .' "amount": 3,'."\n" + .' "disk": 300'."\n" + .' },'."\n" + .' "networkConfig": {'."\n" + .' "type": "vpc",'."\n" + .' "vpcId": "vpc-8vbfu74bmw4m7m84a****",'."\n" + .' "vswitchId": "vsw-8vbnk6cmurbpump2f****",'."\n" + .' "vsArea": "cn-zhangjiakou-c"'."\n" + .' },'."\n" + .' "paymentType": "postpaid",'."\n" + .' "esAdminPassword": "yourPassword",'."\n" + .' "kibanaConfiguration": {'."\n" + .' "spec": "elasticsearch.sn1ne.large"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Create an Indexing Service edition instance with both cold and hot nodes.'."\n" + .'```'."\n" + .'{'."\n" + .' "description": "is-hot-cold",'."\n" + .' "nodeAmount": 2,'."\n" + .' "esVersion": "7.10_with_X-Pack",'."\n" + .' "instanceCategory": "IS",'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.sn2ne.xlarge",'."\n" + .' "disk": 50,'."\n" + .' "diskType": "cloud_ssd"'."\n" + .' },'."\n" + .' "warmNodeConfiguration": {'."\n" + .' "spec": "group.c6.large.500",'."\n" + .' "amount": 3,'."\n" + .' "disk": 300'."\n" + .' },'."\n" + .' "networkConfig": {'."\n" + .' "type": "vpc",'."\n" + .' "vpcId": "vpc-8vbfu74bmw4m7m84a****",'."\n" + .' "vswitchId": "vsw-8vbnk6cmurbpump2f****",'."\n" + .' "vsArea": "cn-zhangjiakou-c"'."\n" + .' },'."\n" + .' "paymentType": "postpaid",'."\n" + .' "esAdminPassword": "yourPassword",'."\n" + .' "kibanaConfiguration": {'."\n" + .' "spec": "elasticsearch.sn1ne.large"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Create an Indexing Service edition instance with OpenStore storage enabled, including both cold and hot nodes.'."\n" + .'```'."\n" + .'{'."\n" + .' "description": "os-1",'."\n" + .' "nodeAmount": 2,'."\n" + .' "esVersion": "7.10_with_X-Pack",'."\n" + .' "instanceCategory": "IS",'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.sn2ne.xlarge",'."\n" + .' "disk": 50,'."\n" + .' "diskType": "cloud_ssd"'."\n" + .' },'."\n" + .' "warmNodeConfiguration": {'."\n" + .' "spec": "openstore.i2g.4xlarge",'."\n" + .' "amount": 3'."\n" + .' },'."\n" + .' "networkConfig": {'."\n" + .' "type": "vpc",'."\n" + .' "vpcId": "vpc-8vbfu74bmw4m7m84a****",'."\n" + .' "vswitchId": "vsw-8vbnk6cmurbpump2f****",'."\n" + .' "vsArea": "cn-zhangjiakou-c"'."\n" + .' },'."\n" + .' "paymentType": "postpaid",'."\n" + .' "esAdminPassword": "yourPassword",'."\n" + .' "kibanaConfiguration": {'."\n" + .' "spec": "elasticsearch.sn1ne.large"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Create an Indexing Service edition instance with OpenStore storage enabled, including shared cold-hot nodes.'."\n" + .'```'."\n" + .'{'."\n" + .' "description": "os-2",'."\n" + .' "nodeAmount": 2,'."\n" + .' "esVersion": "7.10_with_X-Pack",'."\n" + .' "instanceCategory": "IS",'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "openstore.i2g.4xlarge",'."\n" + .' "disk": 50,'."\n" + .' "diskType": "cloud_ssd"'."\n" + .' },'."\n" + .' "networkConfig": {'."\n" + .' "type": "vpc",'."\n" + .' "vpcId": "vpc-8vbfu74bmw4m7m84a****",'."\n" + .' "vswitchId": "vsw-8vbnk6cmurbpump2f****",'."\n" + .' "vsArea": "cn-zhangjiakou-c"'."\n" + .' },'."\n" + .' "paymentType": "postpaid",'."\n" + .' "esAdminPassword": "yourPassword",'."\n" + .' "kibanaConfiguration": {'."\n" + .' "spec": "elasticsearch.sn1ne.large"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'- Create a general commercial edition 7.10 instance with auto-renewal enabled.'."\n" + .'> Set paymentType to prepaid to indicate that the instance uses the subscription billing method. Auto-renewal is configured in the paymentInfo parameter.'."\n" + .'```'."\n" + .'{'."\n" + .' "description": "auto-renewal",'."\n" + .' "nodeAmount": 3,'."\n" + .' "instanceCategory": "x-pack",'."\n" + .' "esVersion": "7.10_with_X-Pack",'."\n" + .' "nodeSpec": {'."\n" + .' "spec": "elasticsearch.sn2ne.xlarge",'."\n" + .' "disk": 50,'."\n" + .' "diskType": "cloud_ssd"'."\n" + .' },'."\n" + .' "kibanaConfiguration": {'."\n" + .' "spec": "elasticsearch.sn1ne.large"'."\n" + .' },'."\n" + .' "networkConfig": {'."\n" + .' "type": "vpc",'."\n" + .' "vpcId": "vpc-8vbfu74bmw4m7m84a****",'."\n" + .' "vswitchId": "vsw-8vbnk6cmurbpump2f****",'."\n" + .' "vsArea": "cn-zhangjiakou-c"'."\n" + .' },'."\n" + .' "paymentType": "prepaid",'."\n" + .' "paymentInfo": {'."\n" + .' "duration": 1,'."\n" + .' "pricingCycle": "Month",'."\n" + .' "isAutoRenew": true,'."\n" + .' "autoRenewDuration": 1'."\n" + .' },'."\n" + .' "esAdminPassword": "yourPassword"'."\n" + .'}'."\n" + .'```', + 'responseParamsDescription' => '## Response parameters'."\n" + .'| Name | Type | Example | Description |'."\n" + .'| ---- | ---- | ---- | ---- |'."\n" + .'| RequestId | String | 838D9D11-8EEF-46D8-BF0D-BC8FC2B0C2F3 | The request ID.|'."\n" + .'| Result | object | | The returned result.|'."\n" + .'| └instanceId | string | es-is-0u2ecp69tt**** | The instance ID.|', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-20T08:07:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-13T08:50:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T09:19:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T09:19:54.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 86400, 'regionId' => '*', 'api' => 'createInstance'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'elasticsearch:DataNodeDiskEncryption', 'validationType' => 'always'], + ['conditionKey' => 'elasticsearch:WarmNodeDiskEncryption', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/*'], + ], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.ap-northeast-1.aliyuncs.com', 'endpoint' => 'elasticsearch.ap-northeast-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.ap-southeast-1.aliyuncs.com', 'endpoint' => 'elasticsearch.ap-southeast-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.ap-southeast-2.aliyuncs.com', 'endpoint' => 'elasticsearch.ap-southeast-2.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.ap-southeast-3.aliyuncs.com', 'endpoint' => 'elasticsearch.ap-southeast-3.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.ap-southeast-5.aliyuncs.com', 'endpoint' => 'elasticsearch.ap-southeast-5.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-beijing.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-beijing.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-chengdu.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-chengdu.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-guangzhou.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-guangzhou.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-hangzhou.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-hangzhou.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-hongkong.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-hongkong.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-qingdao.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-qingdao.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-shanghai.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-shanghai.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-shenzhen.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-shenzhen.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-wulanchabu.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'elasticsearch.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'elasticsearch.us-west-1.aliyuncs.com', 'endpoint' => 'elasticsearch.us-west-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'elasticsearch.us-east-1.aliyuncs.com', 'endpoint' => 'elasticsearch.us-east-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'elasticsearch.eu-west-1.aliyuncs.com', 'endpoint' => 'elasticsearch.eu-west-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'elasticsearch.eu-central-1.aliyuncs.com', 'endpoint' => 'elasticsearch.eu-central-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'elasticsearch.ap-south-1.aliyuncs.com', 'endpoint' => 'elasticsearch.ap-south-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'elasticsearch.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'elasticsearch.cn-north-2-gov-1.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-north-2-gov-1.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-north-2-gov-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'elasticsearch.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'elasticsearch.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'elasticsearch-vpc.cn-hangzhou-finance.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccessEsPermissionError', 'message' => 'There is no permission to access the Elasticsearch cluster. Please check the account number, password and ip whitelist.', 'http_code' => 400, 'description' => 'You are not authorized to access the Elasticsearch cluster. Check your account, password, and whitelist configurations.'], + ['code' => 'AckOperatorNotInstallError', 'message' => 'Failed to install the ACK operator chart for the shipper. Install the chart again. Otherwise, you cannot manage the shipper.', 'http_code' => 400, 'description' => 'Failed to install the ACK operator chart for the shipper. Install the chart again. Otherwise, you cannot manage the shipper.'], + ['code' => 'ActionTrailNoPermission', 'message' => 'You are not authorized to access ActionTrail resources. To access these resources, contact the owner of the Alibaba Cloud account to which the resources belong for authorization.', 'http_code' => 400, 'description' => 'You are not authorized to access the ActionTrail resource. To access the resource, contact the owner of the Alibaba Cloud account to obtain the permissions.'], + ['code' => 'AdvancedInstanceMustNotSetWarmNode', 'message' => 'Elasticsearch Pro clusters do not support warm nodes.', 'http_code' => 400, 'description' => 'Elasticsearch Pro clusters do not support warm nodes.'], + ['code' => 'AdvancedInstanceMustSetDedicateMaster', 'message' => 'You must add dedicated master nodes to Elasticsearch Pro clusters.', 'http_code' => 400, 'description' => 'You must add dedicated master nodes to Elasticsearch Pro clusters.'], + ['code' => 'AlreadyReceivedInterruptSignal', 'message' => 'Interrupt request is being processed, please be patient.', 'http_code' => 400, 'description' => 'Processing the request. Please wait.'], + ['code' => 'ApiConnectTimeout', 'message' => 'API access timed out. Try again.', 'http_code' => 400, 'description' => 'Access timed out. Please try again later.'], + ['code' => 'ApmOutputEsNotFound', 'message' => 'Select the associated Elasticsearch cluster.', 'http_code' => 404, 'description' => 'Select the associated Elasticsearch cluster.'], + ['code' => 'ApmOutputEsNotValid', 'message' => 'The Elasticsearch cluster does not exist, or the version of the Elasticsearch cluster is earlier than 7.10.', 'http_code' => 400, 'description' => 'The Elasticsearch cluster does not exist, or the version of the Elasticsearch cluster is earlier than 7.10.'], + ['code' => 'ApmOutputPasswordUsernameNotFound', 'message' => 'Enter the username and password of the associated Elasticsearch cluster.', 'http_code' => 400, 'description' => 'Enter the username and password of the associated Elasticsearch cluster.'], + ['code' => 'BadFormat', 'message' => 'The specified format is invalid. Check the parameter format and try again.', 'http_code' => 400, 'description' => 'The specified format is invalid. Please check the request format and try again.'], + ['code' => 'BluegreenMasterConflict', 'message' => 'A blue-green restart is not supported for the role or node you specify.', 'http_code' => 400, 'description' => 'A blue-green restart is not supported for the role or node you specify.'], + ['code' => 'CancelPipelineFail', 'message' => 'An error occurred while stopping the specified task.', 'http_code' => 400, 'description' => 'An error occurred while stopping the task.'], + ['code' => 'CheckInstanceCredentialException', 'message' => 'The Elasticsearch cluster fails the connectivity test. Check whether the username and password of the cluster are correct and whether the health status of the cluster is normal.', 'http_code' => 400, 'description' => 'The Elasticsearch cluster fails the connectivity test. Check whether the username and password of the cluster are correct and whether the health status of the cluster is normal.'], + ['code' => 'CheckInstanceCredentialFailed', 'message' => 'The username and password of the Elasticsearch cluster fail the verification. Enter correct username and password.', 'http_code' => 400, 'description' => 'The username and password of the Elasticsearch cluster fail the verification. Enter correct username and password.'], + ['code' => 'ClientNodeAmountMatchZoneCountError', 'message' => 'The number of client nodes must be a multiple of the number of zones.', 'http_code' => 400, 'description' => 'The number of client nodes must be an integer multiple of the number of zones.'], + ['code' => 'ClusterOnHighLoad', 'message' => 'The cluster is busy. You cannot perform this operation.', 'http_code' => 400, 'description' => 'The operation is not supported because the current load of the cluster is high.'], + ['code' => 'ClusterSettingsUnableDowngrade', 'message' => 'The current Elasticsearch cluster configuration does not support this operation. Check the Elasticsearch cluster configuration first.', 'http_code' => 400, 'description' => 'The operation is not supported by the configurations of the current Elasticsearch cluster.'], + ['code' => 'ClusterWithNoReplicaIndex', 'message' => 'Indexes without replicas are found. Configure replicas for these indexes first.', 'http_code' => 400, 'description' => 'An index that has no replica shards exists. Please add a replica shard first.'], + ['code' => 'CmsEndTimeInvalid', 'message' => 'The specified CloudMonitor end time is invalid.', 'http_code' => 400, 'description' => 'The specified end time of CloudMonitor is invalid.'], + ['code' => 'CmsMetricNameInvalid', 'message' => 'The specified CloudMonitor metric name is invalid.', 'http_code' => 400, 'description' => 'The specified metric name of CloudMonitor is invalid.'], + ['code' => 'CmsPermissionDenied', 'message' => 'You must authorize this account to access CloudMonitor. Otherwise, the cluster monitoring features are unavailable.', 'http_code' => 400, 'description' => 'You are not authorized to manage the cluster.'], + ['code' => 'CmsStartTimeInvalid', 'message' => 'The specified CloudMonitor start time is invalid.', 'http_code' => 400, 'description' => 'The specified start time of CloudMonitor is invalid.'], + ['code' => 'CollectorDeployEcsMaxCount', 'message' => 'The number of ECS instances has exceeded the upper limit.', 'http_code' => 400, 'description' => 'The number of ECS instances has exceeded the upper limit.'], + ['code' => 'CollectorEcsDuplicate', 'message' => 'The specified shipper is already installed on the ECS instance.', 'http_code' => 400, 'description' => 'The specified shipper is already installed on the ECS instance.'], + ['code' => 'CollectorECSNeedCloudAssistant', 'message' => 'You must install the Cloud Assistant client on the ECS instances where you want to deploy the shipper.', 'http_code' => 400, 'description' => 'You must install the Cloud Assistant client on the ECS instances where you want to deploy the shipper.'], + ['code' => 'CollectorECSNodeInvalid', 'message' => 'The specified ECS instance does not exist or the instance ID is invalid.', 'http_code' => 400, 'description' => 'The specified ECS instance does not exist or the instance ID is invalid.'], + ['code' => 'CollectorGroupTypeInvalid', 'message' => 'The type of the machine on which the shipper is installed is invalid.', 'http_code' => 400, 'description' => 'The type of the machine on which the shipper is installed is invalid.'], + ['code' => 'CollectorInvalidInstanceType', 'message' => 'The specified cluster type is invalid.', 'http_code' => 400, 'description' => 'The specified cluster type is invalid.'], + ['code' => 'CollectorNodeNotExist', 'message' => 'The specified node does not exist.', 'http_code' => 400, 'description' => 'The specified shipper node does not exist.'], + ['code' => 'CollectorNodeRestartTypeError', 'message' => 'The restart object is invalid.', 'http_code' => 400, 'description' => 'The specified restart type is invalid.'], + ['code' => 'CollectorNotExist', 'message' => 'The specified shipper does not exist.', 'http_code' => 400, 'description' => 'The specified shipper does not exist.'], + ['code' => 'CollectorOutputInstanceIdInvalid', 'message' => 'The cluster specified in Output does not exist. Select another cluster.', 'http_code' => 400, 'description' => 'The cluster specified in Output does not exist. Please select another cluster.'], + ['code' => 'CollectorOutputInstancePasswordInvalid', 'message' => 'The password specified for the Elasticsearch cluster indicated by the Output parameter is not the one used to access the cluster. Change the password.', 'http_code' => 400, 'description' => 'The password specified for the Elasticsearch cluster indicated by the Output parameter is not the one used to access the cluster. Please change the password.'], + ['code' => 'CollectorPathsIsNull', 'message' => 'The log file path cannot be empty.', 'http_code' => 400, 'description' => 'You must specify the shipper path.'], + ['code' => 'CollectorRequiredFieldEmpty', 'message' => 'The required fields in the shipper configuration cannot be empty.', 'http_code' => 400, 'description' => 'You must specify the shipper configuration fields.'], + ['code' => 'CollectorStatusNotSupportedOperations', 'message' => 'The specified operation is not supported when the shipper is in the current state.', 'http_code' => 400, 'description' => 'The operation is not supported while the shipper is in the current state.'], + ['code' => 'CollectorTypeInvalid', 'message' => 'The specified shipper type is invalid.', 'http_code' => 400, 'description' => 'The specified shipper type is invalid.'], + ['code' => 'CollectorVpcMustMatch', 'message' => 'The ECS instance must be connected to the same VPC as the shipper output.', 'http_code' => 400, 'description' => 'The ECS instance must be connected to the same VPC as the shipper output.'], + ['code' => 'ComponentCodeValueError', 'message' => 'The specified component value is invalid.', 'http_code' => 404, 'description' => ''], + ['code' => 'ConcurrencyUpdateInstanceConflict', 'message' => 'The cluster is running tasks. Try again later.', 'http_code' => 400, 'description' => 'The cluster is running tasks. Please try again later.'], + ['code' => 'ConnectionError', 'message' => 'An error occurred while connecting to the source instance or target cluster. Check the source instance or target instance information, and the username, password, and permissions of the account.', 'http_code' => 400, 'description' => 'Failed to connect to the source or destination instance. Please check the source or destination instance information, and the username, password, and permissions of the account.'], + ['code' => 'ConnectionFail', 'message' => 'Failed to connect to the cluster. Please check the URL, username, and password.', 'http_code' => 400, 'description' => 'Failed to connect to the cluster. Please check the connection URL and your account password.'], + ['code' => 'ConnectRdsGetTableFieldsFail', 'message' => 'An error occurred while retrieving the columns in the RDS table. Check the RDS instance ID and status.', 'http_code' => 400, 'description' => 'Failed to retrieve the columns in the RDS table. Please check the ID and state of the instance.'], + ['code' => 'ConnectRdsGetTablesFail', 'message' => 'An error occurred while retrieving the RDS table. Check the RDS instance ID and status.', 'http_code' => 400, 'description' => 'Failed to retrieve the RDS table. Please check the ID and state of the instance.'], + ['code' => 'ConsoleNeedLogin', 'message' => 'Your login has expired. Log on to the console again.', 'http_code' => 400, 'description' => 'Your information has expired. Please log on to the console again.'], + ['code' => 'CoreVersionCanNotChange', 'message' => 'The cluster type cannot be modified.', 'http_code' => 400, 'description' => 'The cluster type cannot be modified.'], + ['code' => 'CpfsUpdateNotAllowed', 'message' => 'If you want to upgrade storage for hot data, submit a ticket.', 'http_code' => 400, 'description' => 'To upgrade storage for hot data, submit a ticket.'], + ['code' => 'CreateServiceLinkedRoleNoPermission', 'message' => 'You do not have permission to create the service linked role. Obtain the required permission first.', 'http_code' => 400, 'description' => 'You are not authorized to create the service-linked role.'], + ['code' => 'CreateVpcEndpointError', 'message' => 'An error occurred while creating the internal endpoint. Try again later.', 'http_code' => 400, 'description' => 'An error occurred while creating the internal endpoint. Please try again later.'], + ['code' => 'CreateVpcEndpointParamsEmpty', 'message' => 'The IDs of the endpoint service and the associated zone cannot be empty. Specify the IDs and try again.', 'http_code' => 400, 'description' => 'The IDs of the endpoint service and the associated zone cannot be empty. Specify the IDs and try again.'], + ['code' => 'CssCheckUpdowngradeError', 'message' => 'The configurations remain unchanged. Change one configuration.', 'http_code' => 400, 'description' => 'The configurations remain unchanged. Please change one configuration.'], + ['code' => 'CurrentInstanceNeedRestart', 'message' => 'The specified cluster does not support this function. To use this function, you must update the cluster by restarting it.', 'http_code' => 400, 'description' => 'The specified cluster does not support this feature. To use this feature, you must update the cluster by restarting it.'], + ['code' => 'CurrentVersionCanNotExpandDisk', 'message' => 'The specified Elasticsearch cluster version does not support expanding disks.', 'http_code' => 400, 'description' => 'The specified Elasticsearch cluster version does not support expanding disks.'], + ['code' => 'CurrentVersionCanNotExpandSpec', 'message' => 'The specified Elasticsearch cluster version does not support upgrading instances.', 'http_code' => 400, 'description' => 'The specified Elasticsearch cluster version does not support upgrading instances.'], + ['code' => 'CurrentVersionCanNotRollback', 'message' => 'The specified Elasticsearch cluster version does not support force rollback.', 'http_code' => 400, 'description' => 'The specified Elasticsearch cluster version does not support force rollback.'], + ['code' => 'CurrentVersionNotSupportUpdateDict', 'message' => 'The specified Elasticsearch cluster version does not support updating dictionaries.', 'http_code' => 400, 'description' => 'The specified Elasticsearch cluster version does not support updating dictionaries.'], + ['code' => 'DataNodeAmountValidateFail', 'message' => 'The number of data nodes must be a multiple of the number of zones. Valid values: from 2 to 50.', 'http_code' => 400, 'description' => 'The number of data nodes must range from 2 to 50 and must be a multiple of the number of zones.'], + ['code' => 'DataNodeCannotChangeSpecGroup', 'message' => 'Specification families cannot be modified.', 'http_code' => 400, 'description' => 'The specification family cannot be modified.'], + ['code' => 'DataNodeChangeDiskTypeError', 'message' => 'Disk types cannot be modified.', 'http_code' => 400, 'description' => 'The storage class cannot be modified.'], + ['code' => 'DataNodeLocalSpecValidateDiskFail', 'message' => 'Local specification families are provided with disks. You do not need to configure the storage settings.', 'http_code' => 400, 'description' => 'You do not need to configure storage for the nodes because they already have local disks.'], + ['code' => 'DataNodeOverMaxDiskError', 'message' => 'The storage space per data node cannot be greater than 2 TiB.', 'http_code' => 400, 'description' => 'The storage space per node cannot be increased by more than 2 TB.'], + ['code' => 'DataNodeSpecValidateFail', 'message' => 'The specifications are not supported. Please choose other specifications.', 'http_code' => 400, 'description' => 'The specifications are not supported. Please choose other specifications.'], + ['code' => 'DataNodeValidateDiskFail', 'message' => 'The setting of storage space per data node is invalid.', 'http_code' => 400, 'description' => 'The specified storage space per data node is invalid.'], + ['code' => 'DatasourceConfigNotSupport', 'message' => 'The index configurations of the source and destination clusters are invalid. Check the versions, index names, index types, and mappings configurations of the clusters.', 'http_code' => 400, 'description' => 'The index configurations of the source and destination clusters are invalid. Check the versions, index names, index types, and mappings configurations of the clusters.'], + ['code' => 'DatasourceConnnectFailed', 'message' => 'Failed to access the cluster. Check whether your IP address is in the whitelist and whether the VPC information and your password are correct.', 'http_code' => 400, 'description' => 'Failed to access the cluster. Check whether your IP address is in the whitelist and whether the VPC information and your password are correct.'], + ['code' => 'DataSourceNameExistError', 'message' => 'The source instance name already exists.', 'http_code' => 400, 'description' => 'The source instance name already exists.'], + ['code' => 'DataSourceNameLengthError', 'message' => 'The length of the source instance name is invalid.', 'http_code' => 400, 'description' => 'The length of the source instance name is invalid.'], + ['code' => 'DataSourceNotExist', 'message' => 'The source instance does not exist.', 'http_code' => 400, 'description' => 'The source instance does not exist.'], + ['code' => 'DataSourcePartitionEmptyError', 'message' => 'MaxCompute tables must be partitioned.', 'http_code' => 400, 'description' => 'The MaxCompute data source does not have partitions.'], + ['code' => 'DedicatedMasterDiskTypeError', 'message' => 'The disk type of the dedicated master nodes is invalid.', 'http_code' => 400, 'description' => 'The storage type of the dedicated coordinator node is invalid.'], + ['code' => 'DefaultWhiteIpGroupCanNotDelete', 'message' => 'By default, the IP address whitelist group named default cannot be deleted.', 'http_code' => 400, 'description' => 'By default, the IP address whitelist group named default cannot be deleted.'], + ['code' => 'DeleteDataSourceError', 'message' => 'An error occurred while deleting the specified source instance. Try again later.', 'http_code' => 400, 'description' => 'An error occurred while deleting the specified source instance. Try again later.'], + ['code' => 'DeleteProtectedOvertime', 'message' => 'The input release protection duration of the cluster exceeds the upper limit. Change the duration to a value within the valid range.', 'http_code' => 400, 'description' => 'The maximum release protection duration of the cluster is exceeded. Please change the duration to a value within the valid range.'], + ['code' => 'DeleteProtectedRepeatTooMuch', 'message' => 'The number of release protection times for the cluster exceeds the upper limit. Choose to delete the cluster immediately.', 'http_code' => 400, 'description' => 'The number of release protections for the cluster cannot exceed 3. You can choose to immediately delete the cluster.'], + ['code' => 'DeleteProtectedTimeInvalid', 'message' => 'The input release protection duration of the cluster is invalid. Change the duration to a value within the valid range.', 'http_code' => 400, 'description' => 'The specified release protection duration of the cluster is invalid. Please change the duration to a value within the valid range.'], + ['code' => 'DeleteVpcEndpointError', 'message' => 'Failed to delete the internal endpoint. Try again later.', 'http_code' => 400, 'description' => 'Failed to delete the internal endpoint. Please try again later.'], + ['code' => 'DiagnosisCloseFail', 'message' => 'An error occurred while disabling Intelligent Maintenance for the specified cluster.', 'http_code' => 400, 'description' => 'Failed to disable intelligent O&M for the current cluster.'], + ['code' => 'DiagnosisCurrentVersionNotSupport', 'message' => 'The specified cluster version does not support Intelligent Maintenance.', 'http_code' => 400, 'description' => 'The current cluster is of an early version and does not support intelligent O&M.'], + ['code' => 'DiagnosisGetHealthFail', 'message' => 'An error occurred while obtaining the cluster health information.', 'http_code' => 400, 'description' => 'Failed to obtain the basic health information of the cluster.'], + ['code' => 'DiagnosisGetIndicesFail', 'message' => 'An error occurred while obtaining the index list.', 'http_code' => 400, 'description' => 'Failed to obtain the cluster index list.'], + ['code' => 'DiagnosisGetInstanceOpenedFail', 'message' => 'An error occurred while obtaining the status of Intelligent Maintenance.', 'http_code' => 400, 'description' => 'Failed to obtain the intelligent O&M status of the cluster.'], + ['code' => 'DiagnosisGetReportFail', 'message' => 'An error occurred while obtaining the diagnosis report details.', 'http_code' => 400, 'description' => 'Failed to obtain the details of the cluster diagnostics report.'], + ['code' => 'DiagnosisGetReportIdsFail', 'message' => 'An error occurred while obtaining the diagnosis report list.', 'http_code' => 400, 'description' => 'Failed to obtain the list of diagnostics reports.'], + ['code' => 'DiagnosisGetSettingFail', 'message' => 'An error occurred while obtaining the cluster diagnosis configuration.', 'http_code' => 400, 'description' => 'Failed to obtain the cluster diagnostics configuration information.'], + ['code' => 'DiagnosisHasTaskRunning', 'message' => 'The specified cluster is running diagnosis tasks.', 'http_code' => 400, 'description' => 'The current cluster has a task in progress.'], + ['code' => 'DiagnosisInstanceNotExist', 'message' => 'The specified cluster does not exist.', 'http_code' => 400, 'description' => 'The specified cluster does not exist in the diagnostics service.'], + ['code' => 'DiagnosisListItemFail', 'message' => 'An error occurred while obtaining the diagnosis item list.', 'http_code' => 400, 'description' => 'Failed to obtain the list of diagnostic items.'], + ['code' => 'DiagnosisListSceneFail', 'message' => 'An error occurred while obtaining the diagnosis scenario list.', 'http_code' => 400, 'description' => 'Failed to obtain the list of diagnostics scenarios.'], + ['code' => 'DiagnosisNotOpened', 'message' => 'This function is unavailable because Intelligent Maintenance is disabled for the specified cluster.', 'http_code' => 400, 'description' => 'This feature is unavailable because intelligent O&M is not enabled for the current cluster.'], + ['code' => 'DiagnosisOpenFail', 'message' => 'An error occurred while enabling Intelligent Maintenance for the specified cluster.', 'http_code' => 400, 'description' => 'Failed to enable intelligent O&M for the current cluster.'], + ['code' => 'DiagnosisQuotaNotEnough', 'message' => 'The number of daily diagnoses that you can perform for the specified cluster reaches the upper limit.', 'http_code' => 400, 'description' => 'The maximum number of cluster diagnostics tasks for the day is reached.'], + ['code' => 'DiagnosisRegionNotExist', 'message' => 'The specified region does not support Intelligent Maintenance.', 'http_code' => 400, 'description' => 'Intelligent O&M is not supported in the current region.'], + ['code' => 'DiagnosisReportNotExist', 'message' => 'The specified cluster diagnosis report does not exist.', 'http_code' => 400, 'description' => 'The specified cluster diagnostics report does not exist.'], + ['code' => 'DiagnosisRequestParamIllegal', 'message' => 'The cluster diagnosis request contains invalid parameters.', 'http_code' => 400, 'description' => 'The request parameter for cluster diagnostics is invalid.'], + ['code' => 'DiagnosisRunFail', 'message' => 'An error occurred while starting the diagnosis task for the specified cluster.', 'http_code' => 400, 'description' => 'Failed to start the diagnostics task for the current cluster.'], + ['code' => 'DiagnosisUpdateSettingFail', 'message' => 'An error occurred while updating the cluster diagnosis configuration.', 'http_code' => 400, 'description' => 'Failed to update the diagnostics configurations of the cluster.'], + ['code' => 'DictAnalyzerTypeInvalid', 'message' => 'The specified dictionary type is invalid. Check the dictionary type.', 'http_code' => 400, 'description' => 'The specified dictionary type is invalid. Please check the dictionary type.'], + ['code' => 'DictIsUsingCanNotDeleting', 'message' => 'An error occurred while deleting the synonym dictionary. The dictionary is in use.', 'http_code' => 400, 'description' => 'The synonym dictionary is in use by an index and cannot be deleted.'], + ['code' => 'DictNameNotMatchError', 'message' => 'The specified dictionary name is invalid. The dictionary list of the selected dictionary type does not contain the specified dictionary. Check the dictionary name and try again.', 'http_code' => 400, 'description' => 'The specified dictionary name is invalid. The dictionary list of the selected dictionary type does not contain the specified dictionary. Check the dictionary name and try again.'], + ['code' => 'DictNameNotMatchPattern', 'message' => 'The specified dictionary name is invalid.', 'http_code' => 400, 'description' => 'The specified dictionary name is invalid.'], + ['code' => 'DictNeedHighSpecification', 'message' => 'To use this dictionary, you must upgrade your Elasticsearch cluster to 2-core 4 GB or higher.', 'http_code' => 400, 'description' => 'To use this dictionary, you must upgrade your Elasticsearch cluster to 2-core 4 GB or higher.'], + ['code' => 'DiskEncryptedNotSupportChanged', 'message' => 'You cannot change the status of disk encryption.', 'http_code' => 400, 'description' => 'You cannot modify the disk encryption status.'], + ['code' => 'DiskLowWaterMarkOnThreshold', 'message' => 'Insufficient disk space(lower than the value set by cluster.routing.allocation.disk.watermark.low), please expand disk first.', 'http_code' => 400, 'description' => 'The remaining disk space indicated by the cluster.routing.allocation.disk.watermark.low parameter is insufficient. Please resize the disk.'], + ['code' => 'DolphinBahamutCancelError', 'message' => 'An error occurred while canceling the task. Wait 60 seconds and try again.', 'http_code' => 400, 'description' => 'Failed to cancel the task. Please wait 60 seconds and try again.'], + ['code' => 'DolphinBahamutGetStateError', 'message' => 'An error occurred while retrieving the task status.', 'http_code' => 400, 'description' => 'An error occurred while retrieving the task state.'], + ['code' => 'DolphinBahamutRunnerError', 'message' => 'An error occurred while running the stream computing task.', 'http_code' => 400, 'description' => 'Failed to run the stream computing task.'], + ['code' => 'DolphinElasticsearchConnectionError', 'message' => 'An error occurred while connecting to the Elasticsearch cluster.', 'http_code' => 400, 'description' => 'Failed to connect to the Elasticsearch cluster.'], + ['code' => 'DolphinElasticsearchRunnerError', 'message' => 'An error occurred while running the Reindex task.', 'http_code' => 400, 'description' => 'Failed to run the Reindex task.'], + ['code' => 'DolphinInvalidParameters', 'message' => 'An error occurred while calling the backend engine because an invalid parameter is passed.', 'http_code' => 400, 'description' => 'An error occurred while calling the backend engine because an invalid parameter is specified.'], + ['code' => 'DolphinInvalidPipelineParameters', 'message' => 'An error occurred while calling the backend engine because an invalid validation parameter is passed.', 'http_code' => 400, 'description' => 'An error occurred while validating the backend engine because an invalid parameter is specified.'], + ['code' => 'DolphinIoExceptionError', 'message' => 'An I/O error occurred to the backend engine.', 'http_code' => 400, 'description' => 'An I/O error occurred while accessing the backend service.'], + ['code' => 'DolphinMultipleTypeError', 'message' => 'An error occurred while writing multiple source instance types into one type. Modify the source instance.', 'http_code' => 400, 'description' => 'Failed to write multiple source instance types into one type. Please modify the source instance.'], + ['code' => 'DolphinPipelineNotExit', 'message' => 'The task does not exist in the backend system.', 'http_code' => 400, 'description' => 'The task is not found in the backend system.'], + ['code' => 'DolphinPipelineValidationError', 'message' => 'An error occurred while running the task because an invalid parameter is passed. Modify the parameter and try again.', 'http_code' => 400, 'description' => 'An error occurred while running the task because an invalid parameter is specified. Please correct the parameter and try again.'], + ['code' => 'DolphinUnknownCode', 'message' => 'A backend error occurred.', 'http_code' => 400, 'description' => 'A backend error occurred.'], + ['code' => 'DolphinUnknownInternalError', 'message' => 'A backend engine error occurred.', 'http_code' => 400, 'description' => 'An error occurred in the backend engine.'], + ['code' => 'DolphinUnknownSearchFlowError', 'message' => 'An error occurred to the backend stream computing engine.', 'http_code' => 400, 'description' => 'An error occurred in the backend stream computing engine.'], + ['code' => 'DolphinValidatorError', 'message' => 'An error occurred while validating the task configuration.', 'http_code' => 400, 'description' => 'An error occurred while validating the task configurations.'], + ['code' => 'DowngradeNotSupportDiskChange', 'message' => 'You cannot change the storage space of %nodeType% on the configuration downgrade page.', 'http_code' => 400, 'description' => 'You cannot change the storage space of %nodeType%s on the configuration downgrade page.'], + ['code' => 'DowngradeSpecTooLow', 'message' => 'To ensure the health and data security of your cluster, you are not allowed to downgrade the specifications to the current specifications.', 'http_code' => 400, 'description' => 'To ensure the health and data security of your cluster, you are not allowed to downgrade the specifications to the current specifications.'], + ['code' => 'DowngradeSpecTooLowInDetail', 'message' => 'To ensure the health and data security of the cluster, you cannot downgrade %nodeType% to the current specifications.', 'http_code' => 400, 'description' => 'To ensure the health and data security of the cluster, you cannot downgrade %nodeType%s to the current specifications.'], + ['code' => 'DuplicateDictName', 'message' => 'The specified dictionary name already exists.', 'http_code' => 400, 'description' => 'The specified dictionary name already exists.'], + ['code' => 'DuplicateTargetIndex', 'message' => 'The index name already exists. Enter a unique index name.', 'http_code' => 400, 'description' => 'The index name already exists. Please enter a unique index name.'], + ['code' => 'EachZoneMustShrinkNode', 'message' => 'You must scale in the same number of nodes in all zones.', 'http_code' => 400, 'description' => 'The number of nodes to reduce must be the same across regions.'], + ['code' => 'ECSIdInvalid', 'message' => 'The ecsInstanceIds parameter is invalid.', 'http_code' => 400, 'description' => 'The specified ecsInstanceIds parameter is invalid.'], + ['code' => 'ElasitcTaskSetCronExpressionError', 'message' => 'The value of the Trigger Period parameter is invalid.', 'http_code' => 400, 'description' => 'The specified trigger period parameter is invalid.'], + ['code' => 'ElasticNodeAmountValidateFail', 'message' => 'The number of elastic nodes must range from 2 to 50 and must be a multiple of the number of zones.', 'http_code' => 400, 'description' => 'The number of elastic nodes must range from 2 to 50 and must be a multiple of the number of zones.'], + ['code' => 'ElasticNodeCannotChangeSpecGroup', 'message' => 'The elastic node type cannot be changed.', 'http_code' => 400, 'description' => 'The elastic node type cannot be changed.'], + ['code' => 'ElasticNodeChangeDiskTypeError', 'message' => 'The disk type of elastic nodes cannot be changed.', 'http_code' => 400, 'description' => 'The disk type of elastic nodes cannot be changed.'], + ['code' => 'ElasticNodeLocalSpecValidateDiskFail', 'message' => 'You do not need to configure storage for the elastic nodes because they already have local disks.', 'http_code' => 400, 'description' => 'You do not need to configure storage for the elastic nodes because they already have local disks.'], + ['code' => 'ElasticNodeNotSetConfigurationError', 'message' => 'You must configure settings related to elastic nodes.', 'http_code' => 400, 'description' => 'You must configure settings related to elastic nodes.'], + ['code' => 'ElasticNodeOverMaxDiskError', 'message' => 'The maximum number of disks for an elastic node is reached.', 'http_code' => 400, 'description' => 'The maximum number of disks for an elastic node is reached.'], + ['code' => 'ElasticNodeSetConfigurationOverError', 'message' => 'You cannot configure settings related to elastic nodes because you have not purchased elastic nodes.', 'http_code' => 400, 'description' => 'You cannot configure settings related to elastic nodes because you have not purchased elastic nodes.'], + ['code' => 'ElasticNodeSpecValidateFail', 'message' => 'The specifications are not supported. Choose other specifications.', 'http_code' => 400, 'description' => 'The specifications are not supported. Please choose other specifications.'], + ['code' => 'ElasticNodeValidateDiskFail', 'message' => 'The storage space per elastic node is incorrect.', 'http_code' => 400, 'description' => 'The specified storage space per elastic node is invalid.'], + ['code' => 'ElasticsearchClientException', 'message' => 'An error occurred. Check the cluster status and configuration.', 'http_code' => 400, 'description' => 'An error occurred. Please check the state and configurations of the cluster.'], + ['code' => 'ElasticsearchVersionNotSupport', 'message' => 'The current Elasticsearch cluster version is not supported.', 'http_code' => 400, 'description' => 'The current Elasticsearch cluster version is not supported.'], + ['code' => 'ElasticTaskMustHasElasticNode', 'message' => 'You have not purchased elastic nodes. Purchase elastic nodes first.', 'http_code' => 400, 'description' => 'You have not purchased elastic nodes. Please purchase elastic nodes first.'], + ['code' => 'ElasticTaskMustHasMasterNode', 'message' => 'You have not purchased dedicated master nodes. Purchase dedicated master nodes first.', 'http_code' => 400, 'description' => 'You have not purchased dedicated master nodes. Please purchase dedicated master nodes first.'], + ['code' => 'ElasticTaskSetNodeCountError', 'message' => 'The number of elastic nodes is incorrect. Change the number.', 'http_code' => 400, 'description' => 'The specified number of elastic nodes is invalid.'], + ['code' => 'EmptyPipelineError', 'message' => 'No pipeline, please go to Kibana to create.', 'http_code' => 400, 'description' => 'The specified pipeline is not configured. Please create a pipeline in Kibana.'], + ['code' => 'ErrorPipelineNotFound', 'message' => 'The specified pipeline does not exist.', 'http_code' => 404, 'description' => 'The specified pipeline does not exist.'], + ['code' => 'ErrorPipelineSettings', 'message' => 'The pipeline parameters are invalid.', 'http_code' => 400, 'description' => 'The specified pipeline configuration parameter is invalid.'], + ['code' => 'EsOwnerValidatorFail', 'message' => 'Enter the ID of the Elasticsearch cluster where you have logged on.', 'http_code' => 400, 'description' => 'Enter the ID of the Elasticsearch cluster where you have logged on.'], + ['code' => 'EssdLevelDowngradeError', 'message' => 'You cannot decrease the performance level of ESSDs for %nodeType% on the configuration upgrade page.', 'http_code' => 400, 'description' => 'You cannot decrease the performance level of ESSDs for %nodeType%s on the configuration upgrade page.'], + ['code' => 'EssdLevelUpgradeError', 'message' => 'You cannot increase the performance level of ESSDs for %nodeType% on the configuration downgrade page.', 'http_code' => 400, 'description' => 'You cannot increase the performance level of ESSDs for %nodeType%s on the configuration downgrade page.'], + ['code' => 'EsVersionError', 'message' => 'The Elasticsearch version is invalid.', 'http_code' => 400, 'description' => 'The version of the Elasticsearch cluster is invalid.'], + ['code' => 'ExceedingPageMaxNum', 'message' => 'Up to 50 entries can be returned per page.', 'http_code' => 400, 'description' => 'The number of requests per page cannot exceed 50.'], + ['code' => 'ExceedPipelineMaxNumber', 'message' => 'You can create no more than 20 pipelines.', 'http_code' => 400, 'description' => 'The number of pipelines cannot exceed 20.'], + ['code' => 'FetchPluginError', 'message' => 'A timeout error occurred while obtaining plug-in information. Try again later.', 'http_code' => 400, 'description' => 'A timeout error occurred while obtaining plug-in information. Please try again later.'], + ['code' => 'FetchSecurityGroupError', 'message' => 'Failed to obtain the information about the security group of the cluster. Try again later.', 'http_code' => 400, 'description' => 'Failed to retrieve the information of the security group of the cluster. Please try again later.'], + ['code' => 'FieldEmptyError', 'message' => 'The required parameters cannot be blank.', 'http_code' => 400, 'description' => 'You must specify the required fields.'], + ['code' => 'FieldTypeNotMatch', 'message' => 'The type of the data returned by the function does not match the type of the column.', 'http_code' => 400, 'description' => 'The type of the return value does not match that of the field value.'], + ['code' => 'FileMD5SummaryNotMatch', 'message' => 'An error occurred while validating the files. You can select and download third-party libraries from the official support list. Do not change the files before you upload them.', 'http_code' => 400, 'description' => 'The file fails the check. Select a file from the official list, download the file, and then upload it. Do not modify the file.'], + ['code' => 'FileNameNotMatchPattern', 'message' => 'The specified file name is invalid.', 'http_code' => 400, 'description' => 'The specified file name is invalid.'], + ['code' => 'FileSizeExceedMaxSize', 'message' => 'The file size exceeds the upper limit.', 'http_code' => 400, 'description' => 'The maximum size of a file is reached.'], + ['code' => 'FrequentRequests', 'message' => 'Excessive requests are submitted within a short period of time. Try again later.', 'http_code' => 400, 'description' => 'Excessive requests are submitted within a short period of time. Please try again later.'], + ['code' => 'GenerateOssDictDownloadUrlError', 'message' => 'The server failed to generate a temporary download link for the dictionary. Try again later.', 'http_code' => 400, 'description' => 'The server failed to generate a temporary download link for the dictionary. Please try again later.'], + ['code' => 'GeRdsConnectionUrlError', 'message' => 'An error occurred while retrieving the RDS connection information. Check the RDS instance ID and status.', 'http_code' => 400, 'description' => 'Failed to retrieve the connection information of the ApsaraDB RDS instance. Please check the ID and state of the instance.'], + ['code' => 'GetAckClusterDetailError', 'message' => 'An error occurred while querying the details of the ACK cluster.', 'http_code' => 400, 'description' => 'An error occurred while querying the details of the ACK cluster.'], + ['code' => 'GetAckClusterUserKubeconfigError', 'message' => 'An error occurred while querying the kubeconfig file of the ACK cluster.', 'http_code' => 400, 'description' => 'An error occurred while querying the kubeconfig file of the ACK cluster.'], + ['code' => 'GetAckOperatorError', 'message' => 'An error occurred while querying the installation information of the ACK operator chart.', 'http_code' => 400, 'description' => 'An error occurred while querying the installation information of the ACK operator chart.'], + ['code' => 'GetElasticsearchInfoException', 'message' => 'An error occurred while retrieving the Elasticsearch cluster information. Try again later.', 'http_code' => 400, 'description' => 'Failed to retrieve the information of the Elasticsearch cluster. Please try again later.'], + ['code' => 'GetFileMD5SummaryError', 'message' => 'An error occurred while retrieving the MD5 message digest.', 'http_code' => 400, 'description' => 'An error occurred while retrieving the MD5 digest of the file.'], + ['code' => 'GetIndexNamesError', 'message' => 'An error occurred while retrieving the index list. Check the Elasticsearch cluster status.', 'http_code' => 400, 'description' => 'Failed to retrieve the index list. Please check the state of the cluster.'], + ['code' => 'GetInnerEndpointFailed', 'message' => 'An error occurred while retrieving the network information that is required for connecting to the Elasticsearch cluster. Check the cluster status.', 'http_code' => 400, 'description' => 'Failed to retrieve the network information that is required for connecting to the Elasticsearch cluster. Please check the state of the cluster.'], + ['code' => 'GetInstanceDictListFail', 'message' => 'An error occurred while retrieving the dictionary list.', 'http_code' => 400, 'description' => 'Failed to retrieve the dictionaries of the instance.'], + ['code' => 'GetMappingEndpointFailed', 'message' => 'An error occurred while retrieving the network information that is required for connecting to the Elasticsearch cluster. Check the cluster status.', 'http_code' => 400, 'description' => 'Failed to retrieve the network information that is required for connecting to the Elasticsearch cluster. Please check the state of the cluster.'], + ['code' => 'GetMappingError', 'message' => 'An error occurred while retrieving the Mapping configuration. Check the index name and the Elasticsearch cluster status.', 'http_code' => 400, 'description' => 'Failed to retrieve the Mapping configuration. Please check the index name and the state of the Elasticsearch cluster.'], + ['code' => 'GetPipelineStatusFail', 'message' => 'An error occurred while retrieving the task status.', 'http_code' => 400, 'description' => 'Failed to retrieve the task state.'], + ['code' => 'GetRdsInfoEmpty', 'message' => 'An error occurred while retrieving the RDS instance information. Check the source instance.', 'http_code' => 400, 'description' => 'Failed to retrieve the ApsaraDB RDS instance information. Please check the source instance.'], + ['code' => 'GetRdsInstanceInfoFail', 'message' => 'An error occurred while retrieving the RDS instance information. Check the RDS instance ID and status.', 'http_code' => 400, 'description' => 'Failed to retrieve the information of the ApsaraDB RDS instance. Please check the ID and state of the instance.'], + ['code' => 'GetRdsServiceError', 'message' => 'An error occurred while accessing the RDS instance. Contact the administrator.', 'http_code' => 400, 'description' => 'An error occurred while accessing the ApsaraDB RDS instance. Please contact the administrator.'], + ['code' => 'GetSecurityGroupIdError', 'message' => 'Failed to obtain the information about the security group of the cluster. Try again later.', 'http_code' => 400, 'description' => 'Failed to retrieve the information of the security group of the cluster. Please try again later.'], + ['code' => 'GetSettingError', 'message' => 'An error occurred while retrieving the Setting configuration. Check the index name and the Elasticsearch cluster status.', 'http_code' => 400, 'description' => 'Failed to retrieve the Setting configuration. Please check the index name and the Elasticsearch cluster state.'], + ['code' => 'GetSnapshotUriFailed', 'message' => 'An error occurred while retrieving the URI of the snapshot of the Elasticsearch cluster. Contact the administrator.', 'http_code' => 400, 'description' => 'Failed to retrieve the URI of the snapshot of the Elasticsearch cluster. Please contact the administrator.'], + ['code' => 'GetVpcEndpointAttributeError', 'message' => 'Failed to obtain the details of the endpoint. Try again later.', 'http_code' => 400, 'description' => 'Failed to retrieve the details of the endpoint. Please try again later.'], + ['code' => 'HasEmptyFieldError', 'message' => 'The required parameters cannot be empty.', 'http_code' => 400, 'description' => 'You must specify the required fields.'], + ['code' => 'HigherConfigNotSupport', 'message' => 'The specifications of your cluster cannot be upgraded to your desired specifications because the related resources are insufficient. Select other specifications.', 'http_code' => 400, 'description' => 'The specifications of your cluster cannot be upgraded to your desired specifications because the related resources are insufficient. Please select other specifications.'], + ['code' => 'HostNotFoundInTheZone', 'message' => 'The specified node cannot be found in the current region.', 'http_code' => 404, 'description' => 'The specified node does not exist in the current region.'], + ['code' => 'HttpsNeedClientNode', 'message' => 'To enable HTTPS, you must first purchase client nodes.', 'http_code' => 400, 'description' => 'You must purchase a coordinate node before you can enable HTTPS.'], + ['code' => 'InactiveInstancePermissionDenied', 'message' => 'The release protection feature is unavailable for clusters in the Locked state.', 'http_code' => 400, 'description' => 'The release protection feature is unavailable for clusters in the Locked state.'], + ['code' => 'IncompatibleHighVersionClusterSettings', 'message' => 'The target version is incompatible with the following settings configuration: %clusterSettings%.', 'http_code' => 400, 'description' => 'The target version is incompatible with the following Settings configuration: %clusterSettings%.'], + ['code' => 'IncompatibleHighVersionIndexSettings', 'message' => 'The target version is incompatible with the following index configuration: %indexSettings%.', 'http_code' => 400, 'description' => 'The target version is incompatible with the following index configuration: %indexSettings%.'], + ['code' => 'IncompatibleHighVersionIndexTemplate', 'message' => 'The target version is incompatible with the following index template configuration: %indexTemplate%.', 'http_code' => 400, 'description' => 'The target version is incompatible with the following index template configuration: %indexTemplate%.'], + ['code' => 'IndexNameFormatError', 'message' => 'The index name format is invalid.', 'http_code' => 400, 'description' => 'The index name format is invalid. Please change the index name format.'], + ['code' => 'IndicesSelectedTooMany', 'message' => 'The number of the selected indexes exceeds the upper limit: 10.', 'http_code' => 400, 'description' => 'The number of selected indexes cannot exceed 10.'], + ['code' => 'IneligibleIkAnalysisPlugin', 'message' => 'The current IK analysis plug-in version does not support a rolling update. You can restart the cluster to update the plug-in or use the standard update method.', 'http_code' => 400, 'description' => 'The current analysis-ik plug-in version does not support rolling update. Restart the cluster to have the plug-in automatically upgraded, or use the standard update method.'], + ['code' => 'InstallAckOperatorError', 'message' => 'An error occurred while installing the ACK operator chart.', 'http_code' => 400, 'description' => 'An error occurred while installing the ACK operator chart.'], + ['code' => 'InstanceAccessError', 'message' => 'An error occurred while retrieving the cluster information.', 'http_code' => 400, 'description' => 'Failed to modify the cluster information.'], + ['code' => 'InstanceActivating', 'message' => 'Instance is activating.', 'http_code' => 400, 'description' => 'Instance is activating.'], + ['code' => 'InstanceActivating', 'message' => 'The system is initializing the cluster. Try again later.', 'http_code' => 400, 'description' => 'The system is initializing the cluster. Please try again later.'], + ['code' => 'InstanceCreating', 'message' => 'The cluster is initializing. Please wait.', 'http_code' => 400, 'description' => 'The cluster is being initialized. Please wait.'], + ['code' => 'InstanceDuplicateScheduledTask', 'message' => 'The cluster has an unfinished task. Try again later.', 'http_code' => 400, 'description' => 'The cluster has an unfinished task. Please try again later.'], + ['code' => 'InstanceFieldUnmodifiable', 'message' => 'Column {0} cannot be modified.', 'http_code' => 400, 'description' => 'The specified field {0} cannot be modified.'], + ['code' => 'InstanceHaveNotOpenPublicNetwork', 'message' => 'Public network access is disabled for the specified cluster.', 'http_code' => 400, 'description' => 'Internet access is disabled for the specified cluster.'], + ['code' => 'InstanceNeedRolling', 'message' => 'This function is available only after the specified cluster is restarted.', 'http_code' => 400, 'description' => 'This feature is available only after the specified cluster is restarted.'], + ['code' => 'InstanceNotActive', 'message' => 'The specified cluster status is invalid. Try again later.', 'http_code' => 400, 'description' => 'The specified cluster state is invalid. Please try again later.'], + ['code' => 'InstanceNotFound', 'message' => 'The specified cluster does not exist. Check the cluster status and try again.', 'http_code' => 404, 'description' => 'The specified cluster does not exist. Check the cluster status and try again.'], + ['code' => 'InstanceNotHealth', 'message' => 'This operation is not allowed because the cluster is unhealthy or contains a large number of closed indexes. We recommend that you perform a force update or try again later.', 'http_code' => 400, 'description' => 'This operation is not allowed because the cluster is unhealthy or contains a large number of closed indexes. We recommend that you perform a force update or try again later.'], + ['code' => 'InstanceNotSupportDowngrade', 'message' => 'Cross-zone clusters and subscription instances cannot be scaled in.', 'http_code' => 400, 'description' => 'Cross-zone and subscription clusters cannot be scaled in.'], + ['code' => 'InstanceSetCPFSError', 'message' => 'Elasticsearch Standard clusters do not support cloud paralleled file systems (CPFS).', 'http_code' => 400, 'description' => 'Elasticsearch Standard clusters do not support cloud paralleled file systems (CPFS).'], + ['code' => 'InstanceStatusNotSupportCurrentAction', 'message' => 'The cluster is running tasks or in an error status. Try again later.', 'http_code' => 400, 'description' => 'The cluster is abnormal or has unfinished tasks. Please try again later.'], + ['code' => 'InstanceStatusNotSupportRollback', 'message' => 'The status of the specified cluster does not support rollback.', 'http_code' => 400, 'description' => 'Rollback is not supported while the cluster is in the current state.'], + ['code' => 'instanceStatusUnsupportIndexManageError', 'message' => 'The cluster is being initialized and created. Some features related to index management are not supported.', 'http_code' => 400, 'description' => 'The cluster is being initialized and created. Some features related to index management are not supported.'], + ['code' => 'InstanceTypeNotSupport', 'message' => 'The specified cluster type is not supported.', 'http_code' => 400, 'description' => 'The specified cluster type is not supported.'], + ['code' => 'InstanceUpdating', 'message' => 'The system is updating the cluster. Try again later.', 'http_code' => 400, 'description' => 'The system is updating the cluster. Please try again later.'], + ['code' => 'InstanceZonesDuplicated', 'message' => 'Duplicate zones are selected. Select different zones for deployment.', 'http_code' => 400, 'description' => 'Duplicate zones are selected. Please select different zones for deployment.'], + ['code' => 'InternalServerError', 'message' => 'An internal server error occurred. Try again later.', 'http_code' => 400, 'description' => 'An internal server error occurred. Please try again later.'], + ['code' => 'InterruptNotSupportOnThisPhase', 'message' => 'You cannot pause tasks at the current stage.', 'http_code' => 400, 'description' => 'The specified stage cannot be interrupted.'], + ['code' => 'InterruptTimesOverThanThreshold', 'message' => 'The number of pause times has reached the upper limit.', 'http_code' => 400, 'description' => 'The maximum number of interruptions is reached.'], + ['code' => 'InvalidAliVersion', 'message' => 'The kernel patch version is invalid.', 'http_code' => 400, 'description' => 'The kernel patch version is invalid.'], + ['code' => 'InvalidBlueGreenStrategy', 'message' => 'To ensure the health and data security of the cluster, you cannot perform a blue-green update.', 'http_code' => 400, 'description' => 'To ensure the health and data security of the cluster, you cannot perform a blue-green update.'], + ['code' => 'InvalidClusterResource', 'message' => 'This operation may cause a shard distribution error or insufficient storage, CPU, or memory resources.', 'http_code' => 400, 'description' => 'The operation may cause insufficient disk, CPU, and memory resources for the cluster, or may cause a shard distribution failure.'], + ['code' => 'InvalidClusterSettingsConfig', 'message' => 'Failed to parse number_of_shards and number_of_replicas. Modify the configuration of the settings file.', 'http_code' => 400, 'description' => 'Failed to parse number_of_shards and number_of_replicas. Please modify the configuration of the settings file.'], + ['code' => 'InvalidComponent', 'message' => 'The parameters are invalid. Modify the parameters and try again.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], + ['code' => 'InvalidDeleteTypeParameter', 'message' => 'The input parameter for the cluster release method is invalid.', 'http_code' => 400, 'description' => 'The specified parameter for the cluster release method is invalid.'], + ['code' => 'InvalidDuration', 'message' => 'The subscription duration is invalid.', 'http_code' => 400, 'description' => 'The specified subscription period is invalid.'], + ['code' => 'InvalidEndpoints', 'message' => 'The address format is invalid.', 'http_code' => 400, 'description' => 'The specified endpoint is invalid.'], + ['code' => 'InvalidEsConfig', 'message' => 'The YML configuration is invalid. Check the YML configuration and try again.', 'http_code' => 400, 'description' => 'The YAML configuration is invalid. Please correct the configuration and try again.'], + ['code' => 'InvalidInPlaceStrategy', 'message' => 'To ensure the health and data security of the cluster, you cannot perform an in-place update.', 'http_code' => 400, 'description' => 'To ensure the health and data security of the cluster, you cannot perform an in-place update.'], + ['code' => 'InvalidInstanceType', 'message' => 'The specified cluster type does not meet the requirements.', 'http_code' => 400, 'description' => 'The specified cluster type does not meet the requirements.'], + ['code' => 'InvalidIpList', 'message' => 'The specified IP list is invalid.', 'http_code' => 400, 'description' => 'The specified IP address list is invalid.'], + ['code' => 'InvalidJPDuration', 'message' => 'The subscription duration is invalid.', 'http_code' => 400, 'description' => 'The specified subscription period is invalid.'], + ['code' => 'InvalidLogicTableName', 'message' => 'The logical table name is invalid.', 'http_code' => 400, 'description' => 'The specified logical table name is invalid.'], + ['code' => 'InvalidLogQueryString', 'message' => 'The specified string for log search is invalid.', 'http_code' => 400, 'description' => 'The specified log query string is invalid.'], + ['code' => 'InvalidMaintainTime.format', 'message' => 'The format of the maintenance window is invalid.', 'http_code' => 400, 'description' => 'The specified O&M time format is invalid.'], + ['code' => 'InvalidParameter', 'message' => 'The parameters are invalid. Modify the parameters and try again.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], + ['code' => 'InvalidPaymentType', 'message' => 'The billing method is invalid.', 'http_code' => 400, 'description' => 'The specified billing method is invalid.'], + ['code' => 'InvalidPipelineIds', 'message' => 'The specified pipeline ID is invalid.', 'http_code' => 400, 'description' => 'The specified pipeline ID is invalid.'], + ['code' => 'InvalidPipelineManagementType', 'message' => 'The specified pipeline management mode is invalid.', 'http_code' => 400, 'description' => 'The specified pipeline management mode is invalid.'], + ['code' => 'InvalidPipelineQueueType', 'message' => 'The specified queue type is invalid.', 'http_code' => 400, 'description' => 'The specified queue type is invalid.'], + ['code' => 'InvalidPluginConflictWithSystemPlugin', 'message' => 'The plug-in already exists.', 'http_code' => 400, 'description' => 'The plug-in already exists.'], + ['code' => 'InvalidPluginVersion', 'message' => 'The version of the plug-in is incorrect.', 'http_code' => 400, 'description' => 'The version of the plug-in is incorrect.'], + ['code' => 'InvalidPluginWithoutDescriptorFile', 'message' => 'The description file of the plug-in does not exist.', 'http_code' => 400, 'description' => 'The description file of the plug-in does not exist.'], + ['code' => 'InvalidPluginWithSafetyRisk', 'message' => 'The plug-in has security risks.', 'http_code' => 400, 'description' => 'The plug-in has security risks.'], + ['code' => 'InvalidPricingCycle', 'message' => 'The subscription duration is invalid.', 'http_code' => 400, 'description' => 'The specified subscription period is invalid.'], + ['code' => 'InvalidSecurityToken.Expired', 'message' => 'The security token expires. Check your security token. We recommend that you apply for a security token again.', 'http_code' => 400, 'description' => 'The security token expires. Please check your security token. We recommend that you apply for a security token again.'], + ['code' => 'InvalidVersion', 'message' => 'The current cluster version does not support this action.', 'http_code' => 400, 'description' => 'The current cluster version does not support this operation.'], + ['code' => 'InvalidYamlSettings', 'message' => 'The YML configuration is incompatible. Modify the configuration.', 'http_code' => 400, 'description' => 'The YAML configuration is invalid.'], + ['code' => 'InvalidYamlSettingsPipelineManger', 'message' => 'To modify pipeline management configuration, choose Pipelines in the left-side navigation pane.', 'http_code' => 400, 'description' => 'Go to the pipeline management module to configure the pipeline.'], + ['code' => 'JsonFormatException', 'message' => 'JSON formatting failed.', 'http_code' => 400, 'description' => 'JSON formatting failed.'], + ['code' => 'JvmHeapPercentOnThreshold', 'message' => 'JVM memory is higher than 75%, please limit QPS or upgrade specifications.', 'http_code' => 400, 'description' => 'The JVM memory usage is higher than 75%. Perform traffic throttling or upgrade the specifications.'], + ['code' => 'KibananDiskValueError', 'message' => 'Kibana does not support storage configuration.', 'http_code' => 400, 'description' => 'You cannot configure storage for the Kibana node.'], + ['code' => 'KibanaNodeConfigurationEmtpy', 'message' => 'The configuration of Kibana nodes cannot be blank.', 'http_code' => 400, 'description' => 'You must configure the Kibana node.'], + ['code' => 'ListAckClustersError', 'message' => 'An error occurred while querying the list of ACK clusters.', 'http_code' => 400, 'description' => 'An error occurred while querying the list of ACK clusters.'], + ['code' => 'ListAckNamespacesError', 'message' => 'An error occurred while querying the list of namespaces for the ACK cluster.', 'http_code' => 400, 'description' => 'An error occurred while querying the list of namespaces for the ACK cluster.'], + ['code' => 'ListVpcEndpointsError', 'message' => 'Failed to obtain the endpoint list. Try again later.', 'http_code' => 400, 'description' => 'Failed to obtain the endpoint list. Try again later.'], + ['code' => 'LocalSpecChangeError', 'message' => 'Local specification families cannot be modified.', 'http_code' => 400, 'description' => 'You cannot modify the specification family.'], + ['code' => 'LocalSpecChangeErrorInDetail', 'message' => 'You cannot modify the specifications of %nodeType%.', 'http_code' => 400, 'description' => 'You cannot modify the specifications of %nodeType%s.'], + ['code' => 'MainDictNotSupportDeleting', 'message' => 'The built-in main dictionary or stopword list cannot be deleted.', 'http_code' => 400, 'description' => 'You cannot delete the built-in main dictionary or stopword list.'], + ['code' => 'MasterNodeAmountError', 'message' => 'The number of dedicated master nodes is invalid.', 'http_code' => 400, 'description' => 'The specified number of dedicated master nodes is invalid.'], + ['code' => 'MasterNodeNotEmptyError', 'message' => 'If you have not purchased dedicated master nodes, then you must leave the dedicated master node configuration empty.', 'http_code' => 400, 'description' => 'You have not purchased dedicated master nodes. Leave the configurations for dedicated master nodes empty.'], + ['code' => 'MaximumNumberOfTaskHasBeenReached', 'message' => 'The number of tasks in the project reaches the upper limit. Delete the tasks that you no longer need.', 'http_code' => 400, 'description' => 'The number of tasks in the project has reached the maximum allowable. Please delete the unnecessary tasks.'], + ['code' => 'MultiZonesMustHaveDedicatedMaster', 'message' => 'You must configure dedicated master nodes for clusters created across zones.', 'http_code' => 400, 'description' => 'You must add dedicated master nodes to multi-zone clusters.'], + ['code' => 'MustChangeOneResource', 'message' => 'The configurations remain unchanged. Change one configuration.', 'http_code' => 400, 'description' => 'The configurations remain unchanged. Please change one configuration.'], + ['code' => 'MustChooseOneTypeOfNode', 'message' => 'You must select at least one type of node (data node or warm node).', 'http_code' => 400, 'description' => 'You must select at least one type of node (data node or warm node).'], + ['code' => 'MustHaveAllPartition', 'message' => 'You must specify all partitions.', 'http_code' => 400, 'description' => 'You must specify all the partitions.'], + ['code' => 'MustRemainZone', 'message' => 'You must keep at least one zone enabled.', 'http_code' => 400, 'description' => 'You must retain at least one zone.'], + ['code' => 'NeedUpgradeKibanaSpec', 'message' => 'To install Kibana plug-ins, you must have an Elasticsearch cluster with the minimum specification of 2-core 4 GB. Upgrade your cluster first.', 'http_code' => 400, 'description' => 'To install Kibana plug-ins, you must have an Elasticsearch cluster with the minimum specification of 2-core 4 GB. Upgrade your cluster first.'], + ['code' => 'NetworkValidateFail', 'message' => 'Check whether the VPC and vSwitch are valid and whether they match the selected zone.', 'http_code' => 400, 'description' => 'Check whether the VPC and vSwitch are valid and whether they match the selected zone.'], + ['code' => 'NewEsVersionIsNotSupport', 'message' => 'Failed to upgrade to the specified version. Check whether the specified version is valid.', 'http_code' => 400, 'description' => 'Failed to upgrade to the specified version.'], + ['code' => 'NodeConfigurationAmountError', 'message' => 'The number of the optional nodes (dedicated master nodes, warm nodes, or client nodes) is invalid.', 'http_code' => 400, 'description' => 'The specified number of nodes is invalid.'], + ['code' => 'NodeConfigurationDiskError', 'message' => 'The storage settings of the optional nodes (dedicated master nodes, warm nodes, or client nodes) are invalid. Modify the disk type or storage space.', 'http_code' => 400, 'description' => 'The storage configuration of a node is invalid.'], + ['code' => 'NodeConfigurationEmptyError', 'message' => 'The configuration of the optional nodes (dedicated master nodes, warm nodes, or client nodes) that you purchase cannot be empty.', 'http_code' => 400, 'description' => 'You must configure a node.'], + ['code' => 'NodeConfigurationSecError', 'message' => 'The type of the optional nodes (dedicated master nodes, warm nodes, client nodes, etc.) is invalid.', 'http_code' => 400, 'description' => 'The specifications of a node are invalid.'], + ['code' => 'NodesAmountNotSupportDowngrading', 'message' => 'You cannot reduce the number of %nodeType%s on the configuration upgrade page.', 'http_code' => 400, 'description' => 'You cannot reduce the number of %nodeType%s on the configuration upgrade page.'], + ['code' => 'NodesAmountNotSupportUpgrading', 'message' => 'You cannot increase the number of %nodeType% on the configuration downgrade page.', 'http_code' => 400, 'description' => 'You cannot increase the number of %nodeType%s on the configuration downgrade page.'], + ['code' => 'NoOpenstoreInstance', 'message' => 'This feature supports only clusters for which OpenStore is enabled.', 'http_code' => 400, 'description' => 'This feature supports only clusters for which OpenStore is enabled.'], + ['code' => 'NoPermission.SystemTag', 'message' => 'You do not have permissions to manage system tags.', 'http_code' => 400, 'description' => 'You do not have permissions to manage system tags.'], + ['code' => 'NoPermissionForCurrentFeature', 'message' => 'This operation is not supported at this time. If you need, please contact customer service or apply for a ticket.', 'http_code' => 400, 'description' => 'The operation is not supported. Contact Alibaba Cloud customer services or submit a ticket.'], + ['code' => 'NoRecommendedDiskSize', 'message' => 'No recommendations. Set the storage space based on your business needs or contact Alibaba Cloud customer service.', 'http_code' => 400, 'description' => 'No recommendations. Set the storage space based on your business needs or contact Alibaba Cloud customer services.'], + ['code' => 'NoRecommendedDiskSpecGroup', 'message' => 'No recommendations. Choose the specifications based on your business needs or contact Alibaba Cloud customer service.', 'http_code' => 400, 'description' => 'No recommendations. Choose the specifications based on your business needs or contact Alibaba Cloud customer services.'], + ['code' => 'NoRecommendedInformation', 'message' => 'No recommendations. Choose a configuration based on your business needs or contact Alibaba Cloud customer service.', 'http_code' => 400, 'description' => 'No recommendations. Choose a configuration based on your business needs or contact Alibaba Cloud customer services.'], + ['code' => 'NoRecommendedSpecifications', 'message' => 'No recommendations. Choose the specifications based on your business needs or contact Alibaba Cloud customer service.', 'http_code' => 400, 'description' => 'No recommendations. Choose the specifications based on your business needs or contact Alibaba Cloud customer services.'], + ['code' => 'NoRecoveryBetweenNodes', 'message' => 'A blue-green restart is not triggered, and data is not migrated between nodes.', 'http_code' => 400, 'description' => 'A blue-green restart is not triggered, and data is not migrated between nodes.'], + ['code' => 'NoSuitableNodeAmount', 'message' => 'No recommendations. Set the number of nodes based on your business needs or contact Alibaba Cloud customer service.', 'http_code' => 400, 'description' => 'No recommendations. Set the number of nodes based on your business needs or contact Alibaba Cloud customer service.'], + ['code' => 'NotCurrentRegion', 'message' => 'The region is incorrect.', 'http_code' => 400, 'description' => 'The specified region is invalid.'], + ['code' => 'NotEnoughPrivateIp', 'message' => 'Please modify the virtual switch to ensure enough available ips', 'http_code' => 400, 'description' => 'Insufficient IP addresses. Select another vSwitch.'], + ['code' => 'NotEnoughShrinkableNode', 'message' => 'The nodes in the cluster contain data. You must migrate the data first.', 'http_code' => 400, 'description' => 'The node contains data. Please migrate the data first.'], + ['code' => 'NotEnoughZones', 'message' => 'The current region does not have sufficient zones.', 'http_code' => 400, 'description' => 'The specified region does not have sufficient zones.'], + ['code' => 'NotInstallPlugin', 'message' => 'The specified plug-in is not installed.', 'http_code' => 400, 'description' => 'You have not installed the plug-in.'], + ['code' => 'NotPartitionedTable', 'message' => 'MaxCompute tables must be partitioned.', 'http_code' => 400, 'description' => 'The MaxCompute data source does not have partitions.'], + ['code' => 'NotSetClientNode', 'message' => 'Client node parameters cannot be empty.', 'http_code' => 400, 'description' => 'You must specify the parameters related to the client node.'], + ['code' => 'NotSupportChange', 'message' => 'You cannot modify the following configuration for %nodeType%: %detail%.', 'http_code' => 400, 'description' => 'You cannot modify the following configuration for %nodeType%s: %detail%.'], + ['code' => 'NotSupportDiskDowngrading', 'message' => 'You cannot decrease the sizes or performance levels of disks on the configuration upgrade page. Check the sizes and performance levels of your disks before and after you change the specifications of your disks.', 'http_code' => 400, 'description' => 'You cannot decrease the sizes or performance levels of disks on the configuration upgrade page. Check the sizes and performance levels of your disks before and after you change the specifications of your disks.'], + ['code' => 'NotSupportDiskDowngradingInDetail', 'message' => 'You cannot reduce the storage space of %nodeType%.', 'http_code' => 400, 'description' => 'You cannot reduce the storage space of %nodeType%s.'], + ['code' => 'NotSupportDiskUpgrading', 'message' => 'You cannot increase the sizes or performance levels of disks when you perform a configuration downgrade. Check the sizes and performance levels of your disks before and after you change the specifications of your disks.', 'http_code' => 400, 'description' => 'You cannot increase the sizes or performance levels of disks when you perform a configuration downgrade. Check the sizes and performance levels of your disks before and after you change the specifications of your disks.'], + ['code' => 'NotSupportDiskUpgradingInDetail', 'message' => 'You cannot increase the storage space of %nodeType% when you perform a configuration downgrade.', 'http_code' => 400, 'description' => 'You cannot increase the storage space of %nodeType%s when you perform a configuration downgrade.'], + ['code' => 'NotSupportDowngrading', 'message' => 'The specified version does not support downgrading.', 'http_code' => 400, 'description' => 'The current version does not support downgrading.'], + ['code' => 'NotSupportDowngradingInDetail', 'message' => 'You cannot downgrade the following configuration for %nodeType% on the configuration upgrade page: %detail%.', 'http_code' => 400, 'description' => 'You cannot downgrade the following configuration for %nodeType%s on the configuration upgrade page: %detail%.'], + ['code' => 'NotSupportGCName', 'message' => 'Only G1 and CMS are supported.', 'http_code' => 400, 'description' => 'Only G1 and CMS are supported.'], + ['code' => 'NotSupportLowerSpec', 'message' => 'Cluster downgrading is not supported.', 'http_code' => 400, 'description' => 'Cluster downgrading is not supported.'], + ['code' => 'NotSupportMultipleInstances', 'message' => 'Not supporting multiple clusters at once', 'http_code' => 400, 'description' => 'You cannot purchase multiple clusters at a time.'], + ['code' => 'NotSupportPaymentType', 'message' => 'The specified billing method is not supported.', 'http_code' => 400, 'description' => 'The specified billing method is not supported.'], + ['code' => 'NotSupportUpdateGC', 'message' => 'The current cluster configuration, such as the Elasticsearch version or memory, does not support changing the garbage collection mode.', 'http_code' => 400, 'description' => 'The specified cluster configuration (including version and memory) does not allow GC modification.'], + ['code' => 'NotSupportUpdateSecurityGroup', 'message' => 'The specified clusters do not support changing network configuration.', 'http_code' => 400, 'description' => 'The specified clusters do not support changing network configuration.'], + ['code' => 'NotSupportUpgradingInDetail', 'message' => 'You cannot upgrade the following configuration for %nodeType% on the configuration downgrade page: %detail%.', 'http_code' => 400, 'description' => 'You cannot upgrade the following configuration for %nodeType%s on the configuration downgrade page: %detail%.'], + ['code' => 'OnUserVpcNotSupportPrivateLink', 'message' => 'The network architecture of the cluster does not support internal endpoints. Therefore, an internal endpoint is not required for the cluster.', 'http_code' => 400, 'description' => 'The network architecture of the cluster does not support internal endpoints. Therefore, an internal endpoint is not required for the cluster.'], + ['code' => 'OpenHttpsConflictWithWriteHa', 'message' => 'Clusters with high write availability enabled do not support access over HTTPS.', 'http_code' => 400, 'description' => 'Clusters with high write availability enabled do not support access over HTTPS.'], + ['code' => 'OpenstoreAllocateMustHaveWarmNode', 'message' => 'Before you enable OpenStore or index migration, you must purchase warm nodes.', 'http_code' => 400, 'description' => 'Before you enable OpenStore or index migration, you must purchase warm nodes.'], + ['code' => 'OpenstoreAndAllocateExistAllError', 'message' => 'You can enable either OpenStore or index migration.', 'http_code' => 400, 'description' => 'You can enable either OpenStore or index migration.'], + ['code' => 'OpenstoreLimitAdvancedInstance', 'message' => 'You can enable OpenStore only for clusters of the Advanced Edition.', 'http_code' => 400, 'description' => 'You can enable OpenStore only for clusters of the Advanced Edition.'], + ['code' => 'OpenstoreNotSupportClose', 'message' => 'You are not allowed to disable the OpenStore feature.', 'http_code' => 400, 'description' => 'You are not allowed to disable the OpenStore feature.'], + ['code' => 'OpenstoreUpgradeHaveWarmBefore', 'message' => 'You are not allowed to enable the OpenStore feature for the cluster because the cluster contains warm nodes.', 'http_code' => 400, 'description' => 'You are not allowed to enable the OpenStore feature for the cluster because the cluster contains warm nodes.'], + ['code' => 'OpenstoreWithNoWarm', 'message' => 'You must enable warm nodes before you can use the OpenStore feature.', 'http_code' => 400, 'description' => 'You must enable warm nodes before you can use the OpenStore feature.'], + ['code' => 'OpenstoreWrongVersion', 'message' => 'The OpenStore feature is available for Elasticsearch clusters whose versions are V7.10.0 or later and kernel versions are V1.5.0 or later.', 'http_code' => 400, 'description' => 'The OpenStore feature is available for Elasticsearch clusters whose versions are V7.10.0 or later and kernel versions are V1.5.0 or later.'], + ['code' => 'OpenWriteHaConflictWithHttps', 'message' => 'Clusters with access over HTTPS enabled do not support high write availability.', 'http_code' => 400, 'description' => 'Clusters with access over HTTPS enabled do not support high write availability.'], + ['code' => 'OperationsNotSupported', 'message' => 'The operation is not supported.', 'http_code' => 400, 'description' => 'The operation is not supported.'], + ['code' => 'OperationsNotSupportedForIsolation', 'message' => 'A switchover is being performed for the cluster, and the current operation is not supported.', 'http_code' => 400, 'description' => 'A switchover is being performed for the cluster, and the current operation is not supported.'], + ['code' => 'OssBucketNotExist', 'message' => 'The specified OSS bucket does not exist.', 'http_code' => 400, 'description' => 'The specified OSS bucket does not exist.'], + ['code' => 'OssFileNotExist', 'message' => 'The specified OSS file does not exist.', 'http_code' => 400, 'description' => 'The specified OSS file does not exist.'], + ['code' => 'OssObjectAccessDenied', 'message' => 'You are not authorized to access the specified OSS object.', 'http_code' => 400, 'description' => 'You are not authorized to access the specified OSS object.'], + ['code' => 'OssRequestFail', 'message' => 'An error occurred while retrieving the OSS file information. Check the OSS configuration and try again.', 'http_code' => 400, 'description' => 'An error occurred while retrieving the OSS file information. Check the OSS configuration and try again.'], + ['code' => 'OssSaveObjectFail', 'message' => 'An error occurred while saving the OSS object.', 'http_code' => 400, 'description' => 'An error occurred while saving the OSS object.'], + ['code' => 'OverdueInstanceUnsupportError', 'message' => 'You cannot recover release protection for clusters in the overdue or silent state.', 'http_code' => 400, 'description' => 'You cannot recover release protection for clusters in the overdue or silent state.'], + ['code' => 'ParameterTagInvalid', 'message' => 'The format of the parameter tag is invalid.', 'http_code' => 400, 'description' => 'The format of the parameter tag is invalid.'], + ['code' => 'PartitionEmptyError', 'message' => 'You must specify a partition.', 'http_code' => 400, 'description' => 'You must specify a partition.'], + ['code' => 'PartitionError', 'message' => 'MaxCompute tables must be partitioned, and you must specify all partitions and separate them with commas (,).', 'http_code' => 400, 'description' => 'MaxCompute tables must be partitioned, and you must specify all partitions and separate them with commas (,).'], + ['code' => 'PartitionLackEqual', 'message' => 'An equal sign (=) was missing from the partition configuration.', 'http_code' => 400, 'description' => 'An equal sign (=) was missing from the partition configuration.'], + ['code' => 'PartitionNotSupportSemicolon', 'message' => 'Use commas (,) to separate partitions.', 'http_code' => 400, 'description' => 'Use commas (,) to separate partitions.'], + ['code' => 'PathNotExist', 'message' => 'The specified path does not exist. Check the path and try again.', 'http_code' => 400, 'description' => 'The specified path does not exist. Check the path and try again.'], + ['code' => 'PipelineInvalidJDBCDriverConfig', 'message' => 'Add allowLoadLocalInfile=false&autoDeserialize=false to the JDBC connect string.', 'http_code' => 400, 'description' => 'Add allowLoadLocalInfile=false&autoDeserialize=false to the JDBC connect string.'], + ['code' => 'PipelineIsNotRunning', 'message' => 'The task is stopped.', 'http_code' => 400, 'description' => 'The task is stopped.'], + ['code' => 'PipelineIsRunning', 'message' => 'The task is running. Try again later.', 'http_code' => 400, 'description' => 'The task is running. Try again later.'], + ['code' => 'PluginCanNotInstall', 'message' => 'An error occurred while querying the status of the plug-in. Try again later.', 'http_code' => 400, 'description' => 'An error occurred while querying the status of the plug-in. Try again later.'], + ['code' => 'PluginHaveInstalledOrInstalling', 'message' => 'The specified plug-in is already installed.', 'http_code' => 400, 'description' => 'The specified plug-in is already installed.'], + ['code' => 'PluginNeedHighSpecification', 'message' => 'To install plug-ins such as analysis-aliws, you must upgrade all nodes in the cluster to 2-core 4 GB or higher. To install plug-ins such as aliyun-knn, you must upgrade all nodes to 2-core 8 GB or higher.', 'http_code' => 400, 'description' => 'To install plug-ins such as analysis-aliws, you must upgrade all nodes in the cluster to 2-core 4 GB or higher. To install plug-ins such as aliyun-knn, you must upgrade all nodes to 2-core 8 GB or higher.'], + ['code' => 'PostonlyOrTokenError', 'message' => 'The logon times out. Refresh the page or log on to the console again.', 'http_code' => 400, 'description' => 'The logon times out. Refresh the page or log on to the console again.'], + ['code' => 'ProjectChannelError', 'message' => 'The specified resource type for the project is invalid.', 'http_code' => 400, 'description' => 'The specified resource type for the project is invalid.'], + ['code' => 'ProjectComputeUnitLimit', 'message' => 'The specified resource allocation setting for the project is invalid.', 'http_code' => 400, 'description' => 'The specified resource allocation setting for the project is invalid.'], + ['code' => 'ProjectCountLimit', 'message' => 'The number of projects exceeds the upper limit.', 'http_code' => 400, 'description' => 'The number of projects exceeds the upper limit.'], + ['code' => 'ProjectNotEnoughComputeUnit', 'message' => 'The project does not have sufficient CUs.', 'http_code' => 400, 'description' => 'The project does not have sufficient CUs.'], + ['code' => 'ProjectNotExist', 'message' => 'The project does not exist.', 'http_code' => 400, 'description' => 'The project does not exist.'], + ['code' => 'PublicNetworkWhiteIpsCanNotBeEmpty', 'message' => 'The public network whitelist cannot be empty.', 'http_code' => 400, 'description' => 'The public network whitelist cannot be empty.'], + ['code' => 'QuotaExceed.TagsPerResource', 'message' => 'You can bind no more than 20 tags to each resource.', 'http_code' => 400, 'description' => 'You can bind no more than 20 tags to each resource.'], + ['code' => 'RdsAssumeRoleError', 'message' => 'An error occurred while accessing the RDS instance. Check whether Elasticsearch is authorized to access the RDS instance.', 'http_code' => 400, 'description' => 'An error occurred while accessing the RDS instance. Check whether Elasticsearch is authorized to access the RDS instance.'], + ['code' => 'RdsInstanceTypeNotSupport', 'message' => 'The RDS instance must be a primary instance.', 'http_code' => 400, 'description' => 'The RDS instance must be a primary instance.'], + ['code' => 'RdsNetWorkNotSupport', 'message' => 'The network of the RDS source instance is not supported. Select another source instance.', 'http_code' => 400, 'description' => 'The network of the RDS source instance is not supported. Select another source instance.'], + ['code' => 'RdsVersionNotSupport', 'message' => 'The version of the RDS source instance is not supported. Select another source instance.', 'http_code' => 400, 'description' => 'The version of the RDS source instance is not supported. Select another source instance.'], + ['code' => 'RegionNotSupportError', 'message' => 'You have not opened this area yet, please contact the supplier if necessary, or switch the area.', 'http_code' => 400, 'description' => 'You have not opened this area yet, please contact the supplier if necessary, or switch the area.'], + ['code' => 'RegionNotSupportFinanceUserError', 'message' => 'You are a Finance Cloud user. Only Finance Cloud regions are supported.', 'http_code' => 400, 'description' => 'You are a Finance Cloud user. Only Finance Cloud regions are supported.'], + ['code' => 'RegionNotSupportPublicCloudUserError', 'message' => 'You are a Public Cloud user. Only Public Cloud regions are supported.', 'http_code' => 400, 'description' => 'You are a Public Cloud user. Only Public Cloud regions are supported.'], + ['code' => 'RegisterDomainPartFail', 'message' => 'An error occurred while registering domain part.', 'http_code' => 400, 'description' => 'An error occurred while registering domain part.'], + ['code' => 'RegisterDomainPartFial', 'message' => 'An error occurred while registering domain part.', 'http_code' => 400, 'description' => 'An error occurred while registering domain part.'], + ['code' => 'ReindexIndexSameError', 'message' => 'The source and destination of the Reindex task must use the same index.', 'http_code' => 400, 'description' => 'The source and destination of the Reindex task must use the same index.'], + ['code' => 'ReindexVpcNotSameError', 'message' => 'The source and destination clusters of the Reindex task must be connected to the same VPC.', 'http_code' => 400, 'description' => 'The source and destination clusters of the Reindex task must be connected to the same VPC.'], + ['code' => 'ReleasePrepaidInstancePermissionDenied', 'message' => 'Subscription services cannot be deleted.', 'http_code' => 400, 'description' => 'Subscription services cannot be deleted.'], + ['code' => 'RemainNodeTooLess', 'message' => 'You must reserve more than two nodes.', 'http_code' => 400, 'description' => 'You must reserve more than two nodes.'], + ['code' => 'RemoveZoneFromVpcEndpointError', 'message' => 'Failed to delete the associated zone for the endpoint. Try again later.', 'http_code' => 400, 'description' => 'Failed to delete the associated zone for the endpoint. Try again later.'], + ['code' => 'RestartNodeNolHosts', 'message' => 'No node is specified for restart.', 'http_code' => 400, 'description' => 'No node is specified for restart.'], + ['code' => 'ResTypeInvalid', 'message' => 'The collector type is invalid.', 'http_code' => 400, 'description' => 'The collector type is invalid.'], + ['code' => 'ResVersionInvalid', 'message' => 'The collector version is invalid.', 'http_code' => 400, 'description' => 'The collector version is invalid.'], + ['code' => 'SchemaValidateError', 'message' => 'The parameters are invalid. Modify the parameters and try again.', 'http_code' => 400, 'description' => 'The parameters are invalid. Modify the parameters and try again.'], + ['code' => 'SendVerifyCodeError', 'message' => 'Too many verification code requests. Try again later.', 'http_code' => 400, 'description' => 'Too many verification code requests. Try again later.'], + ['code' => 'ServiceUnavailable', 'message' => 'Access timed out. Try again.', 'http_code' => 400, 'description' => 'Access timed out. Try again.'], + ['code' => 'ShrinkNodeCountEmpty', 'message' => 'You must specify the nodes to be scaled in.', 'http_code' => 400, 'description' => 'You must specify the nodes to be scaled in.'], + ['code' => 'ShrinkNodeCountInvalid', 'message' => 'The number of nodes that you remove must be a multiple of the number of zones, and the number of nodes that you reserve must be greater than two.', 'http_code' => 400, 'description' => 'The number of nodes that you remove must be a multiple of the number of zones, and the number of nodes that you reserve must be greater than two.'], + ['code' => 'ShrinkNodeCountMustEqualEachZone', 'message' => 'You must scale in the same number of nodes in all zones.', 'http_code' => 400, 'description' => 'You must scale in the same number of nodes in all zones.'], + ['code' => 'ShrinkNodeRepeatHost', 'message' => 'Do not specify a node twice.', 'http_code' => 400, 'description' => 'Do not specify a node twice.'], + ['code' => 'SinkDataSourceInformationEmpty', 'message' => 'The connection information of the target cluster is empty.', 'http_code' => 400, 'description' => 'The connection information of the target cluster is empty.'], + ['code' => 'SinkTypenameNotMatchMappings', 'message' => 'The type differs from that in the mapping configuration.', 'http_code' => 400, 'description' => 'The type differs from that in the mapping configuration.'], + ['code' => 'SlsAssumeRoleError', 'message' => 'Check whether Elasticsearch is authorized to access the source instance.', 'http_code' => 400, 'description' => 'Check whether Elasticsearch is authorized to access the source instance.'], + ['code' => 'SnapshotRepoIsExist', 'message' => 'The specified repository already exists.', 'http_code' => 400, 'description' => 'The specified repository already exists.'], + ['code' => 'SnapshotRepoIsNotExist', 'message' => 'The specified repository does not exist.', 'http_code' => 400, 'description' => 'The specified repository does not exist.'], + ['code' => 'SnapshotRepoNotAvailableError', 'message' => 'The specified repository is unavailable.', 'http_code' => 400, 'description' => 'The specified repository is unavailable.'], + ['code' => 'SnapshotSettingCanNotBeNull', 'message' => 'The snapshot configuration cannot be empty.', 'http_code' => 400, 'description' => 'The snapshot configuration cannot be empty.'], + ['code' => 'SnapshotSettingQuartzExpressionError', 'message' => 'The snapshot period configuration is invalid.', 'http_code' => 400, 'description' => 'The snapshot period configuration is invalid.'], + ['code' => 'SourceDataSourceInformationEmpty', 'message' => 'The connection information of the source cluster is empty.', 'http_code' => 400, 'description' => 'The connection information of the source cluster is empty.'], + ['code' => 'SpecInvalidErrorInDetail', 'message' => 'You cannot purchase the %detail% specifications for %nodeType%.', 'http_code' => 400, 'description' => 'You cannot purchase the %detail% specifications for %nodeType%.'], + ['code' => 'SpecNotSupportDowngrading', 'message' => 'You cannot reduce vCPUs or memory specifications for %nodeType% on the configuration upgrade page.', 'http_code' => 400, 'description' => 'You cannot reduce vCPUs or memory specifications for %nodeType% on the configuration upgrade page.'], + ['code' => 'SpecNotSupportUpgrading', 'message' => 'You cannot increase vCPU or memory specifications for %nodeType% on the configuration downgrade page.', 'http_code' => 400, 'description' => 'You cannot increase vCPU or memory specifications for %nodeType% on the configuration downgrade page.'], + ['code' => 'StsRoleAccountNoPermission', 'message' => 'The role account has no permission or has expired. Please grant the role relevant permissions and make sure that the operation is complete before the permissions expire.', 'http_code' => 401, 'description' => ''], + ['code' => 'StsRoleAccountNoPermission', 'message' => 'The specified role is not authorized or the authorization has expired.', 'http_code' => 401, 'description' => 'The specified role is not authorized or the authorization has expired.'], + ['code' => 'SubAccountNoPermission', 'message' => 'The RAM user has no permission. Please verify the RAM user permissions.', 'http_code' => 401, 'description' => ''], + ['code' => 'SubAccountNoPermission', 'message' => 'The specified RAM user is not authorized. Check the permission of the RAM user and try again.', 'http_code' => 400, 'description' => 'The specified RAM user is not authorized. Check the permission of the RAM user and try again.'], + ['code' => 'SystemCircuitBreaker', 'message' => 'The system is being upgraded. Cluster creation and update operations are not allowed. Please try again later.', 'http_code' => 400, 'description' => 'The system is being upgraded. Cluster creation and update operations are not allowed. Please try again later.'], + ['code' => 'TargetIndexDuplication', 'message' => 'The specified index name already exists.', 'http_code' => 400, 'description' => 'The specified index name already exists.'], + ['code' => 'TargetInstanceHaveConnected', 'message' => 'The specified cluster is already interconnected.', 'http_code' => 400, 'description' => 'The specified cluster is already interconnected.'], + ['code' => 'TargetInstanceIsInvalid', 'message' => 'The specified cluster is invalid.', 'http_code' => 400, 'description' => 'The specified cluster is invalid.'], + ['code' => 'TargetInstanceIsNotConnected', 'message' => 'The submitted cluster is not interconnected.', 'http_code' => 400, 'description' => 'The submitted cluster is not interconnected.'], + ['code' => 'TargetInstanceStatusNotSupportCurrentAction', 'message' => 'The status of the specified cluster is unavailable. Try again later.', 'http_code' => 400, 'description' => 'The status of the specified cluster is unavailable. Try again later.'], + ['code' => 'templateUnsupported', 'message' => 'The template is not supported. Please change the template name.', 'http_code' => 400, 'description' => 'The template is not supported. Please change the template name.'], + ['code' => 'TheComponetsInfoCodeNotSupport', 'message' => 'The field name is invalid.', 'http_code' => 400, 'description' => 'The field name is invalid.'], + ['code' => 'TheDatasourceNotExistCurrentIndex', 'message' => 'The index name does not exist.', 'http_code' => 400, 'description' => 'The index name does not exist.'], + ['code' => 'TheDatasourceNotExistCurrentType', 'message' => 'The type name does not exist.', 'http_code' => 400, 'description' => 'The type name does not exist.'], + ['code' => 'TheEsVersionCanNotSupportUpgrade', 'message' => 'The current version cannot be upgraded.', 'http_code' => 400, 'description' => 'The current version cannot be upgraded.'], + ['code' => 'TheForceRollingActionConflict', 'message' => 'After you change the disk type of nodes, a blue-green restart is triggered. To ensure data security, you are not allowed to turn on Forced Update.', 'http_code' => 400, 'description' => 'After you change the disk type of nodes, a blue-green restart is triggered. To ensure data security, you are not allowed to turn on Forced Update.'], + ['code' => 'TheInstanceVersionNotSupportNewElasticNode', 'message' => 'When you upgrade the configuration of a Standard Edition or Community Edition cluster, you are not allowed to purchase elastic nodes for the cluster.', 'http_code' => 400, 'description' => 'When you upgrade the configuration of a Standard Edition or Community Edition cluster, you are not allowed to purchase elastic nodes for the cluster.'], + ['code' => 'TheNumberOfWhiteListExceedsTheLimit', 'message' => 'You can add no more than 300 IP addresses to the whitelist.', 'http_code' => 400, 'description' => 'You can add no more than 300 IP addresses to the whitelist.'], + ['code' => 'TheOpenstoreNeedSnapshotFunc', 'message' => 'OpenStore depends on the Auto Snapshot feature. Therefore, before you enable OpenStore, you must enable the Auto Snapshot feature.', 'http_code' => 400, 'description' => 'OpenStore depends on the Auto Snapshot feature. Therefore, before you enable OpenStore, you must enable the Auto Snapshot feature.'], + ['code' => 'TheOperatorNotSupportInterrupt', 'message' => 'You cannot pause the current operation.', 'http_code' => 400, 'description' => 'You cannot pause the current operation.'], + ['code' => 'TheSpecAvailableInDetail', 'message' => 'The %nodeType% of the %detail% specifications in the zones are insufficient. Select other specifications.', 'http_code' => 400, 'description' => 'The %nodeType% of the %detail% specifications in the zones are insufficient. Select other specifications.'], + ['code' => 'TheSpecNotEnough', 'message' => 'No quota is available for the selected specification in this zone. Select another specification or change the zone.', 'http_code' => 400, 'description' => 'No quota is available for the selected specification in this zone. Select another specification or change the zone.'], + ['code' => 'TheSpecNotEnoughInDetail', 'message' => 'The %nodeType% of the %detail% specifications are insufficient in the %areaId% zone. Select other specifications or another zone.', 'http_code' => 400, 'description' => 'The %nodeType% of the %detail% specifications are insufficient in the %areaId% zone. Select other specifications or another zone.'], + ['code' => 'TransferSameZone', 'message' => 'You cannot migrate nodes to the zones that are already used by the current cluster.', 'http_code' => 400, 'description' => 'You cannot migrate nodes to the zones that are already used by the current cluster.'], + ['code' => 'TriggerPipelineFail', 'message' => 'An error occurred while starting the task.', 'http_code' => 400, 'description' => 'An error occurred while starting the task.'], + ['code' => 'UnknownDataSourceType', 'message' => 'An error occurred while obtaining the source instance type.', 'http_code' => 400, 'description' => 'An error occurred while obtaining the source instance type.'], + ['code' => 'UnknownPluginStatusError', 'message' => 'An error occurred while obtaining the status of the plug-in.', 'http_code' => 400, 'description' => 'An error occurred while obtaining the status of the plug-in.'], + ['code' => 'UnrecognizedDatasource', 'message' => 'The data source type is invalid.', 'http_code' => 400, 'description' => 'The data source type is invalid.'], + ['code' => 'UpdateInstanceDictFail', 'message' => 'An error occurred while updating the dictionary.', 'http_code' => 400, 'description' => 'An error occurred while updating the dictionary.'], + ['code' => 'UpdateKibanaWhiteIpsFail', 'message' => 'An error occurred while updating the Kibana whitelist.', 'http_code' => 400, 'description' => 'An error occurred while updating the Kibana whitelist.'], + ['code' => 'UpdateLogEnhanceNeedOpenstore', 'message' => 'Before you upgrade your cluster from the Standard Edition to the Advanced Edition, you must enable OpenStore.', 'http_code' => 400, 'description' => 'Before you upgrade your cluster from the Standard Edition to the Advanced Edition, you must enable OpenStore.'], + ['code' => 'UpdatePublicWhiteIpsFail', 'message' => 'An error occurred while updating the public network whitelist.', 'http_code' => 400, 'description' => 'An error occurred while updating the public network whitelist.'], + ['code' => 'UpdateRdsSecurityIpsFail', 'message' => 'An error occurred while editing the RDS whitelist. Check whether Elasticsearch is authorized to access the RDS instance.', 'http_code' => 400, 'description' => 'An error occurred while editing the RDS whitelist. Check whether Elasticsearch is authorized to access the RDS instance.'], + ['code' => 'upgradeVersionMustFromConsole', 'message' => 'You cannot change the Elasticsearch version on the buy page. If you want to upgrade the Elasticsearch version, use the console.', 'http_code' => 400, 'description' => 'You cannot change the Elasticsearch version on the buy page. If you want to upgrade the Elasticsearch version, use the console.'], + ['code' => 'UploadDictFileInfoEmpty', 'message' => 'The path of the dictionary file to be uploaded is invalid.', 'http_code' => 400, 'description' => 'The path of the dictionary file to be uploaded is invalid.'], + ['code' => 'UploadDictFileTypeError', 'message' => 'The format of the dictionary file that you upload is not supported.', 'http_code' => 400, 'description' => 'The format of the dictionary file that you upload is not supported.'], + ['code' => 'UploadFileCountExceedMaxNumber', 'message' => 'The number of files that you upload exceeds the upper limit.', 'http_code' => 400, 'description' => 'The number of files that you upload exceeds the upper limit.'], + ['code' => 'UploadFileInfoEmpty', 'message' => 'No file information is specified.', 'http_code' => 400, 'description' => 'No file information is specified.'], + ['code' => 'UploadFileSumSizeExceedMasterMaxSize', 'message' => 'The total size of the dictionary files that can be uploaded to an Elasticsearch cluster with dedicated master nodes cannot be greater than 10 MB.', 'http_code' => 400, 'description' => 'The total size of the dictionary files that can be uploaded to an Elasticsearch cluster with dedicated master nodes cannot be greater than 10 MB.'], + ['code' => 'UploadFileSumSizeExceedMaxSize', 'message' => 'The total size of the files that you upload exceeds the upper limit.', 'http_code' => 400, 'description' => 'The total size of the files that you upload exceeds the upper limit.'], + ['code' => 'UploadFileTypeError', 'message' => 'Only the following formats are supported: %type_list%', 'http_code' => 400, 'description' => 'Only the following formats are supported: %type_list%'], + ['code' => 'UploadOriginDictNotExist', 'message' => 'The original dictionary file does not exist.', 'http_code' => 400, 'description' => 'The original dictionary file does not exist.'], + ['code' => 'UploadOriginNotExist', 'message' => 'The specified file does not exist. Please check the file name and type.', 'http_code' => 400, 'description' => 'The specified file does not exist. Please check the file name and type.'], + ['code' => 'UploadTypeError', 'message' => 'The specified file type is invalid.', 'http_code' => 400, 'description' => 'The specified file type is invalid.'], + ['code' => 'UserNotLogin', 'message' => 'You must log on first.', 'http_code' => 400, 'description' => 'You must log on first.'], + ['code' => 'UserNotOpen', 'message' => 'The user has not activated the function.', 'http_code' => 401, 'description' => ''], + ['code' => 'UserNotOpen', 'message' => 'You must activate Elasticsearch first.', 'http_code' => 400, 'description' => 'You must activate Elasticsearch first.'], + ['code' => 'UserPluginInvalidError', 'message' => 'Invalid plug-in: You cannot install a built-in plug-in. Make sure that the plug-in version is consistent with the cluster version. The ZIP file must be complete and not encrypted.', 'http_code' => 400, 'description' => 'Invalid plug-in: You cannot install a built-in plug-in. Make sure that the plug-in version is consistent with the cluster version. The ZIP file must be complete and not encrypted.'], + ['code' => 'UserUnauthorized', 'message' => 'User authentication failed. Please log on first and check permissions.', 'http_code' => 401, 'description' => ''], + ['code' => 'UserUnauthorized', 'message' => 'An error occurred while validating the user. Log on, check the permission, and try again.', 'http_code' => 400, 'description' => 'An error occurred while validating the user. Log on, check the permission, and try again.'], + ['code' => 'ValidateMappingSettingError', 'message' => 'A Mapping or Setting error occurred.', 'http_code' => 400, 'description' => 'A Mapping or Setting error occurred.'], + ['code' => 'ValidatorDataSourceError', 'message' => 'An error occurred while validating the source instance.', 'http_code' => 400, 'description' => 'An error occurred while validating the source instance.'], + ['code' => 'VpcEndpointAlreadyExisted', 'message' => 'The endpoint connected to the selected endpoint service and zone already exists. Therefore, the endpoint does not need to be created again.', 'http_code' => 400, 'description' => 'The endpoint connected to the selected endpoint service and zone already exists. Therefore, the endpoint does not need to be created again.'], + ['code' => 'VpcEndpointNotMatch', 'message' => 'The ID of the endpoint for the operation is not found. Confirm and try again.', 'http_code' => 400, 'description' => 'The ID of the endpoint for the operation is not found. Confirm and try again.'], + ['code' => 'VpcEndpointZoneNotMatch', 'message' => 'The zone entry of the cluster does not match the zone associated with the endpoint service. Confirm and try again.', 'http_code' => 400, 'description' => 'The zone entry of the cluster does not match the zone associated with the endpoint service. Confirm and try again.'], + ['code' => 'VpcNotFound', 'message' => 'The specified VPC network does not exist.', 'http_code' => 404, 'description' => 'The specified VPC network does not exist.'], + ['code' => 'VSwitchNotFound', 'message' => 'The specified vSwitch does not exist.', 'http_code' => 404, 'description' => 'The specified vSwitch does not exist.'], + ['code' => 'WarmNodeAmountNotMatchZoneCount', 'message' => 'The number of warm nodes must be a multiple of the number of zones.', 'http_code' => 400, 'description' => 'The number of warm nodes must be a multiple of the number of zones.'], + ['code' => 'WarmNodeAmountValidateFail', 'message' => 'The number of warm nodes must range from 2 to 50 and must be a multiple of the number of zones.', 'http_code' => 400, 'description' => 'The number of warm nodes must range from 2 to 50 and must be a multiple of the number of zones.'], + ['code' => 'WarmNodeCannotChangeSpecGroup', 'message' => 'The specifications of warm nodes cannot be changed because the specifications belong to a different category.', 'http_code' => 400, 'description' => 'The specifications of warm nodes cannot be changed because the specifications belong to a different category.'], + ['code' => 'WarmNodeChangeDiskTypeError', 'message' => 'The disk type of warm nodes cannot be changed.', 'http_code' => 400, 'description' => 'The disk type of warm nodes cannot be changed.'], + ['code' => 'WarmNodeDiskOver', 'message' => 'The warm node storage space exceeds the upper limit.', 'http_code' => 400, 'description' => 'The warm node storage space exceeds the upper limit.'], + ['code' => 'WarmNodeEmptyError', 'message' => 'The warm node configuration cannot be empty.', 'http_code' => 400, 'description' => 'The warm node configuration cannot be empty.'], + ['code' => 'WarmNodeLocalSpecValidateDiskFail', 'message' => 'Storage is not required because warm nodes with the specifications already have storage.', 'http_code' => 400, 'description' => 'Storage is not required because warm nodes with the specifications already have storage.'], + ['code' => 'WarmNodeNotEmptyError', 'message' => 'If you have not purchased warm nodes, then you must leave the warm node configuration empty.', 'http_code' => 400, 'description' => 'If you have not purchased warm nodes, then you must leave the warm node configuration empty.'], + ['code' => 'WarmNodeSpecValidateFail', 'message' => 'The specifications are not supported. Please choose other specifications.', 'http_code' => 400, 'description' => 'The specifications are not supported. Please choose other specifications.'], + ['code' => 'WarmNodeValidateDiskFail', 'message' => 'The storage space per warm node is incorrect.', 'http_code' => 400, 'description' => 'The storage space per warm node is incorrect.'], + ['code' => 'WhiteIpGroupGroupsExceedLimit', 'message' => 'The number of IP address whitelist groups exceeds the upper limit. Merge some of the IP address whitelist groups and try again.', 'http_code' => 400, 'description' => 'The number of IP address whitelist groups exceeds the upper limit. Merge some of the IP address whitelist groups and try again.'], + ['code' => 'WhiteIpGroupIpsExceedLimit', 'message' => 'The number of IP addresses in the whitelist group exceeds the upper limit. Delete some of the IP addresses and try again.', 'http_code' => 400, 'description' => 'The number of IP addresses in the whitelist group exceeds the upper limit. Delete some of the IP addresses and try again.'], + ['code' => 'WhiteIpGroupNameInvalid', 'message' => 'The name of the IP address whitelist group does not meet the requirements. Modify the name and try again.', 'http_code' => 400, 'description' => 'The name of the IP address whitelist group does not meet the requirements. Modify the name and try again.'], + ['code' => 'WhiteIpGroupNameNotMatch', 'message' => 'The IP address whitelist group is not found. Confirm and try again.', 'http_code' => 400, 'description' => 'The IP address whitelist group is not found. Confirm and try again.'], + ['code' => 'WhiteIpListCanNotBeEmpty', 'message' => 'The IP whitelist cannot be empty.', 'http_code' => 400, 'description' => 'The IP whitelist cannot be empty.'], + ['code' => 'WhiteIpListCanNotChangeWithIpGroup', 'message' => 'You cannot modify the IP address whitelists based on both the list of whitelists and the whitelist groups.', 'http_code' => 400, 'description' => 'You cannot modify the IP address whitelists based on both the list of whitelists and the whitelist groups.'], + ['code' => 'WhiteIpTypeCanNotBeEmpty', 'message' => 'The whiteIpType parameter of the selected group cannot be empty. Specify the parameter and try again.', 'http_code' => 400, 'description' => 'The whiteIpType parameter of the selected group cannot be empty. Specify the parameter and try again.'], + ['code' => 'WithIncompatibleElasticsearchPlugins', 'message' => 'The existing plug-in configuration is not compatible with the target version. If you have custom plug-ins, uninstall them before you proceed.', 'http_code' => 400, 'description' => 'The existing plug-in configuration is not compatible with the target version. If you have custom plug-ins, uninstall them before you proceed.'], + ['code' => 'WithInvalidElasticsearchSnapshots', 'message' => 'No cluster snapshot is generated in the last hour. Create snapshots.', 'http_code' => 400, 'description' => 'No cluster snapshot is generated in the last hour. Create snapshots.'], + ['code' => 'WriteHaDeedHighSpec', 'message' => 'High write availability is suitable for clusters with data node specifications of two vCPUs and 4 GiB of memory or higher.', 'http_code' => 400, 'description' => 'High write availability is suitable for clusters with data node specifications of two vCPUs and 4 GiB of memory or higher.'], + ['code' => 'ZoneCountChangeError', 'message' => 'The number of zones cannot be modified.', 'http_code' => 400, 'description' => 'The number of zones cannot be modified.'], + ['code' => 'ZoneCountValueError', 'message' => 'The number of zones is invalid.', 'http_code' => 400, 'description' => 'The number of zones is invalid.'], + ['code' => 'ZoneNotSupport', 'message' => 'This Zone is not supported at this time', 'http_code' => 400, 'description' => 'This Zone is not supported at this time'], + ['code' => 'ZoneValueError', 'message' => 'You can only switch to the zones where the data nodes are deployed.', 'http_code' => 400, 'description' => 'You can only switch to the zones where the data nodes are deployed.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'EnableKibanaPvlNetwork'], + ['description' => 'Request parameters changed', 'api' => 'UpdateInstanceChargeType'], + ['description' => 'Request parameters changed', 'api' => 'UpdateInstanceSettings'], + ['description' => 'Request parameters changed', 'api' => 'UpdateKibanaPvlNetwork'], + ], + 'createdAt' => '2025-12-03T08:11:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ], + 'createdAt' => '2025-10-31T03:31:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateInstanceSettings'], + ], + 'createdAt' => '2025-02-25T10:37:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpgradeEngineVersion'], + ], + 'createdAt' => '2025-01-02T09:10:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListInstance'], + ], + 'createdAt' => '2024-12-10T03:22:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRegionConfiguration'], + ], + 'createdAt' => '2024-12-06T07:57:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpgradeEngineVersion'], + ], + 'createdAt' => '2024-11-21T06:37:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ], + 'createdAt' => '2024-09-10T08:49:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdatePipelineManagementConfig'], + ], + 'createdAt' => '2024-08-07T03:24:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpgradeEngineVersion'], + ], + 'createdAt' => '2024-07-31T09:50:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateLogstash'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePipelineManagementConfig'], + ], + 'createdAt' => '2024-07-04T03:25:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateSnapshot'], + ], + 'createdAt' => '2024-06-27T03:19:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListInstance'], + ], + 'createdAt' => '2024-06-04T07:17:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInstance'], + ], + 'createdAt' => '2024-06-03T07:34:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'ListInstance'], + ], + 'createdAt' => '2024-05-10T04:09:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetRegionConfiguration'], + ], + 'createdAt' => '2024-04-16T05:55:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'RecommendTemplates'], + ['description' => 'Error codes changed', 'api' => 'ValidateSlrPermission'], + ], + 'createdAt' => '2024-04-09T11:50:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteILMPolicy'], + ], + 'createdAt' => '2024-04-09T04:53:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'createInstance'], + ], + 'createdAt' => '2023-11-20T08:07:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UninstallPlugin'], + ], + 'createdAt' => '2023-09-13T15:34:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetEmonGrafanaAlerts'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetEmonGrafanaDashboards'], + ], + 'createdAt' => '2022-12-28T10:33:44.000Z', + 'description' => '战役治理', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCollector'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateIndexTemplate'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDeprecatedTemplate'], + ], + 'createdAt' => '2022-12-28T07:22:50.000Z', + 'description' => 'DeleteDeprecatedTemplate、CreateIndexTemplate、CreateCollector补充API参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDataTasks'], + ], + 'createdAt' => '2022-12-16T10:39:07.000Z', + 'description' => '文档对齐', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateDataTasks'], + ['description' => 'Request parameters changed', 'api' => 'CreateLogstash'], + ['description' => 'Request parameters changed', 'api' => 'ListInstanceHistoryEvents'], + ['description' => 'Request parameters changed', 'api' => 'ListLogstash'], + ], + 'createdAt' => '2022-12-16T09:45:12.000Z', + 'description' => 'API文档字段补充', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'createInstance'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDeprecatedTemplate'], + ['description' => 'Request parameters changed', 'api' => 'TriggerNetwork'], + ], + 'createdAt' => '2022-12-13T08:50:55.000Z', + 'description' => '字段必填', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpgradeEngineVersion'], + ], + 'createdAt' => '2022-12-06T03:13:56.000Z', + 'description' => 'UpgradeVersion 枚举值更新', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpgradeEngineVersion'], + ], + 'createdAt' => '2022-12-01T08:52:52.000Z', + 'description' => '增加文档注释', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddConnectableCluster'], + ['description' => 'Error codes changed', 'api' => 'DeleteConnectedCluster'], + ['description' => 'Error codes changed', 'api' => 'DeleteInstance'], + ['description' => 'Error codes changed', 'api' => 'DeleteLogstash'], + ['description' => 'Error codes changed', 'api' => 'MigrateToOtherZone'], + ], + 'createdAt' => '2022-09-29T17:14:24.000Z', + 'description' => '记录返回日志', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeInstance'], + ['description' => 'Response parameters changed', 'api' => 'ListInstance'], + ], + 'createdAt' => '2022-09-27T11:55:02.000Z', + 'description' => 'ListIntstacen/DescribeInstance 增加返回参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateInstance'], + ], + 'createdAt' => '2022-09-27T11:49:21.000Z', + 'description' => 'UpdateInstance 补齐body API参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CancelDeletion'], + ['description' => 'Request parameters changed', 'api' => 'CancelLogstashDeletion'], + ['description' => 'Request parameters changed', 'api' => 'CancelTask'], + ['description' => 'Request parameters changed', 'api' => 'CloseHttps'], + ['description' => 'Request parameters changed', 'api' => 'CloseManagedIndex'], + ['description' => 'Request parameters changed', 'api' => 'DeleteCollector'], + ['description' => 'Request parameters changed', 'api' => 'DeleteComponentIndex'], + ['description' => 'Request parameters changed', 'api' => 'DeleteConnectedCluster'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataStream'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataTask'], + ], + 'createdAt' => '2022-09-26T04:35:37.000Z', + 'description' => 'Format Useless RequestBody.', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpgradeEngineVersion'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpgradeEngineVersion'], + ], + 'createdAt' => '2022-09-16T04:15:40.000Z', + 'description' => '版本升级API，对其业务参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeRegions'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeRegions'], + ['description' => 'Request parameters changed', 'api' => 'ListComponentIndices'], + ['description' => 'Request parameters changed', 'api' => 'ListComponentIndices'], + ], + 'createdAt' => '2022-09-15T08:10:00.000Z', + 'description' => '删除pop迁移遗留body参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'createInstance'], + ['description' => 'Request parameters changed', 'api' => 'createInstance'], + ], + 'createdAt' => '2022-09-13T09:20:34.000Z', + 'description' => 'CreateInstance补充body参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateKibanaWhiteIps'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateKibanaWhiteIps'], + ], + 'createdAt' => '2022-09-13T08:10:35.000Z', + 'description' => 'API参数补齐', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CloseDiagnosis'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CloseDiagnosis'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeKibanaSettings'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeKibanaSettings'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeLogstash'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeLogstash'], + ['description' => 'Request parameters changed, Response parameters changed, Error codes changed', 'api' => 'DiagnoseInstance'], + ['description' => 'Request parameters changed, Response parameters changed, Error codes changed', 'api' => 'DiagnoseInstance'], + ['description' => 'Request parameters changed', 'api' => 'ListDiagnoseReport'], + ['description' => 'Request parameters changed', 'api' => 'ListDiagnoseReport'], + ], + 'createdAt' => '2022-09-13T03:48:22.000Z', + 'description' => 'pop API迁移，遗留body字段处理', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListSearchLog'], + ['description' => 'Request parameters changed', 'api' => 'StopApm'], + ['description' => 'Request parameters changed, Response parameters changed, Error codes changed', 'api' => 'TagResources'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'UpdateLogstash'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePipelineManagementConfig'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'UpdateXpackMonitorConfig'], + ], + 'createdAt' => '2022-09-05T06:37:45.000Z', + 'description' => 'API参数补充和订正，删除遗留body参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'StartApm'], + ], + 'createdAt' => '2022-09-02T08:54:59.000Z', + 'description' => '更新instanceid 为必填', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CancelDeletion'], + ['description' => 'Error codes changed', 'api' => 'CloseManagedIndex'], + ['description' => 'Error codes changed', 'api' => 'CreateCollector'], + ['description' => 'Error codes changed', 'api' => 'CreateDataStream'], + ['description' => 'Error codes changed', 'api' => 'CreateILMPolicy'], + ['description' => 'Error codes changed', 'api' => 'CreateIndexTemplate'], + ['description' => 'Error codes changed', 'api' => 'DeleteCollector'], + ], + 'createdAt' => '2022-08-30T17:47:59.000Z', + 'description' => '补充API读写类型', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteIndexTemplate'], + ['description' => 'Error codes changed', 'api' => 'DeleteVpcEndpoint'], + ['description' => 'Error codes changed', 'api' => 'DescribeElasticsearchHealth'], + ['description' => 'Error codes changed', 'api' => 'DescribePipelineManagementConfig'], + ['description' => 'Error codes changed', 'api' => 'GetSuggestShrinkableNodes'], + ['description' => 'Error codes changed', 'api' => 'GetTransferableNodes'], + ['description' => 'Error codes changed', 'api' => 'InitializeOperationRole'], + ['description' => 'Error codes changed', 'api' => 'InstallAckOperator'], + ['description' => 'Error codes changed', 'api' => 'ListAlternativeSnapshotRepos'], + ], + 'createdAt' => '2022-08-30T17:29:12.000Z', + 'description' => '补充API读写类型', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetClusterDataInformation'], + ['description' => 'Request parameters changed', 'api' => 'ShrinkNode'], + ['description' => 'Error codes changed', 'api' => 'UninstallKibanaPlugin'], + ['description' => 'Error codes changed', 'api' => 'UninstallLogstashPlugin'], + ['description' => 'Error codes changed', 'api' => 'UninstallPlugin'], + ['description' => 'Error codes changed', 'api' => 'UntagResources'], + ['description' => 'Error codes changed', 'api' => 'UpdateAdminPassword'], + ], + 'createdAt' => '2022-08-30T09:46:14.000Z', + 'description' => '增加错误码映射', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListLogstash'], + ], + 'createdAt' => '2022-06-20T12:34:37.000Z', + 'description' => 'logstash 支持tag筛选', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListShardRecoveries'], + ], + 'createdAt' => '2022-06-07T11:36:57.000Z', + 'description' => '更新pop qps', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeDynamicSettings'], + ['description' => 'OpenAPI offline', 'api' => 'ListActionRecords'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateDynamicSettings'], + ], + 'createdAt' => '2022-05-30T06:30:19.000Z', + 'description' => '支持变更可观测', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ListTagResources'], + ], + 'createdAt' => '2022-02-28T06:41:07.000Z', + 'description' => '废弃ListTagResources Page/Size属性', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListInstanceHistoryEvents'], + ['description' => 'OpenAPI offline', 'api' => 'RebootInstanceNode'], + ], + 'createdAt' => '2022-02-21T10:22:24.000Z', + 'description' => '开放事件中心API，目前张家口支持', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ShrinkNode'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'TransferNode'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ValidateShrinkNodes'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ValidateTransferableNodes'], + ], + 'createdAt' => '2022-01-21T06:07:41.000Z', + 'description' => '补充缩节点/迁移数据相关API参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ListIndexTemplates'], + ], + 'createdAt' => '2022-01-21T06:07:08.000Z', + 'description' => '索引模版列表补充page/size参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'TriggerNetwork'], + ], + 'createdAt' => '2022-01-18T07:08:22.000Z', + 'description' => '修改不规范响应码', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ModifyWhiteIps'], + ], + 'createdAt' => '2022-01-18T07:07:00.000Z', + 'description' => '更改form表单传参为json body', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListComponentIndices'], + ], + 'createdAt' => '2022-01-10T09:28:34.000Z', + 'description' => '发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed, Error codes changed', 'api' => 'CreateLogstash'], + ], + 'createdAt' => '2021-12-30T06:28:35.000Z', + 'description' => 'CreateLogstash 补全请求参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'UpdateComponentIndex'], + ], + 'createdAt' => '2021-12-17T03:38:28.000Z', + 'description' => 'openstore2期', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateComponentIndex'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteComponentIndex'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteDeprecatedTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeComponentIndex'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDeprecatedTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'ListComponentIndices'], + ['description' => 'OpenAPI offline', 'api' => 'ListDeprecatedTemplates'], + ], + 'createdAt' => '2021-12-16T12:47:10.000Z', + 'description' => 'openstore 2 期上线', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateApm'], + ], + 'createdAt' => '2021-11-18T05:38:01.000Z', + 'description' => 'update APM 接口调整', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeApm'], + ['description' => 'Response parameters changed', 'api' => 'ListApm'], + ['description' => 'Response parameters changed', 'api' => 'RemoveApm'], + ['description' => 'Response parameters changed', 'api' => 'StartApm'], + ['description' => 'Response parameters changed', 'api' => 'StopApm'], + ['description' => 'Response parameters changed', 'api' => 'UpdateApm'], + ], + 'createdAt' => '2021-11-18T05:36:53.000Z', + 'description' => '更新接口返回字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeApm'], + ['description' => 'OpenAPI offline', 'api' => 'RemoveApm'], + ['description' => 'OpenAPI offline', 'api' => 'StartApm'], + ['description' => 'OpenAPI offline', 'api' => 'StopApm'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateApm'], + ], + 'createdAt' => '2021-10-21T06:58:11.000Z', + 'description' => '新增APM功能', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAllNode'], + ], + 'createdAt' => '2021-09-22T10:10:53.000Z', + 'description' => '隐藏hostname字段', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartCollector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDictInformation'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDeprecatedTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallUserPlugins'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAllNode'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeConnectableClusters'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLogstashChargeType'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataTasks'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLogstash'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveResourceGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAckClusters'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallKibanaPlugin'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateBlackIps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCollector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunPipelines'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateXpackMonitorConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRegionConfiguration'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDict'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodes'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallLogstashPlugin'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateComponentIndex'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateShrinkNodes'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenDiagnosis'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIndexTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseDiagnosis'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableKibanaPvlNetwork'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLogstash'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDataStreams'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseReport'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLogstashPlugins'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDiagnosisSettings'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyWhiteIps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeKibanaSettings'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceIndices'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewLogstash'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenewInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallAckOperator'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartCollector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallKibanaSystemPlugin'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipelines'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PostEmonTryAlarmRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopPipelines'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseManagedIndex'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListActionRecords'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSnapshot'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnoseReport'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExtendfiles'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExtendfiles'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateExtendConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineIds'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAdminPassword'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallLogstashSystemPlugin'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePublicWhiteIps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceChargeType'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelineManagementConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrivateNetworkWhiteIps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTransferableNodes'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCollector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlternativeSnapshotRepos'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAvailableEsInstanceIds'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetElastictask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListKibanaPlugins'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDescription'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CapacityPlan'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWhiteIps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseHttps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSnapshotSetting'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIndexTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLogstashDescription'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallPlugin'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateVpcEndpoint'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EstimatedLogstashRestartTime'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateSlrPermission'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListShardRecoveries'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSearchLog'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOpenStoreUsage'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateTransferableNodes'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeElasticsearchHealth'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterruptElasticsearchTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopCollector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableKibanaPvlNetwork'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RolloverDataStream'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCollector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLogstashLog'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConnectedClusters'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ['threshold' => '30', 'countWindow' => 86400, 'regionId' => '*', 'api' => 'DiagnoseInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSnapshotReposByInstanceId'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeXpackMonitorConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIndexTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterruptLogstashTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeactivateZones'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmonGrafanaAlerts'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmonGrafanaDashboards'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeprecatedTemplates'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeLogstashTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseReportIds'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDynamicSettings'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLogstash'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListComponentIndices'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEcsInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVpcEndpoints'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelDeletion'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCollector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstanceSettings'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelLogstashDeletion'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAdvancedSetting'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteVpcEndpoint'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipelines'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteLogstash'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSnapshotRepo'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSynonymsDicts'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateKibanaSettings'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerNetwork'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateComponentIndex'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentIndex'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnoseIndices'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDiagnosisItems'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ActivateZones'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateReadWritePolicy'], + ['threshold' => '200', 'countWindow' => 86400, 'regionId' => '*', 'api' => 'createInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSuggestShrinkableNodes'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDynamicSettings'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDicts'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TransferNode'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAliwsDict'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentIndex'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPlugins'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyElastictask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSnapshotSetting'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDefaultCollectorConfigurations'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataStream'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipeline'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCollectorName'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAckNamespaces'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSnapshotRepo'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartLogstash'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallSystemPlugin'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePublicNetwork'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteConnectedCluster'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeElasticsearchTask'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTemplates'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ShrinkNode'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClusterDataInformation'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyDeployMachine'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddConnectableCluster'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateKibanaWhiteIps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDeprecatedTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ValidateConnection'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataStream'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateHotIkDicts'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIndexTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReinstallCollector'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EstimatedRestartTime'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitializeOperationRole'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeEngineVersion'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEmonMonitorData'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartInstance'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePipelineManagementConfig'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelines'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosisSettings'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstanceMaintainTime'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MigrateToOtherZone'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTemplate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteILMPolicy'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RecommendTemplates'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAckOperator'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceHistoryEvents'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCollectors'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateKibanaPvlNetwork'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLogstashSettings'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIndexTemplates'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTags'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenHttps'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateILMPolicy'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateILMPolicy'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListKibanaPvlNetwork'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeILMPolicy'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePipeline'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListILMPolicies'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateLogstash'], + ], + ], + 'ram' => [ + 'productCode' => 'Elasticsearch', + 'productName' => 'Elasticsearch', + 'ramCodes' => ['elasticsearch'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [ + [ + 'name' => 'elasticsearch:TriggerNetworkNodeType', + 'schema' => [ + 'type' => 'String', + 'description' => 'Instance type of cluster node', + 'enums' => ['kibana', 'worker'], + ], + ], + [ + 'name' => 'elasticsearch:InstancePublicNetworkSwitch', + 'schema' => [ + 'type' => 'Boolean', + 'description' => 'whether to enable public network of Elasticsearch instance', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'elasticsearch:DataNodeDiskEncryption', + 'schema' => [ + 'type' => 'Boolean', + 'description' => 'Whether to enable data node disk encryption', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'elasticsearch:WarmNodeDiskEncryption', + 'schema' => [ + 'type' => 'Boolean', + 'description' => 'Whether to enable warm node disk encryption', + 'enums' => ['true', 'false'], + ], + ], + [ + 'name' => 'elasticsearch:TriggerNetworkAction', + 'schema' => [ + 'type' => 'String', + 'description' => 'Action type of enabling or disabling public or private network access to cluster', + 'enums' => ['close', 'open'], + ], + ], + [ + 'name' => 'elasticsearch:TriggerNetworkType', + 'schema' => [ + 'type' => 'String', + 'description' => 'Network type of cluster', + 'enums' => ['public', 'private'], + ], + ], + ], + 'ramActions' => [ + [ + 'apiName' => 'DescribeAckOperator', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeAckOperator', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'ackClusters', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:ackClusters/{#ackClustersId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateSnapshotSetting', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-oew1qbgl****', + [ + 'apiName' => 'ListShardRecoveries', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListShardRecoveries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + ], + [ + 'apiName' => 'UninstallKibanaPlugin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UninstallKibanaPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, + ], + [ + 'apiName' => 'CreateILMPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateILMPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****', - ], - 'Result' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'fileSize' => [ - 'description' => 'The size of the driver file. Unit: byte.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1853083', - ], - 'name' => [ - 'description' => 'The name of the driver file.'."\n", - 'type' => 'string', - 'example' => 'mysql-connector-java-6.0.2.jar', - ], - 'sourceType' => [ - 'description' => 'The source of the driver file. This parameter is fixed as ORIGIN, which indicates that the driver file is retained.'."\n", - 'type' => 'string', - 'example' => 'ORIGIN', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListILMPolicies', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListILMPolicies', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], ], ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'DeleteDataStream', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteDataStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'InstallAckOperator', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallAckOperator', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'ackClusters', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:ackClusters/{#ackClustersId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + [ + 'apiName' => 'UpdateInstanceSettings', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstanceSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', + ], + [ + 'apiName' => 'UpdateDiagnosisSettings', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDiagnosisSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', + ], + ], + [ + 'apiName' => 'UpdateSynonymsDicts', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', + ], + ], + [ + 'apiName' => 'DeleteCollector', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + ], + ], + [ + 'apiName' => 'ListConnectedClusters', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListConnectedClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\",\\n \\"Result\\": [\\n {\\n \\"fileSize\\": 1853083,\\n \\"name\\": \\"mysql-connector-java-6.0.2.jar\\",\\n \\"sourceType\\": \\"ORIGIN\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<Result>\\n <name>mysql-connector-java-5.1.35.jar</name>\\n <fileSize>968668</fileSize>\\n <sourceType>ORIGIN</sourceType>\\n</Result>\\n<RequestId>27F32ECF-0527-43BF-A116-D6260D1240BE</RequestId>","errorExample":""}]', - 'title' => 'UpdateExtendfiles', - 'summary' => 'Updates the driver files of a Logstash cluster.', - 'description' => 'When you call this operation, take note of the following items: You can call this operation only to delete the driver files that are uploaded to a Logstash cluster in the Alibaba Cloud Management Console. You can add or modify driver files only in the Alibaba Cloud Management Console.'."\n", - 'requestParamsDescription' => '## Request body'."\n" - ."\n" - .'You must configure the following parameters in the request body to specify an updated driver file. | Parameter | Type | Required | Example | Description | | ---- | ---- | ---- | ---- | | name | String | Yes |mysql-connector-java-6.0.2.jar|The name of the driver file. The file name extension of each driver file must be .jar. The name of each driver file cannot exceed 100 characters in length and cannot contain Chinese characters. | | sourceType | String | Yes|ORIGIN|The source of the driver file. You can set this parameter only to ORIGIN. The value indicates that the driver file is retained. If you leave this parameter empty for a driver file, the driver file will be deleted. The feature of adding or modifying driver files by calling the operation is under development. You can perform all management operations on driver files in the Alibaba Cloud Management Console. |'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListPipelineIds' => [ - 'path' => '/openapi/instances/{InstanceId}/pipeline-ids', - 'methods' => [ - 'post', + [ + 'apiName' => 'DescribePipeline', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribePipeline', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'OpenDiagnosis', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:OpenDiagnosis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateKibanaWhiteIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateKibanaWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteVpcEndpoint', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteVpcEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], + [ + 'apiName' => 'DiagnoseInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DiagnoseInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'ListLogstashPlugins', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-7g1umu96oit2e****', + [ + 'apiName' => 'ModifyInstanceMaintainTime', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyInstanceMaintainTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{ "userName":"elastic", "password":"xxxxxx" }', + ], + [ + 'apiName' => 'RenewInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RenewInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'pipelineId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testKibanaManagement', - ], - 'available' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeleteIndexTemplate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteIndexTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - '4XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'ListUserPlugin', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - '5XX' => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'InitializeOperationRole', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InitializeOperationRole', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ComponentCodeValueError', - 'errorMessage' => 'component value is disable', + [ + 'apiName' => 'DescribeConnectableClusters', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeConnectableClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - [ - 'errorCode' => 'UserNotOpen', - 'errorMessage' => 'Aliyun account is not open elasticsearch', + ], + [ + 'apiName' => 'EstimatedRestartTime', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:EstimatedRestartTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], - [ - 'errorCode' => 'StsRoleAccountNoPermission', - 'errorMessage' => 'Role account has no permission or expired', + ], + ], + [ + 'apiName' => 'UninstallPlugin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UninstallPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#AccountId}:instances/{#InstanceId}'], ], - [ - 'errorCode' => 'SubAccountNoPermission', - 'errorMessage' => 'Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM', + ], + ], + [ + 'apiName' => 'InstallSystemPlugin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallSystemPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], - [ - 'errorCode' => 'UserUnauthorized', - 'errorMessage' => 'Authentication required', + ], + ], + [ + 'apiName' => 'DescribePipelineManagementConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribePipelineManagementConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"pipelineId\\": \\"testKibanaManagement\\",\\n \\"available\\": true,\\n \\"code\\": \\"OK\\",\\n \\"message\\": \\"OK\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'ListPipelineIds', - 'summary' => 'Queries the IDs of pipelines for a Logstash cluster.', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CancelLogstashDeletion' => [ - 'path' => '/openapi/logstashes/{InstanceId}/actions/cancel-deletion', - 'methods' => [ - 'post', + [ + 'apiName' => 'DescribeTemplates', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeILMPolicy', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeILMPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListInstanceHistoryEvents', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListInstanceHistoryEvents', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UntagResources', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RemoveTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ls-cn-m7r1vsi2****', + [ + 'apiName' => 'UpdatePipelineManagementConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdatePipelineManagementConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], ], ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****', + ], + [ + 'apiName' => 'ResumeLogstashTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ResumeLogstashTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => 'Indicates whether the cluster is restored. Valid values:'."\n" - ."\n" - .'* true: The cluster is restored.'."\n" - .'* false: The cluster is not restored.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '23EBF56B-2DC0-4507-8BE5-B87395DB0FEB', - ], - ], + [ + 'apiName' => 'GetKeystores', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:GetKeystores', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InstanceActivating', - 'errorMessage' => 'Instance is activating.', + [ + 'apiName' => 'InitModel', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InitModel', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], - [ - 'errorCode' => 'InstanceNotFound', - 'errorMessage' => 'The instanceId provided does not exist.', + ], + ], + [ + 'apiName' => 'GetTransferableNodes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"23EBF56B-2DC0-4507-8BE5-B87395DB0FEB\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', - 'title' => 'CancelLogstashDeletion', - 'summary' => 'Restores a Logstash cluster that is frozen after it is released.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'TurnOnZone' => [ - 'summary' => 'Multi-zone Instance, reopening a zone that has been taken offline is only for disaster recovery drills. Please proceed with caution!', - 'path' => '/openapi/instances/{instanceId}/actions/turnOn-zone', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListSearchLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListSearchLogs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DeleteConnectedCluster', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteConnectedCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeLogstash', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'DeactivateZones', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeactivateZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'CancelTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CancelTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateLogstashDescription', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateLogstashDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateILMPolicy', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateILMPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-xxxx', + [ + 'apiName' => 'ListTags', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'zone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-i', + ], + [ + 'apiName' => 'TurnOnZone', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TurnOnZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - ], + [ + 'apiName' => 'ReinstallCollector', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ReinstallCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateTags', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'tags', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:tags/{#tagsId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","type":"json"}]', - 'title' => 'TurnOnZone', - ], - 'ListInstanceHistoryEvents' => [ - 'summary' => '集群触发的硬件运维事件列表', - 'path' => '/openapi/events', - 'methods' => [ - 'post', + [ + 'apiName' => 'StartCollector', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:StartCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DisableKibanaPvlNetwork', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TriggerNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDicts', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDicts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ActivateZones', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ActivateZones', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'UpdateLogstashChargeType', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateLogstashChargeType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'MoveResourceGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:MoveResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDiagnoseReport', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeDiagnoseReport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'instanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-2r42l7a740005****', + [ + 'apiName' => 'InstallKibanaSystemPlugin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallKibanaSystemPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'nodeIP', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10.1.xx.xx', + ], + [ + 'apiName' => 'GrayPublish', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:RestartInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'eventType', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, + ], + [ + 'apiName' => 'DescribeKibanaSettings', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeKibanaSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'eventLevel', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'INFO,WARN', - ], - 'required' => false, + ], + [ + 'apiName' => 'DeleteSnapshotRepo', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteSnapshotRepo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'eventCreateStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1645596516000', + ], + [ + 'apiName' => 'UpdateTemplate', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'eventCreateEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1645596516000', + ], + [ + 'apiName' => 'CreateSnapshot', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateSnapshot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'eventExecuteStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1645596516000', + ], + [ + 'apiName' => 'ModifyElastictask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyElastictask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'eventExecuteEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1645596516000', + ], + [ + 'apiName' => 'ValidateShrinkNodes', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'eventFinashStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1645596516000', + ], + [ + 'apiName' => 'ModifyWhiteIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'eventFinashEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1645596516000', + ], + [ + 'apiName' => 'CreateCollector', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', + ], + [ + 'apiName' => 'UpgradeEngineVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpgradeEngineVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'GetSuggestShrinkableNodes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'eventCycleStatus', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'EXECUTED,FAILED', - ], - 'required' => false, + ], + [ + 'apiName' => 'GetElastictask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:GetElastictask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'sortField' => [ - 'title' => '排序字段', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'event_time', - 'enum' => [ - 'eventCreateTime', - 'eventExecuteTime', - 'eventFinishTime', - ], - ], - 'desc' => [ - 'title' => '是否倒序。true，倒序；false，顺序。', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'required' => false, + ], + [ + 'apiName' => 'UninstallLogstashPlugin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UninstallPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D1A6830A-F59B-4E05-BFAC-9496C21DBBA7', - ], - 'Headers' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'X-Total-Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'X-Total-Failed' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'X-Total-Success' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', - ], - ], - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'eventCreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2017-12-07T00:00:00Z', - ], - 'eventLevel' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'INFO', - ], - 'instanceId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-2r42l7a740005****', - ], - 'eventFinashTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2017-12-07T00:00:00Z', - ], - 'eventCycleStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EXECUTED', - ], - 'regionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'nodeIP' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10.1.xx.xx', - ], - 'eventExecuteTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2017-12-07T00:00:00Z', - ], - 'eventType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ECS:AUTO_RESTART', - ], - 'ecsId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'i-2ze8s9cjdf2cv969****', - ], - ], - ], - ], - ], + [ + 'apiName' => 'UpdateLogstash', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'ListKibanaPvlNetwork', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'DescribeComponentIndex', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeComponentIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'UpdateLogstashSettings', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateLogstashSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'RecommendTemplates', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RecommendTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D1A6830A-F59B-4E05-BFAC-9496C21DBBA7\\",\\n \\"Headers\\": {\\n \\"X-Total-Count\\": 15,\\n \\"X-Total-Failed\\": 2,\\n \\"X-Total-Success\\": 13\\n },\\n \\"Result\\": [\\n {\\n \\"eventCreateTime\\": \\"2017-12-07T00:00:00Z\\",\\n \\"eventLevel\\": \\"INFO\\",\\n \\"instanceId\\": \\"es-cn-2r42l7a740005****\\",\\n \\"eventFinashTime\\": \\"2017-12-07T00:00:00Z\\",\\n \\"eventCycleStatus\\": \\"EXECUTED\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"nodeIP\\": \\"10.1.xx.xx\\",\\n \\"eventExecuteTime\\": \\"2017-12-07T00:00:00Z\\",\\n \\"eventType\\": \\"ECS:AUTO_RESTART\\",\\n \\"ecsId\\": \\"i-2ze8s9cjdf2cv969****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListInstanceHistoryEventsResponse>\\n <RequestId>D1A6830A-F59B-4E05-BFAC-9496C21DBBA7</RequestId>\\n <Headers>\\n <X-Total-Count>15</X-Total-Count>\\n <X-Total-Failed>2</X-Total-Failed>\\n <X-Total-Success>13</X-Total-Success>\\n </Headers>\\n <Result>\\n <eventCreateTime>2017-12-07T00:00:00Z</eventCreateTime>\\n <eventCycleStatus>EXECUTED</eventCycleStatus>\\n <eventExecuteTime>2017-12-07T00:00:00Z</eventExecuteTime>\\n <eventFinashTime>2017-12-07T00:00:00Z</eventFinashTime>\\n <eventLevel>INFO</eventLevel>\\n <instanceId>es-cn-2r42l7a740005****</instanceId>\\n <nodeIP>10.1.xx.xx</nodeIP>\\n <eventType>ECS:AUTO_RESTART</eventType>\\n <regionId>cn-hangzhou</regionId>\\n <ecsId>i-2ze8s9cjdf2cv969****</ecsId>\\n </Result>\\n</ListInstanceHistoryEventsResponse>","errorExample":""}]', - 'title' => 'ListInstanceHistoryEvents', - ], - 'UpdateDynamicSettings' => [ - 'summary' => '修改集群动态配置', - 'path' => '/openapi/instances/{InstanceId}/dynamic-settings', - 'methods' => [ - 'put', + [ + 'apiName' => 'InterruptElasticsearchTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InterruptElasticsearchTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeDiagnosisSettings', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeDiagnosisSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyDeployMachine', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyDeployMachine', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'DeleteComponentIndex', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteComponentIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'DescribeInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateKeystores', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateKeystores', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'type' => 'string', + [ + 'apiName' => 'ResumeElasticsearchTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ResumeElasticsearchTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'UpdateAdminPassword', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateAdminPassword', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'CloseHttps', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CloseHttps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'RemovePlugin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UninstallPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'mode', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'MigrateToOtherZone', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:MigrateToOtherZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'type' => 'boolean', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + [ + 'apiName' => 'TurnOffZone', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TurnOffZone', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'UpdateAliwsDict', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'CreateLogstash', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/*'], ], ], - 404 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'ListDiagnoseReport', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDiagnoseReport', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - 500 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'UpgradeInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], - 'responseDemo' => null, - ], - 'DescribeDynamicSettings' => [ - 'summary' => '获取集群动态指标', - 'path' => '/openapi/instances/{InstanceId}/dynamic-settings', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListEventRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListEventRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListAvailableEsInstanceIds', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListAvailableEsInstanceIds', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListIndexTemplates', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListIndexTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'InstallUserPlugins', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallUserPlugins', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'GetClusterDataInformation', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:GetClusterDataInformation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateHotIkDicts', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListAllNode', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'type' => 'string', + [ + 'apiName' => 'UpdateFalconSeek', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateFalconSeek', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - ], + [ + 'apiName' => 'CloseDiagnosis', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CloseDiagnosis', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responseDemo' => null, - ], - 'ListActionRecords' => [ - 'summary' => '变更记录 变更详情', - 'path' => '/openapi/instances/{InstanceId}/action-records', - 'methods' => [ - 'get', + [ + 'apiName' => 'GetOpenStoreUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:GetOpenstoreUsage', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListStatsEventRecords', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListStatsEventRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDictInformation', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListTagResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'EstimatedLogstashRestartTime', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:EstimatedLogstashRestartTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListVpcEndpoints', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', + 'ramAction' => [ + 'action' => 'elasticsearch:ListVpcEndpoints', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'type' => 'string', + [ + 'apiName' => 'DescribeIndexTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeIndexTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'requestId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'DeleteILMPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteILMPolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'userId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'ModifyScheduleExecuteTime', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ModifyScheduleExecuteTime', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'actionNames', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'ListSnapshotReposByInstanceId', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListSnapshotReposByInstanceId', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'filter', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'InstallLogstashSystemPlugin', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InstallSystemPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], ], ], - [ - 'name' => 'page', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + ], + [ + 'apiName' => 'EnableKibanaPvlNetwork', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TriggerNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'size', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + ], + [ + 'apiName' => 'DeletePipelines', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:DeletePipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], - [ - 'name' => 'startTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + ], + [ + 'apiName' => 'UpdateInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'endTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + ], + [ + 'apiName' => 'ListPipelineIds', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPipelineIds', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Result' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'actionName' => [ - 'type' => 'string', - ], - 'actionParams' => [ - 'type' => 'object', - ], - 'actionResultAccessList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'endTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'instanceId' => [ - 'type' => 'string', - ], - 'process' => [ - 'type' => 'string', - ], - 'recordDiff' => [ - 'type' => 'object', - ], - 'recordIds' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'requestId' => [ - 'type' => 'string', - ], - 'startTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'stateType' => [ - 'type' => 'string', - ], - 'statusInfo' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'subState' => [ - 'type' => 'string', - ], - 'nodeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'completeNodeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'exception' => [ - 'type' => 'string', - ], - 'latencyMills' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'process' => [ - 'type' => 'string', - ], - 'startTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'endTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'stateType' => [ - 'type' => 'string', - ], - 'subStatusInfo' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'subState' => [ - 'type' => 'string', - ], - 'nodeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'completeNodeCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'exception' => [ - 'type' => 'string', - ], - 'latencyMills' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'process' => [ - 'type' => 'string', - ], - 'startTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'endTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'stateType' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'userId' => [ - 'type' => 'string', - ], - 'userType' => [ - 'type' => 'string', - ], - 'ownerId' => [ - 'type' => 'string', - ], - 'userInfo' => [ - 'type' => 'string', - ], - 'metaNow' => [ - 'type' => 'string', - ], - 'metaOld' => [ - 'type' => 'string', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeleteLogstash', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], ], - 'responseDemo' => null, - ], - 'DisableKibanaPvlNetwork' => [ - 'summary' => 'Disable Private Network Access of Kibana', - 'path' => '/openapi/instances/{InstanceId}/actions/disable-kibana-private', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListDiagnoseIndices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDiagnoseIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'PluginAnalysis', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:UploadPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateKibanaSso', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateKibanaSso', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListActionRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListActionRecords', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], ], ], - 'consumes' => [ - 'application/json', - 'application/x-www-form-urlencoded', + [ + 'apiName' => 'AddSnapshotRepo', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:AddSnapshotRepo', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListCollectors', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListCollectors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreatePipelines', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:CreatePipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDeprecatedTemplate', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '203888', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch2PSU4E', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteDeprecatedTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', + [ + 'apiName' => 'UpdateDict', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDict', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'response body', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'request id', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG', - ], - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'DescribeSnapshotSetting', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeSnapshotSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'RestartLogstash', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RestartLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'UpdateXpackMonitorConfig', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateXpackMonitorConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"<DisableKibanaPvlNetworkResponse>\\n <RequestId>5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG</RequestId>\\n <Result>true</Result>\\n</DisableKibanaPvlNetworkResponse>","errorExample":""}]', - 'title' => 'DisableKibanaPvlNetwork', - ], - 'UpdateKibanaPvlNetwork' => [ - 'summary' => '更新kibana私网链接', - 'path' => '/openapi/instances/{InstanceId}/actions/update-kibana-private', - 'methods' => [ - 'post', + [ + 'apiName' => 'UpdateExtendfiles', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateExtendfiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'TriggerNetwork', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TriggerNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'elasticsearch:TriggerNetworkNodeType', 'validationType' => 'always'], + ['conditionKey' => 'elasticsearch:TriggerNetworkAction', 'validationType' => 'always'], + ['conditionKey' => 'elasticsearch:TriggerNetworkType', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDefaultCollectorConfigurations', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDefaultCollectorConfigurations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'ListInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/*'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListAckClusters', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'elasticsearch:ListAckClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListExtendfiles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListExtendfiles', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + [ + 'apiName' => 'RunPipelines', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '203898', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch2PSU4E', + 'ramAction' => [ + 'action' => 'elasticsearch:RunPipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-n6w1o1x0w001c****', + [ + 'apiName' => 'InterruptLogstashTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:InterruptLogstashTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], - [ - 'name' => 'pvlId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-27a3mul6l0***-kibana-internal', + ], + [ + 'apiName' => 'ListLogstashLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListLogstashLog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'title' => '用于保证请求的幂等性', - 'type' => 'string', - 'example' => 'xxxx', + ], + [ + 'apiName' => 'UpdateComponentIndex', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateComponentIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'endpointName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-27a3mul6l00***-kibana', - ], - 'securityGroups' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'sg-xdjiowfn**', - ], - 'required' => false, - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'UpdatePipelines', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdatePipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****', - ], - ], + [ + 'apiName' => 'UpdateCollectorName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateCollectorName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 400 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'RestartInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RestartInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListComponentIndices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListComponentIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateKibanaPvlNetworkResponse>\\n <Result>true</Result>\\n <RequestId>F99407AB-2FA9-489E-A259-40CF6DCC****</RequestId>\\n</UpdateKibanaPvlNetworkResponse>","errorExample":""}]', - ], - 'ListKibanaPvlNetwork' => [ - 'summary' => '查询kibana私网连接信息', - 'path' => '/openapi/instances/{InstanceId}/actions/get-kibana-private', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListEcsInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListCollectors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListPlugins', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPlugin', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CancelDeletion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CancelDeletion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], ], ], - 'consumes' => [ - 'application/json', - 'application/x-www-form-urlencoded', + [ + 'apiName' => 'ListDataStreams', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDataStreams', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'ListDataTasks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDataTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdatePublicWhiteIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdatePublicWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateReadWritePolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateReadWritePolicy', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'GetEmonGrafanaAlerts', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '203895', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch2PSU4E', + 'ramAction' => [ + 'action' => 'elasticsearch:GetEmonGrafanaAlerts', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-mp91kzb8m0009****', + [ + 'apiName' => 'ListInstanceIndices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListInstanceIndices', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'instances', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'request id', - 'type' => 'string', - 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***', - ], - 'Result' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'endpointName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-xxdjfia****-kibana', - ], - 'vpcId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vpc-bp16k1dvzxtma*****', - ], - 'vSwitchIdsZone' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'zoneId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou-e', - ], - 'vswitchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'vsw-xdefafns***', - ], - ], - ], - ], - 'securityGroups' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'sg-2zegcwar0pq4a****', - ], - ], - 'endpointId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ep-bp1tah7zbrwmkjef****', - ], - 'endpointStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Connected', - ], - 'createTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2024-03-07T06:26:28Z', - ], - 'pvlId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'es-cn-27a3mul6l***-kibana-internal', - ], - ], - ], - ], - ], + [ + 'apiName' => 'CreateDataStream', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateDataStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'CancelLogstashDeletion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CancelLogstashDeletion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateVpcEndpoint', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateVpcEndpoint', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\",\\n \\"Result\\": [\\n {\\n \\"endpointName\\": \\"es-cn-xxdjfia****-kibana\\",\\n \\"vpcId\\": \\"vpc-bp16k1dvzxtma*****\\",\\n \\"vSwitchIdsZone\\": [\\n {\\n \\"zoneId\\": \\"cn-hangzhou-e\\",\\n \\"vswitchId\\": \\"vsw-xdefafns***\\"\\n }\\n ],\\n \\"securityGroups\\": [\\n \\"sg-2zegcwar0pq4a****\\"\\n ],\\n \\"endpointId\\": \\"ep-bp1tah7zbrwmkjef****\\",\\n \\"endpointStatus\\": \\"Connected\\",\\n \\"createTime\\": \\"2024-03-07T06:26:28Z\\",\\n \\"pvlId\\": \\"es-cn-27a3mul6l***-kibana-internal\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListKibanaPvlNetworkResponse>\\n <Result>\\n <pvlId>es-cn-vo93ngti8000a****-kibana-internal-internal</pvlId>\\n <endpointId>ep-bp1ie6c7aea23549****</endpointId>\\n <endpointName>es-cn-vo93ngti8000a****-kibana</endpointName>\\n <description>用于在专有网络VPC中通过私网地址访问实例ID为es-cn-vo93ngti8000a****的kibana，您可以前往Elasticsearch控制台Kibana配置中管理</description>\\n <vpcId>vpc-bp19ip2ocyv24w0e2****</vpcId>\\n <vSwitchIdsZone>\\n <vswitchId>vsw-bp194pz9iezj6h1n5****</vswitchId>\\n <zoneId>cn-hangzhou-i</zoneId>\\n </vSwitchIdsZone>\\n <securityGroups>sg-bp1c6fo9l29ergq****z</securityGroups>\\n <endpointStatus>Connected</endpointStatus>\\n <createTime>2024-03-14T08:16:48Z</createTime>\\n </Result>\\n <RequestId>951E58B6-26B8-5583-AAD6-7797D51723DB</RequestId>\\n</ListKibanaPvlNetworkResponse>","errorExample":""}]', - ], - 'EnableKibanaPvlNetwork' => [ - 'summary' => '开启v3 kibana私网', - 'path' => '/openapi/instances/{InstanceId}/actions/enable-kibana-private', - 'methods' => [ - 'post', + [ + 'apiName' => 'PostEmonTryAlarmRule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:PostEmonTryAlarmRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'UpdateInstanceChargeType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstanceChargeType', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'TransferNode', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'DeleteDataTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteDataTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'DescribeXpackMonitorConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeXpackMonitorConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateComponentIndex', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '203874', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearch2PSU4E', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateComponentIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'path', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'es-cn-n6w1oxxx****', + [ + 'apiName' => 'UpdateDescription', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDescription', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - [ - 'name' => 'clientToken', - 'in' => 'query', - 'schema' => [ - 'title' => '用于保证请求的幂等性', - 'type' => 'string', - 'example' => 'xxxxx', + ], + [ + 'apiName' => 'GetEmonMonitorData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:QueryEmonMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'emonProjects', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:emonProjects/{#emonProjectsId}'], ], ], - [ - 'name' => 'body', - 'in' => 'body', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'endpointName' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-27a3mul6l000xxx-kibana-endpoint', - ], - 'securityGroups' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'sg-2sjfaoafee****', - ], - 'required' => true, - ], - 'vSwitchIdsZone' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'vswitchId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-xxxx', - ], - 'zoneId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'vpcId' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-xxx', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'ShrinkNode', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Result' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0DC92CFE-62AF-51AF-9D5B-F1078D7C451E', - ], - ], + [ + 'apiName' => 'UpdateExtendConfig', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateExtendConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], - 400 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], - ], + ], + [ + 'apiName' => 'UpdateKibanaPvlNetwork', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:TriggerNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'UpdatePublicNetwork', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdatePublicNetwork', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'elasticsearch:InstancePublicNetworkSwitch', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'ListPipeline', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListPipeline', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"0DC92CFE-62AF-51AF-9D5B-F1078D7C451E\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableKibanaPvlNetworkResponse>\\n <Result>true</Result>\\n <RequestId>0DC92CFE-62AF-51AF-9D5B-F1078D7C451E</RequestId>\\n</EnableKibanaPvlNetworkResponse>","errorExample":""}]', - ], - 'TurnOffZone' => [ - 'summary' => 'Multi-zone Instance: Shutting down an existing availability zone is only for disaster recovery drills. Proceed with caution!', - 'path' => '/openapi/instances/{instanceId}/actions/turnOff-zone', - 'methods' => [ - 'post', + [ + 'apiName' => 'CloseManagedIndex', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CloseManagedIndex', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DescribeDeprecatedTemplate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeDeprecatedTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'OpenHttps', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:OpenHttps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], ], ], - 'consumes' => [ - 'application/json', + [ + 'apiName' => 'UpdateKibanaSettings', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateKibanaSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], ], - 'produces' => [ - 'application/json', + [ + 'apiName' => 'UpdateIndexTemplate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateIndexTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListKibanaPlugins', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListKibanaPlugins', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'StopCollector', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:StopCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAlternativeSnapshotRepos', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListAlternativeSnapshotRepos', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ValidateSlrPermission', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', + 'ramAction' => [ + 'action' => 'elasticsearch:ValidateSlrPermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'instanceId', - 'in' => 'path', - 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'es-cn-abc', + [ + 'apiName' => 'UpdateBlackIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateBlackIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], ], ], - [ - 'name' => 'zone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-i', + ], + [ + 'apiName' => 'UpdateAdvancedSetting', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateAdvancedSetting', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'requestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9', - ], - ], + [ + 'apiName' => 'GetEmonGrafanaDashboards', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:GetEmonGrafanaDashboards', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:emonProjects/{#ProjectId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListDiagnoseReportIds', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDiagnoseReportIds', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateWhiteIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'createInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [ + ['conditionKey' => 'elasticsearch:DataNodeDiskEncryption', 'validationType' => 'always'], + ['conditionKey' => 'elasticsearch:WarmNodeDiskEncryption', 'validationType' => 'always'], + ], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/*'], + ], + ], + ], + [ + 'apiName' => 'UpdateCollector', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeCollector', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeElasticsearchHealth', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeElasticsearchHealth', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteInstance', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'elasticsearch:DeleteInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDynamicSettings', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:DescribeDynamicSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'AddConnectableCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'elasticsearch:AddConnectableCluster', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ], + ], + ], + [ + 'apiName' => 'ValidateConnection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ValidateConnection', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RolloverDataStream', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RolloverDataStream', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateIndexTemplate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:CreateIndexTemplate', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListAckNamespaces', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListAckNamespaces', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'ackClusters', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:ackClusters/{#ackClustersId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateDynamicSettings', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateDynamicSettings', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListLogstash', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'elasticsearch:ListLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ValidateTransferableNodes', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListDeprecatedTemplates', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'elasticsearch:ListDeprecatedTemplates', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdatePrivateNetworkWhiteIps', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'elasticsearch:UpdateWhiteIps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RestartCollector', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RestartCollector', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], + ], + [ + 'apiName' => 'StopPipelines', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'elasticsearch:StopPipelines', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ], + ], + ], + [ + 'apiName' => 'RenewLogstash', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:RenewLogstash', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListNodes', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'elasticsearch:ListNodes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'Elasticsearch', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","type":"json"}]', - 'title' => 'TurnOffZone', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'elasticsearch.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'elasticsearch.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'elasticsearch.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'elasticsearch.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'elasticsearch.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'elasticsearch.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'elasticsearch.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'elasticsearch.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'elasticsearch.ap-southeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'elasticsearch.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'elasticsearch.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'elasticsearch.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'elasticsearch.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'elasticsearch.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'elasticsearch.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'elasticsearch.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'elasticsearch.ap-south-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'elasticsearch.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'elasticsearch.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'elasticsearch.cn-north-2-gov-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'elasticsearch.cn-guangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'elasticsearch.cn-chengdu.aliyuncs.com', ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'elasticsearch.cn-wulanchabu.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'ackClusters', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:ackClusters/{#ackClustersId}'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{instanceId}'], + ['validationType' => 'always', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/{#collectorsId}'], + ['validationType' => 'always', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}'], + ['validationType' => 'always', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/*'], + ['validationType' => 'always', 'resourceType' => 'tags', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:tags/*'], + ['validationType' => 'always', 'resourceType' => 'tags', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:tags/{#tagsId}'], + ['validationType' => 'always', 'resourceType' => 'collectors', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:collectors/*'], + ['validationType' => 'always', 'resourceType' => 'Logstash', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/*'], + ['validationType' => 'always', 'resourceType' => 'ackClusters', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:ackClusters/*'], + ['validationType' => 'always', 'resourceType' => 'instances', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}'], + ['validationType' => 'always', 'resourceType' => 'emonProjects', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:emonProjects/{#emonProjectsId}'], + ['validationType' => 'always', 'resourceType' => 'snapshotrepository', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:snapshotrepository/*'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:*'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:emonProjects/{#ProjectId}'], + ['validationType' => 'always', 'resourceType' => 'logstashes', 'arn' => 'acs:elasticsearch:{#regionId}:{#accountId}:logstashes/*'], ], ], ]; diff --git a/data/en_us/elasticsearch/2019-04-22/api-docs.php b/data/en_us/elasticsearch/2019-04-22/api-docs.php index 48ce59c..f65b200 100644 --- a/data/en_us/elasticsearch/2019-04-22/api-docs.php +++ b/data/en_us/elasticsearch/2019-04-22/api-docs.php @@ -1,26 +1,18 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'elasticsearch', - 'version' => '2019-04-22', - ], + 'info' => ['style' => 'RPC', 'product' => 'elasticsearch', 'version' => '2019-04-22'], 'directories' => [ [ 'id' => 62994, 'title' => null, 'type' => 'directory', - 'children' => [ - 'DescribeVSwitches', - ], + 'children' => ['DescribeVSwitches'], ], [ 'id' => 62996, 'title' => null, 'type' => 'directory', - 'children' => [ - 'DescribeVpcs', - ], + 'children' => ['DescribeVpcs'], ], ], 'components' => [ @@ -29,14 +21,8 @@ 'apis' => [ 'DescribeVSwitches' => [ 'summary' => '获取用户交换机列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48,85 +34,40 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '64424', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchFBYZT8', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchFBYZT8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'cn-hangzhou', - 'required' => false, - 'title' => '交换机所属区域id', - 'type' => 'string', - ], + 'schema' => ['description' => '', 'docRequired' => true, 'example' => 'cn-hangzhou', 'required' => false, 'title' => '交换机所属区域id', 'type' => 'string'], ], [ 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'vpc-25cdvfeq58pl****', - 'required' => false, - 'title' => '要查询的交换机所属VPC的ID。', - 'type' => 'string', - ], + 'schema' => ['description' => '', 'example' => 'vpc-25cdvfeq58pl****', 'required' => false, 'title' => '要查询的交换机所属VPC的ID。', 'type' => 'string'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '1', - 'required' => false, - 'title' => '列表的页码', - 'type' => 'integer', - 'default' => '1', - ], + 'schema' => ['description' => '', 'example' => '1', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'title' => '列表的页码', 'type' => 'integer', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'maximum' => '50', - 'minimum' => '1', - 'required' => false, - 'title' => '分页查询时每页的行数', - 'type' => 'integer', - 'default' => '50', - ], + 'schema' => ['description' => '', 'example' => '10', 'format' => 'int32', 'maximum' => '50', 'minimum' => '1', 'required' => false, 'title' => '分页查询时每页的行数', 'type' => 'integer', 'default' => '50'], ], [ 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'cn-hangzhou-d', - 'required' => false, - 'title' => '要查询的交换机的ID。', - 'type' => 'string', - ], + 'schema' => ['description' => '', 'example' => 'cn-hangzhou-d', 'required' => false, 'title' => '要查询的交换机的ID。', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B', - 'type' => 'string', - ], + 'RequestId' => ['description' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B', 'type' => 'string'], 'VSwitches' => [ 'description' => '', 'properties' => [ @@ -143,38 +84,13 @@ 'type' => 'string', 'enum' => [], ], - 'VSwitchId' => [ - 'description' => '', - 'example' => 'vsw-25bcdxs7pv1****', - 'title' => '交换机的ID。', - 'type' => 'string', - ], - 'IsDefault' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否是默认交换机。取值：'."\n" - .'true：是默认交换机。'."\n" - .'false：非默认交换机。', - 'type' => 'boolean', - ], - 'CidrBlock' => [ - 'description' => '', - 'example' => '172.16.0.0/24', - 'title' => '交换机的IPv4网段。', - 'type' => 'string', - ], - 'GmtCreate' => [ - 'description' => '', - 'example' => '2022-01-18T12:43:57Z', - 'title' => '交换机的创建时间。', - 'type' => 'string', - ], - 'VSwitchName' => [ - 'description' => '', - 'example' => 'vswitch', - 'title' => '交换机的名称。', - 'type' => 'string', - ], + 'VSwitchId' => ['description' => '', 'example' => 'vsw-25bcdxs7pv1****', 'title' => '交换机的ID。', 'type' => 'string'], + 'IsDefault' => ['description' => '', 'example' => 'true', 'title' => '是否是默认交换机。取值：'."\n" + .'true：是默认交换机。'."\n" + .'false：非默认交换机。', 'type' => 'boolean'], + 'CidrBlock' => ['description' => '', 'example' => '172.16.0.0/24', 'title' => '交换机的IPv4网段。', 'type' => 'string'], + 'GmtCreate' => ['description' => '', 'example' => '2022-01-18T12:43:57Z', 'title' => '交换机的创建时间。', 'type' => 'string'], + 'VSwitchName' => ['description' => '', 'example' => 'vswitch', 'title' => '交换机的名称。', 'type' => 'string'], ], 'type' => 'object', ], @@ -195,14 +111,8 @@ ], 'DescribeVpcs' => [ 'summary' => 'VPC列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -215,72 +125,35 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '64423', - 'abilityTreeNodes' => [ - 'FEATUREelasticsearchGHNE3U', - ], + 'abilityTreeNodes' => ['FEATUREelasticsearchGHNE3U'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'cn-hangzhou', - 'required' => false, - 'title' => '区域ID', - 'type' => 'string', - ], + 'schema' => ['description' => '', 'docRequired' => true, 'example' => 'cn-hangzhou', 'required' => false, 'title' => '区域ID', 'type' => 'string'], ], [ 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'cn-hangzhou-d', - 'required' => false, - 'title' => '可用区Id', - 'type' => 'string', - ], + 'schema' => ['description' => '', 'example' => 'cn-hangzhou-d', 'required' => false, 'title' => '可用区Id', 'type' => 'string'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'minimum' => '1', - 'required' => false, - 'title' => '分页查询页码', - 'type' => 'integer', - 'default' => '1', - ], + 'schema' => ['description' => '', 'example' => '1', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'title' => '分页查询页码', 'type' => 'integer', 'default' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '50', - 'format' => 'int32', - 'required' => false, - 'title' => '分页查询每页大小', - 'type' => 'integer', - 'default' => '50', - ], + 'schema' => ['description' => '', 'example' => '50', 'format' => 'int32', 'required' => false, 'title' => '分页查询每页大小', 'type' => 'integer', 'default' => '50'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B', - 'title' => '唯一请求ID', - 'type' => 'string', - ], + 'RequestId' => ['description' => '', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B', 'title' => '唯一请求ID', 'type' => 'string'], 'Vpcs' => [ 'description' => '', 'properties' => [ @@ -289,18 +162,8 @@ 'items' => [ 'description' => '', 'properties' => [ - 'VpcId' => [ - 'description' => '', - 'example' => 'vpc-bp1qpo0kug3a20qqe****', - 'title' => 'vpc唯一标识', - 'type' => 'string', - ], - 'VpcName' => [ - 'description' => '', - 'example' => 'vpc1', - 'title' => 'vpc名称', - 'type' => 'string', - ], + 'VpcId' => ['description' => '', 'example' => 'vpc-bp1qpo0kug3a20qqe****', 'title' => 'vpc唯一标识', 'type' => 'string'], + 'VpcName' => ['description' => '', 'example' => 'vpc1', 'title' => 'vpc名称', 'type' => 'string'], 'Status' => [ 'description' => '', 'example' => 'Available', @@ -310,44 +173,14 @@ 'type' => 'string', 'enum' => [], ], - 'IsDefault' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否是该地域的默认VPC', - 'type' => 'boolean', - ], - 'CidrBlock' => [ - 'description' => '', - 'example' => '192.168.0.0/16', - 'title' => 'VPC的IPv4网段。', - 'type' => 'string', - ], - 'RegionNo' => [ - 'description' => '', - 'example' => 'cn-hangzhou', - 'title' => 'VPC所在的地域ID。', - 'type' => 'string', - ], - 'GmtCreate' => [ - 'description' => '', - 'example' => '2021-04-18T15:02:37Z', - 'title' => 'VPC的创建时间。', - 'type' => 'string', - ], - 'GmtModified' => [ - 'description' => '', - 'example' => '2021-04-18T15:02:37Z', - 'title' => 'VPC的修改时间。', - 'type' => 'string', - ], + 'IsDefault' => ['description' => '', 'example' => 'true', 'title' => '是否是该地域的默认VPC', 'type' => 'boolean'], + 'CidrBlock' => ['description' => '', 'example' => '192.168.0.0/16', 'title' => 'VPC的IPv4网段。', 'type' => 'string'], + 'RegionNo' => ['description' => '', 'example' => 'cn-hangzhou', 'title' => 'VPC所在的地域ID。', 'type' => 'string'], + 'GmtCreate' => ['description' => '', 'example' => '2021-04-18T15:02:37Z', 'title' => 'VPC的创建时间。', 'type' => 'string'], + 'GmtModified' => ['description' => '', 'example' => '2021-04-18T15:02:37Z', 'title' => 'VPC的修改时间。', 'type' => 'string'], 'VSwitchs' => [ 'description' => '', - 'items' => [ - 'description' => '', - 'example' => 'vsw-bp1nhbnpv2blyz8dl****', - 'title' => 'vpc交换机标识', - 'type' => 'string', - ], + 'items' => ['description' => '', 'example' => 'vsw-bp1nhbnpv2blyz8dl****', 'title' => 'vpc交换机标识', 'type' => 'string'], 'title' => '查询到的VPC中交换机的列表信息。最多可以查询到VPC中最近创建的300个交换机的信息', 'type' => 'array', ], @@ -372,97 +205,28 @@ ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'elasticsearch.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'elasticsearch.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'elasticsearch.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'elasticsearch.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'elasticsearch.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'elasticsearch.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'elasticsearch.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'elasticsearch.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'elasticsearch.ap-southeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'elasticsearch.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'elasticsearch.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'elasticsearch.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'elasticsearch.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'elasticsearch.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'elasticsearch.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'elasticsearch.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'elasticsearch.ap-south-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'elasticsearch.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'elasticsearch.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'elasticsearch.cn-north-2-gov-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'elasticsearch.cn-guangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'elasticsearch.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'elasticsearch.cn-wulanchabu.aliyuncs.com', - ], + ['regionId' => 'cn-qingdao', 'endpoint' => 'elasticsearch.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'endpoint' => 'elasticsearch.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'elasticsearch.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'endpoint' => 'elasticsearch.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'endpoint' => 'elasticsearch.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'endpoint' => 'elasticsearch.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'endpoint' => 'elasticsearch.cn-hongkong.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'endpoint' => 'elasticsearch.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'endpoint' => 'elasticsearch.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'endpoint' => 'elasticsearch.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'endpoint' => 'elasticsearch.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'endpoint' => 'elasticsearch.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'endpoint' => 'elasticsearch.eu-west-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'endpoint' => 'elasticsearch.us-west-1.aliyuncs.com'], + ['regionId' => 'us-east-1', 'endpoint' => 'elasticsearch.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'endpoint' => 'elasticsearch.eu-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'endpoint' => 'elasticsearch.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'elasticsearch.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'elasticsearch.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-north-2-gov-1', 'endpoint' => 'elasticsearch.cn-north-2-gov-1.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'endpoint' => 'elasticsearch.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'endpoint' => 'elasticsearch.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'endpoint' => 'elasticsearch.cn-wulanchabu.aliyuncs.com'], ], ]; |