Overview
Query the current SOP types that can be created, including their display names, target input prompts, and prerequisite constraints.
API details
Constraints
You must have the SOP_TASK:READ permission.
Request path
GET /api/v2/sop/types
Request parameters
None.
Response parameters
Parameter |
Type |
Description |
|
|---|---|---|---|
| successful | Boolean | Whether the request was successful. For successful requests, this field is fixed astrue. |
|
| data.contents | Array | Array of SOP types. | |
| data.contents[].code | String | Type code. Currently, it isREBUILD_STANDBY_TENANT(Rebuild standby tenant),ARBITRATION_FOR_FAULTY_REPLICA(Arbitration service is enabled for abnormal replicas),OBSERVER_DATA_REBUILD(OBServer data reconstruction after exception). |
|
| data.contents[].displayName | String | The display name of the type in the current locale. | |
| data.contents[].targetParamHint | Array<String> | Input prompts for the operation target, returned in the order they are displayed; an empty array if no prompts are available. | |
| data.contents[].constraints | String \ | null | The business constraint description for this type in the current locale. If there is no constraint, it isnull. |
| timestamp | Datetime | The time taken by the server to create the response. | |
| duration | Long | The time consumed by the server for processing, in milliseconds. | |
| status | Integer | HTTP status code. In case of success, it is200. |
|
| traceId | String | Request link ID, used for log troubleshooting. |