DescribeInstance-阿里云帮助中心

Queries the details of an OceanBase cluster.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeInstance

get

*Instance

acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	OceanBase cluster ID.	ob317v4uif****
PageNumber	integer	No	Page number for paged query. Starting value: 1. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	The result of the request.
RequestId	string	The request ID.	EE205C00-30E4-**-**-87E3A8A2AA0C
Instance	object	The information of the OceanBase cluster.
InstanceId	string	The ID of the OceanBase cluster.	ob317v4uif****
InstanceName	string	The name of the OceanBase cluster.	ob4test
InstanceClass	string	The specifications of the cluster. The following plans are supported: 4C16GB: 4-core 16 GB. 8C32GB: 8-core 32 GB. 14C70GB: 14-core 70 GB. 24C120GB: 24-core 120 GB. 30C180GB: 30-core 180 GB. 62C400GB: 62-core 400 GB. 104C600GB: 104-core 600 GB. 16C70GB: 16-core 70 GB. 32C160GB: 32-core 160 GB. 64C380GB: 64-core 380 GB. 20C32GB: 20-core 32 GB. 40C64GB: 40-core 64 GB. 16C32GB: 16-core 32 GB. 32C70GB: 32-core 70 GB. 64C180GB: 64-core 180 GB. 32C180GB: 32-core 180 GB. 64C400GB: 64-core 400 GB.	14C70G
Series	string	The series of the instance. normal (default): Standard Cluster Edition (cloud disk). normal_ssd: Standard Cluster Edition (local disk). history: Archive Database Cluster Edition. normal_kv: OBKV cluster. normal_hg: Innovative application cluster.	Normal
PayType	string	The billing method of the OceanBase cluster. PREPAY: subscription. POSTPAY: pay-as-you-go.	PREPAY
CreateTime	string	The time when the cluster was created. The time is in UTC.	2021-10-19T07:13:41Z
ExpireTime	string	The expiration time of the cluster. The time is in UTC.	2021-10-17T16:00:00Z
Version	string	The version of the OBServer.	2.2.77
DeployType	string	The deployment type of the cluster. multiple: multi-data center. single: single-data center. dual: dual-data center.	multiple
DeployMode	string	The data replication mode of the cluster. n for a single data center. n-n for dual data centers. n-n-n for multiple data centers. Note In this mode, n indicates the number of OBServer nodes in each data center.	1-1-1
DiskType	string	The storage class of the cluster. The default value is cloud_essd_pl1, which indicates an ESSD cloud disk.	cloud_essd_pl1
MaintainTime	string	The daily maintenance window of the cluster. The time is in UTC.	19:00Z-20:00Z
DataMergeTime	string	The data merge time of the cluster.	02:00
AutoRenewal	boolean	Indicates whether auto-renewal is enabled. This parameter is valid only for subscription clusters.	true
IsTrustEcs	boolean	Indicates whether a trusted ECS instance is used.	true
Status	string	The status of the cluster. PENDING_CREATE: The instance is being created. ONLINE: The instance is running. TENANT_CREATING: A tenant is being created. TENANT_SPEC_MODIFYING: The tenant specifications are being modified. EXPANDING: The number of nodes is scaling up. REDUCING: The number of nodes is scaling down. SPEC_UPGRADING: The instance specifications are being upgraded. DISK_UPGRADING: The storage capacity is scaling up. WHITE_LIST_MODIFYING: The whitelist is being modified. PARAMETER_MODIFYING: Parameters are being modified. SSL_MODIFYING: The SSL certificate is being changed. PREPAID_EXPIRE_CLOSED: The subscription cluster is suspended due to an overdue payment. ARREARS_CLOSED: The pay-as-you-go cluster is suspended due to an overdue payment. PENDING_DELETE: The instance is being deleted. The cluster is usually in the ONLINE state.	ONLINE
Resource	object	The resource information of the cluster.
Cpu	object	The CPU resource information of the cluster.
TotalCpu	integer	The total number of CPU cores of the cluster.	14
UsedCpu	integer	The number of used CPU cores of the cluster.	10
UnitCpu	integer	The number of CPU cores of each replica node in the cluster.	10
OriginalTotalCpu	integer	The original number of CPU cores.	14
Memory	object	The memory resource information of the cluster.
TotalMemory	integer	The total memory of the cluster, in GB.	70
UsedMemory	integer	The used memory of the cluster, in GB.	10
UnitMemory	integer	The memory of each replica in the cluster, in GB.	10
OriginalTotalMemory	integer	The original memory size.	72
DiskSize	object	The storage resource information of the cluster.
TotalDiskSize	integer	The total storage space of the cluster, in GB.	200
UsedDiskSize	integer	The used storage space of the cluster, in GB.	100
UnitDiskSize	integer	The storage space of each replica in the cluster, in GB.	200
DataUsedSize	number	The size of the data disk, in GB.	200
MaxDiskUsedPercent	number	The maximum disk usage, in percentage.	0.14
MaxDiskUsedObServer	array	The maximum disk usage of the server.
	string	The list of OBServer nodes with the highest data disk usage.	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	The original disk size.	200
