Querying Details About an Issue Ticket_Issue Ticket Management_Fault Management_API_API Reference

Function

This API is used to query details about an issue ticket based on the service ticket number.

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
coc:ticket:get	Read	-	-	-	-

URI

GET /v1/{ticket_type}/tickets/{ticket_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
ticket_type	Yes	String	Definition: Type of the service ticket to be modified. issues_mgmt indicates that the issue ticket details are queried. Constraints: 1–255 characters Value range: issues_mgmt: issue ticket Default value: N/A
ticket_id	Yes	String	Definition: Service ticket ID. Constraints: 1–255 characters Value range: N/A Default value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
provider_code	String	Definition: Service ID. Value range: N/A Default value: 049
error_code	String	Definition: Request response code. Value range: GOM.00000000~GOM.00009999999 Default value: GOM.00000000
error_msg	String	Definition: Response description for a request. Value range: N/A
data	CocTicketDetailInfoResponseData object	Definition: Details about a service ticket. Value range: N/A

**Table 3** CocTicketDetailInfoResponseData
Parameter	Type	Description
issue_correlation_sla	String	Definition: Issue ticket-associated SLA. Value range: N/A
level	String	Definition: Issue ticket level. Value range: N/A
root_cause_cloud_service	String	Definition: Responsible service of the issue ticket. Value range: N/A
root_cause_type	String	Definition: Root cause category of the issue ticket. Value range: N/A
current_cloud_service_id	String	Definition: Issue ticket service. Value range: N/A
issue_contact_person	String	Definition: Issue ticket contact person. Value range: N/A
issue_version	String	Definition: Version where the issue is found. Value range: N/A
source	String	Definition: Source of the issue ticket. Value range: N/A
commit_upload_attachment	String	Definition: ID of the uploaded attachment. Value range: N/A Default value: N/A
source_id	String	Definition: Source ID of the issue ticket. Value range: N/A
enterprise_project	String	Definition: Enterprise project of the issue ticket. Value range: N/A
virtual_schedule_type	String	Definition: Shift type of an issue ticket. Value range: N/A
title	String	Definition: Title of the issue ticket. Value range: N/A
regions	String	Definition: Region information of the issue ticket. Value range: N/A
description	String	Definition: Issue ticket description. Value range: N/A
root_cause_comment	String	Definition: Root cause analysis of the issue ticket. Value range: N/A
solution	String	Definition: Solution of the issue ticket. Value range: N/A
regions_serch	String	Definition: Value searched by region in the issue ticket. Value range: N/A
level_approve_config	String	Definition: Review configuration of the issue ticket level. Value range: N/A
suspension_approve_config	String	Definition: Review configuration of the issue ticket suspension. Value range: N/A
handle_time	Long	Definition: Issue ticket handling duration. Value range: N/A
fount_time	Long	Definition: Time when an issue ticket is found. Value range: N/A
is_common_issue	Boolean	Definition: Whether the issue is common. Value range: true/false
is_need_change	Boolean	Definition: Whether the issue ticket needs to be changed. Value range: true/false
is_enable_suspension	Boolean	Definition: Whether the issue ticket is suspended. Value range: true/false
is_start_process_async	Boolean	Definition: Whether to start the asynchronous process. Value range: true/false
is_update_null	Boolean	Definition: Whether to resubmit the empty field. Value range: true/false
creator	String	Definition: Issue ticket creator. Value range: N/A
operator	String	Definition: Operator of an issue ticket. Value range: N/A
is_return_full_info	Boolean	Definition: Whether to return all field information. Value range: true/false
is_start_process	Boolean	Definition: Whether to start the process. Value range: true/false
ticket_id	String	Definition: Issue ticket number. Value range: N/A
real_ticket_id	String	Definition: Issue ticket number. Value range: N/A
assignee	String	Definition: Current owner of the issue ticket. Value range: N/A
participator	String	Definition: Issue ticket participant. Value range: N/A
work_flow_status	String	Definition: Issue ticket status. Value range: N/A
engine_error_msg	String	Definition: Process status. Value range: N/A
baseline_status	String	Definition: Baseline status. Value range: N/A
ticket_type	String	Definition: Service ticket type. Value range: issues_mgmt
phase	String	Definition: Current phase of the issue ticket. Value range: N/A
sub_tickets	Array of sub_tickets objects	Definition: Change sub-ticket information. Value range: N/A
enum_data_list	Array of IssuesTicketInfoEnumData objects	Definition: Enumerated values associated with the issue ticket. Value range: N/A
id	String	Definition: Primary key UUID of an issue ticket. Value range: N/A
meta_data_version	Integer	Definition: Application version involved in the issue. Value range: N/A
update_time	Long	Definition: Timestamp when an issue ticket is updated. Value range: N/A
create_time	Long	Definition: Timestamp for issue ticket creation. Value range: N/A
is_deleted	Boolean	Definition: Whether the service ticket is deleted. Value range: N/A
ticket_type_id	String	Definition: Service ticket type. Value range: N/A
_form_info	Object	Definition: Action information. Value range: N/A Default value: N/A

**Table 4** sub_tickets
Parameter	Type	Description
change_ticket_id	String	Definition: ID of the associated change ticket. Value range: N/A
change_ticket_id_sub	String	Definition: Sub-ticket number of the change ticket. Value range: N/A
whether_to_change	Boolean	Definition: Whether a change is required Value range: N/A
is_deleted	Boolean	Definition: Whether it is deleted Value range: N/A
id	String	Definition: Change ticket ID. Value range: N/A
main_ticket_id	String	Definition: Primary key ID of the change ticket. Value range: N/A
parent_ticket_id	String	Definition: Parent ticket ID. Value range: N/A
ticket_id	String	Definition: Issue Ticket ID. Value range: N/A
real_ticket_id	String	Definition: Ticket number. Value range: N/A
ticket_path	String	Definition: Ticket path. Value range: N/A
target_value	String	Definition: Region information. Value range: N/A
target_type	String	Definition: Sub-ticket type. Value range: N/A
create_time	Long	Definition: Time when a service ticket is created. Value range: N/A
update_time	Long	Definition: Time when a ticket is updated. Value range: N/A
creator	String	Definition: ID of the ticket creator. Value range: N/A
operator	String	Definition: ID of the ticket operator. Value range: N/A

**Table 5** IssuesTicketInfoEnumData
Parameter	Type	Description
is_deleted	Boolean	Definition: Whether it is deleted Value range: N/A
match_type	String	Definition: Matched enumerated type. Value range: N/A
ticket_id	String	Definition: Current service ticket ID. Value range: N/A
real_ticket_id	String	Definition: Service ticket ID. Value range: N/A
name_zh	String	Definition: Chinese name. Value range: N/A
name_en	String	Definition: English name. Value range: N/A
biz_id	String	Definition: Unique ID of an enumerated value. When match_type is set to reference__base_config.User, the value of biz_id is the unique ID of the operator. Value range: N/A
prop_id	String	Definition: Type corresponding to the current enumerated value. Value range: N/A
model_id	String	Definition: Model ID corresponding to a background application. Value range: N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
provider_code	String	Definition: Service ID. Value range: N/A Default value: 049
error_code	String	Definition: Request response code. Value range: GOM.00000000~GOM.00009999999 Default value: GOM.00000000
error_msg	String	Definition: Response description for a request. Value range: N/A

Example Requests

Query the details of issue ticket ISU20250709150841010733591.

GET https://{Endpoint}/v1/issues_mgmt/tickets/ISU20250709150841010733591

Example Responses

Status code: 200

Request succeeded.

For more status codes, see Status Codes.

{
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "provider_code" : 4,
  "data" : {
    "ticket_type" : "issues_type_4000",
    "issue_correlation_sla" : "ISU20250709150841010733591",
    "level" : "issues_level_3000",
    "root_cause_cloud_service" : "657184aa20577d4c94e30054",
    "root_cause_type" : "issues_root_cause_type_4000",
    "current_cloud_service_id" : "657184aa20577d4c94e30054",
    "issue_contact_person" : "d8c0bbef-6853-452d-8c79-c3a7f5dd3f55",
    "issue_version" : "123123",
    "source" : "issues_mgmt_associated_type_2000",
    "commit_upload_attachment" : "8fff903d-4794-4e77-af54-bd4f887f2645",
    "source_id" : "al1701156119531X3VnkMNGQ",
    "enterprise_project" : "0",
    "virtual_schedule_type" : "issues_mgmt_virtual_schedule_type_2000",
    "title" : "IAM",
    "regions" : "br-cto-beta",
    "description" : "[Symptom]\n[Impact on the live network] IAM",
    "root_cause_comment" : "123",
    "solution" : "123123",
    "regions_serch" : "br-cto-beta,",
    "level_approve_config" : "{\"approve_role_type\":\"issue_persenal_approve\",\"issue_approve_type\":\"issue_level_approve\",\"level\":\"issues_level_3000,issues_level_4000,issues_level_2000,issues_level_1000\",\"approve_rule\":\"issue_or_sign\",\"approve_personal\":\"86b93d79f4b444968a150d18c4ba610d,64e6fce5334348e4ac87c1880169fb66\",\"approve_oncall_role\":\"27256d8934b94a88b16c00954287e0b0\",\"approve_oncall_scene\":\"7213a392df4c4099a3a3dbf17be3e0cd\",\"status\":true,\"is_start_process_async\":true,\"is_update_null\":false,\"creator\":\"258386eb12554072a0e8a3264b5da448\",\"operator\":\"258386eb12554072a0e8a3264b5da448\",\"is_return_full_info\":false,\"is_start_process\":true,\"ticket_id\":\"04ebd8cb-2734-4076-b78c-213b7d391cc8\",\"real_ticket_id\":\"20250614104911010600790085\",\"participator\":\"64e6fce5334348e4ac87c1880169fb66\",\"work_flow_status\":\"issue_process_control_draft\",\"engine_error_msg\":\"\",\"baseline_status\":\"issue_process_control_draft\",\"sub_tickets\":[],\"enum_data_list\":[],\"id\":\"61534cd9b4b5283104ce9c04add7be2c\",\"meta_data_version\":0,\"update_time\":1751879098336,\"create_time\":1751879098336,\"is_deleted\":false,\"ticket_type_id\":\"issue_process_control\",\"_form_info\":{}}",
    "suspension_approve_config" : "{\"approve_role_type\":\"issue_persenal_approve\",\"issue_approve_type\":\"issue_suspend_approve\",\"level\":\"\",\"approve_rule\":\"issue_all_agreed\",\"approve_personal\":\"64e6fce5334348e4ac87c1880169fb66,86b93d79f4b444968a150d18c4ba610d\",\"approve_oncall_role\":\"27256d8934b94a88b16c00954287e0b0\",\"approve_oncall_scene\":\"7213a392df4c4099a3a3dbf17be3e0cd\",\"status\":true,\"is_start_process_async\":true,\"is_update_null\":false,\"creator\":\"258386eb12554072a0e8a3264b5da448\",\"operator\":\"258386eb12554072a0e8a3264b5da448\",\"is_return_full_info\":false,\"is_start_process\":true,\"ticket_id\":\"2b6fd3df-91fa-470d-86d6-52204edef74a\",\"real_ticket_id\":\"20250614104915011838103583\",\"participator\":\"64e6fce5334348e4ac87c1880169fb66,258386eb12554072a0e8a3264b5da448,86b93d79f4b444968a150d18c4ba610d\",\"work_flow_status\":\"issue_process_control_draft\",\"engine_error_msg\":\"\",\"baseline_status\":\"issue_process_control_draft\",\"sub_tickets\":[],\"enum_data_list\":[],\"id\":\"61a7e0193710a05e02d880fd96f65440\",\"meta_data_version\":0,\"update_time\":1751879104309,\"create_time\":1751879104309,\"is_deleted\":false,\"ticket_type_id\":\"issue_process_control\",\"_form_info\":{}}",
    "handle_time" : 28586,
    "fount_time" : 0,
    "is_common_issue" : false,
    "is_need_change" : false,
    "is_enable_suspension" : false,
    "is_start_process_async" : true,
    "is_update_null" : false,
    "creator" : "d8c0bbef-6853-452d-8c79-c3a7f5dd3f55",
    "operator" : "d8c0bbef-6853-452d-8c79-c3a7f5dd3f55",
    "is_return_full_info" : false,
    "is_start_process" : true,
    "ticket_id" : "ISU20250709150841010733591",
    "real_ticket_id" : "ISU20250709150841010733591",
    "assignee" : "",
    "participator" : "d8c0bbef-6853-452d-8c79-c3a7f5dd3f55",
    "work_flow_status" : "issues_work_flow_status_12000",
    "engine_error_msg" : "",
    "baseline_status" : "issues_mgmt_draft",
    "phase" : "issues_phase_4000",
    "sub_tickets" : [ {
      "id" : "6145652f02d8b7e07811b3833b4b205d",
      "main_ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "parent_ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "ticket_id" : "afd37b27-9026-4a99-aff5-c787dcac38c1",
      "real_ticket_id" : "ISU20250709150841010733591001",
      "ticket_path" : "a82da908-60e9-4f2a-b541-a5cee49075c2:regions:br-cto-beta",
      "target_value" : "br-cto-beta",
      "target_type" : "regions",
      "create_time" : 1752044921778,
      "update_time" : 1752044950789,
      "operator" : "d8c0bbef-6853-452d-8c79-c3a7f5dd3f55",
      "creator" : "d8c0bbef-6853-452d-8c79-c3a7f5dd3f55",
      "is_deleted" : false,
      "sub_tickets" : [ ]
    } ],
    "enum_data_list" : [ {
      "is_deleted" : false,
      "match_type" : "enum",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "Compatibility issues",
      "name_en" : "Compatibility problems",
      "biz_id" : "issues_type_4000",
      "prop_id" : "ticket_type",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "enum",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "Individual",
      "name_en" : "Individuals",
      "biz_id" : "issues_mgmt_virtual_schedule_type_2000",
      "prop_id" : "virtual_schedule_type",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "reference__base_config.User",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "idc-test01-cim",
      "name_en" : "idc-test01-cim",
      "user_name" : "idc-test01-cim",
      "biz_id" : "d8c0bbef-6853-452d-8c79-c3a7f5dd3f55",
      "prop_id" : "creator",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "reference__base_config.Location",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "CloudBU-CTO production-service distribution",
      "name_en" : "CTOPreProd-ServiceDistribution1",
      "biz_id" : "br-cto-beta",
      "prop_id" : "regions",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "reference__base_config.User",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "idc-test01-cim",
      "name_en" : "idc-test01-cim",
      "user_name" : "idc-test01-cim",
      "biz_id" : "d8c0bbef-6853-452d-8c79-c3a7f5dd3f55",
      "prop_id" : "issue_contact_person",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "reference__base_config.Resource",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "cdr-test",
      "name_en" : "cdr-test",
      "biz_id" : "657184aa20577d4c94e30054",
      "prop_id" : "current_cloud_service_id",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "enum",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "Completed",
      "name_en" : "Completed",
      "biz_id" : "issues_work_flow_status_12000",
      "prop_id" : "work_flow_status",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "reference__base_config.Resource",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "cdr-test",
      "name_en" : "cdr-test",
      "biz_id" : "657184aa20577d4c94e30054",
      "prop_id" : "root_cause_cloud_service",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "reference__app.attachment",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "New text file.txt",
      "name_en" : "New text file.txt",
      "biz_id" : "8fff903d-4794-4e77-af54-bd4f887f2645",
      "prop_id" : "commit_upload_attachment",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "enum",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "Alarm",
      "name_en" : "alarms",
      "biz_id" : "issues_mgmt_associated_type_2000",
      "prop_id" : "source",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "enum",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "General",
      "name_en" : "Minor",
      "biz_id" : "issues_level_3000",
      "prop_id" : "level",
      "model_id" : "TicketInfo"
    }, {
      "is_deleted" : false,
      "match_type" : "enum",
      "ticket_id" : "a82da908-60e9-4f2a-b541-a5cee49075c2",
      "real_ticket_id" : "ISU20250709150841010733591",
      "name_zh" : "Data configuration",
      "name_en" : "Data Configuration",
      "biz_id" : "issues_root_cause_type_4000",
      "prop_id" : "root_cause_type",
      "model_id" : "TicketInfo"
    } ],
    "id" : "5c23288a1fbb117f14c1c10b16fd5df9",
    "meta_data_version" : 39,
    "update_time" : 1752044954888,
    "create_time" : 1752044921707,
    "is_deleted" : false,
    "ticket_type_id" : "issues_mgmt",
    "_form_info" : { }
  }
}

Status code: 400

The server failed to process the request.

For more status codes, see Status Codes.

{
  "error_code" : "COC.00067003",
  "error_msg" : "The service ticket does not exist.",
  "provider_code" : 4
}

Status Codes

Status Code	Description
200	Request succeeded. For more status codes, see Status Codes.
400	The server failed to process the request. For more status codes, see Status Codes.

Status Code

Description

200

Request succeeded.

For more status codes, see Status Codes.

400

The server failed to process the request.

For more status codes, see Status Codes.

Error Codes

See Error Codes.

Querying Details About an Issue Ticket

Function

Authorization Information

URI

Request Parameters

Response Parameters

Example Requests

Example Responses

Status Codes

Error Codes

Feedback

Was this page helpful?