DescribeDBInstanceTopology - PolarDB - Centre de documentation Alibaba Cloud

Consulte les informations de topologie d'une instance.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

polardbx:DescribeDBInstanceTopology

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'instance.	cn-hangzhou
DBInstanceName	string	Oui	L'identifiant de l'instance.	pxc-********
StartTime	string	Non	L'heure de début de la plage horaire pour l'interrogation des instances historiques dans la topologie. Format : yyyy-MM-dd HH:mm:ss.	2021-10-21T10:30:45Z 04:00:00
EndTime	string	Non	L'heure de fin de la plage horaire pour l'interrogation des instances historiques dans la topologie. Format : yyyy-MM-dd HH:mm:ss.	2021-10-22T10:30:45Z 04:00:00
MinuteSimple	boolean	Non	Indique si la topologie historique doit être interrogée.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	C458B1E8-1683-3645-B154-6BA32080EEA
Data	object	La structure de données.
LogicInstanceTopology	object	Les informations de topologie.
DBInstanceName	string	The instance name.	pxc-sprcym7g7w****
DBInstanceCreateTime	string	The time when the instance was created. Format: yyyy-MM-dd HH:mm:ss.	2021-10-21T10:30:45Z 04:00:00
MaintainStartTime	string	The start time of the O&M window. Format: HH:mm:ss.	04:00:00
MaintainEndTime	string	The end time of the O&M window. Format: HH:mm:ss.	05:00:00
LockReason	string	The reason why the instance is locked.	欠费
DBInstanceStatus	integer	The instance status.	8
LockMode	integer	The lock status. Valid values: 0: Not locked. 1: Locked.	0
EngineVersion	string	The engine version. Default value: 2.0.	2.0
DBInstanceStorage	integer	The number of storage nodes.	1
DBInstanceConnType	string	Indicates that LVS is used for load balancing.	lvs
DBInstanceId	string	The instance ID.	304726047
Engine	string	The engine type. Default value: polarx.	polarx
DBInstanceDescription	string	The instance description.	pxc-sprcym7******
DBInstanceStatusDescription	string	The description of the instance status.	TDE_MODIFYING
Items	array<object>	The list of nodes.
	array<object>	The node information.
DBInstanceCreateTime	string	The time when the instance was created.	2021-10-21T10:30:45Z
DBInstanceName	string	The instance name.	pxc-i-tk6t4z****
CharacterType	string	The node type. Valid values: polarx_cn: compute node. polarx_store: data node. polarx_gms: GMS node.	节点角色
MaintainStartTime	string	The start time of the O&M window.	不展示
DiskSize	integer	The disk size.	3145728
MaintainEndTime	string	The end time of the O&M window.	不展示
LockReason	string	The reason why the instance is locked.	不展示
DBInstanceStatus	integer	The instance status.	8
LockMode	integer	Indicates whether the node is locked. Valid values: 0: Not locked. 1: Locked.	0
EngineVersion	string	The engine version. Default value: 2.0.	5.7
DBInstanceConnType	integer	The connection type.	不展示
MaxConnections	integer	The maximum number of connections.	4000
DBInstanceId	string	The instance ID.	304726049
Engine	string	The engine type. Valid values: mysql polarx_cdc polarx_dn	mysql
MaxIops	integer	The maximum IOPS.	7000
DBInstanceDescription	string	The instance description.	不展示
DBInstanceStatusDescription	string	The description of the instance status.	不展示
ConnectionIp	array<object>	The data struct.
	object	The connection information.
Port	string	The port.	3306
DBInstanceNetType	integer	The internal connection type. The value is fixed to 1, which indicates the classic network.	1
ConnectionString	string	The connection information.	pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com
Region	string	The region of the node. If the node is an RDS node, the regions of multiple child nodes are separated with a delimiter (,).	cn-hangzhou
Azone	string	The zone of the node. If the node is an RDS node, the zones of multiple child nodes are separated with a delimiter (,).	cn-hangzhou-a
Role	string	The role of the node. Valid values: master: primary node standby: secondary node.	master
Activated	boolean	Indicates whether the node is activated. For the compute layer, only the node in the primary zone is activated. After a primary/secondary switchover is performed on the instance, the standby compute node becomes the primary node. All storage layer nodes are activated.	true
AzoneRoleList	array<object>	The data information list of the RDS three-node cluster.
	object