MaxDiskSize	number	The maximum disk size that can be created.	80000
UnitCount	integer	The number of resource units in the cluster.	1
LogDiskSize	object	The log disk resource information of the cluster.
TotalDiskSize	integer	The total log disk space of the cluster, in GB.	400
UnitDiskSize	integer	The log storage space of each replica in the cluster, in GB.	200
LogAssignedSize	string	The allocated log storage space, in GB.	0.0
MaxLogAssignedObServer	array	The information about the maximum storage space allocated to the server.
	string	The list of OBServer nodes with the highest log disk usage.	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	The maximum percentage of allocated log storage space.	6.68
OriginalTotalDiskSize	integer	The original size of the log disk.	200
CapacityUnit	object	The capacity unit.
MaxCapacityUnit	integer	The maximum capacity unit.	4
MinCapacityUnit	integer	The minimum capacity unit.	1
UsedCapacityUnit	string	The used capacity unit.	2
AutoUpgradeObVersion	boolean	Indicates whether to automatically upgrade the OBServer version.	true
ObRpmVersion	string	The detailed version information of the OBServer.	2.2.77-20210526202046
IsLatestObVersion	boolean	Indicates whether the OBServer is of the latest version.	true
AvailableZones	array	The list of zones.
	string	The list of zones.	cn-hangzhou-i
EnableUpgradeLogDisk	boolean	Indicates whether the log disk specifications can be upgraded.	false
Zones	array	The ID of the zone where the instance belongs. For more information, see DescribeZones to obtain the list of zones.
	string	The ID of the zone where the instance belongs. For more information, see DescribeZones to obtain the list of zones.	cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
InstanceRole	string	The instance role.	NORMAL
NodeNum	string	The number of nodes in the cluster. If the deployment mode is n-n-n, the number of nodes is n × 3.	6
ReplicaMode	string	The number of full-featured replicas. The return value can be 3 or 2. 3: three full-featured replicas. 2: two full-featured replicas. A three-zone deployment supports three full-featured replicas. A dual-zone deployment supports two full-featured replicas. A single-zone deployment can support two or three full-featured replicas.	2
IsolationOptimization	boolean	Indicates whether Cgroup is enabled.	false
EnableIsolationOptimization	boolean	Indicates whether isolation optimization can be enabled.	false
InTempCapacityStatus	boolean	The temporary capacity status.	false
DataDiskAutoScale	boolean	Indicates whether automatic data scaling is enabled. Note This parameter is deprecated.	-
TenantCreatable	object	The tenants that can be created.
EnableCreateTenant	boolean	Indicates whether the cluster allows tenant creation.	true
DisableCreateTenantReason	string	The reason why the cluster does not allow tenant creation.	CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT
DataDiskAutoScaleConfig	object	The configuration of automatic data disk scaling.
AutoScale	boolean	Indicates whether the feature is enabled.	true
Upperbound	integer	The upper limit for scaling.	16
UpperThreshold	integer	The threshold for daily scale-out.	80
UpperMergeThreshold	integer	The threshold for merged scale-out.	90
MaxDiskSize	integer	The maximum disk size.	80000
ScaleStepInNormal	integer	The step size for daily scale-out.	50
ScaleStepInMerge	integer	The step size for merged scale-out.	100
UpperScaleStrategy	string	The scale-out policy. Valid values: RAW and PERCENTAGE.	RAW
UpperScaleStep	string	The scale-out step size.	5
EnableProxyService	boolean	Indicates whether the proxy service is enabled. true false	true
ProxyServiceStatus	string	The status of the proxy service.	ONLINE
ProxyClusterId	string	The ID of the proxy cluster. Note This parameter is returned only when EnableProxyService is true.	proxy-56****a6tg2o
CpuArchitecture	string	The CPU architecture of the cluster.	X86
ReadOnlyResource	object	The resource information of the cluster.
Cpu	object	The CPU resource information of the cluster.
TotalCpu	integer	The total number of CPU cores of the cluster.	14
UsedCpu	integer	The number of used CPU cores of the cluster.	10
UnitCpu	integer	The number of CPU cores of each replica node in the cluster.	10
OriginalTotalCpu	integer	The original number of CPU cores.	14
Memory	object	The memory resource information of the cluster.
TotalMemory	integer	The total memory of the cluster, in GB.	70
UsedMemory	integer	The used memory of the cluster, in GB.	10
UnitMemory	integer	The memory of each replica in the cluster, in GB.	10
OriginalTotalMemory	integer	The original memory size.	72
DiskSize	object	The storage resource information of the cluster.
TotalDiskSize	integer	The total storage space of the cluster, in GB.	200
UsedDiskSize	integer	The used storage space of the cluster, in GB.	100
UnitDiskSize	integer	The storage space of each replica in the cluster, in GB.	200
DataUsedSize	number	The used storage space, in GB.	200
MaxDiskUsedPercent	number	The maximum disk usage, in percentage.	0.14
MaxDiskUsedObServer	array	The maximum disk usage of the server.
	string	The maximum disk usage of the server.	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	The original disk size.	200
MaxDiskSize	number	The maximum disk size that can be created.	80000
UnitCount	integer	The number of resource units in the cluster.	1
LogDiskSize	object	The log disk resource information of the cluster.
TotalDiskSize	integer	The total log disk space of the cluster, in GB.	400
UnitDiskSize	integer	The log storage space of each replica in the cluster, in GB.	200
LogAssignedSize	string	The allocated log storage space.	0.0
MaxLogAssignedObServer	array	The OBServer to which the maximum log space is allocated.
	string	The OBServer to which the maximum log space is allocated.	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	The maximum percentage of allocated log space.	6.68
CapacityUnit	object	The capacity unit.
MaxCapacityUnit	integer	The maximum capacity unit.	4
MinCapacityUnit	integer	The minimum capacity unit.	1
UsedCapacityUnit	string	The used capacity unit.	2
UnitSpec	string	The unit specifications of the proxy service.	2C4G
SharedUnitNumLimit	integer	The upper limit on the number of units for the proxy service in shared mode.	3
ExclusiveUnitNumLimit	integer	The upper limit on the number of units for the proxy service in exclusive mode.	1
EnableReadOnlyReplica	boolean	Indicates whether read-only replicas are supported.	true
EnableReadOnlyReplicaManagement	boolean	Indicates whether you can purchase read-only replicas for the cluster.	false
PrimaryInstance	string	The ID of the primary instance.	ob3h8ytroxxxxx
PrimaryRegion	string	The region of the primary instance.	cn-hangzhou
SpecType	string	The specification type.	dedicatedspec
AllowModifyInternetAddressConnectionLimit	boolean	Indicates whether the maximum number of connections over the Internet can be modified.	false
AllowCreateProxySqlFirewallRule	boolean	Indicates whether the ODP SQL firewall is allowed.	false
Iops	integer		10000

