หน้านี้ยังไม่พร้อมใช้งานในภาษาท้องถิ่นของคุณ เรากำลังพยายามอย่างหนักเพื่อเพิ่มเวอร์ชันภาษาอื่น ๆ เพิ่มเติม ขอบคุณสำหรับการสนับสนุนเสมอมา
- What's New
- Function Overview
- Product Bulletin
- Service Overview
-
Billing
- Billing Overview
- Billing Modes
- Billed Items
- Billing Examples
- Billing Mode Changes
- Renewing Subscriptions
- Bills
- Arrears
- Billing Termination
- Cost Management
-
Billing FAQ
- How Is CBR Billed?
- What Is the Billing Cycle of Pay-per-Use Vaults?
- How Do I Disable CBR?
- How Do I Unsubscribe from CSBS or VBS Resource Packages?
- Why Is a Message Displayed Indicating Insufficient User Rights When I Create a Policy?
- What Can I do If a Yearly/Monthly-Billed Vault Is About to Expire?
- How Do I Unsubscribe from a Vault?
- What Should I Do If the Fee Is Too High When I Expand the Capacity of a Vault?
- Can I Change a Server Backup Vault to a Disk Backup Vault or the Other Way Around?
- Why Are CBR Backups Displayed on the VBS Console?
- What Charges Will I Incur When Using a Backup to Create an Image?
- How Do I Purchase a CBR Replication Traffic Package?
- Can I Change the Protection Type of an Existing Vault?
- What Resources Do I Need to Implement Cross-Region Backup Replication?
- Why AM I Still Being Billed After a Resource is Deleted?
- Getting Started
-
User Guide
- Management permissions
-
Vault Management
- Overview
- Querying a Vault
- Deleting a Vault
- Associating Resources to a Vault
- Dissociating Resources from a Vault
- Migrating Resources from a Vault
- Expanding Vault Capacity
- Reducing Vault Capacity
- Changing from Pay-per-Use to Yearly/Monthly
- Changing Vault Specifications
- Replicating a Vault Across Regions
- Managing Vault Tags
- Managing the Enterprise Projects of Vaults
- Enabling Backup Locking
- Backup Management
- Policy Management
- Organizational Policy Management
- Application-Consistent Backup
- File Backup
-
Restoring Data
- Restoring from a Cloud Server Backup
- Creating an Image from a Cloud Server Backup
- Restoring from a Cloud Disk Backup
- Creating a Disk from a Cloud Disk Backup
- Creating a File System from an SFS Turbo Backup
- Restoring from a Desktop Backup
- Restoring from a File Backup
- Restoring from a Hybrid Cloud Backup
- (Optional) Migrating Resources from CSBS/VBS
- Managing Tasks
- Cloud Eye Monitoring
- Recording CBR Operations Using CTS
- Quotas
- Appendix
-
Hybrid Cloud Backup Feature Guide
- Hybrid Cloud Backup
- Application Scenarios
- Constraints and Limitations
-
VMware Backup
- VMware Backup Process
- Downloading and Installing eBackup
- Configuring eBackup
- Adding a VMware Protected Environment
- Preparing for VMware Backup Storage
- Performing VMware Backup
- Restoring Data Using VMware Backups
- Managing a Protected VMware Environment
- Managing VMware Backup Storage
- Managing VMware Backups
- Common Operations
-
Best Practices
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Verifying the Application-Consistent Backup Result
- Protecting SQL Server
- Troubleshooting a Custom Script Error
- Performing Periodic Recovery Drills Using the Backup Data
- Creating Backup Policies Based on Service Tiering
-
Using a Custom Script to Implement Application-Consistent Backup
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
CBR APIs
- Operations
- File Backup
- Tasks
-
Vaults
- Creating a Vault
- Querying a Specified Vault
- Querying the Vault List
- Modifying a Vault
- Deleting a Vault
- Dissociating Resources
- Associating Resources
- Applying a Policy to a Vault
- Removing a Policy from a Vault
- Querying the Vault List in Other Regions
- Migrating Resources
- Batch Modifying Vaults
- Setting Auto Backup for a Vault
- Creating a Yearly/Monthly Vault
- Querying Vault Usage of a Project
- Projects
- Policies
- Backups
- Protection
- Backup Sharing
- Organizational Policies
- Tags
- Restore Points
- Metering
- Application Cases
- Permissions Policies and Supported Actions
- Appendix
- SDK Reference
-
Troubleshooting
- Failed to Execute a Backup Task
- Failed to Delete a Backup
- Failed to Expand the Vault Capacity
- Failed to Attach Disks
- Data Disks Are Not Displayed After a Windows Server Is Restored
- Failed to Cancel Backup Sharing
- Failed to Download or Install the Agent Required by Application-Consistent
- Failed to Install the Agent on Windows
- Failed to Implement Application-Consistent Backup
- A Server Created Using an Image Enters Maintenance Mode After Login
- Failed to Migrate VMware Backups to the Cloud
- Failed to Restore a VMware Backup to a Cloud Server
- An Error Message Is Displayed Indicating that the Path of a Storage Unit Is Invalid
- Failed to Import an eBackup Image Template, with an Error Displayed Indicating That the File Is Invalid
- The Download Dialog Box Disappears When I Download eBackup on a VMware VM
- File Backup Failed Due to Inconsistent Time Between Backup Client and UTC Time
-
FAQs
- Concepts
-
Billing
- How Is CBR Billed?
- What Is the Billing Cycle of Pay-per-Use Vaults?
- How Do I Disable CBR?
- How Do I Unsubscribe from CSBS or VBS Resource Packages?
- Why Is a Message Displayed Indicating Insufficient User Rights When I Create a Policy?
- What Can I do If a Yearly/Monthly-Billed Vault Is About to Expire?
- How Do I Unsubscribe from a Vault?
- What Should I Do If the Fee Is Too High When I Expand the Capacity of a Vault?
- Can I Change a Server Backup Vault to a Disk Backup Vault or the Other Way Around?
- Why Are CBR Backups Displayed on the VBS Console?
- What Charges Will I Incur When Using a Backup to Create an Image?
- How Do I Purchase a CBR Replication Traffic Package?
- What Resources Do I Need to Implement Cross-Region Backup Replication?
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- How Do I Migrate Server Data Across Regions Using Server Backups?
- Can I Back Up Two Disks to One Target Disk?
- How Do I Replicate a Disk to the Same AZ in a Region as the Source Disk?
- Can I Migrate Backups Between Vaults?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Use an Incremental Backup to Restore Data After a Full Backup Is Deleted?
- Can I Stop an Ongoing Backup Task?
- How Do I Reduce the Vault Space Occupied by Backups?
- How Do I View the Size of Each Backup?
- How Do I View My Backup Data?
- How Long Will My Backups Be Kept?
- How Do I Implement Periodic Full Backups for My Resources?
- How Do I Query Resources that Have not Been Backed Up?
- Is There Any Requirement on the Network Bandwidth During Data Backup?
-
Capacity
- How Large of a Vault Do I Need?
- Why Is My Backup Size Larger Than My Disk Size?
- What Can I Do If the Vault Capacity Is Not Enough?
- Why Does the Used Capacity of a Vault Change Only Slightly After I Deleted Unwanted Backups?
- Will Backup Continue If the Usage of a Vault Reaches the Upper Limit?
- How Do I Adjust the Vault Capacity Alarm Threshold?
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- How Do I Restore Data to a New Server?
- How Do I Restore a Data Disk Backup to a System Disk?
- Can I Use CBR to Restore Data to Any Point When the Data Was Backed Up?
- Can I Stop an Ongoing Restoration Task?
-
Policies
- How Do I Configure Automatic Backup for a Server or Disk?
- Why the New Retention Rule I Changed Is Not Applied?
- How Do I Back Up Multiple Resources at a Time?
- How Do I Retain My Backups Permanently?
- How Can I Cancel Auto Backup or Auto Replication?
- How Can I Have the System Automatically Delete Backups That I No Longer Need?
- Why Aren't My Backups Deleted Based on the Retention Rule?
- Optimization
-
Others
- Is There a Quota for CBR Vaults?
- Can I Merge My Vaults?
- How Do I Delete a Backup That Has Been Used to Create an Image While Retaining the Image?
- Can I Export Disk Backup Data to Another Server?
- Why Do I Need a Vault to Accept the Image Shared to Me?
- Can I Download Backup Data to a Local PC?
- How Do I Copy Disk Data to Another Account?
- Videos
-
More Documents
-
User Guide (ME-Abu Dhabi Region)
- Service Overview
- Getting Started
- Vault Management
- Backup Management
- Policy Management
- Restoring Data
- Managing Tasks
- Monitoring
- Quotas
-
FAQs
- Concepts
- Billing
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- Can I Back Up Two Disks to One Target Disk?
- How Do I Replicate a Disk to the Same AZ in a Region as the Source Disk?
- Will the Server Performance Be Affected If I Delete Its Backups?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Use an Incremental Backup to Restore Data After a Full Backup Is Deleted?
- Can I Stop an Ongoing Backup Task?
- How Do I Reduce the Vault Space Occupied by Backups?
- How Do I View the Size of Each Backup?
- How Do I View My Backup Data?
- How Long Will My Backups Be Kept?
- Capacity
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- How Do I Restore Data to a New Server?
- Can I Stop an Ongoing Restoration Task?
-
Policies
- How Do I Configure Automatic Backup for a Server or Disk?
- Why the New Retention Rule I Changed Is Not Applied?
- How Do I Back Up Multiple Resources at a Time?
- How Do I Retain My Backups Permanently?
- How Can I Cancel Auto Backup?
- How Can I Have the System Automatically Delete Backups That I No Longer Need?
- Why Aren't My Backups Deleted Based on the Retention Rule?
- Optimization
-
Others
- Is There a Quota for CBR Vaults?
- Can I Merge My Vaults?
- How Do I Delete a Backup That Has Been Used to Create an Image While Retaining the Image?
- Can I Export Disk Backup Data to Another Server?
- Why Do I Need a Vault to Accept the Image Shared to Me?
- Can I Download Backup Data to a Local PC?
- How Do I Copy Disk Data to Another Account?
- Troubleshooting Cases
- Appendix
- API Reference (ME-Abu Dhabi Region)
-
Best Practices (ME-Abu Dhabi Region)
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Change History
-
Using a Custom Script to Implement Application-Consistent Backup
-
User Guide (Paris)
- Service Overview
- Getting Started
- Vault Management
- Backup Management
- Policy Management
- Restoring Data
- Application-Consistent Backup
- (Optional) Migrating Resources from CSBS/VBS
- Managing Tasks
- Monitoring
- Auditing
- Quotas
-
FAQs
- Concepts
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- Can I Back Up Two Disks to One Target Disk?
- How Do I Replicate a Disk to the Same AZ in a Region as the Source Disk?
- Will the Server Performance Be Affected If I Delete Its Backups?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Use an Incremental Backup to Restore Data After a Full Backup Is Deleted?
- Can I Stop an Ongoing Backup Task?
- How Do I Reduce the Vault Space Occupied by Backups?
- How Do I View the Size of Each Backup?
- How Do I View My Backup Data?
- How Long Will My Backups Be Kept?
- Capacity
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- How Do I Restore Data to a New Server?
- How Do I Restore a Data Disk Backup to a System Disk?
- Can I Stop an Ongoing Restoration Task?
-
Policies
- How Do I Configure Automatic Backup for a Server or Disk?
- Why the New Retention Rule I Changed Is Not Applied?
- How Do I Back Up Multiple Resources at a Time?
- How Do I Retain My Backups Permanently?
- How Can I Cancel Auto Backup or Auto Replication?
- How Can I Have the System Automatically Delete Backups That I No Longer Need?
- Why Aren't My Backups Deleted Based on the Retention Rule?
- Optimization
-
Others
- Is There a Quota for CBR Vaults?
- Can I Merge My Vaults?
- How Do I Delete a Backup That Has Been Used to Create an Image While Retaining the Image?
- Can I Export Disk Backup Data to Another Server?
- Why Do I Need a Vault to Accept the Image Shared to Me?
- Can I Download Backup Data to a Local PC?
- How Do I Copy Disk Data to Another Account?
- Troubleshooting Cases
- Appendix
- API Reference (Paris)
-
Best Practices (Paris)
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Performing Periodic Recovery Drills Using the Backup Data
- Creating Backup Policies Based on Service Tiering
- Change History
-
Using a Custom Script to Implement Application-Consistent Backup
-
User Guide (Kuala Lumpur Region)
- Service Overview
- Getting Started
- Permissions Management
- Vault Management
- Backup Management
- Policy Management
- Restoring Data
- Application-Consistent Backup
- Managing Tasks
- Monitoring
- Quotas
-
FAQs
- Concepts
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- Will the Server Performance Be Affected If I Delete Its Backups?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Stop an Ongoing Backup Task?
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- Can I Stop an Ongoing Restoration Task?
- Policies
- Others
- Troubleshooting Cases
- Appendix
- API Reference (Kuala Lumpur Region)
-
Best Practices (Kuala Lumpur Region)
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Change History
-
Using a Custom Script to Implement Application-Consistent Backup
-
User Guide (Ankara Region)
- Service Overview
- Getting Started
- Permissions Management
- Vault Management
- Backup Management
- Policy Management
- Restoring Data
- Application-Consistent Backup
- Managing Tasks
- Monitoring
- Quotas
-
FAQs
- Concepts
-
Backup
- Do I Need to Stop the Server Before Performing a Backup?
- Can I Back Up a Server Deployed with Databases?
- How Can I Distinguish Automatic Backups From Manual Backups?
- Can I Choose to Back Up Only Some Partitions of a Disk?
- Does CBR Support Cross-Region Backup?
- Will the Server Performance Be Affected If I Delete Its Backups?
- Can I Use Its Backup for Restoration After a Resource Is Deleted?
- How Many Backups Can I Create for a Resource?
- Can I Stop an Ongoing Backup Task?
- Capacity
-
Restoration
- Do I Need to Stop the Server Before Restoring Data Using Backups?
- Can I Use a System Disk Backup to Recover an ECS?
- Do I Need to Stop the Server Before Restoring Data Using Disk Backups?
- Can a Server Be Restored Using Its Backups After It Is Changed?
- Can a Disk Be Restored Using Its Backups After Its Capacity Is Expanded?
- What Can I Do if the Password Becomes a Random One After I Use a Backup to Restore a Server or Use an Image to Create a Server?
- What Changes Will Be Made to the Original Backup When I Use the Backup to Restore a Server?
- Can I Stop an Ongoing Restoration Task?
- Policies
- Others
- Troubleshooting Cases
- Appendix
- API Reference (Ankara Region)
-
Best Practices (Ankara Region)
-
Using a Custom Script to Implement Application-Consistent Backup
- Using a Custom Script to Implement Consistent Backup for MySQL
- Using a Custom Script to Implement Consistent Backup for SAP HANA
- Using a Custom Script to Implement Consistent Backup for Other Linux Applications
- Troubleshooting a Custom Script Error
- Verifying the Application-Consistent Backup Result (Linux)
- Verifying the Application-Consistent Backup Result (Windows)
- Protecting SQL Server in Failover Cluster Mode
- Protecting SQL Server in Always on Availability Groups Mode
- Change History
-
Using a Custom Script to Implement Application-Consistent Backup
-
User Guide (ME-Abu Dhabi Region)
- Glossary
- General Reference
Copied.
Querying the Organizational Policy List
Function
This API is used to query the organizational policy list.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v3/{project_id}/organization-policies
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
operation_type |
Yes |
String |
Organizational policy type. |
limit |
No |
Integer |
Number of records displayed on each page. The value must be a positive integer. |
offset |
No |
Integer |
Query offset, which is a positive integer. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
policies |
Array of OrganizationPolicy objects |
Organization Policy List |
count |
Integer |
Number of organization policies |
limit |
Integer |
Number of records displayed on each page |
offset |
Integer |
Offset where the query starts |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Organization Policy ID |
name |
String |
Organization Policy Name |
description |
String |
Organization Policy Description |
operation_type |
String |
Organizational policy type.
|
domain_id |
String |
Specifies the ID of the account to which the organization policy belongs. |
policy_name |
String |
Policy Name |
policy_enabled |
Boolean |
Whether the policy is enabled |
policy_operation_definition |
PolicyoODCreate object |
Policy definition. The specific fields in backup and replication are different and consistent with those in the policy. |
policy_trigger |
PolicyTriggerReq object |
Time rule for the policy execution |
status |
String |
Organization Policy Status |
domain_name |
String |
Account to which the organizational policy belongs. |
Parameter |
Type |
Description |
---|---|---|
day_backups |
Integer |
Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied. |
destination_project_id |
String |
ID of the replication destination project, which is mandatory for cross-region replication |
destination_region |
String |
Replication destination region, which is mandatory for cross-region replication The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-). |
enable_acceleration |
Boolean |
Whether to enable the acceleration function to shorten the replication time for cross-region replication. If this parameter is not set, the acceleration function is disabled. |
max_backups |
Integer |
Maximum number of backups that can be automatically created for a backup object. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, backups will not be cleared by quantity limit. If this parameter and retention_duration_days are left blank at the same time, the backups will be retained permanently. This parameter and retention_duration_days cannot be both applied. |
month_backups |
Integer |
Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied. |
retention_duration_days |
Integer |
Duration of retaining a backup, in days. The maximum value is 99999. If the value is set to -1, backups will not be cleared by retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently. This parameter cannot be applied together with max_backups, day_backups, week_backups, month_backups, and year_backups. |
timezone |
String |
Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: day_backups, week_backups, month_backups, year_backups |
week_backups |
Integer |
Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied. |
year_backups |
Integer |
Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and max_backups will both be applied. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both applied. |
full_backup_interval |
Integer |
Defines how often (after how many incremental backups) a full backup is performed. If -1 is specified, full backup will not be performed. Minimum value: -1 Maximum value: 100 |
Parameter |
Type |
Description |
---|---|---|
properties |
PolicyTriggerPropertiesReq object |
Scheduler attributes |
Parameter |
Type |
Description |
---|---|---|
pattern |
Array of strings |
Scheduling rule. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL. FREQ can be set only to WEEKLY or DAILY. BYDAY* can be set to MO, TU, WE, TH, FR, SA, or SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC time) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. For example, if the time of an area is UTC+8. The scheduling is performed at 14:00 every day in this area. The value of FREQ is the same as that of 14:00 minus 8. The rule is as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00. |
Example Requests
Querying the organizational policy list
GET https://{endpoint}/v3/{project_id}/organization-policies?operation_type=backup GET https://{endpoint}/v3/{project_id}/organization-policies?operation_type=backup
Example Responses
Status code: 200
OK
{ "policies" : [ { "id" : "5f5dd325-d7d1-4693-9d97-db37ecb91696", "name" : "organization-policies_create_test", "operation_type" : "backup", "domain_id" : "0ae13f008700d53f0fb4c01200e79660", "policy_name" : "policy_create_test", "policy_operation_definition" : { "max_backups" : -1, "retention_duration_days" : 30, "day_backups" : 0, "week_backups" : 0, "month_backups" : 0, "year_backups" : 0, "timezone" : "UTC+08:00", "full_backup_interval" : -1 }, "policy_enabled" : false, "policy_trigger" : { "properties" : { "pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ] } }, "status" : "syncing" } ], "count" : 4, "limit" : 1000, "offset" : 0 }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot