
Quotas Info
Authorization Information
The following table shows the authorization information corresponding to this API, which can be used in the Action policy element to grant a RAM user or RAM role the permissions to call the API. Please use RAM to set up these permissions and refer to RAM documentation for more instructions.
Request Parameters
Field Name | Field Details |
---|---|
ChargeTypestring | The billing method of the instance. Valid values: View Details... Example:PrePayEnumeration Value:PrePayPostPay |
Seriesstring | The series of the OceanBase cluster. Valid values: View Details... Example:NormalEnumeration Value:normalnormal_ssdhistorynormal_kvnormal_hg |
Zonesstring | The ID of the zone to which the instance belongs. View Details... Example:cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-jReference Value Source: DescribeZones |
InstanceClassstring | The specifications of the cluster. View Details... Example:14C70GBEnumeration Value:64C380GB64C400GB32C70GB14C70GB16C32GB4C16GB32C160GB8C32GB16C70GB24C120GB32C180GB30C180GB40C64GB62C400GB20C32GB104C600GB64C180GBReference Value Source: DescribeInstances |
DiskSizeinteger<int64> | The size of the storage space,in GB. View Details... Notice
The field type is Long, and the precision may be lost during serialization/deserialization. Please note that the value must not be greater than 9007199254740991. Example:200 |
Periodinteger<int64> | The valid duration of the purchased resources. The unit is specified by the PeriodUnit parameter. View Details... Notice
The field type is Long, and the precision may be lost during serialization/deserialization. Please note that the value must not be greater than 9007199254740991. Example:1 |
PeriodUnitstring | The unit of the valid duration of the purchased resources. View Details... Example:Month |
AutoRenewboolean | Specifies whether to enable automatic renewal. View Details... Example:true |
AutoRenewPeriodinteger<int64> | The automatic renewal period of the instance. This parameter is required when the AutoRenew parameter is set to true. Valid values: View Details... Notice
The field type is Long, and the precision may be lost during serialization/deserialization. Please note that the value must not be greater than 9007199254740991. Example:2 |
ResourceGroupIdstring | The ID of the resource group to which the instance belongs. Example:rg-bp67acfmxazb4p**** |
InstanceNamestring | The name of the OceanBase cluster. View Details... Example:amap_aos_tx_obReference Value Source: DescribeInstance |
ObVersionstring | OceanBase Server version number. Example:2.2.77 |
DiskTypestring | The type of the storage disk where the cluster is deployed. This parameter takes effect only for Standard Cluster Edition (Cloud Disk).View Details... Example:cloud_essd_pl1Enumeration Value:cloud_essd_pl1cloud_essd_pl0 |
DryRunboolean | Specifies whether to perform only a dry run for the request. Default value: false. Valid values:View Details... Example:false |
ReplicaModestring | The number of full-featured replicas.View Details... Example:3FEnumeration Value:32 |
IsolationOptimizationstring | Specifies whether to enable the control group feature.View Details... Example:trueEnumeration Value:truefalse |
PrimaryInstancestring | Primary instance ID. Example:ob3h8ytroxxxxxReference Value Source: DescribeInstance |
PrimaryRegionstring | Primary instance region. Example:cn-hangzhou |
CpuArchstring | cpu 架构 Example:x86 |
Response Parameters
Field Name | Field Details |
---|---|
RequestIdstring | The request ID. Example:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
Dataobject | The returned data. |