DescribeParameters - PolarDB - Centre de documentation Alibaba Cloud

Consulte les paramètres 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:DescribeParameters

none

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	La région à laquelle l'instance appartient.	cn-hangzhou
DBInstanceId	string	Oui	L'identifiant de l'instance.	pxc-********
ParamLevel	string	Non	Le niveau du paramètre. Valeurs valides : compute : couche de calcul. storage : couche de stockage.	compute

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	6BA32080EEA
Data	object	Les détails des paramètres.
EngineVersion	string	La version du moteur DPI. Valeur par défaut : 2.0.	2.0
Engine	string	Le moteur. Valeur par défaut : polarx.	polarx
ConfigParameters	array<object>	La liste des paramètres d'origine.
	object
ParameterDescription	string	The parameter description.	存储节点私有协议开关(-1关闭，0开启)
ParameterName	string	The parameter name.	CONN_POOL_XPROTO_STORAGE_DB_PORT
ParameterValue	string	The parameter value.	-1
RunningParameters	array<object>	La liste des détails des paramètres en cours d'exécution.
	object
ParameterDescription	string	The parameter description.	存储节点私有协议开关(-1关闭，0开启)
ParameterName	string	The parameter name.	CONN_POOL_XPROTO_STORAGE_DB_PORT
ParameterValue	string	The parameter value.	-1
DBInstanceId	string

Exemples

JSON format

{
  "RequestId": "6BA32080EEA",
  "Data": {
    "EngineVersion": "2.0",
    "Engine": "polarx",
    "ConfigParameters": [
      {
        "ParameterDescription": "存储节点私有协议开关(-1关闭，0开启)",
        "ParameterName": "CONN_POOL_XPROTO_STORAGE_DB_PORT",
        "ParameterValue": "-1"
      }
    ],
    "RunningParameters": [
      {
        "ParameterDescription": "存储节点私有协议开关(-1关闭，0开启)",
        "ParameterName": "CONN_POOL_XPROTO_STORAGE_DB_PORT",
        "ParameterValue": "-1"
      }
    ],
    "DBInstanceId": ""
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
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.