立即与支持人员聊天
与支持团队交流

Rapid Recovery 6.3 - User Guide

Introduction to Rapid Recovery The Core Console Repositories Core settings Managing privacy Encryption Protecting machines
About protecting machines with Rapid Recovery Understanding the Rapid Recovery Agent software installer Deploying Agent to multiple machines simultaneously from the Core Console Using the Deploy Agent Software Wizard to deploy to one or more machines Modifying deploy settings Understanding protection schedules Protecting a machine About protecting multiple machines Enabling application support Settings and functions for protected Exchange servers Settings and functions for protected SQL servers
Managing protected machines Credentials Vault Snapshots and recovery points Replication Events Reporting VM export Restoring data Bare metal restore
About bare metal restore BMR Windows and Linux Understanding boot CD creation for Windows machines Managing a Linux boot image Performing a bare metal restore using the Restore Machine Wizard Using the Universal Recovery Console for a BMR Performing a bare metal restore for Linux machines Verifying a bare metal restore
Managing aging data Archiving Cloud accounts Core Console references REST APIs Glossary

REST APIs

The purpose of this section is to provide an introduction and overview of the Rapid Recovery Representational State Transfer (REST) Application Program Interfaces (APIs), their use, and their function.

The Rapid Recovery Web Service APIs are RESTful and let you automate and customize certain functions and tasks within the Rapid Recovery software solution to assist you with meeting your business objectives.

These APIs are accessible from the Downloads page of the Rapid Recovery License Portal.

Topics include:

Intended audience

Rapid Recovery APIs are intended for use by application developers who want to integrate and extend Rapid Recovery in their application, as well as administrators who want to script interactions with the Rapid Recovery Core server.

Working with Rapid Recovery REST APIs

The Rapid Recovery APIs are REST-style APIs, which means that they use HTTP requests to provide access to resources (data entities) through URI paths. Rapid Recovery APIs use standard HTTP methods such as GET, PUT, POST, and DELETE. Because REST APIs are based on open standards, you can use any language or tool that supports HTTP calls.

There are two ways that application developers and administrators can work with Rapid Recovery APIs. They are:

  • Using C# or other .NET languages to directly use Rapid Recovery .NET client DLL files.
  • Communicate directly with the HTTP endpoint to generate your own XML.

The first approach is recommended. The client DLLs are included in the Rapid Recovery SDK. The method for calling Rapid Recovery APIs is consistent with the way you would consume any .NET 4.5X Windows Communication Foundation (WCF) service.

Downloading and viewing Core and Agent APIs

The Rapid Recovery Software Developer Kit (SDK) includes REST APIs for the Rapid Recovery Core and Rapid Recovery Agentcomponents, and samples and supporting files. These contents are contained in the following folders and then compressed as an archive that includes the following components:

Table 169: Components included in the SDK archive
Folder name   Contents Description

Core.Contracts

 

Rapid Recovery Core APIs

Contains APIs to assist developers or administrators to script functions in Rapid Recovery Core. There are 2 sets of service contracts.

  1. Open the CoreWeb.Client HTML file in a web browser to view information for general REST standards. The service contracts are listed. When you click any corresponding hyperlinked uniform resource identifier (URI), the browser opens information in the Core.Contracts/docWeb/ directory. The resulting page shows information for general REST service operations, including methods and descriptions.
  2. Open the Core.Client HTML file in a web browser to view detailed C# information. When you click any hyperlinked service contract (class), the browser opens information in the Core.Contracts/doc/ directory. The resulting page shows detailed information for all C# methods in the selected class.

Agent.Contracts

 

Rapid Recovery Agent APIs (deprecated)

Contains APIs that developers or administrators can use to manipulate Rapid Recovery Agent on protected machines.

Caution: Agent APIs are deprecated and will be removed from a future version of the SDK. Direct manipulation of the Agent APIs is not recommended. Use of these APIs is considered customization and will not be supported. The information is provided in documentation for historical purposes.

  1. Open the AgentWeb.Client HTML file in a web browser to view information for general REST standards.
  2. Open the Agent.Client HTML file in a web browser to view detailed C# information.

AppRecoveryAPISamples

 

Code samples and dynamic link libraries

AppRecoveryAPISamples contains code samples that are written in C# programming language. These files represent a good starting point to view code snippets if using the APIs to customize your GUI, management systems, and so on.

AppRecoveryAPISamples\Dependencies contains dynamic link library (DLL) files that Rapid Recovery uses. The DLLs contain data contracts (types the Core is familiar with) and service contracts (management methods and operations that can be used to force Core do something). If you want to customize your own graphic user interface, or use a management system to work with Rapid Recovery, these DLLs are required.

NOTE: The DLL version used must match the version of the Core.

You can download the SDK as archive (API-Reference-x.x.x-xxxx). Each x represents a digit in the build number for the relevant release.

Complete the steps in this procedure to obtain the SDK, download it to your specified destination, and decompress the files in preparation for using Core and Agent APIs.
  1. Log in to the Rapid Recovery License Portal at https://licenseportal.com.
  2. In the left navigation menu of the license portal, click Downloads.
    The Downloads page of the license portal appears.
  3. On the Downloads page, in the Windows-Based Applications section, scroll down to the description for the SDK and click Download.
  4. Save the downloaded archive to your preferred location.
  5. Decompress the archive.
    In the new API-Reference-x.x.x-xxxx folder, you see the separate sets of files described in the preceding table.
  6. Open the key HTML files described in the preceding table in a web browser to see guidance about the APIs.
相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级