Updated on 2025-12-02 GMT+08:00

Creating a Backup Download Policy

Function

This API is used to create a backup download policy.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dds:backup:createDownloadPolicy

    write

    -

    -

    -

    -

URI

POST /v3/{project_id}/backups/download-policy

Table 1 Request Parameters

Name

Type

IN

Mandatory

Description

project_id

string

path

Yes

Definition

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Name

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token obtained from IAM. For details, see Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Name

Mandatory

Type

Description

action

Yes

String

Definition

Backup download switch.

Constraints

N/A

Range

  • open: The backup download function is enabled, and backups can be downloaded from the Internet.
  • close: The backup download function is disabled, and backups cannot be downloaded from the Internet.

Default Value

N/A

Response Parameters

Status code: 200

Example Request

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/backups/download-policy
{    
 "action" : "open"
}

Example Response

Status code: 200

Success.

{ }

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.