GetDisasterRecoveryPlan - - Centre de documentation Alibaba Cloud

Consulte les détails d'un plan de sauvegarde.

Description de l'opération

Avant d'effectuer la requête, assurez-vous d'avoir créé un plan de sauvegarde Global Replicator. Avant d'utiliser Global Replicator, votre compte doit disposer du rôle lié au service AliyunServiceRoleForRMQDisasterRecovery. Ce rôle est utilisé pour accorder l'autorisation à ApsaraMQ for RocketMQ d'accéder au bus d'événements EventBridge. Le système crée généralement ce rôle automatiquement lors de la première utilisation de la fonctionnalité associée. Si la création automatique a échoué, créez le rôle manuellement.

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:GetDisasterRecoveryPlan

get

*Instance.

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

Aucune

Syntaxe de la requête

GET /disaster_recovery/{planId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
planId	integer	Oui	L'identifiant du plan de sauvegarde.	1234

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Result
requestId	string	L'identifiant de la requête.	7358418D-83BD-507A-8079-611C63E0xxx
success	boolean	Indique si la requête a réussi.	true
data	object	Les données de réponse.
planId	integer	L'identifiant du plan.	1300000016
planName	string	Le nom du plan.	xxx
planDesc	string	La description du plan.	xxxx
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.	xxxx
instances	array<object>	Les instances participant au plan de reprise sur sinistre.
	array<object>	Les instances participant au plan de reprise sur sinistre.
instanceType	string	Le type d'instance.	ALIYUN_ROCKETMQ
regionId	string	La région où réside l'instance.	cn-shanghai
instanceId	string	L'identifiant de l'instance.	rmq-cn-gpz3qtcdxxx
instanceRole	string	Le rôle de l'instance.	ACTIVE
authType	string	La méthode d'authentification.	ACL_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-wz9qt50xhtj9krb******
vSwitchId	string	L'identifiant du vSwitch.	vsw-uf6gwtbn6etadpv******
messageProperty	object	La propriété de filtrage des messages.
propertyKey	string	La clé de la propriété.	xxx
propertyValue	string	La valeur de la propriété.	xxx
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_DS_XXX_YYY
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
autoSyncCheckpoint	boolean	Indique si la synchronisation automatique des points de contrôle est activée. Remarque Ce champ n'est valide que lorsque la synchronisation automatique des points de contrôle est activée, c'est-à-dire lorsque le champ syncCheckpointEnabled est défini sur true. Valeurs valides : true : Activé. false : Désactivé.	true
syncCheckpointEnabled	boolean	Indique si la synchronisation des offsets de consommation est activée. Valeurs valides : true : Activé. false : Désactivé.	true
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 n'est renvoyé que lorsque la requête est refusée parce que l'utilisateur RAM ne dispose pas des autorisations requises.	xxx

Exemples

JSON format

{
  "requestId": "7358418D-83BD-507A-8079-611C63E0xxx",
  "success": true,
  "data": {
    "planId": 1300000016,
    "planName": "xxx",
    "planDesc": "xxxx",
    "planType": "ACTIVE_PASSIVE",
    "planStatus": "RUNNING",
    "extInfo": {
      "key": "xxxx"
    },
    "instances": [
      {
        "instanceType": "ALIYUN_ROCKETMQ",
        "regionId": "cn-shanghai",
        "instanceId": "rmq-cn-gpz3qtcdxxx",
        "instanceRole": "ACTIVE",
        "authType": "ACL_AUTH",
        "username": "xxx",
        "password": "xxx",
        "endpointUrl": "xxx",
        "networkType": "TCP_INTERNET",
        "vpcId": "vpc-wz9qt50xhtj9krb******",
        "vSwitchId": "vsw-uf6gwtbn6etadpv******",
        "messageProperty": {
          "propertyKey": "xxx",
          "propertyValue": "xxx"
        },
        "securityGroupId": "sg-bp17hpmgz9******",
        "consumerGroupId": "GID_DS_XXX_YYY"
      }
    ],
    "createTime": "2022-08-01 20:05:50",
    "updateTime": "2022-08-01 20:05:50",
    "autoSyncCheckpoint": true,
    "syncCheckpointEnabled": true
  },
  "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.