CLI Command Reference
Managing the Landing Zone
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Home Region | hcloud RGC ShowHomeRegion | This API is used to query the home region of the landing zone. | |
| Pre-checking for Landing Zone | hcloud RGC CheckLaunch | This API is used to check whether the current region is eligible for setting up a landing zone. | |
| Setting up Landing Zone | hcloud RGC SetupLandingZone | This API is used to create or update a landing zone in the current region. | |
| Deleting a Landing Zone | hcloud RGC DeleteLandingZone | This API is used to delete a landing zone. | |
| Querying Landing Zone Setup Status | hcloud RGC ShowLandingZoneStatus | This API is used to query the status of landing zone setup. | |
| Checking Landing Zone Updates | hcloud RGC ShowAvailableUpdates | This API is used to check whether the landing zone needs to be updated. | |
| Querying Landing Zone Configurations | hcloud RGC ShowLandingZoneConfiguration | This API is used to query all configurations of the current landing zone. | |
| Querying IAM Identity Center Users | hcloud RGC ShowLandingZoneIdentityCenter | This API is used to query the information about IAM Identity Center users. |
Managing Organizations
| API Name | Command | Description | Operation |
|---|---|---|---|
| Registering an OU | hcloud RGC RegisterOrganizationalUnit | This API is used to register an OU in an organization with RGC. | |
| Re-registering an OU | hcloud RGC ReRegisterOrganizationalUnit | This API is used to re-register an OU in an organization with RGC. | |
| Deregistering an OU | hcloud RGC DeregisterOrganizationalUnit | This API is used to deregister an OU in an organization from RGC. | |
| Querying Operations on Registered OUs and Enrolled Accounts | hcloud RGC ListOperation | This API is used to query operations on registered OUs and enrolled accounts in RGC. | |
| Querying Registration Information | hcloud RGC ShowOperation | This API is used to query the registration and deregistration information in RGC. | |
| Deleting a Registered OU | hcloud RGC DeleteManagedOrganizationalUnits | This API is used to delete a registered OU from an organization. | |
| Querying Registered OUs | hcloud RGC ShowManagedOrganizationalUnit | This API is used to query information about OUs registered with RGC. | |
| Creating an OU | hcloud RGC CreateManagedOrganizationalUnit | This API is used to create an OU in an organization via RGC. The OU will be automatically registered in RGC. | |
| Listing Registered OUs Enabled with Governance Policies | hcloud RGC ListManagedOrganizationalUnits | This API is used to list registered OUs that governance policies have been enabled for. | |
| Enrolling an Account | hcloud RGC EnrollAccount | This API is used to enroll an organization account in RGC. | |
| Unmanaging an Account | hcloud RGC UnEnrollAccount | This API is used to cancel the RGC management of an organization account. | |
| Updating an Enrolled Account | hcloud RGC UpdateManagedAccount | This API is used to update an organization account enrolled by RGC. | |
| Querying an Enrolled Account | hcloud RGC ShowManagedAccount | This API is used to query an organization account that is enrolled by RGC. | |
| Querying the Template Information of an Enrolled Account | hcloud RGC ShowManagedAccountTemplate | This API is used to query the template information of an enrolled account in an organization. | |
| Listing Enrolled Accounts in a Registered OU | hcloud RGC ListManagedAccountsForParent | This API is used to list all enrolled accounts in a registered OU of an organization. | |
| Creating an Account | hcloud RGC CreateAccount | This API is used to create an account in a registered OU of an organization. | |
| Listing Enrolled Accounts for Governance Policies | hcloud RGC ListManagedAccounts | This API is used to list enrolled accounts for which governance policies are enabled. | |
| Listing Enrolled Core Accounts | hcloud RGC ShowManagedCoreAccount | This API is used to list all enrolled core accounts in an organization. |
Governing the Landing Zone
| API Name | Command | Description | Operation |
|---|---|---|---|
| Listing Governance Policies | hcloud RGC ListControls | This API is used to list all preset governance policies of RGC. | |
| Listing Non-Compliant Resources | hcloud RGC ListControlViolations | This API is used to list all non-compliant resources in an organization. | |
| Querying a Governance Policy | hcloud RGC ShowControl | This API is used to query details about a preset governance policy. | |
| Enabling a Governance Policy | hcloud RGC EnableControl | This API is used to enable a governance policy for an OU in an organization. | |
| Disabling a Governance Policy | hcloud RGC DisableControl | This API is used to disable a governance policy from an OU in an organization. | |
| Querying the Operating Status of a Governance Policy | hcloud RGC ShowControlOperate | This API is used to query the operating status by operation ID. | |
| Listing Enabled Governance Policies | hcloud RGC ListEnabledControls | This API is used to list all enabled governance policies in an organization. | |
| Listing Governance Policies Enabled for a Registered OU | hcloud RGC ListControlsForOrganizationalUnit | This API is used to list all governance policies enabled for a registered OU in an organization. | |
| Listing Governance Policies Enabled for an Enrolled Account | hcloud RGC ListControlsForAccount | This API is used to list all governance policies enabled for an enrolled account in an organization. | |
| Querying the Compliance of an Enrolled Account | hcloud RGC ShowComplianceStatusForAccount | This API is used to query the compliance status of resources in an enrolled account in an organization. | |
| Querying the Compliance Status of a Registered OU | hcloud RGC ShowComplianceStatusForOrganizationalUnit | This API is used to query the compliance status of resources in all enrolled accounts in a registered OU in an organization. | |
| Querying a Governance Policy Enabled for a Registered OU | hcloud RGC ShowControlsForOrganizationalUnit | This API is used to query details about a governance policy enabled for a registered OU in an organization. | |
| Querying a Governance Policy Enabled for an Enrolled Account | hcloud RGC ShowControlsForAccount | This API is used to query details about a governance policy enabled for an enrolled account in an organization. | |
| Querying the Compliance of Config Rules | hcloud RGC ListConfigRuleCompliances | This API is used to query the compliance of Config rules of an enrolled account. | |
| Querying the Compliance of External Config Rules for Enrolled Accounts | hcloud RGC ListExternalConfigRuleCompliances | This API is used to query the compliance of the external Config rules for enrolled accounts. | |
| Listing Drifts | hcloud RGC ListDriftDetails | This API is used to list all drift details of the landing zone. |
Managing Templates
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Template Deployment Parameters | hcloud RGC ShowTemplateDeployParams | This API is used to query the parameters for deploying templates. | |
| Creating a Template | hcloud RGC CreateTemplate | This API is used to create an RFS template. | |
| Deleting a Template | hcloud RGC DeleteTemplate | This API is used to delete an RFS template. | |
| Querying Predefined Templates | hcloud RGC ListPredefinedTemplates | This API is used to query a list of predefined templates. |
Checking Governance Maturity
| API Name | Command | Description | Operation |
|---|---|---|---|
| Checking Governance Maturity in Eight Domains | hcloud RGC CreateBestPracticeDetect | This API is used to check the governance maturity in eight domains. | |
| Querying the Status of the Latest Governance Check | hcloud RGC ShowBestPracticeStatus | This API is used to query the status of the latest governance maturity check. | |
| Querying Overview of the Latest Successful Governance Check Results | hcloud RGC ShowBestPracticeOverview | This API is used to query the overview of the latest successful governance maturity check results. | |
| Querying Latest Successful Governance Check | hcloud RGC ShowBestPracticeDetails | This API is used to query the details of the latest successful governance maturity check. | |
| Querying Details about the Governance Maturity Account | hcloud RGC ShowBestPracticeAccountInfo | This API is used to query details about the governance maturity account. |
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