Obtaining Event Ticket Details

Function

Obtain event ticket details.

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/external/incident/{incident_num}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
incident_num	Yes	String	Unique ID of an incident ticket.

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	CocIncidentTicketDetailInfoResponseData object	Event ticket details.

**Table 3** CocIncidentTicketDetailInfoResponseData
Parameter	Type	Description
incident_num	String	Event ticket number.
region	Array of strings	Region code. If a WarRoom is automatically created, this field is mandatory. Currently, only one region code is supported.
enterprise_project	Array of strings	Enterprise project ID. Currently, only one enterprise project ID is supported.
current_cloud_service	Array of strings	Home application ID. Currently, only one ID is supported.
incident_level	String	Incident Level For details, see Enumeration [Event Level] (coc_api_04_03_001_006.xml).
is_service_interrupt	Boolean	Whether the service is interrupted. The value can be true or false.
start_time	Long	Timestamp when a fault occurs.
fault_recovery_time	Long	Fault recovery timestamp.
fault_delineation_time	Long	Timestamp when the demarcation is complete.
incident_type	String	Incident type. For details, see Enumeration [Event Type] (coc_api_04_03_001_006.xml).
incident_title	String	Event title. The value contains a maximum of 200 characters.
incident_description	String	Event description. The value contains a maximum of 600 characters.
incident_source	String	Document Source For details, see Enumeration [Event Type] (coc_api_04_03_001_006.xml).
incident_ownership	String	Ownership For details, see Enumeration [Event Belonging] (coc_api_04_03_001_006.xml).
incident_assignee	Array of strings	The owner, scheduling scenario, and scheduling role cannot be empty at the same time. Currently, only one owner, scheduling scenario, and scheduling role are supported.
assignee_scene	String	In the scheduling scenario, the owner and scheduling role cannot be empty at the same time.
assignee_role	String	The scheduling role, scheduling scenario, and owner cannot be empty at the same time.
warroom_id	String	warroom_id.
handle_time	Long	Timestamp when the solution is submitted for the last time.
status	String	Status key.
create_time	Long	Ticket creation timestamp.
creator	String	Ticket creator.
enum_data_list	Array of TicketInfoEnumData objects	Enumeration list.

**Table 4** TicketInfoEnumData
Parameter	Type	Description
filed_key	String	The field key identifies the field.
enum_key	String	Enumeration key.
name_zh	String	Chinese name
name_en	String	Specifies the carrier name in English.

Status code: 400

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

Obtain event ticket details.

https://{Endpoint}/v1/external/incident/{incident_num}

Example Responses

Status code: 200

Request succeeded.

For more status codes, see Status Codes.

{
  "provider_code" : "049",
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "data" : {
    "incident_num" : "207E3F5A248A4F5DAABC012C7E",
    "region" : [ "OCB_cloud" ],
    "enterprise_project" : null,
    "current_cloud_service" : [ "6470681a31da2a47ed50a919" ],
    "incident_level" : "level_10",
    "is_service_interrupt" : true,
    "start_time" : null,
    "incident_type" : "inc_type_p_security_issues",
    "incident_title" : "FA3698893F",
    "incident_description" : "FA3698893F",
    "incident_source" : "incident_source_manual",
    "incident_ownership" : null,
    "incident_assignee" : [ "01649a08fb744291a952f3c470b92f9e" ],
    "assignee_scene" : "",
    "assignee_role" : "",
    "warroom_id" : null,
    "handle_time" : null,
    "status" : "INCIDENT_STATUS_TRIGGERED",
    "create_time" : 1700035856542,
    "fault_recovery_time" : 1700035856542,
    "fault_delineation_time" : 1700035856542,
    "creator" : "9fec03ee5b1040818b91bef6e16213df",
    "enum_data_list" : [ {
      "filed_key" : "current_cloud_service_id",
      "enum_key" : "6470681a31da2a47ed50a919",
      "name_zh" : null,
      "name_en" : null
    }, {
      "filed_key" : "creator",
      "enum_key" : "9fec03ee5b1040818b91bef6e16213df",
      "name_zh" : null,
      "name_en" : null
    }, {
      "filed_key" : "level_id",
      "enum_key" : "level_10",
      "name_zh" : "P1",
      "name_en" : "P1"
    }, {
      "filed_key" : "work_flow_status",
      "enum_key" : "INCIDENT_STATUS_TRIGGERED",
      "name_zh" : "Not yet accepted",
      "name_en" : "TRIGGERED"
    }, {
      "filed_key" : "mtm_type",
      "enum_key" : "inc_type_p_security_issues",
      "name_zh" : "Security",
      "name_en" : "Security issues"
    }, {
      "filed_key" : "source_id",
      "enum_key" : "incident_source_manual",
      "name_zh" : "Manual creation",
      "name_en" : "Manual Creation"
    }, {
      "filed_key" : "assignee",
      "enum_key" : "01649a08fb744291a952f3c470b92f9e",
      "name_zh" : null,
      "name_en" : null
    } ]
  }
}

Status code: 400

The request failed to be processed due to bad syntax.

For more status codes, see Status Codes.

{
  "error_code" : "GOM.00007256",
  "error_msg" : "Invalid parameters",
  "provider_code" : 4,
  "data" : null
}

Status Codes

Status Code	Description
200	Request succeeded. For more status codes, see Status Codes.
400	The request failed to be processed due to bad syntax. For more status codes, see Status Codes.

Status Code

Description

200

Request succeeded.

For more status codes, see Status Codes.

400

The request failed to be processed due to bad syntax.

For more status codes, see Status Codes.