DescribeInstanceTopology - ApsaraDB for OceanBase (Deprecated)

Mengkueri informasi topologi Kluster OceanBase tertentu.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

oceanbase:DescribeInstanceTopology

get

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	ID Kluster OceanBase.	ob317v4uif****

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
RequestId	string	ID permintaan.	EE205C00-30E4-**-**-87E3A8A2AA0C
InstanceTopology	object	Informasi topologi kluster.
Tenants	array<object>	Daftar penyewa.
	array<object>	Parameter tanggapan.
TenantId	string	The ID of the tenant.	t33h8y08k****
TenantName	string	The name of the tenant.	pay_online
TenantCpu	number	The number of CPU cores of the tenant.	2
TenantMemory	number	The memory size of the tenant, in GB.	10
TenantMode	string	The mode of the tenant. Valid values: Oracle MySQL	Oracle
TenantZones	array<object>	The information about the zones.
	array<object>	The information about the zones.
TenantZoneRole	string	The role to access the zone. Valid values: ReadWrite: a role that has the read and write privileges. ReadOnly: a role that has only the read-only privilege.	ReadWrite
IsPrimaryTenantZone	boolean	Indicates whether the zone is the primary zone.	true
TenantZoneId	string	The ID of the zone.	cn-hangzhou-h
Units	array<object>	The information about the resource units.
	object	The information about the resource units.
UnitId	string	The ID of the resource unit.	1002
UnitStatus	string	The status of the resource unit. Valid values: ONLINE: The resource unit is running. IMMIGRATING: The resource unit is being immigrated. EMIGRATING: The resource unit is being emigrated. CANCEL_EMIGRATING: The immigration of the resource unit is being canceled. CANCEL_EMIGRATING: The emigration of the resource unit is being canceled. DELETING: The resource unit is being deleted.	ONLINE
NodeId	string	The ID of the OBServer node in which the resource unit resides.	i-bp16niirq4zdmgvm****
UnitCpu	number	The number of CPU cores of the resource unit.	2
UnitMemory	number	The memory size of the resource unit, in GB.	10
EnableMigrateUnit	boolean	Indicates whether the resource unit can be migrated.	true
ManualMigrate	boolean	Indicates whether the resource unit is manually migrated.	true
EnableCancelMigrateUnit	boolean	Indicates whether the migration can be canceled. This parameter is valid only for resource units that are being manually immigrated or emigrated.	true
UnitDataSize	integer	The data size of the resource unit.	10
ReplicaType	string	The type of the replica. Node filtering conditions are configured based on the replica type when you query the monitoring data of the OceanBase cluster. By default, the replica type is not specified when you query the monitoring data of OceanBase clusters or the access proxy. If you do not specify the replica type when you query the monitoring data of an OceanBase cluster, the monitoring data of all nodes is queried. If you set the replica type to FULL when you query the monitoring data of an OceanBase cluster, the monitoring data of only the full-featured replica nodes is queried. If you set the replica type to READONLY when you query the monitoring data of an OceanBase cluster, the monitoring data of only the read-only replica nodes is queried.	FULL
LogicalZone	string	The ID of the replica.	cn-hangzhou-h-z0
ReplicaType	string	The replica type of the tenant.	FULL
ReadOnlyReplicaType	string	The type of the read-only replica.	ROW_STORE
TenantStatus	string	The status of the tenant. Valid values: PENDING_CREATE: The tenant is being created. RESTORE: The tenant is being restored. ONLINE: The tenant is running. SPEC_MODIFYING: The specification of the tenant is being modified. ALLOCATING_INTERNET_ADDRESS: A public IP address is being allocated to the tenant. PENDING_OFFLINE_INTERNET_ADDRESS: The public IP address is being disabled. PRIMARY_ZONE_MODIFYING: The tenant is being switched to a new primary zone. PARAMETER_MODIFYING: Parameters are being modified. WHITE_LIST_MODIFYING: The allowlist is being modified.	ONLINE
TenantDeployType	string	The deployment type of the tenant. Valid values: multiple: multi-IDC deployment. single: single-IDC deployment. dual: dual-IDC deployment.	multiple
TenantUnitNum	integer	The number of resource units in the tenant.	1
PrimaryZoneDeployType	string	The deployment mode of the primary zone. Valid values: RANDOM. STATIC. Valid values: RANDOM : RANDOM STATIC : STATIC	RANDOM
TenantDiskSize	number	The disk space of the tenant, in GB.	2
TenantUnitCpu	number	The number of CPU cores of a single node in the tenant.	4
TenantUnitMemory	number	The memory size of a single node in the tenant, in GB.	16
Zones	array<object>	Informasi zona kluster.
	array<object>	Parameter tanggapan.
ZoneId	string	The ID of the zone.	cn-hangzhou-i
Region	string	The ID of the region.	cn-hangzhou
ZoneDisk	string	The storage capacity of the zone.	200 GB
Nodes	array<object>	The information about the nodes.
	array<object>	The information about the nodes.
