CLI Command Reference
ExternalCOCTicket
| API Name | Command | Description | Operation |
|---|---|---|---|
| List ticket | hcloud COC ListTickets | List ticket | |
| Search work order history | hcloud COC ListTicketOperationHistories | List Histories | |
| Work order operations | hcloud COC ExecuteTicketAction | Change order approval and cancellation and all operations for issue orders are completed through this interface | |
| Get Ticket info by id | hcloud COC ShowTicketInfo | Get Ticket info by id | |
| Download attachment | hcloud COC DownloadAttachment | Download attachment | |
| Create COC Change Or Incident Ticket | hcloud COC CreateTicket | Create COC Change Or Incident Ticket | |
| upload attachment | hcloud COC CreateAttachment | upload attachment |
ExternalCOCChange
CocChangeV2
| API Name | Command | Description | Operation |
|---|---|---|---|
| update change order | hcloud COC UpdateChange | update change order |
Alarm
| API Name | Command | Description | Operation |
|---|---|---|---|
| ShowAlarm | hcloud COC ShowAlarm | Get alarm info by id | |
| auto-process alarm | hcloud COC HandlerAlarm | auto-process alarm | |
| List Alarm History | hcloud COC ListAlarmHandleHistories | List Alarm History | |
| Transfer Alarm To Incident | hcloud COC TransferAlarmToIncident | Transfer Alarm To Incident | |
| Clear Alarm | hcloud COC ClearAlarm | Clear Alarm |
CocIncidentV2
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query list of incident ticket | hcloud COC ListIncidents | Query list of incident ticket | |
| Query list of incident operation histories | hcloud COC ListIncidentsHistories | Query list of incident operation histories | |
| Operate incident ticket | hcloud COC HandleIncident | Operate incident ticket | |
| Query incident ticket tasks | hcloud COC ShowIncidentTask | Query incident ticket tasks |
Diagnosis
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query the diagnostic task records as a list | hcloud COC ListDiagnosisTasks | Query the diagnostic task records as a list | |
| Submit the diagnostic task | hcloud COC CreateDiagnosisTask | Submit the diagnostic task | |
| Query the details of the specified diagnostic steps under the specified diagnostic record | hcloud COC ShowDiagnosisNode | Query the details of the specified diagnostic steps under the specified diagnostic record | |
| Query the details of a single diagnostic task | hcloud COC ShowDiagnosisTask | Query the details of a single diagnostic task | |
| Retry the diagnostic task | hcloud COC RetryDiagnosisTask | Retry the diagnostic task | |
| Cancel the diagnostic task | hcloud COC CancelDiagnosisTask | Cancel the diagnostic task | |
| Query the result summary of the batch diagnostic task | hcloud COC ShowDiagnosisSummary | Query the result summary of the batch diagnostic task |
WarRoom
compliant
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining a Node Compliance Report | hcloud COC ListInstanceCompliant | This API is used to obtaining node compliance reports by page. | |
| Obtaining Node Patch Details by Page | hcloud COC ShowInstancePatchItems | This API is used to obtain the patch details of a node by page |
ScriptExecutionManagement
| API Name | Command | Description | Operation |
|---|---|---|---|
| Displaying Basic Information about Script Service Tickets | hcloud COC GetScriptJobInfo | Query Execution: Basic Information | |
| Displaying the Batch List | hcloud COC ListScriptJobBatches | Query:Batch List | |
| Displaying Instance Status Statistics | hcloud COC GetScriptJobStatistics | Query: instance status statistics. | |
| Displaying Batch Details | hcloud COC GetScriptJobBatch | Query: Batch details. You can obtain the list of instances in a batch by page. | |
| Displaying the Service Ticket List | hcloud COC ListScriptJobs | Queries the work order list on multiple pages. | |
| Operation Script Service Ticket | hcloud COC OperateScriptJob | Operation type: Cancel Instance, Skip Batch, Cancel Entire Work Order, Suspend Entire Work Order, Continue Entire Work Order |
ScriptManagement
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Scripts | hcloud COC ListScripts | Job Script List:Custom Scripts | |
| Creating a script | hcloud COC CreateScript | Create Job Script:Custom Script | |
| Obtaining Details About a Custom Script | hcloud COC GetScript | Obtaining Script Details | |
| Executing Customized Scripts | hcloud COC ExecuteScript | Execute scripts | |
| Modified Scripts | hcloud COC UpdateScript | Modifying Job Scripts: Custom Scripts | |
| Deleting a Customized Script | hcloud COC DeleteScript | Delete job scripts: Customized scripts. | |
| Obtaining the Automatic Batching Result | hcloud COC ListInstancesBatch | Obtain the batching result based on the batching policy. Only automatic batching is supported. | |
| Evaluate the risk level of the script | hcloud COC CheckScriptRisk | Evaluate the risks of the operation based on the operation content and return the analysis results and information. The results are for reference only. | |
| Approve the script to be approved. | hcloud COC AcceptScript | Function: Approve the script. |
ScriptPublicManagement
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining the Public Script List | hcloud COC ListPublicScripts | Obtain the public script list and pagination logic: The limit+marker mode is used to improve the pagination efficiency. Use the auto-increment ID as the marker parameter. | |
| Displaying public script details | hcloud COC GetPublicScript | Displaying public script details | |
| Executing Common Scripts | hcloud COC ExecutePublicScript | Executing Common Scripts |
DocumentManagement
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Custom Job List | hcloud COC ListDocuments | Querying the Custom Job List | |
| Creating a Custom Job | hcloud COC CreateDocument | Creating a Custom Job | |
| Obtains the atomic capability list | hcloud COC ListDocumentAtomics | Obtains the atomic capability list | |
| Obtains atomic capability details | hcloud COC GetDocumentAtomicInfo | Obtains atomic capability details | |
| Modifying a Custom Job | hcloud COC UpdateDocument | Modifying a Custom Job | |
| Executing a Custom Job | hcloud COC ExecuteDocument | Executing a Custom Job | |
| Querying Details About a User-defined Job | hcloud COC GetDocument | Querying Details About a User-defined Job | |
| Deleting a Custom Job | hcloud COC DeleteDocument | Deleting a Custom Job |
ExecutionManagement
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Work Order Details | hcloud COC GetExecution | Querying Work Order Details | |
| Querying Work Order Step Details | hcloud COC ListExecutionSteps | Querying Work Order Step Details | |
| Querying a Work Order Step Batch Instance | hcloud COC ListExecutionInstances | Query the batch instance of a work order step, for example, the ECS instance in the script batch operation. | |
| Querying the Work Order List | hcloud COC ListExecutions | Querying the Work Order List | |
| Operation work order | hcloud COC OperateExecution | Operation work order |
ResourceTagManagement
resource
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query all resources of the user | hcloud COC ListResources | Query all resources of the user | |
| Synchronize all resources from RMS | hcloud COC SyncResource | Synchronize all resources from RMS | |
| Query the total number of various resources for a user | hcloud COC CountMultiResources | Query the total number of various resources for a user | |
| Query the total number of user resources | hcloud COC CountResources | Query the total number of user resources . | |
| synchronize Huawei cloud resource agent information | hcloud COC SyncResourceAgent | synchronize Huawei cloud resource agent information. |
multipleCloud
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Resources of a User in a Cloud Vendor | hcloud COC ListMultiCloudResources | Querying Resources of a User in a Cloud Vendor | |
| Query the total number of resources a user has in the cloud provider's system. | hcloud COC CountMultiCloudResources | Query the total number of resources a user has on cloud providers (Alibaba Cloud, AWS, Azure, and HCS). | |
| Manually synchronize user resources from cloud providers | hcloud COC SyncMultiCloudResource | Manually synchronize user resources from cloud providers. | |
| Check the latest synchronization status of cloud resources | hcloud COC ShowLastSyncStatus | Check the latest synchronization status of cloud resources. |
delegation_platform
| API Name | Command | Description | Operation |
|---|---|---|---|
| Synchronize offline IDC resource agent information | hcloud COC SyncOtherResourceAgent | Synchronize offline IDC resource agent information. | |
| Import IDC Offline Resources | hcloud COC ImportOtherResource | Import IDC Offline Resources. | |
| Modify Resource | hcloud COC UpdateOtherResource | Manage and modify resources. | |
| Query the number of offline IDC resources | hcloud COC CountOtherResource | Query the number of offline IDC resources | |
| Querying resources in a list | hcloud COC ListOtherResource | Manage resources and query resources in a list. | |
| Resource management,delete resource | hcloud COC DeleteOtherResource | Resource management,delete resource |
resourceView
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query CMDB cross-account resource view | hcloud COC ListResourceViews | Query CMDB cross-account resource view. | |
| Create CMDB cross-account resource view | hcloud COC CreateResourceViews | Create CMDB cross-account resource view. | |
| Update CMDB Cross-Account Resource View | hcloud COC UpdateResourceViews | Update CMDB Cross-Account Resource View. | |
| Delete the cross-account resource management view in CMDB | hcloud COC DeleteResourceViews | Delete the cross-account resource management view in CMDB. | |
| Synchronized CMDB cross-account resource view | hcloud COC SyncResourcesOfResourceView | Synchronized CMDB cross-account resource view. | |
| Query the total number of resources aggregated in the CMDB cross-account resource view | hcloud COC CountResourcesOfResourceView | Query the total number of resources aggregated in the CMDB cross-account resource view. | |
| Query the aggregated resources of the CMDB cross-account resource view | hcloud COC ListResourcesOfResourceView | Query the aggregated resources of the CMDB cross-account resource view. |
ResourceTags
groupRmsResourceRelation
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query resources associated with the group | hcloud COC ListGroupRmsResourceRelations | Query resources associated with the group. | |
| Transfer resources | hcloud COC UpdateGroupRmsResourceRelation | Transfer resources. | |
| Create group resource association | hcloud COC CreateGroupRmsResourceRelation | Create group resource association. | |
| Unbind Group Resource Association | hcloud COC DeleteGroupRmsResourceRelation | Unbind Group Resource Association. | |
| Query the total number of resources associated with the group | hcloud COC CountGroupRmsResourceRelations | Query the total number of resources associated with the group. | |
| Querying Application Capacity Data | hcloud COC ListCapacityView | Querying Application Capacity Data. | |
| Query the ranking of application, component, and group capacity data | hcloud COC ListCapacityOrder | Query the ranking of application, component, and group capacity data. |
groupResourceRelation
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query AliYun resources associated with the group | hcloud COC ListGroupAliResourceRelations | Query AliYun resources associated with the group. | |
| Query IDC resources associated with the group | hcloud COC ListGroupOtherResourceRelations | Query IDC resources associated with the group. |
applicationview
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query application, component, and group name list | hcloud COC ListApplicationView | Query application, component, and group name list. | |
| Batch create applications, groups, and components | hcloud COC BatchCreateApplicationView | Batch create applications, groups, and components |
enterpriseProjectCollect
vendorAccount
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying a Cloud Vendor Account | hcloud COC ListVendorAccount | Query account information for all cloud providers (such as Alibaba Cloud, AWS, Azure, and HCS) | |
| Create cloud service provider account | hcloud COC CreateVendorAccount | Create accounts with cloud service providers (such as Alibaba Cloud, AWS, Azure, and HCS). | |
| Modify Cloud Provider Account | hcloud COC UpdateVendorAccount | Update account information for all cloud service providers (Alibaba Cloud, AWS, Azure, HCS, etc.). | |
| Deleting a Cloud Vendor Account | hcloud COC DeleteVendorAccount | Add a cloud service provider account, and you can delete it when it is no longer needed. |
job
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Task Details | hcloud COC ShowJobDetail | Querying Task Details. |
application
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query application | hcloud COC ListApplications | Query application | |
| Create Application | hcloud COC CreateApplication | Create Application. | |
| Update Application | hcloud COC UpdateApplication | Update Application. | |
| Delete Application | hcloud COC DeleteApplication | Delete Application. |
group
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query Grouping | hcloud COC ListApplicationGroups | Query Grouping. | |
| Create Group | hcloud COC CreateApplicationGroup | Create Group. | |
| Intelligent Synchronization of Group Resources | hcloud COC SyncGroupResource | Intelligent Synchronization of Group Resources. | |
| Update Group | hcloud COC UpdateApplicationGroup | Update Group. | |
| Delete Group | hcloud COC DeleteApplicationGroup | Delete Group. |
component
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query Component | hcloud COC ListApplicationComponents | Query Component. | |
| Create Component | hcloud COC CreateApplicationComponents | Create Component. | |
| Update Component | hcloud COC UpdateApplicationComponent | Update Component. | |
| Delete Component | hcloud COC DeleteApplicationComponent | Delete Component. |
ExternalCocIncident
| API Name | Command | Description | Operation |
|---|---|---|---|
| CreateExternalIncident Creating an incident ticket | hcloud COC CreateCocIncident | CreateExternalIncident Creating an incident ticket | |
| HandleCocIncident Handling Event Tickets | hcloud COC HandleCocIncident | HandleCocIncident Handling Event Tickets | |
| GetCocIncidentDetail Obtain event ticket details | hcloud COC ShowCocIncidentDetail | ShowCocIncidentDetail Obtain event ticket details | |
| Query Simplified Incident Ticket List | hcloud COC ListIncidentSimpleTickets | This API supports paginated queries for incident ticket lists using limit and offset parameters. | |
| GetCocTicketOperationHistories Obtain event ticket history | hcloud COC ListCocTicketOperationHistories | ListCocTicketOperationHistories Obtain event ticket history | |
| Upload file to server. | hcloud COC CreateExternalCocAttachment | Upload file to server. |
ListAuthorizableTicketsExternal
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the List of COCs That Can Be Authorized | hcloud COC ListAuthorizableTicketsExternal | Querying the List of COCs That Can Be Authorized (Change Request No, Event No, War Room, and Alarm) |
ExternalCocIssues
EventMessageIntegration
| API Name | Command | Description | Operation |
|---|---|---|---|
| Prometheus Event access | hcloud COC CreateReportPrometheusEvent | Prometheus Event access |
CustomEventMessageIntegration
| API Name | Command | Description | Operation |
|---|---|---|---|
| Allows users to access alarm data. | hcloud COC CreateReportCustomEvent | Tenants can integrate self-developed monitoring systems into the COC in a standard manner. After the integration, alarms are reported to the COC alarm center in a standard format. |
application-model
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query the lower-level sub-applications, components, and groups | hcloud COC ListApplicationModel | Query the lower-level sub-applications, components, and groups |
ScheduledTask
| API Name | Command | Description | Operation |
|---|---|---|---|
| Query Scheduled Task List | hcloud COC ListScheduledTask | Get ScheduledTask infos | |
| Create Scheduled Task | hcloud COC CreateScheduledTask | Create Scheduled Task | |
| Update ScheduledTask | hcloud COC UpdateScheduledTask | Update ScheduledTask | |
| Query ScheduledTask | hcloud COC ShowScheduledTask | Get ScheduledTask info by id | |
| Delete ScheduledTask | hcloud COC DeleteScheduledTask | Delete scheduled task by id | |
| Query history of scheduledTask | hcloud COC ListScheduledTaskHistory | get scheduled task history list | |
| Enable ScheduledTask | hcloud COC EnableScheduledTask | Enable scheduled task by id | |
| Disable ScheduledTask | hcloud COC DisableScheduledTask | Disable scheduled task by id |
AccountManagement
| API Name | Command | Description | Operation |
|---|---|---|---|
| reset account password | hcloud COC ResetAccountPassword | reset account password | |
| create password change plan | hcloud COC CreatePasswordChangePlan | create password change plan | |
| rewrite password change result | hcloud COC UpdateAccountPassword | rewrite password change result |
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