ListDisasterRecoveryPlans - - Centre de documentation Alibaba Cloud

Consulte la liste des plans de sauvegarde.

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.

rocketmq:ListDisasterRecoveryPlans

get

*All resources.

*

Aucune

Syntaxe de la requête

GET /disaster_recovery HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Non	L'identifiant de l'instance.	rmq-cn-c97xxx
filter	string	Non	La condition de filtrage. Filtre les plans de sauvegarde par nom de sauvegarde ou description de sauvegarde.	xxx
pageNumber	integer	Non	Le numéro de la page à renvoyer.	1
pageSize	integer	Non	Le nombre maximal d'entrées à renvoyer sur chaque page.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result<MyPage>
requestId	string	L'identifiant de la requête.	855EF8E6-9C1D-5DE2-9E84-924E13Exxxx
success	boolean	Indique si la requête a réussi.	True
data	object	Les données de réponse.
scrollId	string	L'identifiant de défilement pour la requête. Le système génère cette valeur automatiquement. Vous devez inclure cette valeur dans les requêtes paginées ultérieures pour poursuivre la pagination.	B13D0B07-F24B-4790-88D8-D47A38063D00
pageNumber	integer	Le numéro de page actuel.	1
pageSize	integer	La taille de la page.	10
totalCount	integer	Le nombre total d'enregistrements.	28
list	array<object>	Les données paginées.
	array<object>	Les données paginées.
planId	integer	L'identifiant du plan.	1300000016
planName	string	Le nom du plan.	xxx
planDesc	string	La description du plan.	xxx
planType	string	Le type de plan. Valeurs valides : ACTIVE_PASSIVE : sauvegarde unidirectionnelle. ACTIVE_ACTIVE : sauvegarde bidirectionnelle.	ACTIVE_PASSIVE
planStatus	string	L'état du plan. Valeurs valides : CREATED : créé. RUNNING : en cours d'exécution. DELETED : supprimé.	RUNNING
extInfo	object	Les informations étendues.
	string	Les informations étendues.	xxx
instances	array<object>	Les instances participant au plan de sauvegarde.
	array<object>	Les instances participant au plan de sauvegarde.
instanceType	string	Le type d'instance.	ALIYUN_ROCKETMQ
regionId	string	La région où réside l'instance.	cn-hangzhou
instanceId	string	L'identifiant de l'instance.	rmq-cn-ot93rbxxx
instanceRole	string	Le rôle de l'instance.	ACTIVE
authType	string	La méthode d'authentification.	NO_AUTH
username	string	Le nom d'utilisateur d'authentification.	xxx
password	string	Le mot de passe d'authentification.	xxx
endpointUrl	string	L'adresse du point de terminaison.	xxx
networkType	string	Le type de réseau.	TCP_INTERNET
vpcId	string	L'identifiant du VPC.	vpc-bp13docqysrgxtbxxxx
vSwitchId	string	L'identifiant du vSwitch.	vsw-uf6gwtbn6etadpv******
messageProperty	object	Les propriétés du message.
propertyKey	string	La clé de propriété.	aaa
propertyValue	string	La valeur de propriété.	bbb
securityGroupId	string	L'identifiant du groupe de sécurité.	sg-bp17hpmgz9******
consumerGroupId	string	L'identifiant du groupe de consommateurs, utilisé pour récupérer les messages de l'instance source.	GID_xxx
syncCheckpointEnabled	boolean	Indique si la synchronisation des offsets de consommation est activée.	true
autoSyncCheckpoint	boolean	Indique si la synchronisation automatique des offsets de consommation est activée.	true
createTime	string	L'heure de création, au format AAAA-MM-JJ HH:mm:ss.	2022-08-01 20:05:50
updateTime	string	L'heure de modification, au format AAAA-MM-JJ HH:mm:ss.	2022-08-01 20:05:50
code	string	Le code d'erreur.	200
message	string	Le message d'erreur.	xxx
httpStatusCode	integer	Le code d'état HTTP.	200
dynamicCode	string	Le code d'erreur dynamique.	InstanceId
dynamicMessage	string	Le message d'erreur dynamique.	InstanceId
accessDeniedDetail	string	Les détails du refus d'accès. Ce champ est renvoyé uniquement lorsque l'accès est refusé en raison d'autorisations RAM insuffisantes.	xxx

Exemples

JSON format

{
  "requestId": "855EF8E6-9C1D-5DE2-9E84-924E13Exxxx",
  "success": true,
  "data": {
    "scrollId": "B13D0B07-F24B-4790-88D8-D47A38063D00\n",
    "pageNumber": 1,
    "pageSize": 10,
    "totalCount": 28,
    "list": [
      {
        "planId": 1300000016,
        "planName": "xxx",
        "planDesc": "xxx",
        "planType": "ACTIVE_PASSIVE",
        "planStatus": "RUNNING",
        "extInfo": {
          "key": "xxx"
        },
        "instances": [
          {
            "instanceType": "ALIYUN_ROCKETMQ",
            "regionId": "cn-hangzhou",
            "instanceId": "rmq-cn-ot93rbxxx",
            "instanceRole": "ACTIVE",
            "authType": "NO_AUTH",
            "username": "xxx",
            "password": "xxx",
            "endpointUrl": "xxx",
            "networkType": "TCP_INTERNET",
            "vpcId": "vpc-bp13docqysrgxtbxxxx",
            "vSwitchId": "vsw-uf6gwtbn6etadpv******",
            "messageProperty": {
              "propertyKey": "aaa",
              "propertyValue": "bbb"
            },
            "securityGroupId": "sg-bp17hpmgz9******",
            "consumerGroupId": "GID_ui_xxx"
          }
        ],
        "syncCheckpointEnabled": true,
        "autoSyncCheckpoint": true,
        "createTime": "2022-08-01 20:05:50",
        "updateTime": "2022-08-01 20:05:50"
      }
    ]
  },
  "code": "200",
  "message": "xxx",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "InstanceId",
  "accessDeniedDetail": "xxx"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.