NodeId	string	The ID of the node.	i-bp16niirq4zdmgvm****
NodeCopyId	integer	The ID of the replica node.	1
NodeStatus	string	The status of the node.	ONLINE
NodeResource	object	The information about node resources.
Cpu	object	The information about the CPU resources of the node.
UsedCpu	number	The number of CPU cores used by the node.	4
TotalCpu	integer	The total number of CPU cores of the node.	14
Memory	object	The information about the memory resources of the node.
UsedMemory	number	The size of memory used by the node, in GB.	10
TotalMemory	integer	The total memory size of the node, in GB.	70
DiskSize	object	The information about the storage resources of the node.
TotalDiskSize	number	The total storage space of the node, in GB.	100
UsedDiskSize	number	The size of storage space used by the node, in GB.	50
ReplicaType	string	The type of the replica. Valid values: FULL. READONLY.	FULL
FullCopyId	integer	The ID of the full-featured replica.	1
ReadOnlyCopyId	integer	The ID of the read-only replica.	1
LogicalZone	string	The ID of the replica.	cn-hangzhou-h-z0
ReadOnlyReplicaType	string	The type of the read-only replica.	ROW_STORE
ZoneResource	object	The information about zones.
DiskSize	object	The information about the storage resources of the node.
MaxDiskUsedPercent	number	The maximum disk usage, in percentage.	0.14
MaxDiskUsedObServer	array	The IDs of OBServer nodes that use the maximum disk space.
	string	The IDs of OBServer nodes that use the maximum disk space.	i-bp1fhj23fs32dfbg4****
Replicas	array<object>	Informasi replika.
	array<object>
LogicalZone	string	The ID of the replica.	cn-hangzhou-h-z0
NodeNum	integer	The number of nodes of the replica.	1
ZoneLogicalName	string	The region of the replica.	cn-hangzhou-h
ZoneRegionName	string	The zone of the replica.	cn-hangzhou-h
ReplicaResource	object	The information about the replica resources.
Memory	object	The information about the memory resources of the replica.
UsedMemory	integer	The size of memory used by the replica, in GB.	16
TotalMemory	integer	The total memory size of the replica, in GB.	32
DiskSize	object	The information about the data disk of the replica.
UsedDiskSize	number	The disk space used by the replica, in GB.	50
TotalDiskSize	integer	The total disk space of the replica, in GB.	100
Cpu	object	The information about the CPU resources of the replica.
TotalCpu	integer	The total number of CPU cores of the replica.	16
UsedCpu	integer	The number of CPU cores used by the replica.	8
ZoneLogicalId	integer	The serial number of the replica.	1
ReplicaType	string	The type of the replica.	FULL
Status	string	The status of the replica. Valid values: ACTIVE, INACTIVE, and UNKNOWN.	ACTIVE
ReadOnlyReplicaType	string	The type of the read-only replica.	ROW_STORE
OnlineNodeNum	integer

Contoh

Respons sukses

JSONformat

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "InstanceTopology": {
    "Tenants": [
      {
        "TenantId": "t33h8y08k****",
        "TenantName": "pay_online",
        "TenantCpu": 2,
        "TenantMemory": 10,
        "TenantMode": "Oracle",
        "TenantZones": [
          {
            "TenantZoneRole": "ReadWrite",
            "IsPrimaryTenantZone": true,
            "TenantZoneId": "cn-hangzhou-h",
            "Units": [
              {
                "UnitId": "1002",
                "UnitStatus": "ONLINE",
                "NodeId": "i-bp16niirq4zdmgvm****",
                "UnitCpu": 2,
                "UnitMemory": 10,
                "EnableMigrateUnit": true,
                "ManualMigrate": true,
                "EnableCancelMigrateUnit": true,
                "UnitDataSize": 10,
                "ReplicaType": "FULL"
              }
            ],
            "LogicalZone": "cn-hangzhou-h-z0",
            "ReplicaType": "FULL",
            "ReadOnlyReplicaType": "ROW_STORE"
          }
        ],
        "TenantStatus": "ONLINE",
        "TenantDeployType": "multiple",
        "TenantUnitNum": 1,
        "PrimaryZoneDeployType": "RANDOM",
        "TenantDiskSize": 2,
        "TenantUnitCpu": 4,
        "TenantUnitMemory": 16
      }
    ],
    "Zones": [
      {
        "ZoneId": "cn-hangzhou-i",
        "Region": "cn-hangzhou",
        "ZoneDisk": "200 GB",
        "Nodes": [
          {
            "NodeId": "i-bp16niirq4zdmgvm****",
            "NodeCopyId": 1,
            "NodeStatus": "ONLINE",
            "NodeResource": {
              "Cpu": {
                "UsedCpu": 4,
                "TotalCpu": 14
              },
              "Memory": {
                "UsedMemory": 10,
                "TotalMemory": 70
              },
              "DiskSize": {
                "TotalDiskSize": 100,
                "UsedDiskSize": 50
              }
            },
            "ReplicaType": "FULL",
            "FullCopyId": 1,
            "ReadOnlyCopyId": 1,
            "LogicalZone": "cn-hangzhou-h-z0",
            "ReadOnlyReplicaType": "ROW_STORE"
          }
        ],
        "ZoneResource": {
          "DiskSize": {
            "MaxDiskUsedPercent": 0.14,
            "MaxDiskUsedObServer": [
              "i-bp1fhj23fs32dfbg4****"
            ]
          }
        }
      }
    ],
    "Replicas": [
      {
        "LogicalZone": "cn-hangzhou-h-z0",
        "NodeNum": 1,
        "ZoneLogicalName": "cn-hangzhou-h",
        "ZoneRegionName": "cn-hangzhou-h",
        "ReplicaResource": {
          "Memory": {
            "UsedMemory": 16,
            "TotalMemory": 32
          },
          "DiskSize": {
            "UsedDiskSize": 50,
            "TotalDiskSize": 100
          },
          "Cpu": {
            "TotalCpu": 16,
            "UsedCpu": 8
          }
        },
        "ZoneLogicalId": 1,
        "ReplicaType": "FULL",
        "Status": "ACTIVE",
        "ReadOnlyReplicaType": "ROW_STORE",
        "OnlineNodeNum": 0
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.