Azone	string	The zone of a node in the RDS three-node cluster.	cn-hangzhou-a
Role	string	The role of a node in the RDS three-node cluster. Valid values: leader: primary node follower: secondary node logger: logger node.	leader
Status	string	The node status. Valid values: 0: Running. 1: Creating. 2: Abnormal. 3: Expired. 4: Releasing. 5: Released. 6: Locked.	0
NodeClass	string	The node specifications. Valid values: polarx.x4.medium.2e: 2 cores, 8 GB polarx.x4.large.2e: 4 cores, 16 GB polarx.x8.large.2e: 4 cores, 32 GB polarx.x4.xlarge.2e: 8 cores, 32 GB polarx.x8.xlarge.2e: 8 cores, 64 GB polarx.x4.2xlarge.2e: 16 cores, 64 GB polarx.x8.2xlarge.2e: 16 cores, 128 GB polarx.x4.4xlarge.2e: 32 cores, 128 GB polarx.x8.4xlarge.2e: 32 cores, 256 GB polarx.st.8xlarge.2e: 60 cores, 470 GB polarx.st.12xlarge.2e: 90 cores, 720 GB.	polarx.x4.large.2e
Version	string	The logger node version.	polarx-cdc-kernel-2.0.0-3985896
PhyInstanceName	string	The physical instance name.	pxc-unrbk8oyz**********
StorageUsed	string	The storage usage, in MB.	16681
InstanceClusterName	string
ReadType	string
HistoryItems	array<object>	The list of historical nodes.
	object
CharacterType	string	The node type. Valid values: polarx_cn: compute node. polarx_store: data node. polarx_gms: GMS node.	节点角色
Role	string	The role of the node. Valid values: master: primary node standby: secondary node.	master
DBInstanceName	string	The instance name.	pxc-sprcym7g7w****
DBInstanceId	string	The instance ID.	304726049
Region	string	The region of the node. If the node is an RDS node, the regions of multiple child nodes are separated with a delimiter (,).	cn-hangzhou
Azone	string	The zone of the node. If the node is an RDS node, the zones of multiple child nodes are separated with a delimiter (,).	cn-hangzhou-a
Activated	boolean	Indicates whether the node is activated. For the compute layer, only the node in the primary zone is activated. After a primary/secondary switchover is performed on the instance, the standby compute node becomes the primary node. All storage layer nodes are activated.	true
PhyInstanceName	string	The physical instance name.	pxc-unrbk8oyz**********

Exemples

JSON format

{
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data": {
    "LogicInstanceTopology": {
      "DBInstanceName": "pxc-sprcym7g7w****",
      "DBInstanceCreateTime": "2021-10-21T10:30:45Z 04:00:00",
      "MaintainStartTime": "04:00:00",
      "MaintainEndTime": "05:00:00",
      "LockReason": "欠费",
      "DBInstanceStatus": 8,
      "LockMode": 0,
      "EngineVersion": "2.0",
      "DBInstanceStorage": 1,
      "DBInstanceConnType": "lvs",
      "DBInstanceId": "304726047",
      "Engine": "polarx",
      "DBInstanceDescription": "pxc-sprcym7******",
      "DBInstanceStatusDescription": "TDE_MODIFYING",
      "Items": [
        {
          "DBInstanceCreateTime": "2021-10-21T10:30:45Z",
          "DBInstanceName": "pxc-i-tk6t4z****",
          "CharacterType": "节点角色",
          "MaintainStartTime": "不展示",
          "DiskSize": 3145728,
          "MaintainEndTime": "不展示",
          "LockReason": "不展示",
          "DBInstanceStatus": 8,
          "LockMode": 0,
          "EngineVersion": "5.7",
          "DBInstanceConnType": 0,
          "MaxConnections": 4000,
          "DBInstanceId": "304726049",
          "Engine": "mysql",
          "MaxIops": 7000,
          "DBInstanceDescription": "不展示",
          "DBInstanceStatusDescription": "不展示",
          "ConnectionIp": [
            {
              "Port": "3306",
              "DBInstanceNetType": 1,
              "ConnectionString": "pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com"
            }
          ],
          "Region": "cn-hangzhou",
          "Azone": "cn-hangzhou-a",
          "Role": "master",
          "Activated": true,
          "AzoneRoleList": [
            {
              "Azone": "cn-hangzhou-a",
              "Role": "leader"
            }
          ],
          "Status": "0",
          "NodeClass": "polarx.x4.large.2e",
          "Version": "polarx-cdc-kernel-2.0.0-3985896",
          "PhyInstanceName": "pxc-unrbk8oyz**********",
          "StorageUsed": "16681",
          "InstanceClusterName": "",
          "ReadType": ""
        }
      ],
      "HistoryItems": [
        {
          "CharacterType": "节点角色",
          "Role": "master",
          "DBInstanceName": "pxc-sprcym7g7w****",
          "DBInstanceId": "304726049",
          "Region": "cn-hangzhou",
          "Azone": "cn-hangzhou-a",
          "Activated": true,
          "PhyInstanceName": "pxc-unrbk8oyz**********"
        }
      ]
    }
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	RAM.Permission.Denied	RAM authentication failed.
404	InvalidDBInstance.NotFound	The specified DB instance does not exist.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.