Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Server Management/ Querying HDA Upgrade Tracing Records of a Server
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying HDA Upgrade Tracing Records of a Server

Function

Queries HDA upgrade tracing records of a server.

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:accessAgent:listUpgradeRecords

    List

    -

    -

    -

    -

URI

GET /v1/{project_id}/app-servers/access-agent/upgrade-record

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Query offset. The default value is 0.

limit

No

Integer

Number of records to be queried. The value ranges from 1 to 100. The default value is 10.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total number.

items

Array of ServerHdaUpgradeRecord objects

The maximum number of records in the returned list is the maximum number of records on each page.
Table 5 ServerHdaUpgradeRecord

Parameter

Type

Description

server_id

String

Server ID.

machine_name

String

Server Name.

server_name

String

Server.

server_group_name

String

ECS group name.

sid

String

SID of the server.

current_version

String

Current AccessAgent Version.

target_version

String

Target AccessAgent Version.

upgrade_status

String

HDA upgrade status.

  • fail: The upgrade failed.

  • upgrade success: The upgrade succeeded.

upgrade_time

String

Update time.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 409

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 0,
  "items" : [ {
    "server_id" : "489533790436196976",
    "machine_name" : "APS-DDP9KKUYTR",
    "server_name" : "APS-20221011032502-DL51DUK113",
    "server_group_name" : "Server Group Used in the Test",
    "sid" : "489533790436196976",
    "current_version" : "22.10.0.1020",
    "target_version" : "22.10.0.1022",
    "upgrade_status" : "SUCCESS",
    "upgrade_time" : "2022-10-25 10:25:10"
  } ]
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

409

The request fails to be processed because a conflict exists.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Server Management