Updated on 2026-07-24 GMT+08:00

Exporting the Upgrade Policy List

Function

Asynchronously exports upgrade policy data.

  • You can filter policies by policy name, policy type, whether to forcibly upgrade, and enabling status.

  • The export task ID is returned. You can query the export result using the task ID.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

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

    workspace:upgradeStrategy:export

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/upgrade-strategies/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

strategy_name

No

String

Policy name. Fuzzy match is supported.

strategy_type

No

Integer

Policy type. The value can be 0 (server) or 1 (client).

is_force_upgrade

No

Integer

Whether to forcibly upgrade the version. The value can be 0 (no) or 1 (yes).

status

No

Integer

Enabling status. The value can be 0 (disabled) or 1 (enabled).

strategy_priority

No

Integer

Protocol policy priority.

language

Yes

String

Language.

  • zh_CN: Chinese.

  • en_US: English.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

task_id

String

Export task ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Service error code.

error_msg

String

Service error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Service error code.

error_msg

String

Service error message.

Example Requests

None

Example Responses

Status code: 200

ok

{
  "task_id" : "task-id-001"
}

Status Codes

Status Code

Description

200

ok

400

Invalid request parameter.

500

Internal server error.

Error Codes

See Error Codes.