This is the multi-page printable view of this section. Click here to print.
Show Cluster
1 - 1.2
scp-cli mariadb cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | |
| dbaas_engine_version_name | DBaaS engine version name | |
| ha_enabled | HA availability | |
| init_config_option | {} | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| is_kernel_patchable | Whether the kernel can be patched | |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| origin_cluster_id | Origin cluster ID | |
| product_image_type | Product image type | |
| product_type | Product type | |
| replicas | Replicas list | |
| role_type | Role type | {} |
| service_state | Service state | |
| service_watch_log_collection | ServiceWatch log collection | |
| software_version | Software version | |
| subnet_id | Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. | |
| timezone | Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. | |
| vip_public_ip_address | (VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. | |
| vip_public_ip_id | (VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. | |
| virtual_ip_address | Virtual IP address |
2 - 1.1
scp-cli mariadb cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261031 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | |
| dbaas_engine_version_name | DBaaS engine version name | |
| ha_enabled | HA availability | |
| init_config_option | {} | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| is_kernel_patchable | Whether the kernel can be patched | |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| origin_cluster_id | Origin cluster ID | |
| product_image_type | Product image type | |
| product_type | Product type | |
| replicas | Replicas list | |
| role_type | Role type | {} |
| service_state | Service state | |
| service_watch_log_collection | ServiceWatch log collection | |
| software_version | Software version | |
| subnet_id | Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. | |
| timezone | Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. | |
| vip_public_ip_address | (VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. | |
| vip_public_ip_id | (VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. | |
| virtual_ip_address | Virtual IP address |
3 - 1.0
scp-cli mariadb cluster show
--cluster_id <value>
Description
Show Cluster.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| cluster_id required | string | Cluster ID | - |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0fdd87aab8cb46f59b7c1f81ed03fb3e |
| account_id | Account ID | |
| allowable_ip_addresses | Allowed IP addresses list | [] |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| dbaas_engine | DBaaS engine | |
| dbaas_engine_version_name | DBaaS engine version name | |
| ha_enabled | HA availability | |
| init_config_option | {} | |
| instance_count | Instance Count | |
| instance_groups | Instance groups list | [] |
| maintenance_option | Maintenance option | {} |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Cluster name | |
| nat_enabled | NAT availability | |
| origin_cluster_id | Origin cluster ID | |
| product_image_type | Product image type | |
| product_type | Product type | |
| replicas | Replicas list | |
| role_type | Role type | {} |
| service_state | Service state | |
| software_version | Software version | |
| subnet_id | Subnet ID. The ID can be obtained via the GET /vpc/v1/subnets endpoint. | |
| timezone | Timezone. The timezone can be obtained via the “GET /support/v1/timezones” endpoint. | |
| vip_public_ip_address | (VIP) Public IP Address. The address can be obtained via “GET /vpc/v1/publicips” endpoint. | |
| vip_public_ip_id | (VIP) Public IP ID. The ID can be obtained via “GET /vpc/v1/publicips” endpoint. | |
| virtual_ip_address | Virtual IP address |