Listing Upgrade Policies

Function

Lists upgrade policies by page.

You can query policies by policy name (fuzzy or exact match), policy type, whether to forcibly upgrade, enabling status, and priority.
By default, the policies are sorted in ascending order of priority.

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:list

List

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:upgradeStrategy:list	List	-	-	-	-

URI

GET /v2/{project_id}/upgrade-strategies

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
is_accurate_name	No	Boolean	Whether to exactly match the name.
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.
offset	No	Integer	Offset. The default value is 0.
limit	No	Integer	Number of records on each page. The default value is 10, and the maximum value is 100.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total_count	Integer	Total quantity.
strategies	Array of TenantUpgradeStrategyDetailRsp objects	Policy list.

**Table 4** TenantUpgradeStrategyDetailRsp
Parameter	Type	Description
id	String	Policy ID.
project_id	String	Project ID.
strategy_type	Integer	Policy type. The value can be 0 (server) or 1 (client).
strategy_name	String	Policy name.
is_force_upgrade	Integer	Whether to forcibly upgrade the version. The value can be 0 (no) or 1 (yes).
min_version	String	Upgrade is required if the version is earlier than this version.
target_version	String	Target version.
strategy_desc	String	Policy description.
strategy_priority	Integer	Priority. A smaller value indicates a higher priority.
status	Integer	Status. The value can be 0 (disabled) or 1 (enabled).

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Service error code.
error_msg	String	Service error message.

Status code: 500

**Table 6** 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

{
  "total_count" : 100,
  "strategies" : [ {
    "id" : "strategy-001",
    "project_id" : "project-001",
    "strategy_type" : 0,
    "strategy_name" : "vGPU policy.",
    "is_force_upgrade" : 1,
    "min_version" : "1.0.0",
    "target_version" : "2.0.0",
    "strategy_desc" : "Upgrade to the latest version.",
    "strategy_priority" : 1,
    "status" : 1
  } ]
}