Examples

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Instance": {
    "InstanceId": "ob317v4uif****",
    "InstanceName": "ob4test",
    "InstanceClass": "14C70G",
    "Series": "Normal",
    "PayType": "PREPAY",
    "CreateTime": "2021-10-19T07:13:41Z",
    "ExpireTime": "2021-10-17T16:00:00Z",
    "Version": "2.2.77",
    "DeployType": "multiple",
    "DeployMode": "1-1-1",
    "DiskType": "cloud_essd_pl1",
    "MaintainTime": "19:00Z-20:00Z",
    "DataMergeTime": "02:00",
    "AutoRenewal": true,
    "IsTrustEcs": true,
    "Status": "ONLINE",
    "Resource": {
      "Cpu": {
        "TotalCpu": 14,
        "UsedCpu": 10,
        "UnitCpu": 10,
        "OriginalTotalCpu": 14
      },
      "Memory": {
        "TotalMemory": 70,
        "UsedMemory": 10,
        "UnitMemory": 10,
        "OriginalTotalMemory": 72
      },
      "DiskSize": {
        "TotalDiskSize": 200,
        "UsedDiskSize": 100,
        "UnitDiskSize": 200,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68",
        "OriginalTotalDiskSize": 200
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "AutoUpgradeObVersion": true,
    "ObRpmVersion": "2.2.77-20210526202046",
    "IsLatestObVersion": true,
    "AvailableZones": [
      "cn-hangzhou-i"
    ],
    "EnableUpgradeLogDisk": false,
    "Zones": [
      "cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j"
    ],
    "InstanceRole": "NORMAL",
    "NodeNum": "6",
    "ReplicaMode": "2",
    "IsolationOptimization": false,
    "EnableIsolationOptimization": false,
    "InTempCapacityStatus": false,
    "DataDiskAutoScale": true,
    "TenantCreatable": {
      "EnableCreateTenant": true,
      "DisableCreateTenantReason": "CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT"
    },
    "DataDiskAutoScaleConfig": {
      "AutoScale": true,
      "Upperbound": 16,
      "UpperThreshold": 80,
      "UpperMergeThreshold": 90,
      "MaxDiskSize": 80000,
      "ScaleStepInNormal": 50,
      "ScaleStepInMerge": 100,
      "UpperScaleStrategy": "RAW",
      "UpperScaleStep": "5"
    },
    "EnableProxyService": true,
    "ProxyServiceStatus": "ONLINE",
    "ProxyClusterId": "proxy-56****a6tg2o",
    "CpuArchitecture": "X86",
    "ReadOnlyResource": {
      "Cpu": {
        "TotalCpu": 14,
        "UsedCpu": 10,
        "UnitCpu": 10,
        "OriginalTotalCpu": 14
      },
      "Memory": {
        "TotalMemory": 70,
        "UsedMemory": 10,
        "UnitMemory": 10,
        "OriginalTotalMemory": 72
      },
      "DiskSize": {
        "TotalDiskSize": 200,
        "UsedDiskSize": 100,
        "UnitDiskSize": 200,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68"
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "UnitSpec": "2C4G",
    "SharedUnitNumLimit": 3,
    "ExclusiveUnitNumLimit": 1,
    "EnableReadOnlyReplica": true,
    "EnableReadOnlyReplicaManagement": false,
    "PrimaryInstance": "ob3h8ytroxxxxx",
    "PrimaryRegion": "cn-hangzhou",
    "SpecType": "dedicatedspec",
    "AllowModifyInternetAddressConnectionLimit": false,
    "AllowCreateProxySqlFirewallRule": false,
    "Iops": 10000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.