CLI Command Reference
APM
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the application list. | hcloud APM ListBusiness | This API is used to query the application list. | |
| Querying the Master Address | hcloud APM ShowMasterAddress | This API is used to obtain the PodLB address of the master service based on the region name. | |
| Obtaining the AK/SK | hcloud APM ListAkSk | This API is used to obtain the created AK/SK. | |
| Searching for Components, Environments, and Agents in a Region | hcloud APM SearchApplication | This API is used to search for components, environments, and Agents in a region. | |
| Saving a Monitoring Item | hcloud APM SaveMonitorItemConfig | This API is used to save a monitoring item. | |
| Querying the Monitoring Item List | hcloud APM ListEnvMonitorItem | This API is used to query the monitoring item list. | |
| Querying All Agents of an Application | hcloud APM SearchAgent | This API is used to query all Agents of an application. | |
| Enabling or Disabling Collection for an Instance | hcloud APM ChangeAgentStatus | This API is used to enable or disable collection for a specified instance. | |
| Deleting an Agent | hcloud APM DeleteAgent | This API is used to delete an Agent. |
REGION
CMDB
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining an Application Tree | hcloud APM ShowTopologyTree | This API is used to obtain an application tree. | |
| Querying Environment Tags | hcloud APM ListEnvTags | This API is used to query environment tags. | |
| Obtaining the Component List | hcloud APM ListApps | This API is used to obtain the component list. | |
| Obtaining the Environment List of a Component | hcloud APM ListAppEnvs | This API is used to obtain the environment list of a component. | |
| Deleting a Component Based on the Component ID | hcloud APM DeleteApp | This API is used to delete a specified component. | |
| Querying the Details About an Application | hcloud APM ShowBusinessDetail | This API is used to query the details about an application. | |
| Querying the Details About a Sub-application | hcloud APM ShowSubBusinessDetail | This API is used to query the details about a sub-application. |
VIEW
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Monitoring Item Configurations | hcloud APM ShowMonitorItemViewConfig | This API is used to query monitoring item configurations. | |
| Querying the Trace Topology | hcloud APM ShowTopology | This API is used to query the trace topology. | |
| Querying Event Details | hcloud APM ShowEventDetail | This API is used to query event details. | |
| Querying Span Data | hcloud APM ShowSpanSearch | This API is used to query span data. | |
| Obtaining All Data of a Trace | hcloud APM ShowTraceEvents | This API is used to obtain all data of a trace. | |
| Obtaining the Trend Graph | hcloud APM ShowTrend | This API is used to obtain the trend graph. | |
| Obtaining Summary Table Data | hcloud APM ShowSumTable | This API is used to obtain summary table data. | |
| Obtaining the Raw Data Table | hcloud APM ShowRawTable | This API is used to obtain the raw data table. | |
| Obtaining Raw Data Details | hcloud APM ShowClobDetail | This API is used to obtain raw data details. | |
| Obtaining the Instance Information | hcloud APM ListEnvInstances | This API is used to obtain the instance information. | |
| Obtaining the Monitoring Item Information | hcloud APM ShowEnvMonitorItems | This API is used to obtain the monitoring item information. | |
| Obtaining the Details About a Monitoring Item | hcloud APM ShowMonitorItemDetail | This API is used to obtain the details about a monitoring item. |
AKSK
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating an AK/SK | hcloud APM CreateAkSk | Create an AK/SK. | |
| Querying the AK/SK of a Tenant | hcloud APM ShowAkSks | This API is used to query the AK/SK of a tenant. | |
| Deleting an AK/SK | hcloud APM DeleteAkSk | This API is used to delete an AK/SK. |
ALARM
TOPOLOGY
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Global Topology of an Application | hcloud APM SearchBusinessTopology | This API is used to query the global topology of an application. | |
| Querying the Topology of a Component Environment | hcloud APM SearchEnvTopology | This API is used to query the topology of a component environment. |
TRANSACTION
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the URL Tracing Configuration List | hcloud APM SearchTransactionConfig | This API is used to query the URL tracing configuration list. | |
| Querying a Region's Environments on Which URLs Are Added for Tracing | hcloud APM ListBusinessEnv | This API is used to query a region's environments on which URLs are added for tracing. | |
| Querying the URL Tracing View List | hcloud APM SearchTransaction | This API is used to query the list of URL tracing views. | |
| Querying the Details About a URL Tracing View | hcloud APM ShowTransactionDetail | This API is used to query the details about a URL tracing view. |
TRACING
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating an Application for Tracing | hcloud APM CreateTracingBusiness | This API is used to create an application for tracing. | |
| Obtaining the Token of an Application for Tracing | hcloud APM ShowTracingToken | This API is used to obtain the token of an application for tracing. | |
| Obtaining the Access Address of an Application for Tracing | hcloud APM ShowTracingAccessPoint | This API is used to obtain the access address of an application for tracing. |
Profiling
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying a Line-Level Flame Graph | hcloud APM ShowFlameLineTree | This API is used to query a line-level flame graph. |
WebMonitor
| API Name | Command | Description | Operation |
|---|---|---|---|
| Uploading a Source Map File for Web Monitoring | hcloud APM UploadSourceMap | This API is used to upload a source map file for web monitoring. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot