DocsICP FilingConsole
Documentation

GetProblem

Updated at:
Copy as MD
Product
My Favorites

Retrieves the details of a fault.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

gemp:GetProblem

get

*All Resource

*

 None None

Request syntax

POST /problem/detail HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
body

object

No

The request body.

problemId

integer

Yes

The fault ID.

1
clientToken

string

No

The client token for idempotency.

C4BE3837-1A13-413B-A225-2C88188E8A43

Response elements

Element

Type

Description

Example

object

The response structure.

data

object

The details.

problemId

integer

The fault ID.

Valid values:

  • Success
  • Fail
  • Cancel

1
createTime

string

The creation time. The format is YYYY-MM-DD HH:mm:ss.

2010-03-09 15:53:45
incidentNumber

string

The incident number.

I3443835000012016260833157948165
incidentId

integer

The incident ID.

130000032
problemNumber

string

The problem number.

P34438300010030116260833538987481
problemName

string

The problem name.

Problem
problemStatus

integer

The problem status. Valid values:

  • 1: Handling.

  • 2: Recovered.

  • 3: Reviewing.

  • 4: Reviewed.

  • 5: Canceled.

1
problemLevel

integer

The problem level. Valid values: 1, 2, 3, and 4, which correspond to P1, P2, P3, and P4 respectively. The severity decreases as the number increases.

1
discoverTime

string

The discovery time. The format is YYYY-MM-DD HH:mm:ss.

2010-03-09 15:53:45
recoveryTime

string

The recovery time. The format is YYYY-MM-DD HH:mm:ss.

2010-03-09 15:53:45
relatedServiceId

integer

The ID of the associated service.

1
serviceName

string

The associated service name.

Service
progressSummary

string

The progress summary.

Progress summary
preliminaryReason

string

The preliminary cause.

Preliminary cause
mainHandler

integer

The primary handler.

123456
mainHandlerId

integer

The ID of the primary handler.

2000
mainHandlerPhone

string

The phone number of the primary handler.

1308987****
feedback

string

The public sentiment feedback.

feedback
cancelReasonDescription

string

The description of the cancellation reason.

Cancellation reason description
cancelReason

integer

The cancellation reason.

37
durationTime

integer

The duration.

300000
progressSummaryRichTextId

integer

The rich text ID of the progress summary.

1231231
handingProblemOperateLogs

array<object>

The operation logs for handling problems.

object

The operation logs for handling problems.

operator

string

The operator.

John
userId

integer

The user ID.

233
actionName

string

The action name.

Cancel problem
actionTime

string

The operation name.

2010-03-09 15:53:45
userIsValid

integer

Specifies whether the user is valid.

1
restoredProblemOperateLogs

array<object>

The operation logs for recovered problems.

object

The operation logs for recovered problems.

operator

string

The operator.

John
userId

integer

The user ID.

3232
actionName

string

The action name.

Recover problem
actionTime

string

The operation name.

2020-08-08 15:39:39
userIsValid

integer

Specifies whether the user is valid.

1
replayingProblemOperateLogs

array<object>

The operation logs of the problem under review.

object

The operation logs of the problem under review.

operator

string

The operator.

Xiao Jie
userId

integer

The user ID.

123456
actionName

string

The action name.

Review problem
actionTime

string

The operation name.

2020-08-08 15:39:39
userIsValid

integer

Specifies whether the user is valid.

1
replayProblemOperateLogs

array<object>

The operation logs of the reviewed problem.

object

The operation logs of the reviewed problem.

operator

string

The operator.

John
userId

integer

The user ID.

2323
actionName

string

The action name.

Review problem
actionTime

string

The operation name.

2020-08-08 15:39:39
userIsValid

integer

Specifies whether the user is valid.

1
effectionServices

array<object>

The affected services.

object

The affected services.

effectionServiceId

integer

The service ID.

1
effectionLevel

integer

The impact level. Valid values: 1, 2, 3, and 4, which correspond to P1, P2, P3, and P4 respectively. The severity decreases as the number increases.

1
effectionStatus

integer

The status of the affected service. Valid values:

  • 0: Not recovered.

  • 1: Recovered.

1
description

string

The impact description.

Description
serviceName

string

The service name.

Shopping cart
serviceDeleteType

integer

The deletion status of the service. Valid values:

  • 1: Normal.

  • 0: Deleted.

1
coordinationGroups

array<object>

The emergency coordination groups.

object

The emergency coordination groups.

serviceGroupId

integer

The service group ID.

1
serviceGroupName

string

The service group name.

Cloud Rush
isValid

integer

Indicates whether the group is valid.

1
timelines

array<object>

The problem operation timeline.

object

The problem operation timeline.

keyNode

string

The key node lookup table (PROBLEM_KEY_NODE).

1,2,3,4,5,7,6,8,9,10
cancelProblemOperateLogs

array<object>

The operation logs of the canceled problem.

object

The operation logs of the canceled problem.

operator

string

The operator.

John
actionName

string

The action name.

Cancel problem
actionTime

string

The operation time. The format is YYYY-MM-DD HH:mm:ss.

2020-09-08 15:38:38
userId

integer

The user ID.

66666
serviceDeleteType

integer

The service deletion type. Valid values:

  • 1: Manual deletion.

  • 2: Automatic deletion.

1
mainHandlerIsValid

integer

The validity status of the primary handler. Valid values:

  • 0: Invalid.

  • 1: Valid.

1
isRuleTrigger

boolean

Indicates whether the problem is triggered by a rule. Valid values:

  • true: Yes.

  • false: No.

true
requestId

string

The request ID.

C4BE3837-1A13-41VB-A225-2C88188E8A43

Examples

Success response

JSON format

{
  "data": {
    "problemId": 1,
    "createTime": "2010-03-09 15:53:45",
    "incidentNumber": "I3443835000012016260833157948165",
    "incidentId": 130000032,
    "problemNumber": "P34438300010030116260833538987481",
    "problemName": "Problem",
    "problemStatus": 1,
    "problemLevel": 1,
    "discoverTime": "2010-03-09 15:53:45",
    "recoveryTime": "2010-03-09 15:53:45",
    "relatedServiceId": 1,
    "serviceName": "Service",
    "progressSummary": "Progress summary",
    "preliminaryReason": "Preliminary cause",
    "mainHandler": 0,
    "mainHandlerId": 2000,
    "mainHandlerPhone": "1308987****",
    "feedback": "feedback",
    "cancelReasonDescription": "Cancellation reason description",
    "cancelReason": 37,
    "durationTime": 300000,
    "progressSummaryRichTextId": 1231231,
    "handingProblemOperateLogs": [
      {
        "operator": "Alex",
        "userId": 233,
        "actionName": "Cancel problem",
        "actionTime": "2010-03-09 15:53:45",
        "userIsValid": 1
      }
    ],
    "restoredProblemOperateLogs": [
      {
        "operator": "Alex",
        "userId": 3232,
        "actionName": "Restore problem",
        "actionTime": "2020-08-08 15:39:39",
        "userIsValid": 1
      }
    ],
    "replayingProblemOperateLogs": [
      {
        "operator": "Xiaojie",
        "userId": 123456,
        "actionName": "Review problem",
        "actionTime": "2020-08-08 15:39:39",
        "userIsValid": 1
      }
    ],
    "replayProblemOperateLogs": [
      {
        "operator": "Alex",
        "userId": 2323,
        "actionName": "Review problem",
        "actionTime": "2020-08-08 15:39:39",
        "userIsValid": 1
      }
    ],
    "effectionServices": [
      {
        "effectionServiceId": 1,
        "effectionLevel": 1,
        "effectionStatus": 1,
        "description": "Description",
        "serviceName": "Shopping cart",
        "serviceDeleteType": 1
      }
    ],
    "coordinationGroups": [
      {
        "serviceGroupId": 1,
        "serviceGroupName": "Soaring into the clouds",
        "isValid": 1
      }
    ],
    "timelines": [
      {
        "keyNode": "1,2,3,4,5,7,6,8,9,10"
      }
    ],
    "cancelProblemOperateLogs": [
      {
        "operator": "Alex",
        "actionName": "Cancel problem",
        "actionTime": "2020-09-08 15:38:38",
        "userId": 66666
      }
    ],
    "serviceDeleteType": 1,
    "mainHandlerIsValid": 1,
    "isRuleTrigger": true
  },
  "requestId": "C4BE3837-1A13-41VB-A225-2C88188E8A43"
}

Error codes

HTTP status code

Error code

Error message

Description
404 ProblemNotExisted The problem does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.