Help Center/ Cloud Operations Center/ API Reference/ API/ Change Management/ Updating a Change Ticket
Updated on 2025-10-24 GMT+08:00
View PDF
Share

Updating a Change Ticket

Function

This API is used to update change ticket information.

Authorization

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

  • If you are using role- or policy-based authorization, refer to Permissions Policies and Supported Actions to obtain the permissions required.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependent Action

    coc:ticket:update

    Write

    -

    -

    -

    -

URI

PUT /v2/changes/{change_id}

Table 1 Request path parameters

Parameter

Type

Mandatory

Description

change_id

String

Yes

Definition:

Change ticket No.

Constraints

String

Range:

Character length: 1 to 50

Default Value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Type

Mandatory

Description

ticket_info

TicketInfoObject object

No

Definition:

Main ticket information about the change.

Constraints

N/A

Range:

N/A

Default Value:

N/A

sub_tickets

Arrays of SubTicketInfoObject

No

Definition:

Sub-ticket information about the change.

Constraints

N/A

Range:

N/A

Default Value:

N/A

history_info

TicketHistoryInfoObject object

No

Definition:

Change history.

Constraints

N/A

Range:

N/A

Default Value:

N/A
Table 3 TicketInfoObject attributes

Parameter

Type

Mandatory

Description

phase

String

No

Definition:

Type of the service ticket operation.

Constraints

Character length: 0 to 255

Range:

Enum value

  • phase_change_end: completed
  • phase_change_cancel: canceled
  • phase_change_draft: draft
  • phase_change_implement: change implementation and verification
  • phase_change_apply: applicant confirmation
  • phase_change_approve: under review
  • phase_change_close: closed

Default Value:

N/A

work_flow_status

String

No

Definition:

Ticket status.

Constraints

Character length: 0 to 255

Range:

N/A

Default Value:

N/A
Table 4 SubTicketInfoObject attributes

Parameter

Type

Mandatory

Description

ticket_id

String

No

Definition:

Sub-ticket ID.

Constraints

Character length: 0 to 100

Range:

N/A

Default Value:

N/A

change_result

String

No

Definition:

Change result.

Constraints

Character length: 1 to 100

Range:

N/A

Default Value:

N/A

is_verified_in_change_time

Boolean

No

Definition:

Whether verification can be performed within the time window.

Constraints

N/A

Range:

true/false

Default Value:

N/A

verified_docs

String

No

Definition:

Verification document ID.

Constraints

Length: 0 to 1,000 characters

Range:

N/A

Default Value:

N/A

comment

String

No

Definition:

Description of the change failure cause.

Constraints

Character length: 0 to 100

Range:

N/A

Default Value:

N/A

change_fail_type

String

No

Definition:

Change failure type.

Constraints

Character length: 1 to 100

Range:

N/A

Default Value:

N/A

rollback_start_time

Long

No

Definition:

Rollback start time.

Constraints

N/A

Range:

1-9999999999999

Default Value:

N/A

rollback_end_time

Long

No

Definition:

Rollback end time.

Constraints

N/A

Range:

1-9999999999999

Default Value:

N/A

is_rollback_success

Boolean

No

Definition:

Whether the rollback is successful.

Constraints

N/A

Range:

true/false

Default Value:

N/A

is_monitor_found

Boolean

No

Definition:

Whether the change is detected by the monitor.

Constraints

N/A

Range:

true/false

Default Value:

N/A
Table 5 TicketHistoryInfoObject attributes:

Parameter

Type

Mandatory

Description

action

String

No

Definition:

Operation type.

Constraints

Character length: 1 to 1,000 characters

Range:

  • change_start_change_success: The change starts.
  • change_end_change_success: The change ends.
  • change_set_change_result_success: Add the change result.
  • change_complete_success: The ticket is closed.

Default Value:

N/A

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Mandatory

Description

provider_code

String

No

Definition:

Service ID.

Range:

Character length: 0 to 256

Default Value:

049

error_code

String

No

Definition:

Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases.

Range:

Character length: 0 to 256

Default Value:

0

error_msg

String

No

Definition:

Response description for a request.

Range:

Character length: 0 to 256

Default Value:

N/A

Request Examples

  • The change is complete.
PUT https://{Endpoint}/v2/changes/{change_id}

{
    "history_info": {
        "action": "change_end_change_success"
    },
    "sub_tickets": [
        {
            "ticket_id": " 92f0c22f-4ca4-4cbe-89cf-281aed331f50"
        }
    ]
}
  • Add change result after the change plan is executed.
PUT https://{Endpoint}/v2/changes/{change_id}

{
    "sub_tickets": [
        {
            "ticket_id": "{{sub_ticket_id}}",
            "sub_tickets": [

            ],
            "change_result": "change_result_failed",
            "verified_docs1": "e67a0d67-310e-4abd-9b35-43eacf681358",
            "verified_docs": null,
            "comment": "111",
            "change_fail_type": "fr_dependent_service_issue",
            "rollback_start_time": 1742888808000,
            "rollback_end_time": 1742975208000,
            "is_rollback_success": false,
            "is_monitor_found": true
        }
    ],
    "history_info": {
        "action": "change_set_change_result_success"
    }
}
  • Close the change after all change plans are executed.
PUT https://{Endpoint}/v2/changes/{change_id}

{
    "history_info": {
        "action": "change_complete_success"
    },
    "ticket_info": {
        "phase": "phase_change_end",
        "work_flow_status": "COMPLETE"
    }
}

Response Examples

Status code: 200

Request result is returned.

For more status codes, see Status Codes.

{
    "provider_code": "049",
    "error_code": "GOM.00000000",
    "error_msg": null
}

Status code: 400

The server failed to process the request.

For more status codes, see Status Codes.

{
  "error_code" : "GOM.00007256",
  "error_msg" : "Parameter error",
  "provider_code" : "049",
  "data" : null
}

Status Codes

Status Code

Description

200

Request result is returned.

For more status codes, see Status Codes.

400

The server failed to process the request.

For more status codes, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Change Management