summaryrefslogtreecommitdiff
path: root/data/en_us/elasticsearch
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/elasticsearch
downloadacs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz
acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/elasticsearch')
-rw-r--r--data/en_us/elasticsearch/2017-06-13/api-docs.php34564
-rw-r--r--data/en_us/elasticsearch/2019-04-22/api-docs.php468
2 files changed, 35032 insertions, 0 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
new file mode 100644
index 0000000..87273f3
--- /dev/null
+++ b/data/en_us/elasticsearch/2017-06-13/api-docs.php
@@ -0,0 +1,34564 @@
+<?php return [
+ 'version' => '1.0',
+ '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',
+ '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',
+ ],
+ ],
+ [
+ 'id' => 123960,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DeleteDataTask',
+ 'GetTransferableNodes',
+ 'ListDataTasks',
+ 'GetClusterDataInformation',
+ 'ValidateTransferableNodes',
+ 'TransferNode',
+ 'CancelTask',
+ ],
+ ],
+ [
+ 'id' => 123968,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateCollector',
+ 'DeleteCollector',
+ 'ModifyDeployMachine',
+ 'UpdateCollector',
+ 'UpdateCollectorName',
+ 'StartCollector',
+ 'StopCollector',
+ 'DescribeCollector',
+ 'ListDefaultCollectorConfigurations',
+ 'ListCollectors',
+ 'ListNodes',
+ 'RestartCollector',
+ 'ReinstallCollector',
+ ],
+ ],
+ [
+ 'id' => 123982,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'UpdateInstance',
+ 'GetSuggestShrinkableNodes',
+ 'ValidateShrinkNodes',
+ 'ShrinkNode',
+ 'UpgradeEngineVersion',
+ ],
+ ],
+ [
+ 'id' => 123988,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'UpdateInstanceSettings',
+ 'UpdateHotIkDicts',
+ 'UpdateSynonymsDicts',
+ 'UpdateDict',
+ 'UpdateAdvancedSetting',
+ 'UpdateExtendConfig',
+ 'UpdateTemplate',
+ 'UpdateAliwsDict',
+ 'UpdateBlackIps',
+ 'DescribeTemplates',
+ 'ListAckClusters',
+ 'ListDictInformation',
+ 'ListEcsInstances',
+ 'DescribeAckOperator',
+ 'GetRegionConfiguration',
+ 'ListAckNamespaces',
+ 'InstallAckOperator',
+ 'InstallUserPlugins',
+ 'RecommendTemplates',
+ 'ValidateSlrPermission',
+ 'InitializeOperationRole',
+ ],
+ ],
+ [
+ 'id' => 124011,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListPlugins',
+ 'InstallSystemPlugin',
+ 'UninstallPlugin',
+ ],
+ ],
+ [
+ 'id' => 124015,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'GetEmonMonitorData',
+ 'DescribeElasticsearchHealth',
+ 'GetEmonGrafanaAlerts',
+ 'GetEmonGrafanaDashboards',
+ 'PostEmonTryAlarmRule',
+ ],
+ ],
+ [
+ 'id' => 124021,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListSearchLog',
+ ],
+ ],
+ [
+ 'id' => 124023,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'AddConnectableCluster',
+ 'DeleteConnectedCluster',
+ 'UpdatePrivateNetworkWhiteIps',
+ 'UpdatePublicWhiteIps',
+ 'UpdatePublicNetwork',
+ 'UpdateAdminPassword',
+ 'ModifyWhiteIps',
+ 'DescribeConnectableClusters',
+ 'ListConnectedClusters',
+ 'TriggerNetwork',
+ 'OpenHttps',
+ 'CloseHttps',
+ 'CreateVpcEndpoint',
+ 'DeleteVpcEndpoint',
+ 'ListVpcEndpoints',
+ ],
+ ],
+ [
+ 'id' => 124039,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateSnapshot',
+ 'AddSnapshotRepo',
+ 'DeleteSnapshotRepo',
+ 'UpdateSnapshotSetting',
+ 'DescribeSnapshotSetting',
+ 'ListSnapshotReposByInstanceId',
+ 'ListAlternativeSnapshotRepos',
+ ],
+ ],
+ [
+ 'id' => 124047,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListDiagnosisItems',
+ 'UpdateDiagnosisSettings',
+ 'ListDiagnoseReport',
+ 'ListDiagnoseReportIds',
+ 'DescribeDiagnoseReport',
+ 'DescribeDiagnosisSettings',
+ 'ListDiagnoseIndices',
+ 'OpenDiagnosis',
+ 'CloseDiagnosis',
+ ],
+ ],
+ [
+ 'id' => 124056,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'UpdateKibanaSettings',
+ 'DescribeKibanaSettings',
+ 'ListKibanaPlugins',
+ 'InstallKibanaSystemPlugin',
+ 'UninstallKibanaPlugin',
+ ],
+ ],
+ [
+ 'id' => 124062,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 124063,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DeleteLogstash',
+ 'UpdateLogstash',
+ 'UpdateLogstashDescription',
+ 'UpdateLogstashChargeType',
+ 'ListLogstash',
+ 'DescribeLogstash',
+ 'RenewLogstash',
+ 'RestartLogstash',
+ 'EstimatedLogstashRestartTime',
+ ],
+ ],
+ [
+ 'id' => 124073,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'UpdateLogstashSettings',
+ 'ListExtendfiles',
+ ],
+ ],
+ [
+ 'id' => 124076,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListLogstashPlugins',
+ 'InstallLogstashSystemPlugin',
+ 'UninstallLogstashPlugin',
+ ],
+ ],
+ [
+ 'id' => 124080,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListLogstashLog',
+ ],
+ ],
+ [
+ 'id' => 124082,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'UpdateXpackMonitorConfig',
+ 'ListAvailableEsInstanceIds',
+ 'DescribeXpackMonitorConfig',
+ 'ValidateConnection',
+ ],
+ ],
+ [
+ 'id' => 124087,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'InterruptLogstashTask',
+ 'ResumeLogstashTask',
+ ],
+ ],
+ [
+ 'id' => 124090,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreatePipelines',
+ 'DeletePipelines',
+ 'UpdatePipelines',
+ 'StopPipelines',
+ 'UpdatePipelineManagementConfig',
+ 'ListPipeline',
+ 'DescribePipeline',
+ 'DescribePipelineManagementConfig',
+ 'RunPipelines',
+ ],
+ ],
+ 'CreateLogstash',
+ 'UpdateExtendfiles',
+ 'ListPipelineIds',
+ 'CancelLogstashDeletion',
+ ],
+ ],
+ [
+ 'id' => 178119,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'TurnOnZone',
+ 'ListInstanceHistoryEvents',
+ 'UpdateDynamicSettings',
+ 'DescribeDynamicSettings',
+ 'ListActionRecords',
+ 'DisableKibanaPvlNetwork',
+ 'UpdateKibanaPvlNetwork',
+ 'ListKibanaPvlNetwork',
+ 'EnableKibanaPvlNetwork',
+ 'TurnOffZone',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'ClientNodeConfiguration' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'diskType' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ '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',
+ ],
+ 'spec' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ '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',
+ ],
+ ],
+ 'disk' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '20',
+ 'minimum' => '20',
+ 'example' => '20',
+ 'backendName' => 'disk',
+ 'enum' => [
+ '20',
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'DictInfo' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'Elasticsearch' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ 'ikHotDicts' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ 'required' => false,
+ 'example' => '9200',
+ 'backendName' => 'port',
+ ],
+ 'kibanaPrivateIPWhitelist' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ 'required' => false,
+ 'example' => 'true',
+ 'backendName' => 'serviceVpc',
+ ],
+ 'tags' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/Tag',
+ ],
+ 'required' => false,
+ 'backendName' => 'tags',
+ ],
+ 'haveKibana' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'backendName' => 'haveKibana',
+ ],
+ 'dictList' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/DictInfo',
+ ],
+ 'required' => false,
+ 'backendName' => 'dictList',
+ ],
+ 'extendConfigs' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'example' => '[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]',
+ 'extendType' => 'true',
+ ],
+ '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',
+ ],
+ 'zoneInfos' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ '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',
+ ],
+ 'aliwsDicts' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ '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',
+ ],
+ 'publicIpWhitelist' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '["0.0.0.0/0"]',
+ 'extendType' => 'true',
+ ],
+ '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',
+ ],
+ 'productType' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'generalBusiness',
+ 'backendName' => 'productType',
+ 'enum' => [
+ 'generalBusiness',
+ 'logEnhancement',
+ 'community',
+ ],
+ ],
+ 'advancedSetting' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'gcName' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'CMS',
+ 'backendName' => 'gcName',
+ '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',
+ ],
+ 'esConfig' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '{"http.cors.allow-credentials":"false"}',
+ ],
+ 'backendName' => 'esConfig',
+ ],
+ 'esIPWhitelist' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '["0.0.0.0/0"]',
+ 'extendType' => 'true',
+ ],
+ 'required' => false,
+ 'backendName' => 'esIPWhitelist',
+ ],
+ 'kibanaIPWhitelist' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '["0.0.0.0/0"]',
+ 'extendType' => 'true',
+ ],
+ 'required' => false,
+ 'backendName' => 'kibanaIPWhitelist',
+ ],
+ 'privateNetworkIpWhiteList' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ 'required' => false,
+ 'example' => 'vpc-bp1uag5jj38c****',
+ 'backendName' => 'vpcInstanceId',
+ ],
+ 'synonymsDicts' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ 'required' => false,
+ 'example' => '9200',
+ 'backendName' => 'publicPort',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'KibanaNodeConfiguration' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'amount' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '1',
+ 'minimum' => '1',
+ 'example' => '2',
+ 'backendName' => 'amount',
+ 'enum' => [
+ '1',
+ ],
+ ],
+ 'spec' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ '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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'Logstash' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'endpointList' => [
+ 'title' => 'EndpointList',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ 'extendType' => 'true',
+ ],
+ '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',
+ ],
+ 'config' => [
+ 'title' => 'Config',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ 'networkConfig' => [
+ 'title' => 'NetworkConfig',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ 'backendName' => 'networkConfig',
+ ],
+ 'zoneInfos' => [
+ 'title' => 'ZoneInfos',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ 'extendType' => 'true',
+ ],
+ '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',
+ ],
+ 'nodeSpec' => [
+ 'title' => 'NodeSpec',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ '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',
+ ],
+ 'tags' => [
+ 'title' => 'Tags',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'tags',
+ ],
+ 'zoneCount' => [
+ 'title' => 'ZoneCount',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ 'backendName' => 'zoneCount',
+ ],
+ ],
+ ],
+ 'MasterNodeConfiguration' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'object',
+ 'properties' => [
+ 'amount' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'maximum' => '3',
+ 'minimum' => '3',
+ 'example' => '3',
+ 'backendName' => 'amount',
+ ],
+ 'spec' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ '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',
+ ],
+ 'diskType' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cloud_essd',
+ 'backendName' => 'diskType',
+ 'enum' => [
+ 'cloud_essd',
+ 'cloud_ssd',
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'NetworkConfig' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ 'whiteIpGroupList' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'extendType' => 'true',
+ '$ref' => '#/components/schemas/WhiteIpGroup',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ 'NodeInfo' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ ],
+ 'NodeSpec' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'diskType' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cloud_ssd',
+ 'backendName' => 'diskType',
+ 'enum' => [
+ 'cloud_essd',
+ 'cloud_efficiency',
+ 'cloud_ssd',
+ ],
+ ],
+ 'spec' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ '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',
+ ],
+ 'diskEncryption' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'backendName' => 'diskEncryption',
+ 'default' => 'false',
+ ],
+ 'performanceLevel' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PL1',
+ 'backendName' => 'performanceLevel',
+ 'enum' => [
+ 'PL0',
+ 'PL1',
+ 'PL2',
+ 'PL3',
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'PaymentInfo' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ ],
+ 'ReadWritePolicy' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ 'writePolicy' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => 'sync',
+ 'backendName' => 'writePolicy',
+ 'enum' => [
+ 'sync',
+ 'async',
+ ],
+ ],
+ ],
+ ],
+ 'Tag' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ ],
+ 'WarmNodeConfiguration' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'diskType' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ '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',
+ ],
+ 'spec' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ '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',
+ ],
+ ],
+ 'disk' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'maximum' => '20480',
+ 'minimum' => '500',
+ 'example' => '500',
+ 'backendName' => 'disk',
+ ],
+ 'performanceLevel' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'Public',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PL1',
+ 'backendName' => 'performanceLevel',
+ 'enum' => [
+ 'PL0',
+ 'PL1',
+ 'PL2',
+ 'PL3',
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'WhiteIpGroup' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ 'ips' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'example' => '["10.2.xx.xx", "10.3.xx.xx"]',
+ 'extendType' => 'true',
+ ],
+ 'backendName' => 'ips',
+ ],
+ ],
+ ],
+ 'ZoneInfo' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'CloseManagedIndex' => [
+ 'summary' => 'Disable Managed Index',
+ 'path' => '/openapi/instances/{InstanceId}/indices/{Index}/close-managed',
+ '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' => 'Instance ID.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-m7r24d27d007q****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'Index',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'Index name. For parameter information, see [ListDataStreams](~~213188~~).',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'test-index1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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-',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\",\\n \\"Result\\": {\\n \\"name\\": \\"ds-\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateILMPolicy' => [
+ 'summary' => '创建索引生命周期策略',
+ 'path' => '/openapi/instances/{InstanceId}/ilm-policies',
+ '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' => '',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'my-policy',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"my-policy\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'CreateILMPolicy',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateIndexTemplate' => [
+ 'summary' => '创建索引模版',
+ 'path' => '/openapi/instances/{InstanceId}/index-templates',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w24n9u900am****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'E1136AE9-4E49-4585-9358-6FDD2A6D****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'indexTemplate' => [
+ 'title' => '索引模版名称',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'index-template',
+ ],
+ 'indexPatterns' => [
+ 'title' => '索引匹配模式正则',
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '索引匹配模式正则元素',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '["schema1*","schema2*"]',
+ ],
+ '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',
+ ],
+ '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\\":{}}',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ '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\\":{}}" } }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"index-template\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteDataStream' => [
+ 'summary' => '删除数据流',
+ 'path' => '/openapi/instances/{InstanceId}/data-streams/{DataStream}',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'DataStream',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ds-001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","type":"json"}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteILMPolicy' => [
+ 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}',
+ 'methods' => [
+ 'delete',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '64235',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyName',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'slm-history-ilm-policy',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '694FDC20-0FDD-47C4-B921-BFF902FA****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"694FDC20-0FDD-47C4-B921-BFF902FA****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteILMPolicy',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteIndexTemplate' => [
+ 'summary' => 'Deletes a top 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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082****',
+ ],
+ ],
+ [
+ 'name' => 'IndexTemplate',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'index-name',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'A0761F7E-0B50-46B9-8CAA-EBB3A420****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"A0761F7E-0B50-46B9-8CAA-EBB3A420****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteIndexTemplate',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeILMPolicy' => [
+ 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyName',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'policy-1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'FF44681E-FD41-4FDE-B8DF-295DCDD6****',
+ ],
+ 'Result' => [
+ 'description' => '',
+ '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":{}}}}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w24n9u900am****',
+ ],
+ ],
+ [
+ 'name' => 'IndexTemplate',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'data-stream-default',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '25DB38F8-82E4-4D16-82BB-FF077C7F****',
+ ],
+ 'Result' => [
+ 'description' => '',
+ '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\\":{}}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ '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' => '查询数据流',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082****',
+ ],
+ ],
+ [
+ 'name' => 'isManaged',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Log1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ 'Headers' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => [
+ 'path' => '/openapi/instances/{InstanceId}/ilm-policies',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-m7r23wodb006n****',
+ ],
+ ],
+ [
+ 'name' => 'policyName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'policy-1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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":{}}}}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListIndexTemplates' => [
+ 'path' => '/openapi/instances/{InstanceId}/index-templates',
+ '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' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082****',
+ ],
+ ],
+ [
+ 'name' => 'indexTemplate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'my-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,
+ 'example' => '50',
+ ],
+ ],
+ ],
+ '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\\"}',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RolloverDataStream' => [
+ 'summary' => '滚动数据流，生成新索引',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'DataStream',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ds-001',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateILMPolicy' => [
+ 'summary' => '修改ES集群索引生命周期策略',
+ 'path' => '/openapi/instances/{InstanceId}/ilm-policies/{PolicyName}',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif24adwc0082w2ka****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyName',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'my-policy',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'my-policy',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"my-policy\\",\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdateILMPolicy',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateIndexTemplate' => [
+ 'summary' => '修改ES集群索引模版配置',
+ 'path' => '/openapi/instances/{InstanceId}/index-templates/{IndexTemplate}',
+ 'methods' => [
+ 'put',
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w24n9u900am****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'IndexTemplate',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'my-template',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'my-template',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'title' => 'A short description of struct',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-tl329rbpc0001****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'template',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ '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" }',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'C20022BA-5382-4339-89FB-30AF48A05431',
+ ],
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-tl329rbpc0001****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'template',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'title' => 'A short description of struct',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-tl329rbpc0001****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'template',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9',
+ ],
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-tl329rbpc0001****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'template',
+ ],
+ ],
+ ],
+ '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" }',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-tl329rbpc0001****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'template',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-tl329rbpc0001****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'template',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '5',
+ 'default' => '1',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '10',
+ 'default' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => [
+ 'application/json',
+ 'application/octet-stream',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-t57p81n7ai89v****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'title' => 'A short description of struct',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-t57p81n7ai89v****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'component-openstore-index-template',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ '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" }',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ '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****',
+ ],
+ ],
+ [
+ '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' => 'deleteType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'protective',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '94B03BBA-A132-42C3-8367-0A0C1C45****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ 'requestParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateInstanceChargeType' => [
+ 'summary' => 'null',
+ 'path' => '/openapi/instances/{InstanceId}/actions/convert-pay-type',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ [
+ 'BearerToken' => [],
+ ],
+ ],
+ '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 ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-0pp1jxvcl000z****',
+ ],
+ ],
+ [
+ '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',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateDescription' => [
+ 'summary' => 'Changes the name of a specified Elasticsearch cluster.',
+ 'path' => '/openapi/instances/{InstanceId}/description',
+ 'methods' => [
+ 'patch',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The return results.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1ptcb30009****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The new name of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'aliyunes_name_test',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateReadWritePolicy' => [
+ 'summary' => '更改ES集群高可用策略',
+ 'path' => '/openapi/instances/{InstanceId}/actions/update-read-write-policy',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdateReadWritePolicy',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ModifyElastictask' => [
+ 'path' => '/openapi/instances/{InstanceId}/elastic-task',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '64337',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****',
+ ],
+ 'Result' => [
+ 'description' => '',
+ '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"]',
+ ],
+ ],
+ ],
+ ],
+ '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' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '["index"] ',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ModifyInstanceMaintainTime' => [
+ 'path' => '/openapi/instances/{InstanceId}/actions/modify-maintaintime',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{ "openMaintainTime": true, "maintainStartTime": "03:00Z", "maintainEndTime": "04:00Z" }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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",
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ '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' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => 'The IP address whitelists of the Kibana node. You cannot configure both the kibanaIPWhitelist and whiteIpGroup parameters.'."\n",
+ '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",
+ '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",
+ '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"]',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The details of the Elasticsearch cluster.'."\n",
+ 'type' => 'string',
+ 'example' => 'E5EF11F1-DBAE-4020-AC24-DFA6C4345CAE',
+ ],
+ 'Result' => [
+ 'description' => 'The private IP address whitelists for access to the Kibana console of the cluster.'."\n",
+ '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",
+ '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' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateWhiteIps' => [
+ 'summary' => 'Updates a private IP address whitelist of an Elasticsearch cluster.',
+ 'path' => '/openapi/instances/{InstanceId}/white-ips',
+ 'methods' => [
+ 'patch',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The request body.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-npk2154oi000b****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ '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,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'Result' => [
+ 'description' => 'The network configurations.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'esIPWhitelist' => [
+ 'description' => 'The list of whitelists.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '64319',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '\\[{"tagKey":"key1","tagValue":"value1"}]'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'vpc-bp16k1dvzxtmagcva\\*\\*\\*\\*'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'cn-hangzhou-i'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'aliyunes_test1',
+ ],
+ ],
+ [
+ 'name' => 'instanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'postpaid'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'es-cn-v641a0ta3000g****',
+ ],
+ ],
+ [
+ 'name' => 'esVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'advanced'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '6.7_with_X-Pack',
+ ],
+ ],
+ [
+ 'name' => 'resourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-aekzvowej3i****',
+ ],
+ ],
+ [
+ 'name' => 'tags',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The header of the response.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[{"tagKey":"key1","tagValue":"value1"}]',
+ ],
+ ],
+ [
+ 'name' => 'vpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vpc-bp16k1dvzxtmagcva****',
+ ],
+ ],
+ [
+ 'name' => 'zoneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The returned data.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou-i',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'instanceCategory',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of data nodes.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'advanced',
+ ],
+ ],
+ [
+ 'name' => 'status',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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",
+ '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '4XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeInstance' => [
+ 'summary' => 'The name of the dictionary file.',
+ 'path' => '/openapi/instances/{InstanceId}',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '64251',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-3h4k3axh33th9****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ 'Result' => [
+ 'description' => '',
+ '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',
+ ],
+ 'dictList' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'synonymsDicts' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'zoneInfos' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'status' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'NORMAL',
+ ],
+ 'zoneId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou-b',
+ ],
+ ],
+ ],
+ ],
+ 'aliwsDicts' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'tags' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'env',
+ ],
+ 'tagValue' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'dev',
+ ],
+ ],
+ ],
+ ],
+ 'esIPWhitelist' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '[ "0.0.0.0/0" ]',
+ ],
+ ],
+ 'extendConfigs' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'example' => '[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]',
+ ],
+ ],
+ 'privateNetworkIpWhiteList' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '0.0.0.0/0',
+ ],
+ ],
+ 'publicIpWhitelist' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '[ "0.0.0.0/0" ]',
+ ],
+ ],
+ 'kibanaPrivateIPWhitelist' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '["192.168.XX.XX"]',
+ ],
+ ],
+ 'esIPBlacklist' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '[ "0.0.0.0/0" ]',
+ ],
+ ],
+ 'kibanaIPWhitelist' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '[ "0.0.0.0/0" ]',
+ ],
+ ],
+ 'nodeSpec' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ 'networkConfig' => [
+ 'description' => '',
+ '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',
+ ],
+ 'whiteIpGroupList' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'whiteIpType' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'PRIVATE_ES',
+ ],
+ 'groupName' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'default',
+ ],
+ 'ips' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '["0.0.0.0", "127.0.XX.XX"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'kibanaConfiguration' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ 'masterConfiguration' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ 'clientNodeConfiguration' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ 'warmNodeConfiguration' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ 'advancedSetting' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'gcName' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'CMS',
+ ],
+ ],
+ ],
+ 'elasticDataNodeConfiguration' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ 'ikHotDicts' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'instanceCategory' => [
+ 'title' => '版本类型。',
+ 'description' => '',
+ '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',
+ ],
+ 'endpoints' => [
+ 'title' => '对于HP_ALILB 多可用区实例，每个可用区对应的私网域名',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => 'The edition of the cluster.'."\n",
+ 'extraInfo' => ' ',
+ ],
+ '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' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ ],
+ 'ListAllNode' => [
+ 'summary' => 'Queries the information of all the 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 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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '64267',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-6ja1ro4jt000c****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***',
+ ],
+ 'Result' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'index',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.',
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListInstanceIndices' => [
+ 'summary' => 'Queries the indexes stored on an Elasticsearch cluster.',
+ 'path' => '/openapi/instances/{InstanceId}/indices',
+ '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',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'false'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-tl329rbpc0001****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'createInstance' => [
+ 'summary' => 'Creates an Elasticsearch cluster.',
+ 'path' => '/openapi/instances',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ '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' => '实例标签组。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '实例标签。',
+ 'type' => 'object',
+ 'properties' => [
+ 'tagKey' => [
+ 'title' => '实例标签键。',
+ 'type' => 'string',
+ ],
+ 'tagValue' => [
+ 'title' => '实例标签值。',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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" } }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 202 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'instanceId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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",
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'EstimatedRestartTime' => [
+ 'path' => '/openapi/instances/{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' => '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,
+ ],
+ ],
+ ],
+ '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' => 'object',
+ 'properties' => [
+ 'unit' => [
+ 'description' => 'The unit.'."\n",
+ 'type' => 'string',
+ 'example' => 'second',
+ ],
+ 'value' => [
+ 'description' => 'The estimated restart time.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '50',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating',
+ ],
+ ],
+ ],
+ '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"
+ .' }',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RestartInstance' => [
+ 'path' => '/openapi/instances/{InstanceId}/actions/restart',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ '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-nif1q8auz0003****',
+ ],
+ ],
+ [
+ 'name' => 'force',
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****',
+ ],
+ 'Result' => [
+ 'description' => 'The return results.'."\n",
+ '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",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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 \\"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' => ' ',
+ ],
+ '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 ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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.',
+ 'requestParamsDescription' => '## RequestBody'."\n"
+ ."\n"
+ .'The following fields are also required in RequestBody to specify the renewal information.'."\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"
+ .'}'."\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ '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-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ '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' => [
+ 'description' => '请求体参数。',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '["cn-hangzhou-i","cn-hangzhou-h"]',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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-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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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",
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'translator' => 'machine',
+ ],
+ 'InterruptElasticsearchTask' => [
+ 'path' => '/openapi/instances/{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 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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ 'Result' => [
+ 'description' => 'Return results:'."\n"
+ ."\n"
+ .'* true: interrupted change successfully'."\n"
+ .'* false: interrupted change failed'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ResumeElasticsearchTask' => [
+ 'path' => '/openapi/instances/{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 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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'MigrateToOtherZone' => [
+ 'path' => '/openapi/instances/{InstanceId}/actions/migrate-zones',
+ '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 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',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ '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"
+ .'```'."\n"
+ .'{'."\n"
+ .' "fromZoneId": "cn-hangzhou-e",'."\n"
+ .' "toZoneId": "cn-hangzhou-f",'."\n"
+ .' "toVswitchId": "vsw-bp16t5hpc689dgkgc****"'."\n"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CancelDeletion' => [
+ 'summary' => 'Restores an Elasticsearch cluster that is frozen after it is released.',
+ 'path' => '/openapi/instances/{InstanceId}/actions/cancel-deletion',
+ '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 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****',
+ ],
+ ],
+ ],
+ '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 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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ '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-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" ] }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the report.'."\n",
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***',
+ ],
+ 'Result' => [
+ 'description' => 'The diagnosis status. Valid values: Supported: SUCCESS, FAILED, and RUNNING.'."\n",
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ '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' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => [
+ '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',
+ ],
+ 'kibanaDomain' => [
+ 'description' => 'The public endpoint of the Kibana console of the cluster.'."\n",
+ 'type' => 'string',
+ 'example' => 'es-cn-nif1q8auz0003****.kibana.elasticsearch.aliyuncs.com',
+ ],
+ 'updatedAt' => [
+ 'description' => 'The time when the cluster was last updated.'."\n",
+ 'type' => 'string',
+ 'example' => '2018-07-18T10:10:04.484Z',
+ ],
+ 'instanceId' => [
+ 'description' => 'The ID of the cluster.'."\n",
+ 'type' => 'string',
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ 'dictList' => [
+ 'description' => 'The configurations of IK 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',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'synonymsDicts' => [
+ 'description' => 'The configurations of 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',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'nodeSpec' => [
+ 'description' => 'The configurations of data nodes.'."\n",
+ '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',
+ ],
+ 'diskType' => [
+ 'description' => 'The storage type.'."\n",
+ 'type' => 'string',
+ 'example' => 'cloud_ssd',
+ ],
+ ],
+ ],
+ 'networkConfig' => [
+ 'description' => 'The network configurations.'."\n",
+ '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',
+ ],
+ 'type' => [
+ 'description' => 'The network type. Only the VPC is supported.'."\n",
+ 'type' => 'string',
+ 'example' => 'vpc',
+ ],
+ 'vswitchId' => [
+ 'description' => 'The ID of the vSwitch.'."\n",
+ 'type' => 'string',
+ 'example' => 'vsw-bp1k4ec6s7sjdbudw****',
+ ],
+ ],
+ ],
+ 'kibanaConfiguration' => [
+ 'description' => 'The configurations of Kibana nodes.'."\n",
+ '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',
+ ],
+ 'diskType' => [
+ 'description' => 'The storage type.'."\n",
+ 'type' => 'string',
+ 'example' => 'cloud_ssd',
+ ],
+ ],
+ ],
+ 'masterConfiguration' => [
+ 'description' => 'The configurations of dedicated master nodes.'."\n",
+ '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',
+ ],
+ 'disk' => [
+ 'description' => 'The storage capacity. Unit: GB.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ 'diskType' => [
+ 'description' => 'The storage type.'."\n",
+ 'type' => 'string',
+ 'example' => 'cloud_ssd',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CapacityPlan' => [
+ 'summary' => 'Capacity Planning',
+ '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',
+ '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.',
+ '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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ '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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'translator' => 'machine',
+ ],
+ 'GetOpenStoreUsage' => [
+ 'summary' => 'View the storage capacity and usage of the OpensStore instance.',
+ 'path' => '/openapi/instances/{InstanceId}/openstore/usage',
+ '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' => [
+ 'description' => 'es-cn-zvp2cqw1f0020\\*\\*\\*\\*'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-zvp2cqw1f0020****',
+ 'title' => '实例id',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '当前使用量',
+ ],
+ ],
+ ],
+ ],
+ 'title' => 'Schema of Response',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ 'Result' => [
+ 'description' => 'The returned result.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ ],
+ 'ListShardRecoveries' => [
+ 'path' => '/openapi/instances/{InstanceId}/cat-recovery',
+ '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 cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-7mz293m9a003j****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListTags' => [
+ 'summary' => 'All tags 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',
+ ],
+ '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' => 'resourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The tag value of the ENI.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INSTANCE',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListTagResources' => [
+ 'summary' => 'Queries the tags that are added to one or more resources.',
+ 'path' => '/openapi/tags',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ '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' => 'ResourceIds',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '["es-cn-aaa","es-cn-bbb"]',
+ ],
+ ],
+ [
+ '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"}]',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UntagResources' => [
+ 'summary' => 'Deletes a user resource tag relationship.',
+ 'path' => '/openapi/tags',
+ 'methods' => [
+ 'delete',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ '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' => 'All',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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******',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'TagResources' => [
+ 'summary' => 'Adds tags to clusters.',
+ 'path' => '/openapi/tags',
+ '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',
+ ],
+ ],
+ 'parameters' => [
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'title' => '返回结果，true 标签关联资源成功。',
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'title' => '请求ID。',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '3D8795D9-8FF5-46B2-86E6-E3B407*******',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteDataTask' => [
+ 'path' => '/openapi/instances/{InstanceId}/data-task',
+ 'methods' => [
+ 'delete',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'taskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the index migration task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'et_cn_0oyg09o96ib40****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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***',
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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.',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ 'name' => 'nodeType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'count',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of nodes to be migrated.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ '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 of the node.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '9200',
+ ],
+ 'host' => [
+ 'description' => 'The IP address of the node.'."\n",
+ 'type' => 'string',
+ 'example' => '192.168.**.**',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-oew1oxiro000f****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ '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 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"]',
+ ],
+ 'description' => 'The index list of the cluster.'."\n",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ 'name' => 'nodeType',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'ValidateTransferableNodes',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'TransferNode' => [
+ 'summary' => 'Runs a data migration task for node scaling operations.',
+ 'path' => '/openapi/instances/{InstanceId}/actions/transfer',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ 'name' => 'nodeType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'WORKER',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ '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 ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ 'name' => 'taskType',
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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 ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ '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' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ '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',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '"filebeat.inputs:xxx"',
+ ],
+ ],
+ '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,
+ ],
+ ],
+ '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" } ] }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '8466BDFB-C513-4B8D-B4E3-5AB256AB****',
+ ],
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'resId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'ct-cn-4135is2tj194p****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteCollector' => [
+ 'summary' => 'Deletes a shipper.',
+ 'path' => '/openapi/collectors/{ResId}',
+ 'methods' => [
+ 'delete',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResId',
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteCollector',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ModifyDeployMachine' => [
+ 'path' => '/openapi/collectors/{ResId}/actions/modify-deploy-machines',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The shipper ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ct-cn-xb1i7q79u65nk****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateCollector' => [
+ 'path' => '/openapi/collectors/{ResId}',
+ 'methods' => [
+ 'put',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The shipper ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ct-cn-77uqof2s7rg5c****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'extendConfigs' => [
+ 'description' => 'The extended parameters that are configured for the shipper.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ '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"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'collectorPaths' => [
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '["/var/log"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateCollectorName' => [
+ 'summary' => 'Changes the name of a shipper.',
+ 'path' => '/openapi/collectors/{ResId}/actions/rename',
+ '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 ID of the shipper.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ct-cn-77uqof2s7rg5c****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '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"
+ ."\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' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ .' }',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StartCollector' => [
+ 'summary' => 'Starts a collector to collect data.',
+ 'path' => '/openapi/collectors/{ResId}/actions/start',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the collector.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ct-cn-77uqof2s7rg5c****',
+ ],
+ ],
+ [
+ '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 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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => 'The returned result.'."\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',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'StartCollector',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StopCollector' => [
+ 'summary' => 'Stops a shipper.',
+ '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 shipper ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ct-cn-77uqof2s7rg5c****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ ],
+ 'DescribeCollector' => [
+ 'path' => '/openapi/collectors/{ResId}',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the shipper.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ct-cn-rg31ahn82m0qd****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '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"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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.',
+ '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",
+ 'extraInfo' => ' ',
+ ],
+ 'ListDefaultCollectorConfigurations' => [
+ 'path' => '/openapi/beats/default-configurations',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'resType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'resVersion',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '8BAE3C32-8E4A-47D6-B4B0-95B5DE643BF5',
+ ],
+ 'Result' => [
+ 'description' => 'The returned result.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListCollectors' => [
+ 'summary' => 'Queries a list of shippers.',
+ 'path' => '/openapi/collectors',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'resId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the shipper.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'ct-cn-77uqof2s7rg5c****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the shipper.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'collectorName1',
+ ],
+ ],
+ [
+ 'name' => 'instanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the resource with which the shipper is associated.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'es-cn-nif1q8auz0003****',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'sourceType',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ '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' => '5',
+ ],
+ ],
+ ],
+ 'Result' => [
+ 'description' => 'The returned result.'."\n",
+ '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",
+ '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' => [
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '["es-cn-n6w1o1x*****.elasticsearch.aliyuncs.com:9200"]',
+ ],
+ ],
+ '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',
+ ],
+ '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' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'instanceId' => [
+ 'description' => 'The IDs of the ECS instances.'."\n",
+ 'type' => 'string',
+ 'example' => 'i-bp13y63575oypr9d****',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ '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",
+ 'extraInfo' => ' ',
+ ],
+ 'ListNodes' => [
+ 'summary' => 'The list of historical reports of Intelligent Maintenance.',
+ 'path' => '/openapi/collectors/{ResId}/nodes',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ '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' => 'size',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ecsInstanceIds',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The IDs of the ECS instances.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'i-bp1ei8ysh7orb6eq****',
+ ],
+ ],
+ [
+ 'name' => 'ecsInstanceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the ECS instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'tags',
+ '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"}]',
+ ],
+ ],
+ [
+ 'name' => 'ResId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the shipper.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ct-cn-l871nd0u73c45****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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",
+ 'type' => 'object',
+ 'properties' => [
+ 'X-Total-Count' => [
+ 'description' => 'The number of entries returned.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'Result' => [
+ 'description' => 'The returned result.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RestartCollector' => [
+ 'summary' => 'Restarts a shipper.',
+ 'path' => '/openapi/collectors/{ResId}/actions/restart',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the shipper.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ct-cn-77uqof2s7rg5c****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"84B4038A-AF38-4BF4-9FAD-EA92A4FFF00A\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'RestartCollector',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ReinstallCollector' => [
+ 'summary' => 'Installs a shipper that failed to be installed when you create the shipper.',
+ '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',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ResId',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ '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****',
+ ],
+ ],
+ [
+ '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"
+ .'}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ .' }',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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 request.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1ptcb30009****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The result of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'orderActionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of data nodes.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'upgrade',
+ ],
+ ],
+ [
+ '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' => 'force',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ '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",
+ 'type' => 'object',
+ 'properties' => [
+ 'nodeAmount' => [
+ 'description' => 'The billing method of the instance. 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"
+ ."\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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'disk' => [
+ 'description' => 'The node specifications.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ 'diskType' => [
+ 'description' => 'The number of nodes.'."\n",
+ 'type' => 'string',
+ 'example' => 'cloud_ssd',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'amount' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '3',
+ ],
+ 'disk' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '20',
+ ],
+ 'diskType' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'cloud_ssd',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ 'name' => 'nodeType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'count',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of nodes that you want to remove.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ignoreStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to ignore the instance status. Default value: false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ '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.**.**',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '2'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ 'name' => 'nodeType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ignoreStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'count',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'es-cn-pl32xxxxxxx-data-f-1',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ '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',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ 'name' => 'nodeType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'WORKER',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'ignoreStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'count',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '64397',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ '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' => [
+ 'title' => '用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过64个ASCII字符。',
+ 'description' => 'The moderation results.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'dryRun',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ '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',
+ ],
+ ],
+ 'plugins' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'updateStrategy',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'blue_green: 蓝绿变更'."\n"
+ .'normal： 原地变更'."\n"
+ .'intelligent： 智能变更',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The verification information.'."\n",
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC*****',
+ ],
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ '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",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'status' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ '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-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ 'name' => 'updateStrategy',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ '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',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'esConfig' => [
+ 'title' => '对于对象类型，指定待更新的 YML 参数的值。',
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'title' => '指定待更新的 YML 参数的key',
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'docRequired' => false,
+ ],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否强制变更',
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "esConfig": {'."\n"
+ .' "thread_pool.bulk.queue_size": 500'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateHotIkDicts' => [
+ 'summary' => 'null',
+ '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',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-oew1q8bev0002****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The cluster ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '7C5622CC-B312-426F-85AA-B0271*******',
+ ],
+ 'Result' => [
+ 'description' => 'The returned result.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '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',
+ ],
+ 'type' => [
+ 'description' => 'The dictionary type. Valid values:'."\n"
+ ."\n"
+ .'* MAIN: IK main dicrionary'."\n"
+ .'* STOP: IK stopword list'."\n",
+ 'type' => 'string',
+ 'example' => 'MAIN',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ .'```',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ '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-09k1ruw79000u****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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 ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateExtendConfig' => [
+ 'path' => '/openapi/instances/{InstanceId}/extend-configs/actions/update',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdateExtendConfig',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateTemplate' => [
+ 'path' => '/openapi/instances/{InstanceId}/templates/{TemplateName}',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'TemplateName',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dynamicSettings',
+ ],
+ ],
+ [
+ '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}" }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => true,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Result' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'esIPBlacklist' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => null,
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'example' => 'dynamicSettings',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListAckClusters' => [
+ 'path' => '/openapi/ack-clusters',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '50',
+ 'minimum' => '1',
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'vpcId',
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'F93EAA49-284F-4FCE-9E67-FA23FB4BB512',
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ 'name' => 'bucketName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'search-cloud-test-cn-****',
+ ],
+ ],
+ [
+ 'name' => 'key',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'oss/dic_0.dic',
+ ],
+ ],
+ [
+ 'name' => 'analyzerType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'ALIWS',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '7C4334EA-D22B-48BD-AE28-08EE68******',
+ ],
+ 'Result' => [
+ 'description' => '',
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ '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',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'test'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '["i-bp13y63575oypr9d****","i-bp1gyhphjaj73jsr****"]',
+ ],
+ ],
+ [
+ 'name' => 'ecsInstanceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '\\[{ "tagKey":"a","tagValue":"b"}]'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'tags',
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ '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",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the ACK cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'c79acd3fbf462423fb6450e513bb6****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ ],
+ 'GetRegionConfiguration' => [
+ 'path' => '/openapi/region',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '64288',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'zoneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou-f',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6F******',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => 'The minimum number of nodes.'."\n",
+ 'extraInfo' => ' ',
+ ],
+ 'ListAckNamespaces' => [
+ 'path' => '/openapi/ack-clusters/{ClusterId}/namespaces',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ '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' => 'size',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'c79acd3fbf462423fb6450e513bb6****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\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.',
+ 'extraInfo' => ' ',
+ ],
+ 'InstallAckOperator' => [
+ 'summary' => 'Installs ES-operator for a Container Service for Kubernetes (ACK) cluster.',
+ 'path' => '/openapi/ack-clusters/{ClusterId}/operator',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClusterId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The cluster ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'c79acd3fbf462423fb6450e513bb6****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ '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-i7m27ausp001l****',
+ ],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6F*****',
+ ],
+ 'Result' => [
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '["pluginName1.zip", "pluginName2.zip"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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-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"
+ ."\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"
+ ."\n"
+ .'Sample code:'."\n"
+ ."\n"
+ .'```'."\n"
+ .'['."\n"
+ .' {"name": "pluginName1.zip"},'."\n"
+ .' {"name": "pluginName2.zip"}'."\n"
+ .']'."\n"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RecommendTemplates' => [
+ 'path' => '/openapi/instances/{InstanceId}/recommended-templates',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '64346',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-oew20apwz0007****',
+ ],
+ ],
+ [
+ 'name' => 'usageScenario',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '*'."\n"
+ .'*'."\n"
+ .'*'."\n"
+ .'*'."\n"
+ .'*'."\n"
+ ."\n"
+ .'**'."\n"
+ ."\n"
+ .'****'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'general',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ValidateSlrPermission' => [
+ 'path' => '/openapi/user/servicerolepermission',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '64400',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchZEMBRN',
+ ],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'rolename',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'AliyunServiceRoleForElasticsearchCollector',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'BC4ED7DD-8C84-49B5-8A95-456F82E44D13',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.|',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListPlugins' => [
+ 'summary' => 'Queries the plug-ins that are installed on a specified Elasticsearch cluster.',
+ 'path' => '/openapi/instances/{InstanceId}/plugins',
+ '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',
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The header of the response.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'source',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The total number of entries returned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'SYSTEM',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'InstallSystemPlugin' => [
+ 'path' => '/openapi/instances/{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' => '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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",
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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-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.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UninstallPlugin' => [
+ 'summary' => 'Call UninstallPlugin to uninstall the preset plug-in.',
+ 'path' => '/openapi/instances/{InstanceId}/plugins/actions/uninstall',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ [
+ 'name' => 'force',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否强制卸载。可取消安装正在安装中的插件，仅限于新架构实例。默认值：false。',
+ 'type' => 'boolean',
+ 'default' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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-mysql"]',
+ ],
+ 'description' => 'The list of plug-ins to be unloaded. If the unloading fails, an exception is returned.'."\n",
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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' => ' ',
+ ],
+ 'GetEmonMonitorData' => [
+ 'summary' => 'GetEmonMonitorData',
+ 'path' => '/openapi/emon/projects/{ProjectId}/metrics/query',
+ 'methods' => [
+ 'post',
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-185320276651****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ '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-tl325wxga000l****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ 'Result' => [
+ 'description' => 'The color that indicates the health status of the cluster.'."\n",
+ 'type' => 'string',
+ 'example' => 'GREEN',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetEmonGrafanaAlerts' => [
+ 'summary' => '获取高级监控报警自定义Grafana监控报警项',
+ 'path' => '/openapi/emon/projects/{ProjectId}/grafana/proxy/api/alerts',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchEC84H8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-133071096032****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetEmonGrafanaDashboards' => [
+ 'summary' => '获取高级监控报警自定义Grafana监控大盘列表',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-133071096032****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'PostEmonTryAlarmRule' => [
+ 'summary' => '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' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchEC84H8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ProjectId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-133071096032****',
+ ],
+ ],
+ [
+ 'name' => 'AlarmGroupId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":""}]',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListSearchLog' => [
+ 'summary' => 'Queries the logs of an Elasticsearch cluster.',
+ 'path' => '/openapi/instances/{InstanceId}/search-log',
+ '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' => [
+ 'FEATUREelasticsearchCDBLP9',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'title' => '',
+ 'description' => '1531910852074'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '1531910852074'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'INSTANCELOG',
+ ],
+ ],
+ [
+ 'name' => 'query',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '1'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'host:172.16.**.** AND content:netty',
+ ],
+ ],
+ [
+ '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 header of the response.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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",
+ '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' => '',
+ '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]] ...])."}',
+ ],
+ 'instanceId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ 'level' => [
+ 'description' => 'The timestamp when the log is generated. Unit: ms.'."\n",
+ 'type' => 'string',
+ 'example' => 'info',
+ ],
+ 'host' => [
+ 'description' => 'Details of the log entry. Different content fields are returned for different log types.'."\n",
+ 'type' => 'string',
+ 'example' => '192.168.**.**',
+ ],
+ '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] ',
+ ],
+ 'timestamp' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1531985112420',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'AddConnectableCluster' => [
+ 'path' => '/openapi/instances/{InstanceId}/connected-clusters',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'es-cn-n6w1o1x0w001c\\*\\*\\*\\*'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'description' => '请求体。',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{ "instanceId":"es-cn-09k1rgid9000g****" }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => 'The following information is returned:'."\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' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteConnectedCluster' => [
+ 'path' => '/openapi/instances/{InstanceId}/connected-clusters',
+ 'methods' => [
+ 'delete',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the current 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****',
+ ],
+ ],
+ [
+ 'name' => 'connectedInstanceId',
+ 'in' => 'query',
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'extraInfo' => ' ',
+ ],
+ 'UpdatePublicWhiteIps' => [
+ 'summary' => 'null',
+ 'path' => '/openapi/instances/{InstanceId}/public-white-ips',
+ 'methods' => [
+ 'patch',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'extraInfo' => ' ',
+ ],
+ 'UpdatePublicNetwork' => [
+ 'summary' => 'null',
+ 'path' => '/openapi/instances/{InstanceId}/public-network',
+ 'methods' => [
+ 'patch',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ '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-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ .'```',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-nif1q9o8r0008****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'esAdminPassword' => [
+ 'title' => 'Elasticsearch实例的elastic账号的密码。',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'es_password',
+ 'maxLength' => 32,
+ 'minLength' => 8,
+ ],
+ ],
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{ "esAdminPassword": "es_password*" }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '0FA05123-745C-42FD-A69B-AFF48EF9****',
+ ],
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'extraInfo' => ' ',
+ ],
+ 'ModifyWhiteIps' => [
+ 'path' => '/openapi/instances/{InstanceId}/actions/modify-white-ips',
+ 'methods' => [
+ 'patch',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1DERFG',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ '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 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***',
+ ],
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'networkType' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'vpc',
+ ],
+ 'instances' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'es-cn-xxx',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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 {\\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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListConnectedClusters' => [
+ 'summary' => 'Call ListConnectedClusters to query the instances that are interconnected with the current instance.',
+ 'path' => '/openapi/instances/{InstanceId}/connected-clusters',
+ '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 current instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-0pp1jxvcl000z****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'TriggerNetwork' => [
+ 'summary' => 'You can call this operation to enable or disable public or private network access for a Elasticsearch or Kibana cluster.',
+ 'path' => '/openapi/instances/{InstanceId}/actions/network-trigger',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '407d02b74c49beb5bfdac7ec8bde2488',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '',
+ 'description' => '',
+ '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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5A5D8E74-565C-43DC-B031-29289FA****',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ '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****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ ],
+ 'CloseHttps' => [
+ 'path' => '/openapi/instances/{InstanceId}/actions/close-https',
+ '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' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B350****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DC****',
+ ],
+ ],
+ ],
+ ],
+ '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' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateVpcEndpoint' => [
+ 'summary' => '创建私网链接VPC终端节点',
+ 'path' => '/openapi/instances/{InstanceId}/vpc-endpoints',
+ '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 ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-2r429tctl000d****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The returned result details.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***',
+ ],
+ ],
+ [
+ 'name' => 'dryRun',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user endpoint service associated with the endpoint.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'serviceId' => [
+ 'title' => '终端节点服务ID',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'epsrv-hp3xdsq46ael67lo****',
+ ],
+ 'zoneId' => [
+ 'title' => '可用区ID',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou-i',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteVpcEndpoint' => [
+ 'summary' => 'Deletes an endpoint in the VPC within the Elasticsearch 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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-2r429tctl000d****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***',
+ ],
+ ],
+ [
+ 'name' => 'EndpointId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ep-bp18s6wy9420wdi4****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC47D9',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'DeleteVpcEndpoint',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListVpcEndpoints' => [
+ 'path' => '/openapi/instances/{InstanceId}/vpc-endpoints',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The cluster ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-2r429tctl000d****',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ '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 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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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***',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'AddSnapshotRepo' => [
+ 'path' => '/openapi/instances/{InstanceId}/snapshot-repos',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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.',
+ 'requestParamsDescription' => '## RequestBody'."\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"
+ .'}'."\n"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteSnapshotRepo' => [
+ 'path' => '/openapi/instances/{InstanceId}/snapshot-repos',
+ 'methods' => [
+ 'delete',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ '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-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ 'name' => 'repoPath',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Reference instance ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1rux8i000w****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-oew1rgiev0009****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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 ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-0pp1jxvcl000z****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => 'object',
+ 'properties' => [
+ 'Enable' => [
+ 'description' => 'Whether to enable automatic backup.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'QuartzRegex' => [
+ 'description' => 'Automatic backup time configuration, using Quartz Cron expression.'."\n",
+ 'type' => 'string',
+ 'example' => '0 0 01 ? * * *',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 404 => [
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The specified cluster does not exist. Check the cluster status and try again.',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-0pp1jxvcl000z****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => [
+ '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',
+ ],
+ 'instanceId' => [
+ 'description' => 'Reference instance ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'es-cn-6ja1ro4jt000c****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-0pp1jxvcl000z****',
+ ],
+ ],
+ [
+ 'name' => 'alreadySetItems',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Indicates whether to return the OSS reference repository added. The return value. Valid values: true and false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '163553',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchMWTZRB',
+ 'FEATUREelasticsearchEC84H8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'en' => '',
+ 'zt' => '',
+ 'fr' => '',
+ 'zh' => '',
+ 'es' => '',
+ ],
+ 'example' => 'en',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D****',
+ ],
+ '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异常，可能会导致数据丢失，且会造成系统资源消耗严重',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ '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****',
+ ],
+ ],
+ [
+ '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' => 'lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The language of the response. Default value: en.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'en',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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.',
+ 'requestParamsDescription' => '## RequestBody'."\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'detail',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'SYSTEM'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'trigger',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'SYSTEM',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ '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",
+ '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 -&gt; 1][geoname09 : 0 -&gt; 1][geonametest01 : 0 -&gt; 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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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 -&gt; 1][geoname09 : 0 -&gt; 1][geonametest01 : 0 -&gt; 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' => ' ',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ '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-n6w1qu7ei000p****',
+ ],
+ ],
+ [
+ 'name' => 'lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The language of the reports.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'spanish',
+ ],
+ ],
+ [
+ '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' => 'endTime',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-mp91kzb8m0009****',
+ ],
+ ],
+ [
+ 'name' => 'lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'en',
+ ],
+ ],
+ [
+ 'name' => 'ReportId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'scheduled__2020-09-15T00:40:00',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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 -&gt; 1][geoname09 : 0 -&gt; 1][geonametest01 : 0 -&gt; 1]',
+ ],
+ 'suggest' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'You can call the following function in the Elasticsearch API....',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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 -&gt; 1][geoname09 : 0 -&gt; 1][geonametest01 : 0 -&gt; 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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeDiagnosisSettings' => [
+ 'path' => '/openapi/diagnosis/instances/{InstanceId}/settings',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of an instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-68n1n8b7f000a****',
+ ],
+ ],
+ [
+ 'name' => 'lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The language of the returned result. Default value: en.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'en',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '5E82B8A8-EED7-4557-A6E9-D1AD3E58****',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ '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 cluster ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ 'name' => 'lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The language. Multiple languages are supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'en',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'F05ED12E-140A-4ACB-B059-3A508A69F2E1',
+ ],
+ 'Result' => [
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '["my_index_aliws", "aliyun-index-test","filebeat-6.7.0-2020.11.15", "filebeat-6.7.0-2020.12.27"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'OpenDiagnosis' => [
+ 'path' => '/openapi/diagnosis/instances/{InstanceId}/actions/open-diagnosis',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'en',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CloseDiagnosis' => [
+ 'summary' => 'Disables the intelligent O\\&M feature for an Elasticsearch cluster.',
+ 'path' => '/openapi/diagnosis/instances/{InstanceId}/actions/close-diagnosis',
+ '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' => '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****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'lang',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'spanish',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'CloseDiagnosis',
+ 'requestParamsDescription' => ' ',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ '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****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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*****',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\n"
+ .'You can also specify the Kibana language by setting the **i18n.locale** parameter in RequestBody (optional, valid value: en by default). Example: '."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "i18n.locale":"en"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ .'> The `i18n.locale` parameter can only be en (English) or zh-CN (Chinese).',
+ 'responseParamsDescription' => ' ',
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ '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*****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'ListKibanaPlugins' => [
+ 'summary' => 'Queries a list of Kibana plug-ins.',
+ 'path' => '/openapi/instances/{InstanceId}/kibana-plugins',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchWSK8NP',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-oew1q8bev0002****',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of the page to return. Default value: 1.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries to return on each page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'schema' => [
+ 'description' => 'The ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-n6w1o1x0w00******',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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",
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ 'requestParamsDescription' => '## RequestBody'."\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"]`.',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UninstallKibanaPlugin' => [
+ 'summary' => 'Call the UninstallKibanaPlugin to uninstall the Kibana plug-in.',
+ '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 ID of the instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'es-cn-6ja1ro4jt000c****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ '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",
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => '## RequestBody'."\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"]`.',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteLogstash' => [
+ 'path' => '/openapi/logstashes/{InstanceId}',
+ 'methods' => [
+ 'delete',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-n6w1o5jq****',
+ ],
+ ],
+ [
+ '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' => 'deleteType',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '94B03BBA-A132-42C3-8367-0A0C1C45****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '64388',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchDYS3SR',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-n6w1o5jq****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '',
+ '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',
+ 'required' => false,
+ 'maximum' => '20',
+ 'minimum' => '1',
+ 'example' => '3',
+ ],
+ ],
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-n6w1o5jq****',
+ ],
+ ],
+ [
+ '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',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'description' => [
+ 'type' => 'string',
+ ],
+ ],
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\n"
+ .' {'."\n"
+ .' "description": "logstash_name"'."\n"
+ .' }'."\n",
+ 'responseParamsDescription' => 'The returned result also contains the following parameters.'."\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~~).',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateLogstashChargeType' => [
+ 'path' => '/openapi/logstashes/{InstanceId}/actions/convert-pay-type',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'The ID of the cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-n6w1o5jq****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ ],
+ 'ListLogstash' => [
+ 'summary' => 'Queries the information about a Logstash cluster or all Logstash clusters.',
+ 'path' => '/openapi/logstashes',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ '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' => 'version',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5.5.3_with_X-Pack',
+ ],
+ ],
+ [
+ 'name' => 'resourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Details of the request header.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-acfm2h5vbzd****',
+ ],
+ ],
+ [
+ 'name' => 'tags',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries returned per page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '[{"tagKey":"key1","tagValue":"value1"}]',
+ ],
+ ],
+ ],
+ '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",
+ 'type' => 'object',
+ 'properties' => [
+ 'X-Total-Count' => [
+ 'description' => 'The number of data nodes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeLogstash' => [
+ 'summary' => 'Queries the information about a Logstash cluster.',
+ 'path' => '/openapi/logstashes/{InstanceId}',
+ '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' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-s9dsk3k4k****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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",
+ '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",
+ 'type' => 'string',
+ 'example' => '7.4.0_with_X-Pack',
+ ],
+ 'instanceId' => [
+ 'description' => 'The access information of the node.'."\n",
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ '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-n6w1o5jq****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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"
+ ."\n"
+ .'You must configure the following parameters in the request body.'."\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"
+ ."\n\n"
+ .'Sample code:'."\n"
+ ."\n"
+ .'```'."\n"
+ .'{'."\n"
+ .' "duration":1,'."\n"
+ .' "pricingCycle":"Year"'."\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ 'Result' => [
+ 'description' => '',
+ '$ref' => '#/components/schemas/Logstash',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\n"
+ .'Sample code:'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "restartType":"nodeIp",'."\n"
+ .' "nodes": ["172.16.xx.xx"],'."\n"
+ .' "blueGreenDep":true'."\n"
+ .' }',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdateLogstashSettings' => [
+ 'summary' => 'Updates the configuration of the specified Logstash instance.',
+ 'path' => '/openapi/logstashes/{InstanceId}/instance-settings',
+ 'methods' => [
+ 'patch',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => 'ls-cn-2r42btxr\\*\\*\\*\\*'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-2r42btxr****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '5A2CFF0E-5718-45B5-9D4D-70B3FF\\*\\*\\*\\*'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '71D0D1DA-B22F-58CB-AF5B-D1657A6A****',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\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. |',
+ 'extraInfo' => ' ',
+ ],
+ '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 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 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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '3'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-oew1qbgl****',
+ ],
+ ],
+ [
+ 'name' => 'name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'USER'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'logstash-filter-clone',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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-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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'example' => '["logstash-input-datahub", "logstash-input-maxcompute" ]',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ 'Result' => [
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '["logstash-input-datahub", "logstash-input-maxcompute" ]',
+ ],
+ 'description' => '',
+ ],
+ 'Headers' => [
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'extraInfo' => ' ',
+ ],
+ 'ListLogstashLog' => [
+ 'summary' => 'Queries the logs of a Logstash cluster.',
+ 'path' => '/openapi/logstashes/{InstanceId}/search-log',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-oew1qbgl****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '5XX' => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => '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' => [
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ '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',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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***',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\n"
+ .'Sample code:'."\n"
+ ."\n"
+ .' {'."\n"
+ .' "endpoints": ['."\n"
+ .' "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"'."\n"
+ .' ],'."\n"
+ .' "userName": "elastic",'."\n"
+ .' "password": "xxxx"'."\n"
+ .' }',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ '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 cluster ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-4591f1y6****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ 'Result' => [
+ 'description' => 'Indicates whether the task is suspended. Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreatePipelines' => [
+ 'summary' => 'Creates a pipeline in a Logstash cluster.',
+ 'path' => '/openapi/logstashes/{InstanceId}/pipelines',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-oew1qbgl****',
+ ],
+ ],
+ [
+ 'name' => 'trigger',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否部署。true，保存并部署。false，仅保存。',
+ 'description' => '',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ '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',
+ ],
+ ],
+ '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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ '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 cluster.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-oew1qbgl****',
+ ],
+ ],
+ [
+ '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' => 'pipelineIds',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the pipeline.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'pipeline-test',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UpdatePipelines' => [
+ 'summary' => 'Updates a pipeline of a Logstash cluster.',
+ 'path' => '/openapi/logstashes/{InstanceId}/pipelines',
+ 'methods' => [
+ 'put',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'trigger',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to deploy the pipeline immediately.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ '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,
+ 'docRequired' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\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"
+ ."\n"
+ .'```'."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "pipelineId": "test",'."\n"
+ .' "config": "input {\\n\\n}\\nfilter {\\n\\n}\\noutput {\\n \\n}"'."\n"
+ .' }'."\n"
+ .']'."\n"
+ .'```',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StopPipelines' => [
+ 'path' => '/openapi/logstashes/{InstanceId}/pipelines/action/stop',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ '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****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '64390',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchDYS3SR',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-oew1qbgl****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '******',
+ ],
+ 'pipelineIds' => [
+ 'title' => 'Kibana管理的管道列表。管理方式为ES设置',
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'Kibana管理的管道。管理方式为ES设置',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '["testKibanaManagement"]',
+ ],
+ 'required' => false,
+ ],
+ 'pipelineManagementType' => [
+ 'title' => '管道管理方式',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ES',
+ 'enum' => [
+ '',
+ '',
+ ],
+ ],
+ 'esInstanceId' => [
+ 'type' => 'string',
+ ],
+ ],
+ 'required' => false,
+ 'example' => '{ "pipelineManagementType": "ES", "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "pipelineIds": [ "testKibanaManagement" ], "userName": "elastic", "password": "xxxx", "esInstanceId": "es-cn-n6w1o1x0w001c****" }',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ 404 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
+ 'title' => 'UpdatePipelineManagementConfig',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListPipeline' => [
+ 'summary' => 'Queries a list of pipelines.',
+ 'path' => '/openapi/logstashes/{InstanceId}/pipelines',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '15'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-oew1qbgl****',
+ ],
+ ],
+ [
+ 'name' => 'pipelineId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'pipeline_test',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The header of the response.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribePipeline' => [
+ 'path' => '/openapi/logstashes/{InstanceId}/pipelines/{PipelineId}',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'PipelineId',
+ 'in' => 'path',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribePipelineManagementConfig' => [
+ 'summary' => 'Queries the management configurations of pipelines in a Logstash cluster.',
+ 'path' => '/openapi/logstashes/{InstanceId}/pipeline-management-config',
+ '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****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RunPipelines' => [
+ 'path' => '/openapi/logstashes/{InstanceId}/pipelines/action/run',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ '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-oew1qbgl****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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",
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateLogstash' => [
+ 'summary' => 'Creates a Logstash cluster.',
+ 'path' => '/openapi/logstashes',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5A2CFF0E-5718-45B5-9D4D-70B3FF****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'description' => [
+ 'title' => 'Logstash实例别名。',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ls-cn-abc',
+ ],
+ 'resourceGroupId' => [
+ 'title' => 'Logstash实例所属资源组。',
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7.4.0_with_X-Pack',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****',
+ ],
+ 'Result' => [
+ 'description' => '',
+ '$ref' => '#/components/schemas/Logstash',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 500 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ '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-oew1qbgl****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ls-cn-7g1umu96oit2e****',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '{ "userName":"elastic", "password":"xxxxxx" }',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ '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-m7r1vsi2****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'InstanceActivating',
+ 'errorMessage' => 'Instance is activating.',
+ ],
+ [
+ 'errorCode' => 'InstanceNotFound',
+ 'errorMessage' => 'The instanceId provided does not exist.',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ 'in' => 'path',
+ 'schema' => [
+ 'title' => 'A short description of struct',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'es-cn-xxxx',
+ ],
+ ],
+ [
+ 'name' => 'zone',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou-i',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F99407AB-2FA9-489E-A259-40CF6DCC47D9\\"\\n}","type":"json"}]',
+ 'title' => 'TurnOnZone',
+ ],
+ 'ListInstanceHistoryEvents' => [
+ 'summary' => '集群触发的硬件运维事件列表',
+ 'path' => '/openapi/events',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'instanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'es-cn-2r42l7a740005****',
+ ],
+ ],
+ [
+ 'name' => 'nodeIP',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10.1.xx.xx',
+ ],
+ ],
+ [
+ 'name' => 'eventType',
+ 'in' => 'query',
+ 'style' => 'simple',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'eventLevel',
+ 'in' => 'query',
+ 'style' => 'simple',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'INFO,WARN',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'eventCreateStartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1645596516000',
+ ],
+ ],
+ [
+ 'name' => 'eventCreateEndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1645596516000',
+ ],
+ ],
+ [
+ 'name' => 'eventExecuteStartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1645596516000',
+ ],
+ ],
+ [
+ 'name' => 'eventExecuteEndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1645596516000',
+ ],
+ ],
+ [
+ 'name' => 'eventFinashStartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1645596516000',
+ ],
+ ],
+ [
+ 'name' => 'eventFinashEndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1645596516000',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'eventCycleStatus',
+ 'in' => 'query',
+ 'style' => 'simple',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'EXECUTED,FAILED',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => [
+ 'title' => '幂等参数',
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'mode',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'type' => 'boolean',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => null,
+ ],
+ 'DescribeDynamicSettings' => [
+ 'summary' => '获取集群动态指标',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'title' => 'Id of the request',
+ 'type' => 'string',
+ ],
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => null,
+ ],
+ 'ListActionRecords' => [
+ 'summary' => '变更记录 变更详情',
+ 'path' => '/openapi/instances/{InstanceId}/action-records',
+ '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',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'title' => 'A short description of struct',
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'requestId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'userId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'actionNames',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'filter',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ ],
+ [
+ 'name' => 'size',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ ],
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => null,
+ ],
+ 'DisableKibanaPvlNetwork' => [
+ 'summary' => 'Disable Private Network Access of Kibana',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => [
+ 'application/json',
+ ],
+ 'produces' => [
+ 'application/json',
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '203898',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearch2PSU4E',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'path',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-n6w1o1x0w001c****',
+ ],
+ ],
+ [
+ 'name' => 'pvlId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'es-cn-27a3mul6l0***-kibana-internal',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '用于保证请求的幂等性',
+ 'type' => 'string',
+ 'example' => 'xxxx',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F99407AB-2FA9-489E-A259-40CF6DCC****',
+ ],
+ ],
+ ],
+ ],
+ 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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-mp91kzb8m0009****',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ '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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'es-cn-n6w1oxxx****',
+ ],
+ ],
+ [
+ 'name' => 'clientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '用于保证请求的幂等性',
+ 'type' => 'string',
+ 'example' => 'xxxxx',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '0DC92CFE-62AF-51AF-9D5B-F1078D7C451E',
+ ],
+ ],
+ ],
+ ],
+ 400 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'type' => 'string',
+ ],
+ 'Code' => [
+ 'type' => 'string',
+ ],
+ 'Message' => [
+ 'type' => 'string',
+ ],
+ 'Success' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ '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',
+ ],
+ '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',
+ 'in' => 'path',
+ 'schema' => [
+ 'title' => 'A short description of struct',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'es-cn-abc',
+ ],
+ ],
+ [
+ 'name' => 'zone',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou-i',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ ],
+];
diff --git a/data/en_us/elasticsearch/2019-04-22/api-docs.php b/data/en_us/elasticsearch/2019-04-22/api-docs.php
new file mode 100644
index 0000000..48ce59c
--- /dev/null
+++ b/data/en_us/elasticsearch/2019-04-22/api-docs.php
@@ -0,0 +1,468 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'elasticsearch',
+ 'version' => '2019-04-22',
+ ],
+ 'directories' => [
+ [
+ 'id' => 62994,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeVSwitches',
+ ],
+ ],
+ [
+ 'id' => 62996,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeVpcs',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'DescribeVSwitches' => [
+ 'summary' => '获取用户交换机列表',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '64424',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchFBYZT8',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ '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',
+ ],
+ 'VSwitches' => [
+ 'description' => '',
+ 'properties' => [
+ 'VSwitch' => [
+ 'description' => '',
+ 'items' => [
+ 'properties' => [
+ 'Status' => [
+ 'description' => '',
+ 'example' => 'Available',
+ 'title' => '交换机的状态，取值：'."\n"
+ .'Pending：配置中。'."\n"
+ .'Available：可用。',
+ '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',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ 'title' => '交换机数据结构体。',
+ 'type' => 'array',
+ ],
+ ],
+ 'title' => '交换机数组结果',
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B\\",\\n \\"VSwitches\\": {\\n \\"VSwitch\\": [\\n {\\n \\"Status\\": \\"Available\\",\\n \\"VSwitchId\\": \\"vsw-25bcdxs7pv1****\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"172.16.0.0/24\\",\\n \\"GmtCreate\\": \\"2022-01-18T12:43:57Z\\",\\n \\"VSwitchName\\": \\"vswitch\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVSwitchesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83B</RequestId>\\n <VSwitches>\\n <VSwitch>\\n <Status>Available</Status>\\n <VSwitchId>vsw-25bcdxs7pv1****</VSwitchId>\\n <IsDefault>true</IsDefault>\\n <CidrBlock>172.16.0.0/24</CidrBlock>\\n <GmtCreate>2022-01-18T12:43:57Z</GmtCreate>\\n <VSwitchName>vswitch</VSwitchName>\\n </VSwitch>\\n </VSwitches>\\n</DescribeVSwitchesResponse>","errorExample":""}]',
+ 'title' => 'DescribeVSwitches',
+ ],
+ 'DescribeVpcs' => [
+ 'summary' => 'VPC列表',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '64423',
+ 'abilityTreeNodes' => [
+ 'FEATUREelasticsearchGHNE3U',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B',
+ 'title' => '唯一请求ID',
+ 'type' => 'string',
+ ],
+ 'Vpcs' => [
+ 'description' => '',
+ 'properties' => [
+ 'Vpc' => [
+ 'description' => '',
+ 'items' => [
+ 'description' => '',
+ 'properties' => [
+ 'VpcId' => [
+ 'description' => '',
+ 'example' => 'vpc-bp1qpo0kug3a20qqe****',
+ 'title' => 'vpc唯一标识',
+ 'type' => 'string',
+ ],
+ 'VpcName' => [
+ 'description' => '',
+ 'example' => 'vpc1',
+ 'title' => 'vpc名称',
+ 'type' => 'string',
+ ],
+ 'Status' => [
+ 'description' => '',
+ 'example' => 'Available',
+ 'title' => 'VPC的状态，取值：'."\n"
+ .'Pending：配置中。'."\n"
+ .'Available：可用。',
+ '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',
+ ],
+ 'VSwitchs' => [
+ 'description' => '',
+ 'items' => [
+ 'description' => '',
+ 'example' => 'vsw-bp1nhbnpv2blyz8dl****',
+ 'title' => 'vpc交换机标识',
+ 'type' => 'string',
+ ],
+ 'title' => '查询到的VPC中交换机的列表信息。最多可以查询到VPC中最近创建的300个交换机的信息',
+ 'type' => 'array',
+ ],
+ ],
+ 'title' => '',
+ 'type' => 'object',
+ ],
+ 'title' => '单个vpc信息',
+ 'type' => 'array',
+ ],
+ ],
+ 'title' => '返回结果，vpc集合',
+ 'type' => 'object',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B\\",\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1qpo0kug3a20qqe****\\",\\n \\"VpcName\\": \\"vpc1\\",\\n \\"Status\\": \\"Available\\",\\n \\"IsDefault\\": true,\\n \\"CidrBlock\\": \\"192.168.0.0/16\\",\\n \\"RegionNo\\": \\"cn-hangzhou\\",\\n \\"GmtCreate\\": \\"2021-04-18T15:02:37Z\\",\\n \\"GmtModified\\": \\"2021-04-18T15:02:37Z\\",\\n \\"VSwitchs\\": [\\n \\"vsw-bp1nhbnpv2blyz8dl****\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeVpcsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0FE2C83B</RequestId>\\n <Vpcs>\\n <Vpc>\\n <VpcId>vpc-bp1qpo0kug3a20qqe****</VpcId>\\n <VpcName>vpc1</VpcName>\\n <Status>Available</Status>\\n <IsDefault>true</IsDefault>\\n <CidrBlock>192.168.0.0/16</CidrBlock>\\n <RegionNo>cn-hangzhou</RegionNo>\\n <GmtCreate>2021-04-18T15:02:37Z</GmtCreate>\\n <GmtModified>2021-04-18T15:02:37Z</GmtModified>\\n <VSwitchs>vsw-bp1nhbnpv2blyz8dl****</VSwitchs>\\n </Vpc>\\n </Vpcs>\\n</DescribeVpcsResponse>","errorExample":""}]',
+ 'title' => 'DescribeVpcs',
+ ],
+ ],
+ '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',
+ ],
+ ],
+];
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-07 16:22:08 +0000