Updated on 2024-05-11 GMT+08:00

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

operation_type

Yes

String

Organizational policy type

Request Parameters

Table 3 Request header 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.

Default: MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX...

Response Parameters

Status code: 200

Table 4 Response body parameters

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

Table 5 OrganizationPolicy

Parameter

Type

Description

id

String

Organization Policy ID

name

String

Organization Policy Name

Minimum: 1

Maximum: 64

description

String

Organization Policy Description

Minimum: 0

Maximum: 255

operation_type

String

Organizational policy type

  • backup: backup policy
  • replication: replication policy

Enumeration values:

  • backup
  • replication

domain_id

String

Specifies the ID of the account to which the organization policy belongs.

policy_name

String

Policy Name

Minimum: 1

Maximum: 64

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

Table 6 PolicyoODCreate

Parameter

Type

Description

day_backups

Integer

Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

Minimum: 0

Maximum: 100

destination_project_id

String

ID of the replication destination project, which is mandatory for cross-region replication

destination_region

String

ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain 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 retained backups. The value can be -1 or ranges from 0 to 99999. If the value is set to -1, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and retention_duration_days are both left blank, the backups will be retained permanently.

Minimum: 1

Maximum: 99999

Default: -1

month_backups

Integer

Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

Minimum: 0

Maximum: 100

retention_duration_days

Integer

Duration of retaining a backup, in days. The maximum value is 99999. -1 indicates that the backups will not be cleared based on the retention duration. If this parameter and max_backups are left blank at the same time, the backups will be retained permanently.

Minimum: 1

Maximum: 99999

Default: -1

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

Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

year_backups

Integer

Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by max_backups. The value ranges from 0 to 100. If this parameter is configured, timezone is mandatory.

Minimum: 0

Maximum: 100

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

Minimum: -1

Maximum: 100

Table 7 PolicyTriggerReq

Parameter

Type

Description

properties

PolicyTriggerPropertiesReq object

Scheduler attributes

Table 8 PolicyTriggerPropertiesReq

Parameter

Type

Description

pattern

Array of strings

Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the FREQ, BYDAY, BYHOUR, BYMINUTE, and INTERVAL parameters. FREQ can be set only to WEEKLY or DAILY. BYDAY can be set to MO, TU, WE, TH, FR, SA, and SU (seven days of a week). BYHOUR ranges from 0 to 23 hours. BYMINUTE ranges from 0 to 59 minutes. The scheduling interval cannot 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) from Monday to Sunday, set the scheduling rule as follows: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00

Example Requests

Request body for querying the organizational policy list

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.