tencent cloud

Cloud Access Management

Product Introduction
CAM Overview
Features
Scenarios
Basic Concepts
Use Limits
User Types
Purchase Guide
Getting Started
Creating Admin User
Creating and Authorizing Sub-account
Logging In to Console with Sub-account
User Guide
Overview
Users
Access Key
User Groups
Role
Identity Provider
Policies
Permissions Boundary
Troubleshooting
Downloading Security Analysis Report
CAM-Enabled Role
Overview
Compute
Container
Microservice
Essential Storage Service
Data Process and Analysis
Data Migration
Relational Database
Enterprise Distributed DBMS
NoSQL Database
Database SaaS Tool
Database SaaS Service
Networking
CDN and Acceleration
Network Security
Data Security
Application Security
Domains & Websites
Big Data
Middleware
Interactive Video Services
Real-Time Interaction
Media On-Demand
Media Process Services
Media Process
Cloud Real-time Rendering
Game Services
Cloud Resource Management
Management and Audit Tools
Developer Tools
Monitor and Operation
More
CAM-Enabled API
Overview
Compute
Edge Computing
Container
Distributed cloud
Microservice
Serverless
Essential Storage Service
Data Process and Analysis
Data Migration
Relational Database
Enterprise Distributed DBMS
NoSQL Database
Database SaaS Tool
Networking
CDN and Acceleration
Network Security
Endpoint Security
Data Security
Business Security
Application Security
Domains & Websites
Office Collaboration
Big Data
Voice Technology
Image Creation
Tencent Big Model
AI Platform Service
Natural Language Processing
Optical Character Recognition
Middleware
Communication
Interactive Video Services
Real-Time Interaction
Stream Services
Media On-Demand
Media Process Services
Media Process
Cloud Real-time Rendering
Game Services
Education Sevices
Medical Services
Cloud Resource Management
Management and Audit Tools
Developer Tools
Monitor and Operation
More
Use Cases
Security Practical Tutorial
Multi-Identity Personnel Permission Management
Authorizing Certain Operations by Tag
Supporting Isolated Resource Access for Employees
Enterprise Multi-Account Permissions Management
Reviewing Employee Operation Records on Tencent Cloud
Implementing Attribute-Based Access Control for Employee Resource Permissions Management
During tag-based authentication, only tag key matching is supported
Business Use Cases
TencentDB for MySQL
CLB
CMQ
COS
CVM
VPC
VOD
Others
API Documentation
History
Introduction
API Category
Making API Requests
User APIs
Policy APIs
Role APIs
Identity Provider APIs
Data Types
Error Codes
FAQs
Role
Key
Others
CAM Users and Permissions
Glossary

Elasticsearch Service

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-04-03 09:43:01

Fundamental information

Product Abbreviation in CAM Console Authorization by Tag Authorization Granularity IP Restriction
Elasticsearch Service es Supported Supported Resource level Partially supported

Note:

The authorization granularity of cloud products is divided into three levels: service level, operation level, and resource level, based on the degree of granularity.

  • Service level: It defines whether a user has the permission to access the service as a whole. A user can have either full access or no access to the service. For the authorization granularity of cloud products at service level, the authorization of specific APIs are not supported.
  • Operation level: It defines whether a user has the permission to call a specific API of the service. For example, granting an account read-only access to the CVM service is an authorization at the operation level.
  • Resource level: It is the finest authorization granularity which defines whether a user has the permission to access specific resources. For example, granting an account read/write access to a specific CVM instance is an authorization at the resource level.

API authorization granularity

Two authorization granularity levels of API are supported: resource level, and operation level.

  • Resource level: It supports the authorization of a specific resource.
  • Operation level: It does not support the authorization of a specific resource. If the policy syntax restricts a specific resource during authorization, CAM will determine that this API is not within the scope of authorization, and deem it as unauthorized.

Write operations

API API Description Authorization Granularity Six-segment Resource Description IP Restriction
AddCVMInstancesOfCollector add cvm instance for a collector Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
AddDataToDataset AddDataToDataset Operation level * Supported
AddForceMergeTask Add force merge task Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
BindSpaceToAnotherCluster bind space to another cluster Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
CancelEsClusterTask Cancel Es Cluster Task Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
ChatWithKnowledge Knowledge Chat Operation level * Supported
ChunkDocument ChunkDocument Operation level * Supported
CloseClusterTcpVip close the tcp vip for cluster Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
CloseInstanceCamTokenUser close instance user cam token Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
ClosePostPayService ClosePostpayService Operation level * Supported
CommitDatasetVersion CommitDatasetVersion Operation level * Supported
CountDataImport data import count Resource level qcs::es::uin/${uin}:collectorId/${CollectorId} Supported
CreateAlertPolicy Create instance alert policy Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
CreateAlertTemplate create instance alert template Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
CreateApplication CreateApplication Operation level * Supported
CreateAutoBackUpStrategy Create Auto BackUp Strategy Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
CreateCdcEsQuota Create CDC cluster es quota Operation level * Supported
CreateCollector create collector Resource level qcs::es::uin/${uin}:collector/* Supported
CreateCosMigrateToServerlessInstance CreateCosMigrateToServerlessInstance Resource level qcs::es:${Region}:uin/${uin}:instance/${ServerlessId} Supported
CreateDSLBlockTask Create Cluster DSL Block Task Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
CreateDataImport Create dataimport integration Operation level * Supported
CreateEvaluationTasks Create evaluation tasks Operation level * Supported
CreateIndex CreateIndex Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
CreateIndexKibanaPattern Create Index Kibana Pattern Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
CreateIndexMetaFieldToJson Create Index Meta Field To Json Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
CreateIndexMetaJsonToField Create Index Meta Json To Field Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
CreateIndexMigrateToNewSpace Create Index Migrate To NewSpace Resource level qcs::${ApiModule}:${Region}:uin/:index/${ServerlessId} Supported
CreateInstance Create an ES cluster instance Operation level * not supported
CreateInstanceLogExport Create instance log export Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
CreateLogstashInstance Create logstash instance Operation level * Supported
CreateMCPInstance create mcp server Operation level * Supported
CreateMappingsFromSample Create Mappings From Sample Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
CreateOnlineReindex online reindex Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
CreateOperationDurationEvent create operation duration event Operation level * Supported
CreateOrUpdateServerlessWatcher CreateOrUpdateServerlessWatcher Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
CreateRetrieveConfig CreateRetrieveConfig Operation level * Supported
CreateSearchIndex Create search index Operation level * Supported
CreateSearchIndexFieldToMeta CreateSearchIndexFieldToMeta Operation level * Supported
CreateSearchIndexMappings Create mappings from sample data Operation level * Supported
CreateSearchIndexMetaToField CreateSearchIndexMetaToField Operation level * Supported
CreateSearchSpace Create search index space Operation level * Supported
CreateServerlessDi Create Serverless Di Resource level qcs::es:${region}:uin/${uin}:index/${ServerlessId} Supported
CreateServerlessIndexMetaFieldToJson Converting metadata fields to JSON when creating a Serverless index Operation level * Supported
CreateServerlessIndexMetaJsonToField Converting metadata JSON to fields when creating a Serverless index Operation level * Supported
CreateServerlessInstance Create Serverless Index Operation level * Supported
CreateServerlessInstanceUser CreateServerlessInstanceUser Resource level qcs::es:${region}:uin/${uin}:index/${InstanceId} Supported
CreateServerlessMappingsFromSample Create index mapping from Serverless data sample Operation level * Supported
CreateServerlessMcpInstance create serverless Mcp service Resource level qcs::es::uin/${uin}:space/${SpaceId} Supported
CreateServerlessSpace create Serverless Space of Index Operation level * Supported
CreateServerlessSpaceUser Create a serverless space user Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
CreateServerlessSpaceV2 create new Serverless Space Operation level * Supported
CreateSpace CreateSpace Operation level * Supported
CreateThreatIndicators create threat indicators Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
CreateTradeSignAuth create sign auth for trade Operation level * Supported
CreateVipForMcpAgent crate mcp agent vip Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DeleteAlertPolicy Delete instance alert policy Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DeleteAlertTemplate delete es instance alert template Operation level * Supported
DeleteApplication DeleteApplication Operation level * Supported
DeleteAutoBackUpStrategy Delete Auto BackUp Strategy Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DeleteCVMInstancesOfCollector delete cvm instance of a collector Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
DeleteClusterSnapshot Delete Cluster Snapshot Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DeleteCollector delete collector Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
DeleteDSLBlockTask Delete DSL Block Task Resource level qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} Supported
DeleteDataImport delete data import Resource level qcs::es::uin/${uin}:IntegrationId/${IntegrationId} Supported
DeleteDataset DeleteDataset Operation level * Supported
DeleteDatasetSample DeleteDatasetSample Operation level * Supported
DeleteDocuments DeleteDocuments Operation level * Supported
DeleteEvaluationTask DeleteEvaluationTask Operation level * Supported
DeleteIndex DeleteIndex Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DeleteInstance Delete an ES cluster instance Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DeleteLogstashInstance Delete logstash instance Resource level qcs::${ApiModule}:${Region}:uin/:logstash/${InstanceId} Supported
DeleteLogstashPipelines Delete logstash pipelines Resource level qcs::es:${region}:uin/${uin}:logstash/$instanceId Supported
DeleteRetrieveConfig DeleteRetrieveConfig Operation level * Supported
DeleteSearchIndex Delete search index Resource level qcs::es::uin/${uin}:index/${IndexId} Supported
DeleteSearchSpace Delete Search Space Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DeleteServerlessDi Delete Serverless Di Resource level qcs::es:${region}:uin/${uin}:index/${ServerlessId} Supported
DeleteServerlessInstance delete serverlessIndex Resource level qcs::${ApiModule}:${Region}:uin/:index/${InstanceId} Supported
DeleteServerlessInstanceUser DeleteServerlessInstanceUser Resource level qcs::es:${region}:uin/${uin}:index/${InstanceId} Supported
DeleteServerlessMcpInstance delete serverless mcp service Resource level qcs::es::uin/${uin}:space/${SpaceId} Supported
DeleteServerlessSpace Delete ServerlessSpace Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DeleteServerlessSpaceUser Delete a serverless space user Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DeleteServerlessWatcher DeleteServerlessWatcher Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DeleteThreatIndicators delete threat indicators Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DeleteVipForMcpAgent delete mcp agent vip Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DownloadCerts Download es instance certificate Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
GenerateSceneCode GenerateSceneCode Operation level * Supported
InjectClusterNodesFailure InjectClusterNodesFailure Operation level * Supported
MarkCosMigrateTask MarkCosMigrateTask Operation level * Supported
MigrateEsInstance Migrate ES Instance from one zone to another zone Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
MigrateLogstashInstance migrate logstash from zone to another zone Resource level qcs::es:${Region}:uin/:logstash/${InstanceId} Supported
ModifyAutoBackUpCommonInfo Modify Auto BackUp Common Info Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
ModifyAutoBackUpStrategy Modify Auto BackUp Strategy Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
ModifyAutoScaleDiskInfo Modify Auto Scale Disk Info Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
ModifyClusterVpcServiceProperty Modify Cluster Vpc Service Property Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
ModifyEsVipSecurityGroup Modify ES cluster security group Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
ModifyInstanceDisasterRecoverGroup Modify es instance disaster recover group configuration Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
ModifyInstanceEsVipStatus modify instance es vip rs status Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
OpenClusterTcpVip open the tcp vip for cluster Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
OpenInstanceCamTokenUser open instance cam token Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
OpenPostPayService OpenPostpayService Operation level * Supported
PredictCluster Predict Cluster Operation level * Supported
PredictInstance Predict Instance Operation level * Supported
PrepayInstanceTransferToPost Convert prepaid instance to postpaid. Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
ReconcileIndex auto reconcile Resource level qcs::es::uin/${uin}:index/${ServerlessId} Supported
RecoverClusterNodesFailure RecoverClusterNodesFailure Operation level * Supported
RefreshInstanceCamTokenUser refresh instance user cam token Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
ReinstallCollector reinstall collecotr Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
RenewInstance Renew the specified ES cluster instance by year and month Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
RenewLogstashInstance Renew the specified Logstash monthly subscription instance Resource level qcs::${ApiModule}:${Region}:uin/:logstash/${InstanceId} Supported
RepairNodesMachine RepairNodesMachine Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
RequestInstances request es instance Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
ResetInstancePassword reset instance cam password Operation level * not supported
RestartCollector restart collector Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
RestartInstance Restart an ES cluster instance Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
RestartKibana Restart kibana nodes of ES cluster Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
RestartLogstashInstance Restart logstash instance Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
RestartLogstashNodes Restart Logstash Nodes Resource level qcs::es:${region}:uin/${uin}:logstash/${InstanceId} Supported
RestartNodes Restart nodes of ES Cluster Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
RestoreClusterSnapshot Restore Cluster Snapshot Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
RetryDataset RetryDataset Operation level * Supported
RetryDocuments RetryDocuments Operation level * Supported
RunRerank RunRerank Operation level * Supported
SaveAndDeployLogstashPipeline Save and deploy logstash pipelines Resource level qcs::es:${region}:uin/${uin}:logstash/$instanceId Supported
SendVerificationCode SendVerificationCode Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
SmartAdvisorManage ES Smart Advisor Manage Resource level qcs::es:${Region}:uin/${uin}:instance/${InstanceId} Supported
SmartAdvisorManageBatch ES Smart Advisor Manage batch Resource level qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} Supported
StartCollector start collector Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
StartLogstashPipelines Start logstash pipelines Resource level qcs::es:${region}:uin/${uin}:logstash/$instanceId Supported
StopCollector stop collector Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
StopLogstashPipelines Stop logstash pipelines Resource level qcs::es:${region}:uin/${uin}:logstash/$instanceId Supported
TerminateMCPInstance terminate mcp server Operation level * Supported
UpdateAlertPolicy Update instance alert policy Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
UpdateAlertPolicyAlertEnabled Update alert policy alert enabled Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
UpdateAlertTemplate update es instance alert template Operation level * Supported
UpdateApplication UpdateApplication Operation level * Supported
UpdateAuditLogStatus Update AuditLog Status Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
UpdateCdcEsQuota Update cdc cluster es quota. Operation level * Supported
UpdateClusterStatus update cluster status Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
UpdateCollector update beats collector Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
UpdateCollectorName update collector\\\'s name Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
UpdateDSLBlockTask Update DSL Block Task Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
UpdateDataImport update data import Resource level qcs::es::uin/${uin}:integrationId/${IntegrationId} Supported
UpdateDataImportName update data import name Resource level qcs::es::uin/${uin}:integrationId/${IntegrationId} Supported
UpdateDatasetSample UpdateDatasetSample Operation level * Supported
UpdateDiagnoseSettings this interface(UpdateDiagnoseSettings) use to update diagnose settings Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
UpdateDictionaries this interface(UpdateDictionaries) use to update dictionaries Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
UpdateDns Update Dns Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
UpdateEsAiInstanceModelStatus UpdateEsAiInstanceModelStatus Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
UpdateEsOperationDurations batch update es operation duration Operation level * Supported
UpdateForceMergeTask Update force merge task Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
UpdateHeteroDelayScaleIn Update hetero scale in status Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
UpdateIndex UpdateIndex Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
UpdateIndexMetaJsonToField Update Index Meta Json To Field Resource level qcs::es::uin/${uin}:InstanceId/${InstanceId} Supported
UpdateInstance Update an ES cluster instance Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
UpdateInstancePublicAccess Update ES Instance Kibana And Cerebro Public Access Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
UpdateInstanceScalingHetero Scaling es instance with heterogeneous cvm Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
UpdateInternal Update Internal Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
UpdateIpTraceStatus Update es instance ip trace status Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
UpdateJdk Update Jdk config Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
UpdateJvmHeap update jvm heap Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
UpdateKibanaSoftware Update Kibana Software Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
UpdateKnowledgeConfig UpdateKnowledgeConfig Operation level * Supported
UpdateLogSetting Update cluster logger settings Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
UpdateLogstashInstance Update logstash instance Resource level qcs::${ApiModule}:${Region}:uin/:logstash/${InstanceId} Supported
UpdateLogstashPipelineDesc update logstash pipeline desc Resource level qcs::es::uin/${uin}:logstash/${InstanceId} Supported
UpdateLsOperationDurations batch update logstash operation duration Operation level * Supported
UpdateNodesStatus Used to start or shut down the node Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
UpdateOutboundPublicAccess update es instance outbound access Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
UpdatePlugins Update an ES cluster\\\\\\\\\\\\\\\'s plugins Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
UpdateRequestTargetNodeTypes Update the target node types of es vip. Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
UpdateRetrieveConfig UpdateRetrieveConfig Operation level * Supported
UpdateSearchIndex Update search index Resource level qcs::es::uin/${uin}:index/${IndexId} Supported
UpdateSearchIndexFieldToMeta Update search index field to meta Operation level * Supported
UpdateSearchIndexMetaToField UpdateSearchIndexMetaToField Operation level * Supported
UpdateSearchSpace Update search space Resource level qcs::es::uin/${uin}:space/${SpaceId} Supported
UpdateServerlessDi Update Serverless Di Resource level qcs::es:${region}:uin/${uin}:index/${ServerlessId} Supported
UpdateServerlessIndexMetaFieldToJson Convert metadata fields to JSON when updating Serverless index Resource level qcs::es::uin/${uin}:index/${InstanceId} Supported
UpdateServerlessIndexMetaJsonToField Convert metadata JSON to fields when updating Serverless index Resource level qcs::es::uin/${uin}:index/${InstanceId} Supported
UpdateServerlessInstance Update ServerlessInstance Resource level qcs::${ApiModule}:${Region}:uin/:index/${InstanceId} Supported
UpdateServerlessInstanceUser UpdateServerlessInstanceUser Resource level qcs::es:${region}:uin/${uin}:index/${InstanceId} Supported
UpdateServerlessSpace Update ServerlessSpace Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
UpdateServerlessSpaceRestrict Update Serverless Space Restrictions Operation level * Supported
UpdateServerlessSpaceUser Update a serverless space user Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
UpdateServerlessWatcher UpdateServerlessWatcher Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
UpdateUserBundles Update user bundles Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
UpgradeInstance UpgradeInstance Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
UpgradeLicense Upgrade an ES cluster\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\'s X-Pack license Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
UpgradeMCPInstance upgrade mcp server Operation level * Supported
UploadKnowledge UploadKnowledge Operation level * Supported

Read operations

API API Description Authorization Granularity Six-segment Resource Description IP Restriction
ChatCompletions ChatCompletions Operation level * Supported
CheckCamLinkedRole check user has service role Operation level * Supported
CheckClusterName use to check cluster name valid or repeat Operation level * Supported
CheckCreateIndex Check index with creating Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
CheckEvaluationSample CheckEvaluationSample Operation level * Supported
CheckForceRestart check force restart Operation level * Supported
CheckOperation check operation is valid for scale in or restart Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
CheckScaleUpgrade check scale or upgrade is valid Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
CheckSearchSpaceName Check search space name Operation level * Supported
CheckServerlessIndexName Check index name Operation level * Supported
CheckServerlessSpaceName Check serverless space name Operation level * Supported
CheckServerlessUsername Check username at index level Resource level qcs::es::uin/${uin}:index/${InstanceId} Supported
CheckUpdateInstance check update instance is valid Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
ChunkDocumentAsync ChunkDocumentAsync Operation level * Supported
CountCollectors get collector count Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/${CollectorId} Supported
CountInstances describe es instance count Operation level * Supported
CountLogstashInstances describe logstash instance count Operation level * Supported
CreateDataset CreateDataset Operation level * Supported
DescribeAISearchMetrics DescribeAISearchMetrics Operation level * Supported
DescribeAlertPolicies describe instance alert policy list Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeAlertRecordDetail describe instance record detail Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeApmSearch search for apm Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeApplicationDetail DescribeApplicationDetail Operation level * Supported
DescribeApplicationVersions Get application version details Operation level * Supported
DescribeAtomicServiceDetails DescribeAtomicServiceDetails Operation level * Supported
DescribeAtomicServices DescribeAtomicServices Operation level * Supported
DescribeAuditLogStatus Describe AuditLog Status Resource level qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} Supported
DescribeAutoBackUpStrategy Describe AutoBackUp Strategy Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DescribeAutoScaleDiskInfo Describe Auto Scale Disk Info Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DescribeCVMInstancesOfCollector Get the dispatched cvm instances of the collector Resource level qcs::es:${region}:uin/${uin}:collector/${CollectorId} Supported
DescribeCVMInstancesOfSameCollector get collector\\\\\\\\\\\\\\\'s cvm of a very type Operation level * Supported
DescribeClientIp get user ip Operation level * Supported
DescribeClusterDiskRange Describe Cluster Disk Range Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DescribeClusterNodesFailureStats DescribeClusterNodesFailureStats Operation level * Supported
DescribeClusterVpcServiceProperty Describe Cluster Vpc Service Property Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
DescribeDataImportDetail describe data import detail Resource level qcs::es::uin/${uin}:IntegrationId/${IntegrationId} Supported
DescribeDataImportOperations describe data import operation detail Resource level qcs::es::uin/${uin}:instanceId/${InstanceId} Supported
DescribeDataImports Describe data import Operation level * Supported
DescribeDatasetDetail DescribeDatasetDetail Operation level * Supported
DescribeDatasetSamples DescribeDatasetSamples Operation level * Supported
DescribeDatasetVersions DescribeDatasetVersions Operation level * Supported
DescribeDatasets DescribeDatasets Operation level * Supported
DescribeDbTknPwdRules describe password rules Operation level * not supported
DescribeDbTknResource describe instance account open cam Operation level * not supported
DescribeDiagnose this interface(DescribeDiagnose) use to query diagnose Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DescribeDiagnoseStats describe diagnose stats for intelligence operations Resource level qcs::es::uin/${uin}:InstanceId/${InstanceId} Supported
DescribeDocumentChunks DescribeDocumentChunks Operation level * Supported
DescribeDocumentTasks DescribeDocumentTasks Operation level * Supported
DescribeEsInstanceDeployedModelList DescribeEsInstanceDeployedModelList Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeEsInstanceEventLists DescribeEsInstanceEventLists Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
DescribeEsInstanceModelList DescribeEsInstanceModelList Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeEvaluationReport DescribeEvaluationReport Operation level * Supported
DescribeEvaluationSamples DescribeEvaluationSamples Operation level * Supported
DescribeEvaluationTasks DescribeEvaluationTasks Operation level * Supported
DescribeEventDataDetail DescribeEventDataDetail Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeForceMergeTask Query the list of added forcemerge tasks Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeGenPromptTemplates DescribeGenPromptTemplates Operation level * Supported
DescribeIndexFieldCaps DescribeI idex field Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeIndexList DescribeIndexList Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DescribeIndexLogs DescribeIndexLogs Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DescribeIndexMeta DescribeIndexMeta Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DescribeIndexOperations DescribeIndexOperations Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DescribeIndices describe index mode Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeInstanceBundleList this interface(DescribeInstanceBundleList) use to query instance bundle list Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DescribeInstanceCamTokenUsers describe instance cam users Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeInstanceLogExportIndex Obtain the logs and export them to serverless Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeInstanceLogs Describes cluster logs Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
DescribeInstanceOperations Describe ES cluster\'s activity records Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
DescribeInstancePluginList get the plugin list of a es cluster Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DescribeInstanceSaml saml protocol status Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeInstanceUpgradePlanList describe instance upgrade plan list Operation level * Supported
DescribeInstanceUsers describe instance uses Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeKibanaTools embed kibana Resource level qcs::es:${region}:uin/${uin}:index/${InstanceId} Supported
DescribeKibanaUrl describe kibana url Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeKnowledgeConfigs DescribeKnowledgeConfigs Operation level * Supported
DescribeLastCosBackupInfo Describe Last CosBackup Info Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DescribeLogstashInstanceLogs Query logs of logstash instance Resource level qcs::es:${region}:uin/${uin}:logstash/$instanceId Supported
DescribeLogstashInstanceOperations Query operations of logstash instance Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
DescribeLogstashPipelineTemplates describe logstash template pipeline list Operation level * Supported
DescribeLogstashPipelines Query list of logstash pipelines Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
DescribeLogstashViews DescribeLogstashViews Resource level qcs::es::uin/${uin}:logstash/${LogstashInstanceId} Supported
DescribeMCPInstance describe mcp server Operation level * Supported
DescribeModelDetails DescribeModelDetails Operation level * Supported
DescribeModels DescribeModels Operation level * Supported
DescribeNetworkConnection describe instance ldap connection Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeNodes Used to query the cluster node list, including: node IP, node ID, node type and other information Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DescribeOperationDurationEvent Describe Operation Duration Event Operation level * Supported
DescribePocQuota Get poc code for user Operation level * Supported
DescribePostPayStatus query aisearch post-pay activation status Operation level * Supported
DescribePromptTemplates DescribePromptTemplates Operation level * Supported
DescribeRegions describe regions for es support Operation level * Supported
DescribeResourcePackage query user resource package detail Operation level * Supported
DescribeResourcePackageMeta query billing-item metadata Operation level * Supported
DescribeRetrieveConfigs DescribeRetrieveConfigList Operation level * Supported
DescribeScenes DescribeScenes Operation level * Supported
DescribeSearchIndexOperations Describe search index operations Resource level qcs::es::uin/${uin}:index/${IndexId} Supported
DescribeSearchIndices Describe search indices Operation level * Supported
DescribeSearchSpaceOperations Search Space describe space operation Resource level qcs::es::uin/${uin}:space/${SpaceId} Supported
DescribeSearchSpaceUsers Describe search space users Resource level qcs::es::uin/${uin}:space/${SpaceId} Supported
DescribeSearchSpaces Describe search index list Operation level * Supported
DescribeSecurityGroupBindEs describe Security Group Bind Es Resource level qcs::es::uin/${uin}:instance/* Supported
DescribeServerlessDi Describe Serverless Di Resource level qcs::es:${region}:uin/${uin}:index/${ServerlessId} Supported
DescribeServerlessInstanceLogs Describe serverless instance logs Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeServerlessInstanceMeta Describe ServerlessInstanceMeta Resource level qcs::${ApiModule}:${Region}:uin/:index/${InstanceId} Supported
DescribeServerlessInstanceOperation Describe ServerlessInstance Operation Resource level qcs::${ApiModule}:${Region}:uin/:index/${InstanceId} Supported
DescribeServerlessInstanceUsers DescribeServerlessInstanceUsers Resource level qcs::es:${region}:uin/${uin}:index/${InstanceId} Supported
DescribeServerlessInstances describe serverlessInstance List Resource level qcs::es:${region}:uin/${uin}:index/${InstanceId} Supported
DescribeServerlessMappingFields DescribeServerlessMappingFields Operation level * Supported
DescribeServerlessMetrics DescribeServerlessMetrics Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DescribeServerlessOverview serverless overview Operation level * Supported
DescribeServerlessQuota Get Serverless quota Operation level * Supported
DescribeServerlessSpaceOperations ServerlessSpace describe space operation Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DescribeServerlessSpaceRestrict Query space restrictions Operation level * Supported
DescribeServerlessSpaceUser Describe a serverless space user Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DescribeServerlessSpaces describe ServerlessSpace List Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DescribeServerlessWatchers DescribeServerlessWatchers Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DescribeSpaceDomain Describe a serverless space domain Resource level qcs::es:${Region}:uin/${uin}:space/${SpaceId}, Supported
DescribeSpaceKibanaTools Obtain the token required for space embed kibana Resource level qcs::es:${region}:uin/${uin}:space/${SpaceId} Supported
DescribeSpaces DescribeSpaces Operation level * Supported
DescribeThreatIndicators describe threat indicators Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeUpgrade Describe Upgrade Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeUserCosSnapshotList DescribeUserCosSnapshotList Resource level qcs::es::uin/${uin}:instance/${ClusterInstanceId} Supported
DescribeUserCosSnapshotTaskList DescribeUserCosSnapshotTaskList Resource level qcs::es:${Region}:uin/${uin}:instance/${InstanceId} Supported
DescribeUserIndexMigrateStatus DescribeUserIndexMigrateStatus Resource level qcs::es:${region}:uin/${uin}:index/${InstanceId} Supported
DescribeViews Describe instance view info, include cluster/node/kibana Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
DiagnoseInstance diagnose ES Instance Intelligently Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DownloadDatasetSamples DownloadDatasetSamples Operation level * Supported
DownloadEvaluationReport DownloadEvaluationReport Operation level * Supported
EstimateTaskToken EstimateTaskToken Operation level * Supported
ExportIpTraceLog Export pure ip and request timestamp trace log Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
GenDiCollectorRule GenDiCollectorRule Operation level * Supported
GenerateApplicationCode generate application code Operation level * Supported
GetAllIndexName get all index name Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
GetAllTraceIp Get all trace ip Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
GetCDCInstanceCnt Count es instance number on CDC cluster. Operation level * Supported
GetCDCTotalResources Get CDC cluster total es quota. Operation level * Supported
GetCDCUsedResources Get CDC cluster es quota has beed used. Operation level * Supported
GetClientIp get client ip Operation level * Supported
GetClusterMetric get cluster metric for es instance Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
GetCosMonitorData this interface(GetCosMonitorData) use to query cos monitor data Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
GetDiCollectorSetting GetDiCollectorSetting Operation level * Supported
GetDiagnoseSettings Get diagnose settings Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
GetDocumentChunkResult GetDocumentChunkResult Operation level * Supported
GetDocumentParseResult GetDocumentParseResult Operation level * Supported
GetDocumentParsingResult GetDocumentParsingResult Operation level * Supported
GetEsCreateGoodsInfo Get Es Create Goods Info Operation level * Supported
GetEsYmlConfig get es yml config Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
GetFederationToken Get federation token Operation level * Supported
GetFreeTrialUsage GetFreeTrialUsage Operation level * Supported
GetHeteroScalingCvmInfo Get hetero scaling cvm list Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
GetInstanceUpdateMode get instance update mode Resource level qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} Supported
GetInternalAccountUinToJudge Get internal account uin Operation level * Supported
GetIpTraceStatus Get Es instance ip trace status Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
GetJvmHeapInfo get jvm heap Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
GetMultiModalEmbedding GetMultiModalEmbedding Operation level * Supported
GetNodesMetric get es cluster nodes metric Resource level qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} Supported
GetPlatformModelList GetPlatformModelList Operation level * Supported
GetRagEvaluationStatus GetRagEvaluationStatus Operation level * Supported
GetRequestTargetNodeTypes Get the target node types of es vip Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
GetTaskFlow Get task process information Resource level qcs::es:${Region}:uin/${uin}:instance/${InstanceId} Supported
InquirePriceCreateInstance Inquire Price CreateInstance Operation level * Supported
InquirePriceRenewInstance inquire instance price when renew instance Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
InstallInstanceModel Install Instance Model Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
ListEsClusterTask List Es Cluster Task Resource level qcs::es:${region}:uin/${uin}:InstanceId/${InstanceId} Supported
ParseDocument ParseDocument Operation level * Supported
ParseDocumentAsync ParseDocumentAsync Operation level * Supported
PreviewAlertPolicyDSL Preview alert policy DSL result Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
QueryAggsIpCountLog Aggs query access ip Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
QueryAggsIpFrequenceLog Count ip access frequence Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
QueryAndCheckServerlessWatcher QueryAndCheckServerlessWatcher Resource level qcs::es::uin/${uin}:serverlessId/${ServerlessId} Supported
QueryIpTraceLog Query ip trace log Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
QueryRegionZone Query Region Zone Operation level * Supported
QueryRegionZoneForLogstash describe logstash region and zone Operation level * Supported
QueryRegionZoneForSearch Query search index region zone Operation level * Supported
QueryRegionZoneForServerless QueryRegionZoneForServerless Operation level * Supported
QuerySearchIndex Search index query endpoint Resource level qcs::es::uin/${uin}:index/${IndexId} Supported
QueryZoneResource Query zone resource Operation level * Supported
QueryZoneResourceForLogstash describe zone resource for logstash Operation level * Supported
RetryEvaluationTask RetryEvaluationTask Operation level * Supported
RunRagEvaluation RunRagEvaluation Operation level * Supported
SearchServerlessData Internal interface for obtaining serverless index data Resource level qcs::es:${region}:uin/${uin}:index/${ServerlessId} Supported
SearchServerlessInstance Internal interface for obtaining serverless index data Resource level qcs::es:${region}:uin/${uin}:index/${ServerlessId} Supported
UpdateIndexMetaFieldToJson Update Index Meta Field To Json Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
VerifyInstancePaas valid instance user and passward Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
WebSearch Web Search Api Operation level * Supported

Other Operations

API API Description Authorization Granularity Six-segment Resource Description IP Restriction
CheckMigrateIndexMetaData CheckMigrateIndexMetaData Resource level qcs::es:${Region}:uin/${uin}:instance/${ServerlessId} Supported
CreateClusterSnapshot create cluster snapshot Resource level qcs::${ApiModule}:${Region}:uin/:instance/${InstanceId} Supported
GetImageEmbedding Get image embedding vector Operation level * Supported
GetTextEmbedding GetTextEmbedding Operation level * Supported
NotifyEsServerless NotifyEsServerless Operation level * Supported

List Operations

API API Description Authorization Granularity Six-segment Resource Description IP Restriction
DescribeAlertRecords describe instance alert record list Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeAlertTemplates describe es instance alert tempate Resource level qcs::es:${Region}:uin/:instance/${InstanceId} Supported
DescribeApplications DescribeApplications Operation level * Supported
DescribeAuditLogOperateList describe audit log operate list Resource level qcs::es::uin/${uin}:instance/${InstanceId} Supported
DescribeClusterSnapshot Describe Cluster Snapshot List Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DescribeCollectors Get the list of collectors Resource level qcs::${ApiModule}:${region}:uin/${uin}:collector/* Supported
DescribeDSLBlockTask Describe Cluster DSL Block Task Resource level qcs::es:${region}:uin/${uin}:instance/${InstanceId} Supported
DescribeDocuments DescribeDocuments Operation level * Supported
DescribeInstances Query all eligible instances Resource level qcs::es:${region}:uin/${uin}:instance/$instanceId Supported
DescribeInstancesOverview Get the overview info of all es clusters Resource level qcs::es:${region}:uin/${uin}:instance/${instanceId} Supported
DescribeLogstashInstances Get the list of logstash instances Resource level qcs::es:${region}:uin/${uin}:logstash/* Supported

Ajuda e Suporte

Esta página foi útil?

comentários