DescribeParameters - - Centre de documentation Alibaba Cloud

Consulte les paramètres de configuration d'une instance ApsaraDB for MongoDB.

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.

dds:DescribeParameters

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Remarque Si vous définissez ce paramètre sur l'identifiant d'une instance de cluster fragmenté, vous devez également spécifier le paramètre NodeId.	dds-bpxxxxxxxx
NodeId	string	Non	L'identifiant du nœud mongos ou fragment dans l'instance de cluster fragmenté spécifiée. Remarque Ce paramètre est valide lorsque le paramètre DBInstanceId est défini sur l'identifiant d'une instance de cluster fragmenté.	d-bpxxxxxxxx
CharacterType	string	Non	Le rôle de l'instance. Valeurs valides : db : un nœud fragment. cs : un nœud Configserver. mongos : un nœud mongos.	mongos
ExtraParam	string	Non	Le paramètre qui sera disponible ultérieurement.	terrform

Éléments de réponse

Élément	Type	Description	Exemple
	object
RunningParameters	object
Parameter	array<object>	Les paramètres de configuration qui ont pris effet.
	object
CheckingCode	string	The valid values of the parameter.	[33554432-268435456]
ParameterName	string	The name of the parameter.	setParameter.internalQueryExecMaxBlockingSortBytes
ParameterValue	string	The value of the parameter.	33554432
ForceRestart	string	Indicates whether a restart is required for parameter modifications to take effect. Valid values: false: A restart is not required. Modifications take effect immediately. true: A restart is required for parameter modifications to take effect.	false
ParameterDescription	string	The description of the parameter.	The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)
ModifiableStatus	string	Indicates whether the parameter value can be modified. Valid values: false: The parameter value cannot be modified. true: The parameter value can be modified.	true
CharacterType	string	The role type of the instance. Valid values: db: shard role. cs: config server role. mongos: mongos role.	db
EngineVersion	string	La version du moteur de base de données de l'instance.	4.0
RequestId	string	L'identifiant de la requête.	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParameters	object
Parameter	array<object>	Les paramètres de configuration du modèle de configuration.
	object
CheckingCode	string	The valid values of the parameter.	[0-65536]
ParameterName	string	The name of the parameter.	operationProfiling.slowOpThresholdMs
ParameterValue	string	The value of the parameter.	200
ForceRestart	boolean	Indicates whether a restart is required for parameter modifications to take effect. Valid values: false: A restart is not required. Modifications take effect immediately. true: A restart is required for parameter modifications to take effect.	true
ParameterDescription	string	The description of the parameter.	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
ModifiableStatus	boolean	Indicates whether the parameter value can be modified. Valid values: false: The parameter value cannot be modified. true: The parameter value can be modified.	true
Engine	string	Le moteur de base de données de l'instance. Valeur par défaut : mongodb.	mongodb

Exemples

JSON format

{
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[33554432-268435456]",
        "ParameterName": "setParameter.internalQueryExecMaxBlockingSortBytes",
        "ParameterValue": "33554432",
        "ForceRestart": "false",
        "ParameterDescription": "The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
        "ModifiableStatus": "true",
        "CharacterType": "db"
      }
    ]
  },
  "EngineVersion": "4.0",
  "RequestId": "3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0-65536]",
        "ParameterName": "operationProfiling.slowOpThresholdMs",
        "ParameterValue": "200",
        "ForceRestart": true,
        "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
        "ModifiableStatus": true
      }
    ]
  },
  "Engine": "mongodb"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidDBInstanceClass.NotFound	The specified DB instance type is not found.	Invalid instance type. Specify another instance type.

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

Notes de version

Consultez Notes de version pour la liste complète.