API overview
API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (BDRC/2023-08-08) follows the ROA standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Resource Classification Management
|
API |
Title |
Description |
| DeleteResourceCategory | DeleteResourceCategory | Deletes a resource category. |
| UpdateResourceCategory | UpdateResourceCategory | Updates a resource category. |
| ListResourceCategories | ListResourceCategories | Retrieves a list of resource categories. |
| GetResourceCategory | GetResourceCategory | Retrieves a single resource category. |
| CreateResourceCategory | CreateResourceCategory | Creates a resource category. |
Message Center
|
API |
Title |
Description |
| ListMessages | ListMessages | Queries messages in batches. |
| GetMessage | GetMessage | Retrieves a single message. |
Protection Strategy Center
|
API |
Title |
Description |
| ListProtectionPolicyApplications | ListProtectionPolicyApplications | Retrieves the application history of the protection policy. |
| UpdateProtectionPolicy | UpdateProtectionPolicy | Updates a protection policy. |
| ListProtectionPolicies | ListProtectionPolicies | Retrieves a list of protection policies. |
| GetProtectionPolicy | GetProtectionPolicy | Retrieves a protection policy. |
| DeleteProtectionPolicy | DeleteProtectionPolicy | Deletes a protection policy. |
| CreateProtectionPolicy | CreateProtectionPolicy | Creates a protection policy. |
Resource Center
|
API |
Title |
Description |
| UpdateResources | UpdateResources | Updates the resource list. When you call this operation, an asynchronous task is triggered to update your resource list and data protection score. |
| EnableCheckResource | EnableCheckResource | Enables data protection scoring for a single resource. |
| EnableCheckProduct | EnableCheckProduct | Enables data protection scoring for a cloud product. |
| DisableCheckResource | DisableCheckResource | Disables the data protection score for a resource. |
| DisableCheckProduct | DisableCheckProduct | Disables the data protection score for a cloud product. |
| CheckRules | CheckRules | Checks data protection scoring rules. Calling this operation triggers an asynchronous task to check whether your resources meet the data protection scoring requirements. |
| DescribeRules | DescribeRules | Lists all data protection rules. |
| DescribeCheckDetails | DescribeCheckDetails | Retrieves the check results for data protection rules. |
| DescribeResources | DescribeResources | Retrieves a list of resources. |
| DescribeProducts | DescribeProducts | Returns the status of the data protection score for a cloud product. |
| DescribeTopRiskyResources | DescribeTopRiskyResources | Lists the most threatened resources. |
| DescribeProductDataRedundancyTypeStat | DescribeProductDataRedundancyTypeStat | Queries statistics on data redundancy types for a cloud service. |
Others
|
API |
Title |
Description |
| CloseBdrcService | CloseBdrcService | Shuts down the Backup and Disaster Recovery Center. |
| DescribeTask | DescribeTask | Retrieves the details of an asynchronous task. |
| DescribeTasks | DescribeTasks | Retrieves asynchronous tasks. |
| GetBdrcService | GetBdrcService | Queries the status of the Backup and Disaster Recovery Center. |
| OpenBdrcService | OpenBdrcService | Enables the Backup and Disaster Recovery Center. |