Interroger les informations d’un modèle de paramètres - - Centre de documentation Alibaba Cloud

Un modèle de paramètres permet de configurer plusieurs paramètres simultanément, puis d’appliquer ce modèle aux instances. Pour plus d’informations, consultez les rubriques Utiliser un modèle de paramètres pour configurer les paramètres des instances ApsaraDB RDS for MySQL ou Utiliser un modèle de paramètres pour configurer les paramètres des instances ApsaraDB RDS for PostgreSQL.

Remarque

Les modèles de paramètres s’appliquent uniquement aux instances ApsaraDB RDS for MySQL et ApsaraDB RDS for PostgreSQL.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d’appeler cette opération via OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeParameterGroup	Opération à effectuer. Définissez la valeur sur DescribeParameterGroup.
ParameterGroupId	String	Oui	rpg-dp****	ID du modèle de paramètres. Appelez l’opération DescribeParameterGroups pour interroger les ID des modèles de paramètres.
RegionId	String	Oui	cn-hangzhou	ID de région du modèle de paramètres. Appelez l’opération DescribeRegions pour obtenir la liste des régions les plus récentes.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	498AE8CA-8C81-4A01-AF37-2B902014ED30	ID de la requête.
ParamGroup	Array of ParameterGroup		Informations relatives au modèle de paramètres.
ParameterGroup
UpdateTime	String	2019-10-22T06:07:54Z	Date de la dernière mise à jour du modèle de paramètres. L’heure est exprimée au format ISO 8601 : yyyy-MM-ddTHH:mm:ssZ. Elle est affichée en temps universel coordonné (UTC).
ParameterGroupDesc	String	testGroup1	Description du modèle de paramètres.
CreateTime	String	2019-10-22T06:02:53Z	Date de création du modèle de paramètres.
ForceRestart	Integer	1	Indique si le redémarrage d’une instance est nécessaire pour que le modèle de paramètres prenne effet. Valeurs possibles : 0 : aucun redémarrage n’est requis. 1 : un redémarrage est requis.
ParameterGroupId	String	rpg-dp****	ID du modèle de paramètres.
ParameterGroupName	String	test123456	Nom du modèle de paramètres.
Engine	String	mysql	Moteur de base de données.
ParamCounts	Integer	2	Nombre de paramètres dans le modèle de paramètres.
EngineVersion	String	5,6	Version du moteur de base de données.
ParameterGroupType	Integer	1	Type de modèle de paramètres. Valeurs possibles : 0 : modèle de paramètres par défaut. 1 : modèle de paramètres personnalisé. 2 : modèle de paramètres de sauvegarde automatique. Après l’application de ce type de modèle, le système sauvegarde automatiquement les paramètres d’origine et enregistre la sauvegarde sous forme de modèle.
ParamDetail	Array of ParameterDetail		Tableau de paramètres.
ParameterDetail
ParamName	String	back_log	Nom du paramètre.
ParamValue	String	2000	Valeur du paramètre.
RelatedCustinsInfo	Array of RelatedCustinsInfo		Instance à laquelle le modèle de paramètres a été appliqué. Remarque Le paramètre RelatedCustinsInfo est disponible uniquement pour les instances ApsaraDB RDS for PostgreSQL.
RelatedCustinsInfo
DBInstanceName	String	rm-bp170****	ID de l’instance.
AppliedTime	String	2022-10-17T03:19:02Z	Date d’application du modèle de paramètres.

Exemples

Exemple de requête

http(s)://rds.aliyuncs.com/?Action=DescribeParameterGroup
&ParameterGroupId=rpg-dp****
&RegionId=cn-hangzhou
&Common request parameters

Exemple de réponse réussie

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeParameterGroupResponse>
    <RequestId>498AE8CA-8C81-4A01-AF37-2B902014ED30</RequestId>
    <ParamGroup>
        <UpdateTime>2019-10-22T06:07:54Z</UpdateTime>
        <ParameterGroupDesc>testGroup1</ParameterGroupDesc>
        <CreateTime>2019-10-22T06:02:53Z</CreateTime>
        <ForceRestart>1</ForceRestart>
        <ParameterGroupId>rpg-dp****</ParameterGroupId>
        <ParameterGroupName>test123456</ParameterGroupName>
        <Engine>mysql</Engine>
        <ParamCounts>2</ParamCounts>
        <EngineVersion>5.6</EngineVersion>
        <ParameterGroupType>1</ParameterGroupType>
        <ParamDetail>
            <ParamName>back_log</ParamName>
            <ParamValue>2000</ParamValue>
        </ParamDetail>
    </ParamGroup>
    <RelatedCustinsInfo>
        <DBInstanceName>rm-bp170****</DBInstanceName>
        <AppliedTime>2022-10-17T03:19:02Z</AppliedTime>
    </RelatedCustinsInfo>
</DescribeParameterGroupResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "498AE8CA-8C81-4A01-AF37-2B902014ED30",
  "ParamGroup" : [ {
    "UpdateTime" : "2019-10-22T06:07:54Z",
    "ParameterGroupDesc" : "testGroup1",
    "CreateTime" : "2019-10-22T06:02:53Z",
    "ForceRestart" : 1,
    "ParameterGroupId" : "rpg-dp****",
    "ParameterGroupName" : "test123456",
    "Engine" : "mysql",
    "ParamCounts" : 2,
    "EngineVersion" : "5.6",
    "ParameterGroupType" : 1,
    "ParamDetail" : [ {
      "ParamName" : "back_log",
      "ParamValue" : "2000"
    } ]
  } ],
  "RelatedCustinsInfo" : [ {
    "DBInstanceName" : "rm-bp170****",
    "AppliedTime" : "2022-10-17T03:19:02Z"
  } ]
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs de l'API.