Deployments
复制页面
Elasticsearch API
Accounts
Updates the current account
Updates the current account
Fetch current account information
Authentication
Delete API key
Get API key
Create API key
Delete API keys
Get all API keys
BillingCostsAnalysis
Get costs overview for the organization
Get deployments costs for the organization
Get itemized costs for the organization
Get itemized costs by deployments
DeploymentTemplates
Get deployment templates
Get deployment template
Deployments
Shutdown Deployment Elasticsearch Resource
POST
Start all instances
POST
Restores a shutdown resource
POST
Restores a shutdown Deployment
POST
Set remote clusters
PUT
Get remote clusters
GET
Stop instances
POST
Reset the secret token for an APM resource.
POST
Get Deployment Enterprise Search Resource Info
GET
Get Deployment Kibana Resource Info
GET
Set AppSearch read-only status
PUT
Set AppSearch read-only status
GET
Start instances
POST
Restart Deployment Stateless Resource
POST
Shuts down Deployment
POST
Migrate Elasticsearch resource to use SLM
POST
Start maintenance mode
POST
Restart Deployment Elasticsearch Resource
POST
Start maintenance mode (all instances)
POST
Reset 'elastic' user password
POST
Stop all instances
POST
Migrate Elasticsearch and associated Kibana resources to enable CCR
POST
Add or remove settings from the Elasticsearch resource keystore
PATCH
Get the settings from the Elasticsearch resource keystore
GET
Search Deployments
POST
Get eligible remote clusters
POST
Update Deployment
PUT
Get Deployment
GET
Get Deployment Elasticsearch Resource Info
GET
Stop maintenance mode (all instances)
POST
Migrate Elasticsearch resource to use ILM
POST
Shutdown Deployment Stateless Resource
POST
Get Deployment APM Resource Info
GET
Stop maintenance mode
POST
Cancel resource pending plan
DELETE
Get Deployment App Search Resource Info
GET
Get eligible remote clusters
POST
Create Deployment
POST
List Deployments
GET
Upgrade Kibana, APM, AppSearch inside Deployment
POST
DeploymentsTrafficFilter
Delete ruleset association
Create ruleset association
Get associated deployments
Create a ruleset
List traffic filter rulesets
Get associated rulesets
Updates a ruleset
Delete a ruleset
Retrieves the ruleset by ID.
Extensions
Create an extension
List Extensions
Uploads the Extension
Update Extension
Delete Extension
Get Extension
Stack
Get stack versions
数据模型
默认分组
Schemas
AppSearchPayload
ElasticsearchClusterPlansInfo
DeploymentSearchResponse
TransientAppSearchPlanConfiguration
SnapshotStatusInfo
ElasticsearchConfiguration
DtsDimensionCosts
RestoreSnapshotConfiguration
ApmConfiguration
ManagedMonitoringSettings
ElasticsearchScriptingUserSettings
PlanStrategy
ElasticsearchClusterUser
ElasticsearchShardsInfo
ElasticsearchClusterPlanInfo
ElasticsearchReplicaElement
ApiKeysResponse
DeploymentCosts
ApmPayload
BasicFailedReplyElement
RestoreSnapshotApiConfiguration
TransientElasticsearchPlanConfiguration
ClusterPlanStepLogMessageInfo
DeploymentUpdateRequest
KibanaConfiguration
RestoreSnapshotRepoConfiguration
KeystoreSecret
ClusterMetadataPortInfo
ElasticsearchNodeType
DeploymentResourceUpgradeResponse
CrossClusterSearchInfo
DeploymentDiagnostics
ElasticsearchDependant
EnterpriseSearchPlanInfo
ApmSettings
DeploymentTemplateInfoV2
ElasticsearchMonitoringInfo
ElasticsearchClusterBlockingIssueElement
DeploymentCreateRequest
ItemCosts
KibanaClusterInfo
ElasticsearchScriptTypeSettings
AppSearchPlansInfo
AppSearchConfiguration
RollingGrowShrinkStrategyConfig
ClusterMetadataInfo
Extensions
RemoteClusterInfo
ElasticsearchClusterSecurityInfo
AppSearch
DeploymentUpdateMetadata
ApiKeyResponse
TrafficFilterRulesets
TargetElasticsearchCluster
DeploymentRestoreResponse
ElasticsearchClusterRole
BoolQuery
FilterAssociation
ExtensionFileMetadata
ElasticsearchClusterPlan
SearchRequest
UpdateExtensionRequest
ElasticsearchClusterBlockingIssues
Orphaned
DeploymentUpdateResources
ClusterTopologyInfo
DiscreteSizes
CrossClusterSearchSettings
AppSearchNodeTypes
ElasticsearchMasterInfo
DeploymentCreateSettings
StackVersionApmConfig
EnterpriseSearchConfiguration
AppSearchSystemSettings
AccountUpdateRequest
EnterpriseSearchSettings
QueryStringQuery
NestedQuery
KibanaClusterTopologyElement
DeploymentsSearchResponse
StackVersionConfigs
Period
ElasticsearchMasterElement
ClusterCurationSettings
KibanaSubClusterInfo
StackVersionInstanceCapacityConstraint
SimplifiedLineItem
ClusterInstanceInfo
KeystoreContents
ClusterSnapshotRetention
AccountTrustRelationship
AutodetectStrategyConfig
InstanceMoveRequest
DtsQuantity
ChangeSourceInfo
ApmSubInfo
KibanaResourceInfo
EnterpriseSearchPlan
ClusterSnapshotSettings
DeploymentsListResponse
ElasticsearchCuration
DeploymentMetrics
DeploymentGetResponse
DeploymentSettings
EnterpriseSearch
RemoteClusterRef
MatchNoneQuery
EnterpriseSearchSubInfo
ApmTopologyElement
ServiceUrl
Extension
ClusterSystemAlert
DeploymentUpdateSettings
StackVersionAppSearchConfig
EnterpriseSearchPlansInfo
ApmCrudResponse
Creates
RulesetAssociations
ApmPlanInfo
PrefixQuery
AppSearchTopologyElement
ElasticsearchResourceInfo
ClusterMetadataSettings
AllocatorMoveRequest
ExternalTrustRelationship
DeploymentObservabilitySettings
CostsOverview
StackVersionMetadata
RemoteResourceRef
TrafficFilterRulesetResponse
Kibana
ClusterCurationSpec
TermQuery
Apm
AppSearchSettings
StackVersionKibanaConfig
EnterpriseSearchNodeTypes
KibanaClusterSettings
ElasticsearchPlanControlConfiguration
StackVersionTemplateInfo
ElasticsearchClusterInfo
EnableIlmRequest
TransientKibanaPlanConfiguration
DeploymentShutdownResponse
IpFilteringSettings
AppSearchResourceInfo
KibanaClusterPlansInfo
EmptyResponse
KibanaDeeplink
EnterpriseSearchSystemSettings
ExistsQuery
TopologyElementControl
EnterpriseSearchInfo
DeploymentsCosts
DeploymentResource
ApmPlansInfo
ReadOnlyRequest
ElasticsearchUserPlugin
ObservabilityIssue
DeploymentObservability
DeploymentResourceCommandResponse
Updates
IndexPattern
GrowShrinkStrategyConfig
TopologySize
DeploymentCreateResponse
AppSearchPlanControlConfiguration
Hyperlink
DtsRate
TrafficFilterSettings
StackVersionNodeType
EnterpriseSearchPlanControlConfiguration
DeploymentCreateMetadata
AppSearchInfo
AppSearchPlanInfo
TrafficFilterRulesetInfo
ElasticsearchInfo
Balance
ElasticsearchClusterTrustSettings
DeploymentsListingData
ClusterPlanStepInfo
MatchQuery
CreateExtensionRequest
ElasticsearchPayload
EnterpriseSearchResourceInfo
DeleteApiKeysRequest
KibanaClusterPlanInfo
RemoteResourceInfo
ApmResourceInfo
KibanaPlanControlConfiguration
ApmPlan
DeploymentTemplateReference
ApmInfo
ClusterCredentials
KibanaPayload
AppSearchSubInfo
QueryContainer
AbsoluteRefId
InstanceConfigurationInfo
DeploymentUpdateResponse
TransientApmPlanConfiguration
StackVersionConfig
DeploymentMetadata
ReadOnlyResponse
ElasticsearchClusterTopologyElement
DeploymentLoggingSettings
ElasticsearchElasticUserPasswordResetResponse
RemoteResources
DeploymentResources
StackVersionTemplateFileHash
TransientEnterpriseSearchPlanConfiguration
ElasticsearchClusterSettings
ReplyWarning
KibanaClusterPlan
AccountResponse
OrphanedElasticsearch
EnterpriseSearchTopologyElement
DeploymentCreateResources
ElasticsearchShardElement
ElasticsearchSystemSettings
ElasticsearchUserBundle
BasicFailedReply
KibanaSystemSettings
DeploymentMetricsSettings
ApmPlanControlConfiguration
DeploymentResourceCrudResponse
Costs
Elasticsearch
AccountTrustSettings
ClusterInstanceDiskInfo
DeploymentLogging
RollingStrategyConfig
MetadataItem
TrafficFilterRulesetRequest
TrafficFilterEgressRule
MatchAllQuery
TrafficFilterRule
AppSearchPlan
RangeQuery
ItemsCosts
ClusterInstanceConfigurationInfo
StackVersionElasticsearchConfig
ApmSystemSettings
ClusterInstanceMemoryInfo
ExternalHyperlink
CreateApiKeyRequest
Deployments
MCP
复制页面
Get Deployment
开发环境
http://127.0.0.1
开发环境
http://127.0.0.1
GET
/deployments/{deployment_id}
调试
Run in Apifox
Run in Apifox
Retrieves information about a Deployment.
请求参数
Path 参数
生成代码
Query 参数
生成代码
Header 参数
生成代码
返回响应
🟢
200
The Deployment info response
application/json
生成代码
Body
application/json
生成代码
🟠
401
You are not authorized to perform this action.
🟠
404
The Deployment specified by {deployment_id} cannot be found. (code: `deployments.deployment_not_found`)
请求示例
请求示例
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
'http://127.0.0.1/deployments/'
\
--header
'Authorization: ApiKey {{EC_API_KEY}}'
响应示例
响应示例
200 -
示例 1
修改于
2021-10-07 08:42:04
上一页
Update Deployment
下一页
Get Deployment Elasticsearch Resource Info