Querying a Single Policy

policy_id

Yes

String

Policy ID. Default value: N/A

For details about how to obtain the policy ID, see Obtaining a Policy ID.

project_id

Yes

String

Project ID. Default value: N/A

For details about how to obtain the project ID, see Obtaining a Project ID.

X-Auth-Token

Yes

String

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Default value: N/A

policy

Policy object

Response to the request for creating a policy

enabled

Boolean

Whether the policy is enabled.

The value can be:

• true: The policy is enabled.

• false: The policy is disabled.

id

String

Policy ID. Range: N/A

name

String

Policy name. The value consists of 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

operation_definition

PolicyoODCreate object

Policy attributes.

operation_type

String

Protection type. The value can be backup or replication.

trigger

PolicyTriggerResp object

Time scheduling rule for the policy

associated_vaults

Array of PolicyAssociateVault objects

Associated vault

policy_type

String

Policy type. The value can be:

• custom_policy: common-user policy

• organization_policy_v1: organizational policy of the old version

• organization_policy_v2: organizational policy of the new version

• organization_policy_removed: new organizational policy associated with a vault for a user that has left the organization. (The policy is not automatically disassociated from the vault, and cannot be associated with a new vault.)

day_backups

Integer

Number of daily backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.

destination_project_id

String

Project ID of the destination region, which is mandatory for cross-region replication. Default value: N/A

For details about how to obtain the project ID, see Obtaining a Project ID.

destination_region

String

Destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains a maximum of 255 characters, including only letters, digits, underscores (_), and hyphens (-). Default value: N/A

For details about how to obtain the region ID, see Querying Regions and Endpoints.

enable_acceleration

Boolean

Whether to enable acceleration to shorten the cross-region replication time. If this parameter is not set, the acceleration function is disabled. If enabled, the acceleration function is additionally charged.

• true: The acceleration function is enabled.

• false: The acceleration function is disabled.

max_backups

Integer

Maximum number of backups that can be automatically created for a resource. The value can be -1 or in the range of 1 to 99999. Default value: N/A If the value is set to -1, backups will not be cleared when they reach the quantity limit. If this parameter and retention_duration_days are both left unspecified, backups will be retained permanently. This parameter and retention_duration_days cannot be both specified.

month_backups

Integer

Number of monthly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.

retention_duration_days

Integer

Backup retention period, in days. The maximum value is 99999. Default value: N/A -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are both left blank, the backups will be retained permanently. This parameter cannot be applied together with max_backups, day_backups, week_backups, month_backups, or year_backups.

timezone

String

Time zone where the user is located, for example, UTC+08:00. Default value: N/A If any of the yearly, monthly, weekly, and daily backup parameters is selected, this parameter cannot be left blank.

week_backups

Integer

Number of weekly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.

year_backups

Integer

Number of yearly backups retained, which is not affected by the allowed maximum number of retained backups. The value ranges from 0 to 100. Default value: N/A If this parameter is configured, timezone is mandatory. This parameter and retention_duration_days cannot be both specified.

full_backup_interval

Integer

Defines how often a full backup is performed. If -1 is specified, full backup will not be performed. Range: [-1, 100]; Default value: N/A

id

String

Scheduler ID. Range: N/A

name

String

Scheduler name. Range: N/A

properties

PolicyTriggerPropertiesResp object

Policy scheduler attributes.

type

String

Scheduler type. Currently, only time (periodic scheduling) is supported.

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.

start_time

String

Scheduler start time, for example, 2020-01-08 09:59:49.

destination_vault_id

String

ID of the associated remote vault.

For details, see Obtaining a Vault ID, where project_id must be set to the project ID of the destination region.

vault_id

String

Vault ID.

For details about how to obtain the vault ID, see Obtaining a Vault ID.

200

OK